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