include/MUtils/OSSupport.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // MuldeR's Utilities for Qt
   3 // Copyright (C) 2004-2019 LoRd_MuldeR <MuldeR2@GMX.de>
   4 //
   5 // This library is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU Lesser General Public
   7 // License as published by the Free Software Foundation; either
   8 // version 2.1 of the License, or (at your option) any later version.
   9 //
  10 // This library is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // Lesser General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU Lesser General Public
  16 // License along with this library; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  18 //
  19 // http://www.gnu.org/licenses/lgpl-2.1.txt
  20 //////////////////////////////////////////////////////////////////////////////////
  21
  22 /**
  23  * @file
  24  * @brief This file contains function that wrap OS-specific functionality in a platform-independent way
  25  */
  26
  27 #pragma once
  28
  29 //MUtils
  30 #include <MUtils/Global.h>
  31
  32 //Qt
  33 #include <QString>
  34 #include <QMap>
  35 #include <QDate>
  36 #include <QWidget>
  37
  38 //Forward declaration
  39 class QFile;
  40
  41 ///////////////////////////////////////////////////////////////////////////////
  42
  43 /**
  44 * \brief Global MUtils namespace
  45 */
  46 namespace MUtils
  47 {
  48         /**
  49         * \brief MUtils OS-specific functions namespace
  50         */
  51         namespace OS
  52         {
  53                 /**
  54                 * \brief OS version information namespace
  55                 */
  56                 namespace Version
  57                 {
  58                         /**
  59                         * \brief This enumeration specifies the type of the underlaying operating system
  60                         */
  61                         typedef enum
  62                         {
  63                                 OS_UNKNOWN = 0,  ///< Unknown operating system
  64                                 OS_WINDOWS = 1   ///< Microsoft(R) Windows
  65                         }
  66                         os_type_t;
  67
  68                         /**
  69                         * \brief This struct contains version information about the underlaying operating system. See `_os_version_t` for details!
  70                         */
  71                         typedef struct _os_version_t
  72                         {
  73                                 unsigned int type;          ///< The type of the underlaying operating system, as `os_type_t`
  74                                 unsigned int versionMajor;  ///< The *major* version of the underlaying operating system
  75                                 unsigned int versionMinor;  ///< The *minor* version of the underlaying operating system
  76                                 unsigned int versionBuild;  ///< The *build* number of the underlaying operating system
  77                                 unsigned int versionSPack;  ///< The *service pack* version of the underlaying operating system
  78                                 bool overrideFlag;
  79
  80                                 MUTILS_API bool operator== (const _os_version_t &rhs) const;
  81                                 MUTILS_API bool operator!= (const _os_version_t &rhs) const;
  82                                 MUTILS_API bool operator>  (const _os_version_t &rhs) const;
  83                                 MUTILS_API bool operator>= (const _os_version_t &rhs) const;
  84                                 MUTILS_API bool operator<  (const _os_version_t &rhs) const;
  85                                 MUTILS_API bool operator<= (const _os_version_t &rhs) const;
  86                         }
  87                         os_version_t;
  88
  89                         //Known Windows NT versions
  90                         MUTILS_API extern const os_version_t WINDOWS_WIN2K;  ///< \brief Operating system version constant \details Microsoft(R) Windows 2000
  91                         MUTILS_API extern const os_version_t WINDOWS_WINXP;  ///< \brief Operating system version constant \details Microsoft(R) Windows XP
  92                         MUTILS_API extern const os_version_t WINDOWS_XPX64;  ///< \brief Operating system version constant \details Microsoft(R) Windows XP x64-edition
  93                         MUTILS_API extern const os_version_t WINDOWS_VISTA;  ///< \brief Operating system version constant \details Microsoft(R) Windows Vista
  94                         MUTILS_API extern const os_version_t WINDOWS_WIN70;  ///< \brief Operating system version constant \details Microsoft(R) Windows 7
  95                         MUTILS_API extern const os_version_t WINDOWS_WIN80;  ///< \brief Operating system version constant \details Microsoft(R) Windows 8
  96                         MUTILS_API extern const os_version_t WINDOWS_WIN81;  ///< \brief Operating system version constant \details Microsoft(R) Windows 8.1
  97                         MUTILS_API extern const os_version_t WINDOWS_WN100;  ///< \brief Operating system version constant \details Microsoft(R) Windows 10
  98
  99                         //Unknown OS
 100                         MUTILS_API extern const os_version_t UNKNOWN_OPSYS;  ///< \brief Operating system version constant \details Unknown operating system version
 101                 }
 102
 103                 /**
 104                 * \brief This enumeration specifies "known" folder identifiers
 105                 */
 106                 typedef enum
 107                 {
 108                         FOLDER_LOCALAPPDATA = 0,  ///< Local application data (non-roaming)
 109                         FOLDER_PROGRAMFILES = 2,  ///< Program files
 110                         FOLDER_SYSTEMFOLDER = 3,  ///< System directory
 111                         FOLDER_SYSTROOT_DIR = 4   ///< System "root" directory
 112                 }
 113                 known_folder_t;
 114
 115                 /**
 116                 * \brief This enumeration specifies network connection types
 117                 */
 118                 typedef enum
 119                 {
 120                         NETWORK_TYPE_ERR = 0,  ///< Network connection is unknown
 121                         NETWORK_TYPE_NON = 1,  ///< Computer is **not** connected to a network
 122                         NETWORK_TYPE_YES = 2   ///< Computer *is* connected to a network
 123                 }
 124                 network_type_t;
 125
 126                 /**
 127                 * \brief This enumeration specifies drive types
 128                 */
 129                 typedef enum
 130                 {
 131                         DRIVE_TYPE_ERR = 0,  ///< The drive type cannot be determined
 132                         DRIVE_TYPE_FDD = 1,  ///< Floppy Drive, or Flash Card reader
 133                         DRIVE_TYPE_HDD = 2,  ///< Hard Disk drive or Solid-State Drive
 134                         DRIVE_TYPE_NET = 3,  ///< Remote/Network drive
 135                         DRIVE_TYPE_OPT = 4,  ///< Optical disk srive, e.g. CD or DVD
 136                         DRIVE_TYPE_RAM = 5   ///< RAM disk
 137                 }
 138                 drive_type_t;
 139
 140                 //System message
 141                 MUTILS_API void system_message_nfo(const wchar_t *const title, const wchar_t *const text);
 142                 MUTILS_API void system_message_wrn(const wchar_t *const title, const wchar_t *const text);
 143                 MUTILS_API void system_message_err(const wchar_t *const title, const wchar_t *const text);
 144
 145                 //CLI Arguments
 146                 typedef QMap<QString,QString> ArgumentMap;
 147                 MUTILS_API const QStringList crack_command_line(const QString &command_line = QString());
 148                 MUTILS_API const ArgumentMap &arguments(void);
 149
 150                 //Copy file
 151                 typedef bool (*progress_callback_t)(const double &progress, void *const userData);
 152                 MUTILS_API bool copy_file(const QString &sourcePath, const QString &outputPath, const bool &overwrite = true, const progress_callback_t callback = NULL, void *const userData = NULL);
 153
 154                 //Get file version
 155                 MUTILS_API bool get_file_version(const QString fileName, quint16 *const major = NULL, quint16 *const minor = NULL, quint16 *const patch = NULL, quint16 *const build = NULL);
 156
 157                 //Get the OS version
 158                 MUTILS_API const Version::os_version_t &os_version(void);
 159                 MUTILS_API const char *os_friendly_name(const MUtils::OS::Version::os_version_t &os_version);
 160                 MUTILS_API const bool &running_on_wine(void);
 161
 162                 //Get known Folder
 163                 MUTILS_API const QString &known_folder(known_folder_t folder_id);
 164
 165                 //Current Date & Time
 166                 MUTILS_API QDate current_date(void);
 167                 MUTILS_API quint64 current_file_time(void);
 168
 169                 //Check for process elevation
 170                 MUTILS_API bool is_elevated(bool *bIsUacEnabled = NULL);
 171                 MUTILS_API bool user_is_admin(void);
 172
 173                 /**
 174                 * \brief Check the network status
 175                 *
 176                 * Checks whether the computer is *currently* connected to a network. Note that an existing network connection does **not** necessarily imply actual Internet access!
 177                 *
 178                 * \return The function returns the current network status as a `OS::network_type_t` value.
 179                 */
 180                 MUTILS_API int network_status(void);
 181
 182                 //Message handler
 183                 MUTILS_API bool handle_os_message(const void *const message, long *result);
 184
 185                 /**
 186                 * \brief Suspend calling thread
 187                 *
 188                 * This function suspends the calling thread. The thread will give up its current time-slice and enter "sleeping" state. The thread will remain in "sleeping" for the specified duration. After the specified duration has elapsed, the thread will be resumed.
 189                 *
 190                 * Note that it depends on the operating system's scheduling decisions, when the thread will actually be allowed to execute again! While the thread is still in "sleeping" state, it can **not** be selected for execution by the operating system's scheduler. Once the thread is *no* longer in "sleeping" state, i.e. the specified period has elapsed, the thread *can* be selected for execution by the operating system's scheduler again - but this does **not** need to happen *immediately*! The scheduler decides which thread is allowed to execute next, taking into consideration thread priorities.
 191                 *
 192                 * \param duration The amount of time that the thread will be suspended, in milliseconds. A value of **0** means that the thread will *not* actually enter "sleeping" state, but it will still give up its current time-slice!
 193                 */
 194                 MUTILS_API void sleep_ms(const size_t &duration);
 195
 196                 //Is executable/library file?
 197                 MUTILS_API bool is_executable_file(const QString &path);
 198                 MUTILS_API bool is_library_file(const QString &path);
 199
 200                 //Shutdown & Hibernation
 201                 MUTILS_API bool is_hibernation_supported(void);
 202                 MUTILS_API bool shutdown_computer(const QString &message, const unsigned long timeout, const bool forceShutdown, const bool hibernate);
 203
 204                 //Free diskspace
 205                 MUTILS_API bool free_diskspace(const QString &path, quint64 &freeSpace);
 206
 207                 /**
 208                 * \brief Detect drive type
 209                 *
 210                 * This function detetcs the type of the drive to which the given path is pointing.
 211                 *
 212                 * \param path The path to the drive whose type is to be detected. On the Windows platform, only the drive letter is relevant.
 213                 *
 214                 * \param fast_seeking Pointer to a variable that will be set to TRUE, if the drive supports "fast" seeking (e.g. SSD or similar device), or to FALSE otherwise. This parameter is optional and may be NULL.
 215                 *
 216                 * \return The function returns the type of the drive as a `OS::drive_type_t` value. In case of error, the value `DRIVE_TYPE_ERR` will be returned.
 217                 */
 218                 MUTILS_API drive_type_t get_drive_type(const QString &path, bool *fast_seeking = NULL);
 219
 220                 //Shell open
 221                 MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const bool explore = false);
 222                 MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const QString &parameters, const QString &directory, const bool explore = false);
 223
 224                 //Open media file
 225                 MUTILS_API bool open_media_file(const QString &mediaFilePath);
 226
 227                 //Process priority
 228                 MUTILS_API bool change_process_priority(const int priority);
 229                 MUTILS_API bool change_process_priority(const QProcess *proc, const int priority);
 230
 231                 //Process ID
 232                 MUTILS_API quint32 process_id(void);
 233                 MUTILS_API quint32 process_id(const QProcess *const proc);
 234
 235                 //Thread ID
 236                 MUTILS_API quint32 thread_id(void);
 237                 MUTILS_API quint32 thread_id(const QProcess *const proc);
 238
 239                 //Suspend or resume processv
 240                 MUTILS_API bool suspend_process(const QProcess *proc, const bool suspend);
 241
 242                 //System timer resolution
 243                 MUTILS_API bool setup_timer_resolution(const quint32 &interval = 1);
 244                 MUTILS_API bool reset_timer_resolution(const quint32 &interval = 1);
 245
 246                 //Set file time
 247                 MUTILS_API bool set_file_time(const QFile &file,   const QDateTime &created = QDateTime(), const QDateTime &modified = QDateTime(), const QDateTime &accessed = QDateTime());
 248                 MUTILS_API bool set_file_time(const QString &path, const QDateTime &created = QDateTime(), const QDateTime &modified = QDateTime(), const QDateTime &accessed = QDateTime());
 249
 250                 //Keyboard support
 251                 MUTILS_API bool check_key_state_esc(void);
 252
 253                 //Shell notification
 254                 MUTILS_API void shell_change_notification(void);
 255
 256                 //Get file path from descriptor
 257                 MUTILS_API QString get_file_path(const int &fd);
 258
 259                 //WOW64 redirection
 260                 MUTILS_API bool wow64fsredir_disable(void *oldValue);
 261                 MUTILS_API bool wow64fsredir_revert (void *oldValue);
 262
 263                 //Environment variables
 264                 MUTILS_API QString get_envvar(const QString &name);
 265                 MUTILS_API bool set_envvar(const QString &name, const QString &value);
 266
 267                 //NULL device
 268                 MUTILS_API const QLatin1String &null_device(void);
 269
 270                 //Check if debugger is present
 271                 MUTILS_API void check_debugger(void);
 272
 273                 //Error handling
 274                 MUTILS_API void fatal_exit(const wchar_t* const errorMessage);
 275         }
 276 }
 277
 278 ///////////////////////////////////////////////////////////////////////////////