OSDN Git Service

Added the copy_file() function + some improvements to directory clean-up code.
[mutilities/MUtilities.git] / src / Global.cpp
index 81614d2..17db27c 100644 (file)
 #define _CRT_RAND_S 1
 #endif
 
+//MUtils
 #include <MUtils/Global.h>
 #include <MUtils/OSSupport.h>
 
+//Internal
+#include "DirLocker.h"
+#include "3rd_party/strnatcmp/include/strnatcmp.h"
+
 //Qt
 #include <QDir>
 #include <QReadWriteLock>
 #include <QProcess>
+#include <QTextCodec>
 
 //CRT
 #include <cstdlib>
 #include <ctime>
 #include <process.h>
 
+//VLD
+#ifdef _MSC_VER
+#include <vld.h>
+#endif
+
 ///////////////////////////////////////////////////////////////////////////////
 // Random Support
 ///////////////////////////////////////////////////////////////////////////////
@@ -102,70 +113,54 @@ QString MUtils::rand_str(const bool &bLong)
 // TEMP FOLDER
 ///////////////////////////////////////////////////////////////////////////////
 
-static QReadWriteLock g_temp_folder_lock;
-static QFile*         g_temp_folder_file = NULL;
-static QString*       g_temp_folder_path = NULL;
-
-#define INIT_TEMP_FOLDER_RAND(OUT_PTR, FILE_PTR, BASE_DIR) do \
-{ \
-       for(int _i = 0; _i < 128; _i++) \
-       { \
-               const QString _randDir = QString("%1/%2").arg((BASE_DIR), rand_str()); \
-               if(!QDir(_randDir).exists()) \
-               { \
-                       *(OUT_PTR) = try_init_folder(_randDir, (FILE_PTR)); \
-                       if(!(OUT_PTR)->isEmpty()) break; \
-               } \
-       } \
-} \
-while(0)
-
-static QString try_init_folder(const QString &folderPath, QFile *&lockFile)
-{
-       static const char *TEST_DATA = "Lorem ipsum dolor sit amet, consectetur, adipisci velit!";
-       
-       bool success = false;
-
-       const QFileInfo folderInfo(folderPath);
-       const QDir folderDir(folderInfo.absoluteFilePath());
+static QScopedPointer<MUtils::Internal::DirLock> g_temp_folder_file;
+static QReadWriteLock                            g_temp_folder_lock;
 
-       //Remove existing lock file
-       if(lockFile)
-       {
-               lockFile->remove();
-               MUTILS_DELETE(lockFile);
-       }
-
-       //Create folder, if it does *not* exist yet
-       if(!folderDir.exists())
+static QString try_create_subfolder(const QString &baseDir, const QString &postfix)
+{
+       const QString baseDirPath = QDir(baseDir).absolutePath();
+       for(int i = 0; i < 32; i++)
        {
-               for(int i = 0; i < 16; i++)
+               QDir directory(baseDirPath);
+               if(directory.mkpath(postfix) && directory.cd(postfix))
                {
-                       if(folderDir.mkpath(".")) break;
+                       return directory.canonicalPath();
                }
        }
+       return QString();
+}
 
-       //Make sure folder exists now *and* is writable
-       if(folderDir.exists())
+static MUtils::Internal::DirLock *try_init_temp_folder(const QString &baseDir)
+{
+       const QString tempPath = try_create_subfolder(baseDir, MUtils::rand_str());
+       if(!tempPath.isEmpty())
        {
-               const QByteArray testData = QByteArray(TEST_DATA);
                for(int i = 0; i < 32; i++)
                {
-                       lockFile = new QFile(folderDir.absoluteFilePath(QString("~%1.tmp").arg(MUtils::rand_str())));
-                       if(lockFile->open(QIODevice::ReadWrite | QIODevice::Truncate))
+                       MUtils::Internal::DirLock *lockFile = NULL;
+                       try
                        {
-                               if(lockFile->write(testData) >= testData.size())
-                               {
-                                       success = true;
-                                       break;
-                               }
-                               lockFile->remove();
-                               MUTILS_DELETE(lockFile);
+                               lockFile = new MUtils::Internal::DirLock(tempPath);
+                               return lockFile;
+                       }
+                       catch(MUtils::Internal::DirLockException&)
+                       {
+                               /*ignore error and try again*/
                        }
                }
        }
+       return NULL;
+}
 
-       return (success ? folderDir.canonicalPath() : QString());
+static void temp_folder_cleaup(void)
+{
+       QWriteLocker writeLock(&g_temp_folder_lock);
+       
+       //Clean the directory
+       while(!g_temp_folder_file.isNull())
+       {
+               g_temp_folder_file.reset(NULL);
+       }
 }
 
 const QString &MUtils::temp_folder(void)
@@ -173,9 +168,9 @@ const QString &MUtils::temp_folder(void)
        QReadLocker readLock(&g_temp_folder_lock);
 
        //Already initialized?
-       if(g_temp_folder_path && (!g_temp_folder_path->isEmpty()))
+       if(!g_temp_folder_file.isNull())
        {
-               return (*g_temp_folder_path);
+               return g_temp_folder_file->getPath();
        }
 
        //Obtain the write lock to initilaize
@@ -183,52 +178,133 @@ const QString &MUtils::temp_folder(void)
        QWriteLocker writeLock(&g_temp_folder_lock);
        
        //Still uninitilaized?
-       if(g_temp_folder_path && (!g_temp_folder_path->isEmpty()))
+       if(!g_temp_folder_file.isNull())
+       {
+               return g_temp_folder_file->getPath();
+       }
+
+       //Try the %TMP% or %TEMP% directory first
+       if(MUtils::Internal::DirLock *lockFile = try_init_temp_folder(QDir::tempPath()))
+       {
+               g_temp_folder_file.reset(lockFile);
+               atexit(temp_folder_cleaup);
+               return lockFile->getPath();
+       }
+
+       qWarning("%%TEMP%% directory not found -> trying fallback mode now!");
+       static const OS::known_folder_t FOLDER_ID[2] = { OS::FOLDER_LOCALAPPDATA, OS::FOLDER_SYSTROOT_DIR };
+       for(size_t id = 0; id < 2; id++)
+       {
+               const QString &knownFolder = OS::known_folder(FOLDER_ID[id]);
+               if(!knownFolder.isEmpty())
+               {
+                       const QString tempRoot = try_create_subfolder(knownFolder, QLatin1String("TEMP"));
+                       if(!tempRoot.isEmpty())
+                       {
+                               if(MUtils::Internal::DirLock *lockFile = try_init_temp_folder(tempRoot))
+                               {
+                                       g_temp_folder_file.reset(lockFile);
+                                       atexit(temp_folder_cleaup);
+                                       return lockFile->getPath();
+                               }
+                       }
+               }
+       }
+
+       qFatal("Temporary directory could not be initialized !!!");
+       return (*((QString*)NULL));
+}
+
+///////////////////////////////////////////////////////////////////////////////
+// REMOVE DIRECTORY / FILE
+///////////////////////////////////////////////////////////////////////////////
+
+bool MUtils::remove_file(const QString &fileName)
+{
+       QFileInfo fileInfo(fileName);
+       if(!(fileInfo.exists() && fileInfo.isFile()))
        {
-               return (*g_temp_folder_path);
+               return true;
        }
 
-       //Create the string, if not done yet
-       if(!g_temp_folder_path)
+       for(int i = 0; i < 32; i++)
        {
-               g_temp_folder_path = new QString();
+               QFile file(fileName);
+               file.setPermissions(QFile::ReadOther | QFile::WriteOther);
+               if((!(fileInfo.exists() && fileInfo.isFile())) || file.remove())
+               {
+                       return true;
+               }
+               fileInfo.refresh();
+       }
+
+       qWarning("Could not delete \"%s\"", MUTILS_UTF8(fileName));
+       return false;
+}
+
+static bool remove_directory_helper(QDir folder)
+{
+       if(!folder.exists())
+       {
+               return true;
        }
        
-       g_temp_folder_path->clear();
+       const QString dirName = folder.dirName();
+       if(dirName.isEmpty() || (!folder.cdUp()))
+       {
+               return false;
+       }
 
-       //Try the %TMP% or %TEMP% directory first
-       QString tempPath = try_init_folder(QDir::temp().absolutePath(), g_temp_folder_file);
-       if(!tempPath.isEmpty())
+       return folder.rmdir(dirName);
+}
+
+bool MUtils::remove_directory(const QString &folderPath, const bool &recursive)
+{
+       QDir folder(folderPath);
+       if(!folder.exists())
        {
-               INIT_TEMP_FOLDER_RAND(g_temp_folder_path, g_temp_folder_file, tempPath);
+               return true;
        }
 
-       //Otherwise create TEMP folder in %LOCALAPPDATA% or %SYSTEMROOT%
-       if(g_temp_folder_path->isEmpty())
+       if(recursive)
        {
-               qWarning("%%TEMP%% directory not found -> trying fallback mode now!");
-               static const OS::known_folder_t folderId[2] = { OS::FOLDER_LOCALAPPDATA, OS::FOLDER_SYSTROOT_DIR };
-               for(size_t id = 0; (g_temp_folder_path->isEmpty() && (id < 2)); id++)
+               const QFileInfoList entryList = folder.entryInfoList(QDir::AllEntries | QDir::NoDotAndDotDot | QDir::Hidden);
+               for(QFileInfoList::ConstIterator iter = entryList.constBegin(); iter != entryList.constEnd(); iter++)
                {
-                       const QString &knownFolder = OS::known_folder(folderId[id]);
-                       if(!knownFolder.isEmpty())
+                       if(iter->isDir())
                        {
-                               tempPath = try_init_folder(QString("%1/Temp").arg(knownFolder), g_temp_folder_file);
-                               if(!tempPath.isEmpty())
-                               {
-                                       INIT_TEMP_FOLDER_RAND(g_temp_folder_path, g_temp_folder_file, tempPath);
-                               }
+                               remove_directory(iter->canonicalFilePath(), true);
+                       }
+                       else if(iter->isFile())
+                       {
+                               remove_file(iter->canonicalFilePath());
                        }
                }
        }
 
-       //Failed to create TEMP folder?
-       if(g_temp_folder_path->isEmpty())
+       for(int i = 0; i < 32; i++)
        {
-               qFatal("Temporary directory could not be initialized !!!");
+               if(!folder.exists())
+               {
+                       return true;
+               }
+               const QString dirName = folder.dirName();
+               if(!dirName.isEmpty())
+               {
+                       QDir parent(folder);
+                       if(parent.cdUp())
+                       {
+                               if(parent.rmdir(dirName))
+                               {
+                                       return true;
+                               }
+                       }
+               }
+               folder.refresh();
        }
        
-       return (*g_temp_folder_path);
+       qWarning("Could not rmdir \"%s\"", MUTILS_UTF8(folderPath));
+       return false;
 }
 
 ///////////////////////////////////////////////////////////////////////////////
@@ -279,3 +355,155 @@ void MUtils::init_process(QProcess &process, const QString &wokringDir, const bo
        process.setReadChannel(QProcess::StandardOutput);
        process.setProcessEnvironment(env);
 }
+
+///////////////////////////////////////////////////////////////////////////////
+// NATURAL ORDER STRING COMPARISON
+///////////////////////////////////////////////////////////////////////////////
+
+static bool natural_string_sort_helper(const QString &str1, const QString &str2)
+{
+       return (MUtils::Internal::NaturalSort::strnatcmp(MUTILS_WCHR(str1), MUTILS_WCHR(str2)) < 0);
+}
+
+static bool natural_string_sort_helper_fold_case(const QString &str1, const QString &str2)
+{
+       return (MUtils::Internal::NaturalSort::strnatcasecmp(MUTILS_WCHR(str1), MUTILS_WCHR(str2)) < 0);
+}
+
+void MUtils::natural_string_sort(QStringList &list, const bool bIgnoreCase)
+{
+       qSort(list.begin(), list.end(), bIgnoreCase ? natural_string_sort_helper_fold_case : natural_string_sort_helper);
+}
+
+///////////////////////////////////////////////////////////////////////////////
+// CLEAN FILE PATH
+///////////////////////////////////////////////////////////////////////////////
+
+static const struct
+{
+       const char *const search;
+       const char *const replace;
+}
+CLEAN_FILE_NAME[] =
+{
+       { "\\",  "-"  },
+       { " / ", ", " },
+       { "/",   ","  },
+       { ":",   "-"  },
+       { "*",   "x"  },
+       { "?",   "!"  },
+       { "<",   "["  },
+       { ">",   "]"  },
+       { "|",   "!"  },
+       { "\"",  "'"  },
+       { NULL,  NULL }
+};
+
+QString MUtils::clean_file_name(const QString &name)
+{
+       QString str = name.simplified();
+
+       for(size_t i = 0; CLEAN_FILE_NAME[i].search; i++) 
+       {
+               str.replace(CLEAN_FILE_NAME[i].search, CLEAN_FILE_NAME[i].replace);
+       }
+       
+       QRegExp regExp("\"(.+)\"");
+       regExp.setMinimal(true);
+       str.replace(regExp, "`\\1ยด");
+       
+       return str.simplified();
+}
+
+QString MUtils::clean_file_path(const QString &path)
+{
+       QStringList parts = path.simplified().replace("\\", "/").split("/", QString::SkipEmptyParts);
+
+       for(int i = 0; i < parts.count(); i++)
+       {
+               parts[i] = MUtils::clean_file_name(parts[i]);
+       }
+
+       return parts.join("/");
+}
+
+///////////////////////////////////////////////////////////////////////////////
+// REGULAR EXPESSION HELPER
+///////////////////////////////////////////////////////////////////////////////
+
+bool MUtils::regexp_parse_uint32(const QRegExp &regexp, quint32 &value)
+{
+       return regexp_parse_uint32(regexp, &value, 1);
+}
+
+bool MUtils::regexp_parse_uint32(const QRegExp &regexp, quint32 *values, const size_t &count)
+{
+       const QStringList caps = regexp.capturedTexts();
+       
+       if(caps.isEmpty() || (quint32(caps.count()) <= count))
+       {
+               return false;
+       }
+
+       for(size_t i = 0; i < count; i++)
+       {
+               bool ok = false;
+               values[i] = caps[i+1].toUInt(&ok);
+               if(!ok)
+               {
+                       return false;
+               }
+       }
+
+       return true;
+}
+
+///////////////////////////////////////////////////////////////////////////////
+// AVAILABLE CODEPAGES
+///////////////////////////////////////////////////////////////////////////////
+
+QStringList MUtils::available_codepages(const bool &noAliases)
+{
+       QStringList codecList;
+       QList<QByteArray> availableCodecs = QTextCodec::availableCodecs();
+
+       while(!availableCodecs.isEmpty())
+       {
+               const QByteArray current = availableCodecs.takeFirst();
+               if(!current.toLower().startsWith("system"))
+               {
+                       codecList << QString::fromLatin1(current.constData(), current.size());
+                       if(noAliases)
+                       {
+                               if(QTextCodec *const currentCodec = QTextCodec::codecForName(current.constData()))
+                               {
+                                       const QList<QByteArray> aliases = currentCodec->aliases();
+                                       for(QList<QByteArray>::ConstIterator iter = aliases.constBegin(); iter != aliases.constEnd(); iter++)
+                                       {
+                                               availableCodecs.removeAll(*iter);
+                                       }
+                               }
+                       }
+               }
+       }
+
+       return codecList;
+}
+
+///////////////////////////////////////////////////////////////////////////////
+// SELF-TEST
+///////////////////////////////////////////////////////////////////////////////
+
+int MUtils::Internal::selfTest(const char *const buildKey, const bool debug)
+{
+       static const bool MY_DEBUG_FLAG = MUTILS_DEBUG;
+       static const char *const MY_BUILD_KEY = __DATE__"@"__TIME__;
+
+       if(strncmp(buildKey, MY_BUILD_KEY, 14) || (MY_DEBUG_FLAG != debug))
+       {
+               MUtils::OS::system_message_err(L"MUtils", L"FATAL ERROR: MUtils library version mismatch detected!");
+               MUtils::OS::system_message_wrn(L"MUtils", L"Please re-build the complete solution in order to fix this issue!");
+               abort();
+       }
+       return 0;
+}