src/Global.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // MuldeR's Utilities for Qt
   3 // Copyright (C) 2004-2015 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 // COMPUTE PARITY
 114 ///////////////////////////////////////////////////////////////////////////////
 115
 116 /*
 117  * Compute parity in parallel
 118  * http://www.graphics.stanford.edu/~seander/bithacks.html#ParityParallel
 119  */
 120 bool MUtils::parity(quint32 value)
 121 {
 122         value ^= value >> 16;
 123         value ^= value >> 8;
 124         value ^= value >> 4;
 125         value &= 0xf;
 126         return ((0x6996 >> value) & 1) != 0;
 127 }
 128
 129 ///////////////////////////////////////////////////////////////////////////////
 130 // TEMP FOLDER
 131 ///////////////////////////////////////////////////////////////////////////////
 132
 133 static QScopedPointer<MUtils::Internal::DirLock> g_temp_folder_file;
 134 static QReadWriteLock                            g_temp_folder_lock;
 135
 136 static QString try_create_subfolder(const QString &baseDir, const QString &postfix)
 137 {
 138         const QString baseDirPath = QDir(baseDir).absolutePath();
 139         for(int i = 0; i < 32; i++)
 140         {
 141                 QDir directory(baseDirPath);
 142                 if(directory.mkpath(postfix) && directory.cd(postfix))
 143                 {
 144                         return directory.canonicalPath();
 145                 }
 146         }
 147         return QString();
 148 }
 149
 150 static MUtils::Internal::DirLock *try_init_temp_folder(const QString &baseDir)
 151 {
 152         const QString tempPath = try_create_subfolder(baseDir, MUtils::rand_str());
 153         if(!tempPath.isEmpty())
 154         {
 155                 for(int i = 0; i < 32; i++)
 156                 {
 157                         MUtils::Internal::DirLock *lockFile = NULL;
 158                         try
 159                         {
 160                                 lockFile = new MUtils::Internal::DirLock(tempPath);
 161                                 return lockFile;
 162                         }
 163                         catch(MUtils::Internal::DirLockException&)
 164                         {
 165                                 /*ignore error and try again*/
 166                         }
 167                 }
 168         }
 169         return NULL;
 170 }
 171
 172 static bool temp_folder_cleanup_helper(const QString &tempPath)
 173 {
 174         size_t delay = 1;
 175         static const size_t MAX_DELAY = 8192;
 176         forever
 177         {
 178                 QDir::setCurrent(QDir::rootPath());
 179                 if(MUtils::remove_directory(tempPath, true))
 180                 {
 181                         return true;
 182                 }
 183                 else
 184                 {
 185                         if(delay > MAX_DELAY)
 186                         {
 187                                 return false;
 188                         }
 189                         MUtils::OS::sleep_ms(delay);
 190                         delay *= 2;
 191                 }
 192         }
 193 }
 194
 195 static void temp_folder_cleaup(void)
 196 {
 197         QWriteLocker writeLock(&g_temp_folder_lock);
 198
 199         //Clean the directory
 200         while(!g_temp_folder_file.isNull())
 201         {
 202                 const QString tempPath = g_temp_folder_file->getPath();
 203                 g_temp_folder_file.reset(NULL);
 204                 if(!temp_folder_cleanup_helper(tempPath))
 205                 {
 206                         MUtils::OS::system_message_wrn(L"Temp Cleaner", L"Warning: Not all temporary files could be removed!");
 207                 }
 208         }
 209 }
 210
 211 const QString &MUtils::temp_folder(void)
 212 {
 213         QReadLocker readLock(&g_temp_folder_lock);
 214
 215         //Already initialized?
 216         if(!g_temp_folder_file.isNull())
 217         {
 218                 return g_temp_folder_file->getPath();
 219         }
 220
 221         //Obtain the write lock to initilaize
 222         readLock.unlock();
 223         QWriteLocker writeLock(&g_temp_folder_lock);
 224
 225         //Still uninitilaized?
 226         if(!g_temp_folder_file.isNull())
 227         {
 228                 return g_temp_folder_file->getPath();
 229         }
 230
 231         //Try the %TMP% or %TEMP% directory first
 232         if(MUtils::Internal::DirLock *lockFile = try_init_temp_folder(QDir::tempPath()))
 233         {
 234                 g_temp_folder_file.reset(lockFile);
 235                 atexit(temp_folder_cleaup);
 236                 return lockFile->getPath();
 237         }
 238
 239         qWarning("%%TEMP%% directory not found -> trying fallback mode now!");
 240         static const OS::known_folder_t FOLDER_ID[2] = { OS::FOLDER_LOCALAPPDATA, OS::FOLDER_SYSTROOT_DIR };
 241         for(size_t id = 0; id < 2; id++)
 242         {
 243                 const QString &knownFolder = OS::known_folder(FOLDER_ID[id]);
 244                 if(!knownFolder.isEmpty())
 245                 {
 246                         const QString tempRoot = try_create_subfolder(knownFolder, QLatin1String("TEMP"));
 247                         if(!tempRoot.isEmpty())
 248                         {
 249                                 if(MUtils::Internal::DirLock *lockFile = try_init_temp_folder(tempRoot))
 250                                 {
 251                                         g_temp_folder_file.reset(lockFile);
 252                                         atexit(temp_folder_cleaup);
 253                                         return lockFile->getPath();
 254                                 }
 255                         }
 256                 }
 257         }
 258
 259         qFatal("Temporary directory could not be initialized !!!");
 260         return (*((QString*)NULL));
 261 }
 262
 263 ///////////////////////////////////////////////////////////////////////////////
 264 // REMOVE DIRECTORY / FILE
 265 ///////////////////////////////////////////////////////////////////////////////
 266
 267 static const QFile::Permissions FILE_PERMISSIONS_NONE = QFile::ReadOther | QFile::WriteOther;
 268
 269 bool MUtils::remove_file(const QString &fileName)
 270 {
 271         QFileInfo fileInfo(fileName);
 272         if(!(fileInfo.exists() && fileInfo.isFile()))
 273         {
 274                 return true;
 275         }
 276
 277         for(int i = 0; i < 32; i++)
 278         {
 279                 QFile file(fileName);
 280                 file.setPermissions(FILE_PERMISSIONS_NONE);
 281                 if((!(fileInfo.exists() && fileInfo.isFile())) || file.remove())
 282                 {
 283                         return true;
 284                 }
 285                 fileInfo.refresh();
 286         }
 287
 288         qWarning("Could not delete \"%s\"", MUTILS_UTF8(fileName));
 289         return false;
 290 }
 291
 292 static bool remove_directory_helper(const QDir &folder)
 293 {
 294         if(!folder.exists())
 295         {
 296                 return true;
 297         }
 298         const QString dirName = folder.dirName();
 299         if(!dirName.isEmpty())
 300         {
 301                 QDir parent(folder);
 302                 if(parent.cdUp())
 303                 {
 304                         QFile::setPermissions(folder.absolutePath(), FILE_PERMISSIONS_NONE);
 305                         if(parent.rmdir(dirName))
 306                         {
 307                                 return true;
 308                         }
 309                 }
 310         }
 311         return false;
 312 }
 313
 314 bool MUtils::remove_directory(const QString &folderPath, const bool &recursive)
 315 {
 316         QDir folder(folderPath);
 317         if(!folder.exists())
 318         {
 319                 return true;
 320         }
 321
 322         if(recursive)
 323         {
 324                 const QFileInfoList entryList = folder.entryInfoList(QDir::AllEntries | QDir::NoDotAndDotDot | QDir::Hidden);
 325                 for(QFileInfoList::ConstIterator iter = entryList.constBegin(); iter != entryList.constEnd(); iter++)
 326                 {
 327                         if(iter->isDir())
 328                         {
 329                                 remove_directory(iter->canonicalFilePath(), true);
 330                         }
 331                         else if(iter->isFile())
 332                         {
 333                                 remove_file(iter->canonicalFilePath());
 334                         }
 335                 }
 336         }
 337
 338         for(int i = 0; i < 32; i++)
 339         {
 340                 if(remove_directory_helper(folder))
 341                 {
 342                         return true;
 343                 }
 344                 folder.refresh();
 345         }
 346
 347         qWarning("Could not rmdir \"%s\"", MUTILS_UTF8(folderPath));
 348         return false;
 349 }
 350
 351 ///////////////////////////////////////////////////////////////////////////////
 352 // PROCESS UTILS
 353 ///////////////////////////////////////////////////////////////////////////////
 354
 355 void MUtils::init_process(QProcess &process, const QString &wokringDir, const bool bReplaceTempDir)
 356 {
 357         //Environment variable names
 358         static const char *const s_envvar_names_temp[] =
 359         {
 360                 "TEMP", "TMP", "TMPDIR", "HOME", "USERPROFILE", "HOMEPATH", NULL
 361         };
 362         static const char *const s_envvar_names_remove[] =
 363         {
 364                 "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
 365         };
 366
 367         //Initialize environment
 368         QProcessEnvironment env = process.processEnvironment();
 369         if(env.isEmpty()) env = QProcessEnvironment::systemEnvironment();
 370
 371         //Clean a number of enviroment variables that might affect our tools
 372         for(size_t i = 0; s_envvar_names_remove[i]; i++)
 373         {
 374                 env.remove(QString::fromLatin1(s_envvar_names_remove[i]));
 375                 env.remove(QString::fromLatin1(s_envvar_names_remove[i]).toLower());
 376         }
 377
 378         const QString tempDir = QDir::toNativeSeparators(temp_folder());
 379
 380         //Replace TEMP directory in environment
 381         if(bReplaceTempDir)
 382         {
 383                 for(size_t i = 0; s_envvar_names_temp[i]; i++)
 384                 {
 385                         env.insert(s_envvar_names_temp[i], tempDir);
 386                 }
 387         }
 388
 389         //Setup PATH variable
 390         const QString path = env.value("PATH", QString()).trimmed();
 391         env.insert("PATH", path.isEmpty() ? tempDir : QString("%1;%2").arg(tempDir, path));
 392
 393         //Setup QPorcess object
 394         process.setWorkingDirectory(wokringDir);
 395         process.setProcessChannelMode(QProcess::MergedChannels);
 396         process.setReadChannel(QProcess::StandardOutput);
 397         process.setProcessEnvironment(env);
 398 }
 399
 400 ///////////////////////////////////////////////////////////////////////////////
 401 // NATURAL ORDER STRING COMPARISON
 402 ///////////////////////////////////////////////////////////////////////////////
 403
 404 static bool natural_string_sort_helper(const QString &str1, const QString &str2)
 405 {
 406         return (MUtils::Internal::NaturalSort::strnatcmp(MUTILS_WCHR(str1), MUTILS_WCHR(str2)) < 0);
 407 }
 408
 409 static bool natural_string_sort_helper_fold_case(const QString &str1, const QString &str2)
 410 {
 411         return (MUtils::Internal::NaturalSort::strnatcasecmp(MUTILS_WCHR(str1), MUTILS_WCHR(str2)) < 0);
 412 }
 413
 414 void MUtils::natural_string_sort(QStringList &list, const bool bIgnoreCase)
 415 {
 416         qSort(list.begin(), list.end(), bIgnoreCase ? natural_string_sort_helper_fold_case : natural_string_sort_helper);
 417 }
 418
 419 ///////////////////////////////////////////////////////////////////////////////
 420 // CLEAN FILE PATH
 421 ///////////////////////////////////////////////////////////////////////////////
 422
 423 static const struct
 424 {
 425         const char *const search;
 426         const char *const replace;
 427 }
 428 CLEAN_FILE_NAME[] =
 429 {
 430         { "\\",  "-"  },
 431         { " / ", ", " },
 432         { "/",   ","  },
 433         { ":",   "-"  },
 434         { "*",   "x"  },
 435         { "?",   "!"  },
 436         { "<",   "["  },
 437         { ">",   "]"  },
 438         { "|",   "!"  },
 439         { "\"",  "'"  },
 440         { NULL,  NULL }
 441 };
 442
 443 QString MUtils::clean_file_name(const QString &name)
 444 {
 445         QRegExp regExp("\"(.+)\"");
 446         regExp.setMinimal(true);
 447
 448         QString str = QString(name).replace(regExp, "``\\1´´").trimmed();
 449         for(size_t i = 0; CLEAN_FILE_NAME[i].search; i++)
 450         {
 451                 str.replace(CLEAN_FILE_NAME[i].search, CLEAN_FILE_NAME[i].replace);
 452         }
 453
 454         while(str.endsWith(QLatin1Char('.')))
 455         {
 456                 str.chop(1);
 457                 str = str.trimmed();
 458         }
 459
 460         return str.trimmed();
 461 }
 462
 463 QString MUtils::clean_file_path(const QString &path)
 464 {
 465         const bool root = path.startsWith(QLatin1Char('/')) || path.startsWith(QLatin1Char('\\'));
 466         QStringList parts = QDir::fromNativeSeparators(path.trimmed()).split(QLatin1Char('/'), QString::SkipEmptyParts);
 467
 468         for(int i = 0; i < parts.count(); i++)
 469         {
 470                 if((i == 0) && (!root) && (parts[i].length() == 2) && parts[i][0].isLetter() && (parts[i][1] == QLatin1Char(':')))
 471                 {
 472                         continue; //handle case "c:\"
 473                 }
 474                 parts[i] = MUtils::clean_file_name(parts[i]);
 475         }
 476
 477         return root ? parts.join(QLatin1String("/")).prepend(QLatin1Char('/')) : parts.join(QLatin1String("/"));
 478 }
 479
 480 ///////////////////////////////////////////////////////////////////////////////
 481 // REGULAR EXPESSION HELPER
 482 ///////////////////////////////////////////////////////////////////////////////
 483
 484 bool MUtils::regexp_parse_uint32(const QRegExp &regexp, quint32 &value)
 485 {
 486         return regexp_parse_uint32(regexp, &value, 1);
 487 }
 488
 489 bool MUtils::regexp_parse_uint32(const QRegExp &regexp, quint32 *values, const size_t &count)
 490 {
 491         const QStringList caps = regexp.capturedTexts();
 492
 493         if(caps.isEmpty() || (quint32(caps.count()) <= count))
 494         {
 495                 return false;
 496         }
 497
 498         for(size_t i = 0; i < count; i++)
 499         {
 500                 bool ok = false;
 501                 values[i] = caps[i+1].toUInt(&ok);
 502                 if(!ok)
 503                 {
 504                         return false;
 505                 }
 506         }
 507
 508         return true;
 509 }
 510
 511 ///////////////////////////////////////////////////////////////////////////////
 512 // AVAILABLE CODEPAGES
 513 ///////////////////////////////////////////////////////////////////////////////
 514
 515 QStringList MUtils::available_codepages(const bool &noAliases)
 516 {
 517         QStringList codecList;
 518         QList<QByteArray> availableCodecs = QTextCodec::availableCodecs();
 519
 520         while(!availableCodecs.isEmpty())
 521         {
 522                 const QByteArray current = availableCodecs.takeFirst();
 523                 if(!current.toLower().startsWith("system"))
 524                 {
 525                         codecList << QString::fromLatin1(current.constData(), current.size());
 526                         if(noAliases)
 527                         {
 528                                 if(QTextCodec *const currentCodec = QTextCodec::codecForName(current.constData()))
 529                                 {
 530                                         const QList<QByteArray> aliases = currentCodec->aliases();
 531                                         for(QList<QByteArray>::ConstIterator iter = aliases.constBegin(); iter != aliases.constEnd(); iter++)
 532                                         {
 533                                                 availableCodecs.removeAll(*iter);
 534                                         }
 535                                 }
 536                         }
 537                 }
 538         }
 539
 540         return codecList;
 541 }
 542
 543 ///////////////////////////////////////////////////////////////////////////////
 544 // SELF-TEST
 545 ///////////////////////////////////////////////////////////////////////////////
 546
 547 int MUtils::Internal::selfTest(const char *const buildKey, const bool debug)
 548 {
 549         static const bool MY_DEBUG_FLAG = MUTILS_DEBUG;
 550         static const char *const MY_BUILD_KEY = __DATE__ "@" __TIME__;
 551
 552         if(strncmp(buildKey, MY_BUILD_KEY, 13) || (MY_DEBUG_FLAG != debug))
 553         {
 554                 MUtils::OS::system_message_err(L"MUtils", L"FATAL ERROR: MUtils library version mismatch detected!");
 555                 MUtils::OS::system_message_wrn(L"MUtils", L"Perform a clean(!) re-install of the application to fix the problem!");
 556                 abort();
 557         }
 558         return 0;
 559 }