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