OSDN Git Service

Added the copy_file() function + some improvements to directory clean-up code.
[mutilities/MUtilities.git] / src / Global.cpp
index eba0258..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
 ///////////////////////////////////////////////////////////////////////////////
@@ -91,3 +108,402 @@ QString MUtils::rand_str(const bool &bLong)
        }
        return QString("%1%2").arg(rand_str(false), rand_str(false));
 }
+
+///////////////////////////////////////////////////////////////////////////////
+// TEMP FOLDER
+///////////////////////////////////////////////////////////////////////////////
+
+static QScopedPointer<MUtils::Internal::DirLock> g_temp_folder_file;
+static QReadWriteLock                            g_temp_folder_lock;
+
+static QString try_create_subfolder(const QString &baseDir, const QString &postfix)
+{
+       const QString baseDirPath = QDir(baseDir).absolutePath();
+       for(int i = 0; i < 32; i++)
+       {
+               QDir directory(baseDirPath);
+               if(directory.mkpath(postfix) && directory.cd(postfix))
+               {
+                       return directory.canonicalPath();
+               }
+       }
+       return QString();
+}
+
+static MUtils::Internal::DirLock *try_init_temp_folder(const QString &baseDir)
+{
+       const QString tempPath = try_create_subfolder(baseDir, MUtils::rand_str());
+       if(!tempPath.isEmpty())
+       {
+               for(int i = 0; i < 32; i++)
+               {
+                       MUtils::Internal::DirLock *lockFile = NULL;
+                       try
+                       {
+                               lockFile = new MUtils::Internal::DirLock(tempPath);
+                               return lockFile;
+                       }
+                       catch(MUtils::Internal::DirLockException&)
+                       {
+                               /*ignore error and try again*/
+                       }
+               }
+       }
+       return NULL;
+}
+
+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)
+{
+       QReadLocker readLock(&g_temp_folder_lock);
+
+       //Already initialized?
+       if(!g_temp_folder_file.isNull())
+       {
+               return g_temp_folder_file->getPath();
+       }
+
+       //Obtain the write lock to initilaize
+       readLock.unlock();
+       QWriteLocker writeLock(&g_temp_folder_lock);
+       
+       //Still uninitilaized?
+       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 true;
+       }
+
+       for(int i = 0; i < 32; i++)
+       {
+               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;
+       }
+       
+       const QString dirName = folder.dirName();
+       if(dirName.isEmpty() || (!folder.cdUp()))
+       {
+               return false;
+       }
+
+       return folder.rmdir(dirName);
+}
+
+bool MUtils::remove_directory(const QString &folderPath, const bool &recursive)
+{
+       QDir folder(folderPath);
+       if(!folder.exists())
+       {
+               return true;
+       }
+
+       if(recursive)
+       {
+               const QFileInfoList entryList = folder.entryInfoList(QDir::AllEntries | QDir::NoDotAndDotDot | QDir::Hidden);
+               for(QFileInfoList::ConstIterator iter = entryList.constBegin(); iter != entryList.constEnd(); iter++)
+               {
+                       if(iter->isDir())
+                       {
+                               remove_directory(iter->canonicalFilePath(), true);
+                       }
+                       else if(iter->isFile())
+                       {
+                               remove_file(iter->canonicalFilePath());
+                       }
+               }
+       }
+
+       for(int i = 0; i < 32; i++)
+       {
+               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();
+       }
+       
+       qWarning("Could not rmdir \"%s\"", MUTILS_UTF8(folderPath));
+       return false;
+}
+
+///////////////////////////////////////////////////////////////////////////////
+// PROCESS UTILS
+///////////////////////////////////////////////////////////////////////////////
+
+void MUtils::init_process(QProcess &process, const QString &wokringDir, const bool bReplaceTempDir)
+{
+       //Environment variable names
+       static const char *const s_envvar_names_temp[] =
+       {
+               "TEMP", "TMP", "TMPDIR", "HOME", "USERPROFILE", "HOMEPATH", NULL
+       };
+       static const char *const s_envvar_names_remove[] =
+       {
+               "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
+       };
+
+       //Initialize environment
+       QProcessEnvironment env = process.processEnvironment();
+       if(env.isEmpty()) env = QProcessEnvironment::systemEnvironment();
+
+       //Clean a number of enviroment variables that might affect our tools
+       for(size_t i = 0; s_envvar_names_remove[i]; i++)
+       {
+               env.remove(QString::fromLatin1(s_envvar_names_remove[i]));
+               env.remove(QString::fromLatin1(s_envvar_names_remove[i]).toLower());
+       }
+
+       const QString tempDir = QDir::toNativeSeparators(temp_folder());
+
+       //Replace TEMP directory in environment
+       if(bReplaceTempDir)
+       {
+               for(size_t i = 0; s_envvar_names_temp[i]; i++)
+               {
+                       env.insert(s_envvar_names_temp[i], tempDir);
+               }
+       }
+
+       //Setup PATH variable
+       const QString path = env.value("PATH", QString()).trimmed();
+       env.insert("PATH", path.isEmpty() ? tempDir : QString("%1;%2").arg(tempDir, path));
+       
+       //Setup QPorcess object
+       process.setWorkingDirectory(wokringDir);
+       process.setProcessChannelMode(QProcess::MergedChannels);
+       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;
+}