OSDN Git Service

Various improvements to known_folder() function, again.
[mutilities/MUtilities.git] / src / OSSupport_Win32.cpp
index 862bf02..a1fe52a 100644 (file)
@@ -690,43 +690,164 @@ const bool &MUtils::OS::running_on_wine(void)
 static QReadWriteLock                         g_known_folders_lock;
 static QScopedPointer<QHash<size_t, QString>> g_known_folders_data;
 
-typedef HRESULT (WINAPI *SHGetKnownFolderPath_t)(const GUID &rfid, DWORD dwFlags, HANDLE hToken, PWSTR *ppszPath);
-typedef HRESULT (WINAPI *SHGetFolderPath_t)     (HWND hwndOwner, int nFolder, HANDLE hToken, DWORD dwFlags, LPWSTR pszPath);
+typedef HRESULT (WINAPI *SHGetKnownFolderPathProc)(const GUID &rfid, DWORD dwFlags, HANDLE hToken, PWSTR *ppszPath);
+typedef HRESULT (WINAPI *SHGetFolderPathProc)(HWND hwndOwner, int nFolder, HANDLE hToken, DWORD dwFlags, LPWSTR pszPath);
 
-const QString &MUtils::OS::known_folder(known_folder_t folder_id)
+static const struct
 {
-       typedef enum { KF_FLAG_CREATE = 0x00008000 } kf_flags_t;
-       
-       struct
+       MUtils::OS::known_folder_t id;
+       INT32 csidl;
+       GUID known_folder_id;
+}
+s_known_folders_lut[] =
+{
+       { MUtils::OS::FOLDER_PROFILE_USER,  0x0028, { 0x5E6C858F, 0x0E22, 0x4760, { 0x9A, 0xFE, 0xEA, 0x33, 0x17, 0xB6, 0x71, 0x73 } } },  //CSIDL_PROFILE
+       { MUtils::OS::FOLDER_PROFILE_PUBL,  0x0000, { 0xDFDF76A2, 0xC82A, 0x4D63, { 0x90, 0x6A, 0x56, 0x44, 0xAC, 0x45, 0x73, 0x85 } } },  //FOLDERID_Public
+       { MUtils::OS::FOLDER_APPDATA_ROAM,  0x001A, { 0x3EB685DB, 0x65F9, 0x4CF6, { 0xA0, 0x3A, 0xE3, 0xEF, 0x65, 0x72, 0x9F, 0x3D } } },  //CSIDL_APPDATA
+       { MUtils::OS::FOLDER_APPDATA_LOCA,  0x001C, { 0xF1B32785, 0x6FBA, 0x4FCF, { 0x9D, 0x55, 0x7B, 0x8E, 0x7F, 0x15, 0x70, 0x91 } } },  //CSIDL_LOCAL_APPDATA
+       { MUtils::OS::FOLDER_DOCS_USER,     0x0005, { 0xFDD39AD0, 0x238F, 0x46AF, { 0xAD, 0xB4, 0x6C, 0x85, 0x48, 0x03, 0x69, 0xC7 } } },  //CSIDL_MYDOCUMENTS
+       { MUtils::OS::FOLDER_DOCS_PUBL,     0x002E, { 0xED4824AF, 0xDCE4, 0x45A8, { 0x81, 0xE2, 0xFC, 0x79, 0x65, 0x08, 0x36, 0x34 } } },  //CSIDL_COMMON_DOCUMENTS
+       { MUtils::OS::FOLDER_DESKTOP_USER,  0x0010, { 0xB4BFCC3A, 0xDB2C, 0x424C, { 0xB0, 0x29, 0x7F, 0xE9, 0x9A, 0x87, 0xC6, 0x41 } } },  //CSIDL_DESKTOPDIRECTORY
+       { MUtils::OS::FOLDER_DESKTOP_PUBL,  0x0019, { 0xC4AA340D, 0xF20F, 0x4863, { 0xAF, 0xEF, 0xF8, 0x7E, 0xF2, 0xE6, 0xBA, 0x25 } } },  //CSIDL_COMMON_DESKTOPDIRECTORY
+       { MUtils::OS::FOLDER_PICTURES_USER, 0x0027, { 0x33E28130, 0x4E1E, 0x4676, { 0x83, 0x5A, 0x98, 0x39, 0x5C, 0x3B, 0xC3, 0xBB } } },  //CSIDL_MYPICTURES
+       { MUtils::OS::FOLDER_PICTURES_PUBL, 0x0036, { 0xB6EBFB86, 0x6907, 0x413C, { 0x9A, 0xF7, 0x4F, 0xC2, 0xAB, 0xF0, 0x7C, 0xC5 } } },  //CSIDL_COMMON_PICTURES
+       { MUtils::OS::FOLDER_MUSIC_USER,    0x000D, { 0x4BD8D571, 0x6D19, 0x48D3, { 0xBE, 0x97, 0x42, 0x22, 0x20, 0x08, 0x0E, 0x43 } } },  //CSIDL_MYMUSIC
+       { MUtils::OS::FOLDER_MUSIC_PUBL,    0x0035, { 0x3214FAB5, 0x9757, 0x4298, { 0xBB, 0x61, 0x92, 0xA9, 0xDE, 0xAA, 0x44, 0xFF } } },  //CSIDL_COMMON_MUSIC
+       { MUtils::OS::FOLDER_VIDEO_USER,    0x000E, { 0x18989B1D, 0x99B5, 0x455B, { 0x84, 0x1C, 0xAB, 0x7C, 0x74, 0xE4, 0xDD, 0xFC } } },  //CSIDL_MYVIDEO
+       { MUtils::OS::FOLDER_VIDEO_PUBL,    0x0037, { 0x2400183A, 0x6185, 0x49FB, { 0xA2, 0xD8, 0x4A, 0x39, 0x2A, 0x60, 0x2B, 0xA3 } } },  //CSIDL_COMMON_VIDEO
+       { MUtils::OS::FOLDER_PROGRAMS_DEF,  0x0026, { 0x905E63B6, 0xC1BF, 0x494E, { 0xB2, 0x9C, 0x65, 0xB7, 0x32, 0xD3, 0xD2, 0x1A } } },  //CSIDL_PROGRAM_FILES
+       { MUtils::OS::FOLDER_PROGRAMS_X86,  0x002A, { 0x7C5A40EF, 0xA0FB, 0x4BFC, { 0x87, 0x4A, 0xC0, 0xF2, 0xE0, 0xB9, 0xFA, 0x8E } } },  //CSIDL_PROGRAM_FILESX86
+       { MUtils::OS::FOLDER_PROGRAMS_X64,  0x0000, { 0x6D809377, 0x6AF0, 0x444B, { 0x89, 0x57, 0xA3, 0x77, 0x3F, 0x02, 0x20, 0x0E } } },  //FOLDERID_ProgramFilesX64 (not supported for 32-bit applications)
+       { MUtils::OS::FOLDER_SYSROOT,       0x0024, { 0xF38BF404, 0x1D43, 0x42F2, { 0x93, 0x05, 0x67, 0xDE, 0x0B, 0x28, 0xFC, 0x23 } } },  //CSIDL_WINDOWS
+       { MUtils::OS::FOLDER_SYSTEM_DEF,    0x0025, { 0x1AC14E77, 0x02E7, 0x4E5D, { 0xB7, 0x44, 0x2E, 0xB1, 0xAE, 0x51, 0x98, 0xB7 } } },  //CSIDL_SYSTEM
+       { MUtils::OS::FOLDER_SYSTEM_X86,    0x0029, { 0xD65231B0, 0xB2F1, 0x4857, { 0xA4, 0xCE, 0xA8, 0xE7, 0xC6, 0xEA, 0x7D, 0x27 } } },  //CSIDL_SYSTEMX86
+       { static_cast<MUtils::OS::known_folder_t>(0) }
+};
+
+static QString known_folder_verify(const wchar_t *const path)
+{
+       const QDir folderPath = QDir(QDir::fromNativeSeparators(MUTILS_QSTR(path)));
+       if (folderPath.exists())
        {
-               const int csidl;
-               const GUID guid;
+               const QString absolutePath = folderPath.absolutePath();
+               const HANDLE handle = CreateFileW(MUTILS_WCHR(QDir::toNativeSeparators(absolutePath)), 0U, FILE_SHARE_READ | FILE_SHARE_WRITE, NULL, OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS, NULL);
+               if (handle != INVALID_HANDLE_VALUE)
+               {
+                       SetHandleInformation(handle, HANDLE_FLAG_PROTECT_FROM_CLOSE, HANDLE_FLAG_PROTECT_FROM_CLOSE);
+                       return absolutePath;
+               }
        }
-       static s_folders[] =
+
+       return QString(); /*failed*/
+}
+
+static QString known_folder_fallback(const size_t folderId)
+{
+       static const DWORD s_shgfpTypes[3] =
        {
-               { 0x001a, {0x3EB685DB,0x65F9,0x4CF6,{0xA0,0x3A,0xE3,0xEF,0x65,0x72,0x9F,0x3D}} },  //CSIDL_APPDATA
-               { 0x001c, {0xF1B32785,0x6FBA,0x4FCF,{0x9D,0x55,0x7B,0x8E,0x7F,0x15,0x70,0x91}} },  //CSIDL_LOCAL_APPDATA
-               { 0x0028, {0x5E6C858F,0x0E22,0x4760,{0x9A,0xFE,0xEA,0x33,0x17,0xB6,0x71,0x73}} },  //CSIDL_PROFILE
-               { 0x0026, {0x905e63b6,0xc1bf,0x494e,{0xb2,0x9c,0x65,0xb7,0x32,0xd3,0xd2,0x1a}} },  //CSIDL_PROGRAM_FILES
-               { 0x0025, {0x1AC14E77,0x02E7,0x4E5D,{0xB7,0x44,0x2E,0xB1,0xAE,0x51,0x98,0xB7}} },  //CSIDL_SYSTEM_FOLDER
-               { 0x0024, {0xF38BF404,0x1D43,0x42F2,{0x93,0x05,0x67,0xDE,0x0B,0x28,0xFC,0x23}} },  //CSIDL_WINDOWS_FOLDER
+               0, /*SHGFP_TYPE_CURRENT*/
+               1, /*SHGFP_TYPE_DEFAULT*/
+               MAXDWORD
        };
 
-       size_t folderId = size_t(-1);
+       static const INT32 s_shgfpFlags[3] = 
+       {
+               0x0000, /*No extra flags*/
+               0x8000, /*SHGFP_FLAG_CREATE*/
+               MAXINT32
+       };
 
-       switch(folder_id)
+       if (s_known_folders_lut[folderId].csidl)
        {
-               case FOLDER_ROAMING_DATA: folderId = 0; break;
-               case FOLDER_LOCALAPPDATA: folderId = 1; break;
-               case FOLDER_USER_PROFILE: folderId = 2; break;
-               case FOLDER_PROGRAMFILES: folderId = 3; break;
-               case FOLDER_SYSTEMFOLDER: folderId = 4; break;
-               case FOLDER_SYSTROOT_DIR: folderId = 5; break;
-               default:
-                       qWarning("Invalid 'known' folder was requested!");
-                       return Internal::g_empty;
+               const SHGetFolderPathProc getFolderPath = MUtils::Win32Utils::resolve<SHGetFolderPathProc>(QLatin1String("shell32"), QLatin1String("SHGetFolderPathW"));
+               if (getFolderPath)
+               {
+                       QVector<WCHAR> pathBuffer(MAX_PATH);
+                       for (size_t i = 0; s_shgfpTypes[i] != MAXDWORD; ++i)
+                       {
+                               for (size_t j = 0; s_shgfpFlags[j] != MAXINT32; ++j)
+                               {
+                                       if (getFolderPath(NULL, s_known_folders_lut[folderId].csidl | s_shgfpFlags[j], NULL, s_shgfpTypes[i], pathBuffer.data()) == S_OK)
+                                       {
+                                               //MessageBoxW(0, pathBuffer.data(), L"SHGetFolderPathW", MB_TOPMOST);
+                                               const QString folderPath = known_folder_verify(pathBuffer.data());
+                                               if (!folderPath.isEmpty())
+                                               {
+                                                       return folderPath;
+                                               }
+                                       }
+                               }
+                       }
+               }
        }
 
+       return QString(); /*failed!*/
+}
+
+static QString known_folder_detect(const size_t folderId)
+{
+       typedef enum
+       {
+               KF_FLAG_DEFAULT      = 0x00000000,
+               KF_FLAG_DEFAULT_PATH = 0x00000400,
+               KF_FLAG_CREATE       = 0x00008000
+       }
+       kf_flag_t;
+
+       static const DWORD s_kfFlags[5] =
+       { 
+               KF_FLAG_DEFAULT,
+               KF_FLAG_CREATE,
+               KF_FLAG_DEFAULT_PATH,
+               KF_FLAG_DEFAULT_PATH | KF_FLAG_CREATE,
+               MAXDWORD
+       };
+
+       const SHGetKnownFolderPathProc getKnownFolderPath = MUtils::Win32Utils::resolve<SHGetKnownFolderPathProc>(QLatin1String("shell32"), QLatin1String("SHGetKnownFolderPath"));
+       if (getKnownFolderPath)
+       {
+               for (size_t i = 0; s_kfFlags[i] != MAXDWORD; ++i)
+               {
+                       WCHAR* path = NULL;
+                       if (getKnownFolderPath(s_known_folders_lut[folderId].known_folder_id, s_kfFlags[i], NULL, &path) == S_OK)
+                       {
+                               //MessageBoxW(0, path, L"SHGetKnownFolderPath", MB_TOPMOST);
+                               const QString folderPath = known_folder_verify(path);
+                               CoTaskMemFree(path);
+                               if (!folderPath.isEmpty())
+                               {
+                                       return folderPath;
+                               }
+                       }
+               }
+       }
+
+       return known_folder_fallback(folderId); /*fallback!*/
+}
+
+static size_t known_folder_decode(const MUtils::OS::known_folder_t folder_id)
+{
+       for (size_t i = 0; s_known_folders_lut[i].id; ++i)
+       {
+               if (s_known_folders_lut[i].id == folder_id)
+               {
+                       return i;
+               }
+       }
+       qWarning("Invalid 'known' folder was requested!");
+       return SIZE_MAX;
+}
+
+const QString &MUtils::OS::known_folder(const known_folder_t folder_id)
+{
+       //Map to numeric id
+       const size_t folderId = known_folder_decode(folder_id);
+       if (folderId == SIZE_MAX)
+       {
+               return Internal::g_empty;
+       }
+       
+       //Obtain read lock 
        QReadLocker readLock(&g_known_folders_lock);
 
        //Already in cache?
@@ -757,41 +878,8 @@ const QString &MUtils::OS::known_folder(known_folder_t folder_id)
                g_known_folders_data.reset(new QHash<size_t, QString>());
        }
 
-       QString folderPath;
-
-       //Try SHGetKnownFolderPath() first!
-       if(const SHGetKnownFolderPath_t known_folders_fpGetKnownFolderPath = MUtils::Win32Utils::resolve<SHGetKnownFolderPath_t>(QLatin1String("shell32"), QLatin1String("SHGetKnownFolderPath")))
-       {
-               WCHAR *path = NULL;
-               if(known_folders_fpGetKnownFolderPath(s_folders[folderId].guid, KF_FLAG_CREATE, NULL, &path) == S_OK)
-               {
-                       //MessageBoxW(0, path, L"SHGetKnownFolderPath", MB_TOPMOST);
-                       const QDir folderTemp = QDir(QDir::fromNativeSeparators(MUTILS_QSTR(path)));
-                       if(folderTemp.exists())
-                       {
-                               folderPath = folderTemp.canonicalPath();
-                       }
-                       CoTaskMemFree(path);
-               }
-       }
-
-       //Fall back to SHGetFolderPathW()
-       if (folderPath.isEmpty())
-       {
-               if (const SHGetFolderPath_t known_folders_fpGetFolderPath = MUtils::Win32Utils::resolve<SHGetFolderPath_t>(QLatin1String("shell32"), QLatin1String("SHGetFolderPathW")))
-               {
-                       QScopedArrayPointer<WCHAR> path(new WCHAR[4096]);
-                       if (known_folders_fpGetFolderPath(NULL, s_folders[folderId].csidl | CSIDL_FLAG_CREATE, NULL, NULL, path.data()) == S_OK)
-                       {
-                               //MessageBoxW(0, path, L"SHGetFolderPathW", MB_TOPMOST);
-                               const QDir folderTemp = QDir(QDir::fromNativeSeparators(MUTILS_QSTR(path.data())));
-                               if (folderTemp.exists())
-                               {
-                                       folderPath = folderTemp.canonicalPath();
-                               }
-                       }
-               }
-       }
+       //Detect path now!
+       const QString folderPath = known_folder_detect(folderId);
 
        //Update cache
        if (!folderPath.isEmpty())