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