src/Global.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // MuldeR's Utilities for Qt
   3 // Copyright (C) 2004-2014 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 #if _MSC_VER
  23 #define _CRT_RAND_S 1
  24 #endif
  25
  26 //MUtils
  27 #include <MUtils/Global.h>
  28 #include <MUtils/OSSupport.h>
  29
  30 //Internal
  31 #include "DirLocker.h"
  32 #include "3rd_party/strnatcmp/include/strnatcmp.h"
  33
  34 //Qt
  35 #include <QDir>
  36 #include <QReadWriteLock>
  37 #include <QProcess>
  38 #include <QTextCodec>
  39
  40 //CRT
  41 #include <cstdlib>
  42 #include <ctime>
  43 #include <process.h>
  44
  45 //VLD
  46 #ifdef _MSC_VER
  47 #include <vld.h>
  48 #endif
  49
  50 ///////////////////////////////////////////////////////////////////////////////
  51 // Random Support
  52 ///////////////////////////////////////////////////////////////////////////////
  53
  54 //Robert Jenkins' 96 bit Mix Function
  55 static unsigned int mix_function(const unsigned int x, const unsigned int y, const unsigned int z)
  56 {
  57         unsigned int a = x;
  58         unsigned int b = y;
  59         unsigned int c = z;
  60
  61         a=a-b;  a=a-c;  a=a^(c >> 13);
  62         b=b-c;  b=b-a;  b=b^(a << 8 );
  63         c=c-a;  c=c-b;  c=c^(b >> 13);
  64         a=a-b;  a=a-c;  a=a^(c >> 12);
  65         b=b-c;  b=b-a;  b=b^(a << 16);
  66         c=c-a;  c=c-b;  c=c^(b >> 5 );
  67         a=a-b;  a=a-c;  a=a^(c >> 3 );
  68         b=b-c;  b=b-a;  b=b^(a << 10);
  69         c=c-a;  c=c-b;  c=c^(b >> 15);
  70
  71         return a ^ b ^ c;
  72 }
  73
  74 void MUtils::seed_rand(void)
  75 {
  76         qsrand(mix_function(clock(), time(NULL), _getpid()));
  77 }
  78
  79 quint32 MUtils::next_rand32(void)
  80 {
  81         quint32 rnd = 0xDEADBEEF;
  82
  83 #ifdef _CRT_RAND_S
  84         if(rand_s(&rnd) == 0)
  85         {
  86                 return rnd;
  87         }
  88 #endif //_CRT_RAND_S
  89
  90         for(size_t i = 0; i < sizeof(quint32); i++)
  91         {
  92                 rnd = (rnd << 8) ^ qrand();
  93         }
  94
  95         return rnd;
  96 }
  97
  98 quint64 MUtils::next_rand64(void)
  99 {
 100         return (quint64(next_rand32()) << 32) | quint64(next_rand32());
 101 }
 102
 103 QString MUtils::rand_str(const bool &bLong)
 104 {
 105         if(!bLong)
 106         {
 107                 return QString::number(next_rand64(), 16).rightJustified(16, QLatin1Char('0'));
 108         }
 109         return QString("%1%2").arg(rand_str(false), rand_str(false));
 110 }
 111
 112 ///////////////////////////////////////////////////////////////////////////////
 113 // TEMP FOLDER
 114 ///////////////////////////////////////////////////////////////////////////////
 115
 116 static QScopedPointer<MUtils::Internal::DirLock> g_temp_folder_file;
 117 static QReadWriteLock                            g_temp_folder_lock;
 118
 119 static QString try_create_subfolder(const QString &baseDir, const QString &postfix)
 120 {
 121         const QString baseDirPath = QDir(baseDir).absolutePath();
 122         for(int i = 0; i < 32; i++)
 123         {
 124                 QDir directory(baseDirPath);
 125                 if(directory.mkpath(postfix) && directory.cd(postfix))
 126                 {
 127                         return directory.canonicalPath();
 128                 }
 129         }
 130         return QString();
 131 }
 132
 133 static MUtils::Internal::DirLock *try_init_temp_folder(const QString &baseDir)
 134 {
 135         const QString tempPath = try_create_subfolder(baseDir, MUtils::rand_str());
 136         if(!tempPath.isEmpty())
 137         {
 138                 for(int i = 0; i < 32; i++)
 139                 {
 140                         MUtils::Internal::DirLock *lockFile = NULL;
 141                         try
 142                         {
 143                                 lockFile = new MUtils::Internal::DirLock(tempPath);
 144                                 return lockFile;
 145                         }
 146                         catch(MUtils::Internal::DirLockException&)
 147                         {
 148                                 /*ignore error and try again*/
 149                         }
 150                 }
 151         }
 152         return NULL;
 153 }
 154
 155 static void temp_folder_cleaup(void)
 156 {
 157         QWriteLocker writeLock(&g_temp_folder_lock);
 158
 159         //Clean the directory
 160         while(!g_temp_folder_file.isNull())
 161         {
 162                 g_temp_folder_file.reset(NULL);
 163         }
 164 }
 165
 166 const QString &MUtils::temp_folder(void)
 167 {
 168         QReadLocker readLock(&g_temp_folder_lock);
 169
 170         //Already initialized?
 171         if(!g_temp_folder_file.isNull())
 172         {
 173                 return g_temp_folder_file->getPath();
 174         }
 175
 176         //Obtain the write lock to initilaize
 177         readLock.unlock();
 178         QWriteLocker writeLock(&g_temp_folder_lock);
 179
 180         //Still uninitilaized?
 181         if(!g_temp_folder_file.isNull())
 182         {
 183                 return g_temp_folder_file->getPath();
 184         }
 185
 186         //Try the %TMP% or %TEMP% directory first
 187         if(MUtils::Internal::DirLock *lockFile = try_init_temp_folder(QDir::tempPath()))
 188         {
 189                 g_temp_folder_file.reset(lockFile);
 190                 atexit(temp_folder_cleaup);
 191                 return lockFile->getPath();
 192         }
 193
 194         qWarning("%%TEMP%% directory not found -> trying fallback mode now!");
 195         static const OS::known_folder_t FOLDER_ID[2] = { OS::FOLDER_LOCALAPPDATA, OS::FOLDER_SYSTROOT_DIR };
 196         for(size_t id = 0; id < 2; id++)
 197         {
 198                 const QString &knownFolder = OS::known_folder(FOLDER_ID[id]);
 199                 if(!knownFolder.isEmpty())
 200                 {
 201                         const QString tempRoot = try_create_subfolder(knownFolder, QLatin1String("TEMP"));
 202                         if(!tempRoot.isEmpty())
 203                         {
 204                                 if(MUtils::Internal::DirLock *lockFile = try_init_temp_folder(tempRoot))
 205                                 {
 206                                         g_temp_folder_file.reset(lockFile);
 207                                         atexit(temp_folder_cleaup);
 208                                         return lockFile->getPath();
 209                                 }
 210                         }
 211                 }
 212         }
 213
 214         qFatal("Temporary directory could not be initialized !!!");
 215         return (*((QString*)NULL));
 216 }
 217
 218 ///////////////////////////////////////////////////////////////////////////////
 219 // REMOVE DIRECTORY / FILE
 220 ///////////////////////////////////////////////////////////////////////////////
 221
 222 bool MUtils::remove_file(const QString &fileName)
 223 {
 224         QFileInfo fileInfo(fileName);
 225         if(!(fileInfo.exists() && fileInfo.isFile()))
 226         {
 227                 return true;
 228         }
 229
 230         for(int i = 0; i < 32; i++)
 231         {
 232                 QFile file(fileName);
 233                 file.setPermissions(QFile::ReadOther | QFile::WriteOther);
 234                 if(file.remove())
 235                 {
 236                         return true;
 237                 }
 238         }
 239
 240         qWarning("Could not delete \"%s\"", MUTILS_UTF8(fileName));
 241         return false;
 242 }
 243
 244 bool MUtils::remove_directory(const QString &folderPath)
 245 {
 246         QDir folder(folderPath);
 247         if(!folder.exists())
 248         {
 249                 return true;
 250         }
 251
 252         const QFileInfoList entryList = folder.entryInfoList(QDir::AllEntries | QDir::NoDotAndDotDot | QDir::Hidden);
 253         for(int i = 0; i < entryList.count(); i++)
 254         {
 255                 if(entryList.at(i).isDir())
 256                 {
 257                         remove_directory(entryList.at(i).canonicalFilePath());
 258                 }
 259                 else
 260                 {
 261                         remove_file(entryList.at(i).canonicalFilePath());
 262                 }
 263         }
 264
 265         for(int i = 0; i < 32; i++)
 266         {
 267                 if(folder.rmdir("."))
 268                 {
 269                         return true;
 270                 }
 271         }
 272
 273         qWarning("Could not rmdir \"%s\"", MUTILS_UTF8(folderPath));
 274         return false;
 275 }
 276
 277 ///////////////////////////////////////////////////////////////////////////////
 278 // PROCESS UTILS
 279 ///////////////////////////////////////////////////////////////////////////////
 280
 281 void MUtils::init_process(QProcess &process, const QString &wokringDir, const bool bReplaceTempDir)
 282 {
 283         //Environment variable names
 284         static const char *const s_envvar_names_temp[] =
 285         {
 286                 "TEMP", "TMP", "TMPDIR", "HOME", "USERPROFILE", "HOMEPATH", NULL
 287         };
 288         static const char *const s_envvar_names_remove[] =
 289         {
 290                 "WGETRC", "SYSTEM_WGETRC", "HTTP_PROXY", "FTP_PROXY", "NO_PROXY", "GNUPGHOME", "LC_ALL", "LC_COLLATE", "LC_CTYPE", "LC_MESSAGES", "LC_MONETARY", "LC_NUMERIC", "LC_TIME", "LANG", NULL
 291         };
 292
 293         //Initialize environment
 294         QProcessEnvironment env = process.processEnvironment();
 295         if(env.isEmpty()) env = QProcessEnvironment::systemEnvironment();
 296
 297         //Clean a number of enviroment variables that might affect our tools
 298         for(size_t i = 0; s_envvar_names_remove[i]; i++)
 299         {
 300                 env.remove(QString::fromLatin1(s_envvar_names_remove[i]));
 301                 env.remove(QString::fromLatin1(s_envvar_names_remove[i]).toLower());
 302         }
 303
 304         const QString tempDir = QDir::toNativeSeparators(temp_folder());
 305
 306         //Replace TEMP directory in environment
 307         if(bReplaceTempDir)
 308         {
 309                 for(size_t i = 0; s_envvar_names_temp[i]; i++)
 310                 {
 311                         env.insert(s_envvar_names_temp[i], tempDir);
 312                 }
 313         }
 314
 315         //Setup PATH variable
 316         const QString path = env.value("PATH", QString()).trimmed();
 317         env.insert("PATH", path.isEmpty() ? tempDir : QString("%1;%2").arg(tempDir, path));
 318
 319         //Setup QPorcess object
 320         process.setWorkingDirectory(wokringDir);
 321         process.setProcessChannelMode(QProcess::MergedChannels);
 322         process.setReadChannel(QProcess::StandardOutput);
 323         process.setProcessEnvironment(env);
 324 }
 325
 326 ///////////////////////////////////////////////////////////////////////////////
 327 // NATURAL ORDER STRING COMPARISON
 328 ///////////////////////////////////////////////////////////////////////////////
 329
 330 static bool natural_string_sort_helper(const QString &str1, const QString &str2)
 331 {
 332         return (MUtils::Internal::NaturalSort::strnatcmp(MUTILS_WCHR(str1), MUTILS_WCHR(str2)) < 0);
 333 }
 334
 335 static bool natural_string_sort_helper_fold_case(const QString &str1, const QString &str2)
 336 {
 337         return (MUtils::Internal::NaturalSort::strnatcasecmp(MUTILS_WCHR(str1), MUTILS_WCHR(str2)) < 0);
 338 }
 339
 340 void MUtils::natural_string_sort(QStringList &list, const bool bIgnoreCase)
 341 {
 342         qSort(list.begin(), list.end(), bIgnoreCase ? natural_string_sort_helper_fold_case : natural_string_sort_helper);
 343 }
 344
 345 ///////////////////////////////////////////////////////////////////////////////
 346 // CLEAN FILE PATH
 347 ///////////////////////////////////////////////////////////////////////////////
 348
 349 static const struct
 350 {
 351         const char *const search;
 352         const char *const replace;
 353 }
 354 CLEAN_FILE_NAME[] =
 355 {
 356         { "\\",  "-"  },
 357         { " / ", ", " },
 358         { "/",   ","  },
 359         { ":",   "-"  },
 360         { "*",   "x"  },
 361         { "?",   "!"  },
 362         { "<",   "["  },
 363         { ">",   "]"  },
 364         { "|",   "!"  },
 365         { "\"",  "'"  },
 366         { NULL,  NULL }
 367 };
 368
 369 QString MUtils::clean_file_name(const QString &name)
 370 {
 371         QString str = name.simplified();
 372
 373         for(size_t i = 0; CLEAN_FILE_NAME[i].search; i++)
 374         {
 375                 str.replace(CLEAN_FILE_NAME[i].search, CLEAN_FILE_NAME[i].replace);
 376         }
 377
 378         QRegExp regExp("\"(.+)\"");
 379         regExp.setMinimal(true);
 380         str.replace(regExp, "`\\1´");
 381
 382         return str.simplified();
 383 }
 384
 385 QString MUtils::clean_file_path(const QString &path)
 386 {
 387         QStringList parts = path.simplified().replace("\\", "/").split("/", QString::SkipEmptyParts);
 388
 389         for(int i = 0; i < parts.count(); i++)
 390         {
 391                 parts[i] = MUtils::clean_file_name(parts[i]);
 392         }
 393
 394         return parts.join("/");
 395 }
 396
 397 ///////////////////////////////////////////////////////////////////////////////
 398 // REGULAR EXPESSION HELPER
 399 ///////////////////////////////////////////////////////////////////////////////
 400
 401 bool MUtils::regexp_parse_uint32(const QRegExp &regexp, quint32 &value)
 402 {
 403         return regexp_parse_uint32(regexp, &value, 1);
 404 }
 405
 406 bool MUtils::regexp_parse_uint32(const QRegExp &regexp, quint32 *values, const size_t &count)
 407 {
 408         const QStringList caps = regexp.capturedTexts();
 409
 410         if(caps.isEmpty() || (quint32(caps.count()) <= count))
 411         {
 412                 return false;
 413         }
 414
 415         for(size_t i = 0; i < count; i++)
 416         {
 417                 bool ok = false;
 418                 values[i] = caps[i+1].toUInt(&ok);
 419                 if(!ok)
 420                 {
 421                         return false;
 422                 }
 423         }
 424
 425         return true;
 426 }
 427
 428 ///////////////////////////////////////////////////////////////////////////////
 429 // AVAILABLE CODEPAGES
 430 ///////////////////////////////////////////////////////////////////////////////
 431
 432 QStringList MUtils::available_codepages(const bool &noAliases)
 433 {
 434         QStringList codecList;
 435         QList<QByteArray> availableCodecs = QTextCodec::availableCodecs();
 436
 437         while(!availableCodecs.isEmpty())
 438         {
 439                 const QByteArray current = availableCodecs.takeFirst();
 440                 if(!current.toLower().startsWith("system"))
 441                 {
 442                         codecList << QString::fromLatin1(current.constData(), current.size());
 443                         if(noAliases)
 444                         {
 445                                 if(QTextCodec *const currentCodec = QTextCodec::codecForName(current.constData()))
 446                                 {
 447                                         const QList<QByteArray> aliases = currentCodec->aliases();
 448                                         for(QList<QByteArray>::ConstIterator iter = aliases.constBegin(); iter != aliases.constEnd(); iter++)
 449                                         {
 450                                                 availableCodecs.removeAll(*iter);
 451                                         }
 452                                 }
 453                         }
 454                 }
 455         }
 456
 457         return codecList;
 458 }
 459
 460 ///////////////////////////////////////////////////////////////////////////////
 461 // SELF-TEST
 462 ///////////////////////////////////////////////////////////////////////////////
 463
 464 int MUtils::Internal::selfTest(const char *const buildKey, const bool debug)
 465 {
 466         static const bool MY_DEBUG_FLAG = MUTILS_DEBUG;
 467         static const char *const MY_BUILD_KEY = __DATE__"@"__TIME__;
 468
 469         if(strncmp(buildKey, MY_BUILD_KEY, 14) || (MY_DEBUG_FLAG != debug))
 470         {
 471                 MUtils::OS::system_message_err(L"MUtils", L"FATAL ERROR: MUtils library version mismatch detected!");
 472                 MUtils::OS::system_message_wrn(L"MUtils", L"Please re-build the complete solution in order to fix this issue!");
 473                 abort();
 474         }
 475         return 0;
 476 }