/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is Mozilla Communicator client code, released * March 31, 1998. * * The Initial Developer of the Original Code is * Netscape Communications Corporation. * Portions created by the Initial Developer are Copyright (C) 2000 * the Initial Developer. All Rights Reserved. * * Contributor(s): * Conrad Carlen * * Alternatively, the contents of this file may be used under the terms of * either of the GNU General Public License Version 2 or later (the "GPL"), * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ #include "nsAppFileLocationProvider.h" #include "nsAppDirectoryServiceDefs.h" #include "nsDirectoryServiceDefs.h" #include "nsIAtom.h" #include "nsILocalFile.h" #include "nsString.h" #include "nsXPIDLString.h" #include "nsISimpleEnumerator.h" #include "prenv.h" #include "nsCRT.h" #if (defined(XP_MAC) || defined(XP_MACOSX)) && !defined(VBOX_MACOSX_FOLLOWS_UNIX_IO) #include #include #include #include #include "nsILocalFileMac.h" #elif defined(XP_OS2) #define INCL_DOSPROCESS #define INCL_DOSMODULEMGR #include #elif defined(XP_WIN) #include #include #elif defined(XP_UNIX) #include #include #include #elif defined(XP_BEOS) #include #include #include #endif // WARNING: These hard coded names need to go away. They need to // come from localizable resources #if defined(XP_MAC) || defined(XP_MACOSX) #define APP_REGISTRY_NAME NS_LITERAL_CSTRING("Application Registry") #define ESSENTIAL_FILES NS_LITERAL_CSTRING("Essential Files") #elif defined(XP_WIN) || defined(XP_OS2) #define APP_REGISTRY_NAME NS_LITERAL_CSTRING("registry.dat") #else #define APP_REGISTRY_NAME NS_LITERAL_CSTRING("appreg") #endif // define default product directory #ifdef XP_MAC #define DEFAULT_PRODUCT_DIR NS_LITERAL_CSTRING("Mozilla") #else #define DEFAULT_PRODUCT_DIR NS_LITERAL_CSTRING(MOZ_USER_DIR) #endif // Locally defined keys used by nsAppDirectoryEnumerator #define NS_ENV_PLUGINS_DIR "EnvPlugins" // env var MOZ_PLUGIN_PATH #define NS_USER_PLUGINS_DIR "UserPlugins" #if defined(XP_MAC) || defined(XP_MACOSX) #define NS_MACOSX_USER_PLUGIN_DIR "OSXUserPlugins" #define NS_MACOSX_LOCAL_PLUGIN_DIR "OSXLocalPlugins" #define NS_MAC_CLASSIC_PLUGIN_DIR "MacSysPlugins" #endif #if defined(XP_MAC) #define DEFAULTS_DIR_NAME NS_LITERAL_CSTRING("Defaults") #define DEFAULTS_PREF_DIR_NAME NS_LITERAL_CSTRING("Pref") #define DEFAULTS_PROFILE_DIR_NAME NS_LITERAL_CSTRING("Profile") #define RES_DIR_NAME NS_LITERAL_CSTRING("Res") #define CHROME_DIR_NAME NS_LITERAL_CSTRING("Chrome") #define PLUGINS_DIR_NAME NS_LITERAL_CSTRING("Plug-ins") #define SEARCH_DIR_NAME NS_LITERAL_CSTRING("Search Plugins") #else #define DEFAULTS_DIR_NAME NS_LITERAL_CSTRING("defaults") #define DEFAULTS_PREF_DIR_NAME NS_LITERAL_CSTRING("pref") #define DEFAULTS_PROFILE_DIR_NAME NS_LITERAL_CSTRING("profile") #define RES_DIR_NAME NS_LITERAL_CSTRING("res") #define CHROME_DIR_NAME NS_LITERAL_CSTRING("chrome") #define PLUGINS_DIR_NAME NS_LITERAL_CSTRING("plugins") #define SEARCH_DIR_NAME NS_LITERAL_CSTRING("searchplugins") #endif //***************************************************************************** // nsAppFileLocationProvider::Constructor/Destructor //***************************************************************************** nsAppFileLocationProvider::nsAppFileLocationProvider() { } //***************************************************************************** // nsAppFileLocationProvider::nsISupports //***************************************************************************** NS_IMPL_THREADSAFE_ISUPPORTS2(nsAppFileLocationProvider, nsIDirectoryServiceProvider, nsIDirectoryServiceProvider2) //***************************************************************************** // nsAppFileLocationProvider::nsIDirectoryServiceProvider //***************************************************************************** NS_IMETHODIMP nsAppFileLocationProvider::GetFile(const char *prop, PRBool *persistant, nsIFile **_retval) { nsCOMPtr localFile; nsresult rv = NS_ERROR_FAILURE; NS_ENSURE_ARG(prop); *_retval = nsnull; *persistant = PR_TRUE; #if (defined (XP_MAC) || defined(XP_MACOSX)) && !defined(VBOX_MACOSX_FOLLOWS_UNIX_IO) short foundVRefNum; SInt32 foundDirID; FSSpec fileSpec; nsCOMPtr macFile; #endif if (nsCRT::strcmp(prop, NS_APP_APPLICATION_REGISTRY_DIR) == 0) { rv = GetProductDirectory(getter_AddRefs(localFile)); } else if (nsCRT::strcmp(prop, NS_APP_APPLICATION_REGISTRY_FILE) == 0) { rv = GetProductDirectory(getter_AddRefs(localFile)); if (NS_SUCCEEDED(rv)) rv = localFile->AppendNative(APP_REGISTRY_NAME); } else if (nsCRT::strcmp(prop, NS_APP_DEFAULTS_50_DIR) == 0) { rv = CloneMozBinDirectory(getter_AddRefs(localFile)); if (NS_SUCCEEDED(rv)) rv = localFile->AppendRelativeNativePath(DEFAULTS_DIR_NAME); } else if (nsCRT::strcmp(prop, NS_APP_PREF_DEFAULTS_50_DIR) == 0) { rv = CloneMozBinDirectory(getter_AddRefs(localFile)); if (NS_SUCCEEDED(rv)) { rv = localFile->AppendRelativeNativePath(DEFAULTS_DIR_NAME); if (NS_SUCCEEDED(rv)) rv = localFile->AppendRelativeNativePath(DEFAULTS_PREF_DIR_NAME); } } else if (nsCRT::strcmp(prop, NS_APP_PROFILE_DEFAULTS_50_DIR) == 0 || nsCRT::strcmp(prop, NS_APP_PROFILE_DEFAULTS_NLOC_50_DIR) == 0) { rv = CloneMozBinDirectory(getter_AddRefs(localFile)); if (NS_SUCCEEDED(rv)) { rv = localFile->AppendRelativeNativePath(DEFAULTS_DIR_NAME); if (NS_SUCCEEDED(rv)) rv = localFile->AppendRelativeNativePath(DEFAULTS_PROFILE_DIR_NAME); } } else if (nsCRT::strcmp(prop, NS_APP_USER_PROFILES_ROOT_DIR) == 0) { rv = GetDefaultUserProfileRoot(getter_AddRefs(localFile)); } else if (nsCRT::strcmp(prop, NS_APP_RES_DIR) == 0) { rv = CloneMozBinDirectory(getter_AddRefs(localFile)); if (NS_SUCCEEDED(rv)) rv = localFile->AppendRelativeNativePath(RES_DIR_NAME); } else if (nsCRT::strcmp(prop, NS_APP_CHROME_DIR) == 0) { rv = CloneMozBinDirectory(getter_AddRefs(localFile)); if (NS_SUCCEEDED(rv)) rv = localFile->AppendRelativeNativePath(CHROME_DIR_NAME); } else if (nsCRT::strcmp(prop, NS_APP_PLUGINS_DIR) == 0) { rv = CloneMozBinDirectory(getter_AddRefs(localFile)); if (NS_SUCCEEDED(rv)) rv = localFile->AppendRelativeNativePath(PLUGINS_DIR_NAME); } #if (defined(XP_MAC) || defined(XP_MACOSX)) && !defined(VBOX_MACOSX_FOLLOWS_UNIX_IO) else if (nsCRT::strcmp(prop, NS_MACOSX_USER_PLUGIN_DIR) == 0) { if (!(::FindFolder(kUserDomain, kInternetPlugInFolderType, kDontCreateFolder, &foundVRefNum, &foundDirID)) && !(::FSMakeFSSpec(foundVRefNum, foundDirID, "\p", &fileSpec))) { rv = NS_NewLocalFileWithFSSpec(&fileSpec, PR_TRUE, getter_AddRefs(macFile)); if (NS_SUCCEEDED(rv)) localFile = macFile; } } else if (nsCRT::strcmp(prop, NS_MACOSX_LOCAL_PLUGIN_DIR) == 0) { if (!(::FindFolder(kLocalDomain, kInternetPlugInFolderType, kDontCreateFolder, &foundVRefNum, &foundDirID)) && !(::FSMakeFSSpec(foundVRefNum, foundDirID, "\p", &fileSpec))) { rv = NS_NewLocalFileWithFSSpec(&fileSpec, PR_TRUE, getter_AddRefs(macFile)); if (NS_SUCCEEDED(rv)) localFile = macFile; } } else if (nsCRT::strcmp(prop, NS_MAC_CLASSIC_PLUGIN_DIR) == 0) { if (!(::FindFolder(kOnAppropriateDisk, kInternetPlugInFolderType, kDontCreateFolder, &foundVRefNum, &foundDirID)) && !(::FSMakeFSSpec(foundVRefNum, foundDirID, "\p", &fileSpec))) { rv = NS_NewLocalFileWithFSSpec(&fileSpec, PR_TRUE, getter_AddRefs(macFile)); if (NS_SUCCEEDED(rv)) localFile = macFile; } } #else else if (nsCRT::strcmp(prop, NS_ENV_PLUGINS_DIR) == 0) { NS_ERROR("Don't use nsAppFileLocationProvider::GetFile(NS_ENV_PLUGINS_DIR, ...). " "Use nsAppFileLocationProvider::GetFiles(...)."); const char *pathVar = PR_GetEnv("VBOX_XPCOM_PLUGIN_PATH"); if (pathVar) rv = NS_NewNativeLocalFile(nsDependentCString(pathVar), PR_TRUE, getter_AddRefs(localFile)); } else if (nsCRT::strcmp(prop, NS_USER_PLUGINS_DIR) == 0) { rv = GetProductDirectory(getter_AddRefs(localFile)); if (NS_SUCCEEDED(rv)) rv = localFile->AppendRelativeNativePath(PLUGINS_DIR_NAME); } #endif else if (nsCRT::strcmp(prop, NS_APP_SEARCH_DIR) == 0) { rv = CloneMozBinDirectory(getter_AddRefs(localFile)); if (NS_SUCCEEDED(rv)) rv = localFile->AppendRelativeNativePath(SEARCH_DIR_NAME); } else if (nsCRT::strcmp(prop, NS_APP_INSTALL_CLEANUP_DIR) == 0) { // This is cloned so that embeddors will have a hook to override // with their own cleanup dir. See bugzilla bug #105087 rv = CloneMozBinDirectory(getter_AddRefs(localFile)); #ifdef XP_MAC if (NS_SUCCEEDED(rv)) rv = localFile->AppendNative(ESSENTIAL_FILES); #endif } if (localFile && NS_SUCCEEDED(rv)) return localFile->QueryInterface(NS_GET_IID(nsIFile), (void**)_retval); return rv; } NS_METHOD nsAppFileLocationProvider::CloneMozBinDirectory(nsILocalFile **aLocalFile) { NS_ENSURE_ARG_POINTER(aLocalFile); nsresult rv; if (!mMozBinDirectory) { // Get the mozilla bin directory // 1. Check the directory service first for NS_XPCOM_CURRENT_PROCESS_DIR // This will be set if a directory was passed to NS_InitXPCOM // 2. If that doesn't work, set it to be the current process directory nsCOMPtr directoryService(do_GetService(NS_DIRECTORY_SERVICE_CONTRACTID, &rv)); if (NS_FAILED(rv)) return rv; rv = directoryService->Get(NS_XPCOM_CURRENT_PROCESS_DIR, NS_GET_IID(nsIFile), getter_AddRefs(mMozBinDirectory)); if (NS_FAILED(rv)) { rv = directoryService->Get(NS_OS_CURRENT_PROCESS_DIR, NS_GET_IID(nsIFile), getter_AddRefs(mMozBinDirectory)); if (NS_FAILED(rv)) return rv; } } nsCOMPtr aFile; rv = mMozBinDirectory->Clone(getter_AddRefs(aFile)); if (NS_FAILED(rv)) return rv; nsCOMPtr lfile = do_QueryInterface (aFile); if (!lfile) return NS_ERROR_FAILURE; NS_IF_ADDREF(*aLocalFile = lfile); return NS_OK; } //---------------------------------------------------------------------------------------- // GetProductDirectory - Gets the directory which contains the application data folder // // UNIX : ~/.mozilla/ // WIN : \Mozilla // Mac : :Documents:Mozilla: //---------------------------------------------------------------------------------------- NS_METHOD nsAppFileLocationProvider::GetProductDirectory(nsILocalFile **aLocalFile) { NS_ENSURE_ARG_POINTER(aLocalFile); nsresult rv; PRBool exists; nsCOMPtr localDir; #if defined(XP_MAC) nsCOMPtr directoryService = do_GetService(NS_DIRECTORY_SERVICE_CONTRACTID, &rv); if (NS_FAILED(rv)) return rv; OSErr err; long response; err = ::Gestalt(gestaltSystemVersion, &response); const char *prop = (!err && response >= 0x00001000) ? NS_MAC_USER_LIB_DIR : NS_MAC_DOCUMENTS_DIR; rv = directoryService->Get(prop, NS_GET_IID(nsILocalFile), getter_AddRefs(localDir)); if (NS_FAILED(rv)) return rv; #elif defined(XP_MACOSX) && !defined(VBOX_MACOSX_FOLLOWS_UNIX_IO) FSRef fsRef; OSErr err = ::FSFindFolder(kUserDomain, kDomainLibraryFolderType, kCreateFolder, &fsRef); if (err) return NS_ERROR_FAILURE; NS_NewLocalFile(EmptyString(), PR_TRUE, getter_AddRefs(localDir)); if (!localDir) return NS_ERROR_FAILURE; nsCOMPtr localDirMac(do_QueryInterface(localDir)); rv = localDirMac->InitWithFSRef(&fsRef); if (NS_FAILED(rv)) return rv; #elif defined(XP_OS2) nsCOMPtr directoryService = do_GetService(NS_DIRECTORY_SERVICE_CONTRACTID, &rv); if (NS_FAILED(rv)) return rv; rv = directoryService->Get(NS_OS2_HOME_DIR, NS_GET_IID(nsILocalFile), getter_AddRefs(localDir)); if (NS_FAILED(rv)) return rv; #elif defined(XP_WIN) nsCOMPtr directoryService = do_GetService(NS_DIRECTORY_SERVICE_CONTRACTID, &rv); if (NS_FAILED(rv)) return rv; rv = directoryService->Get(NS_WIN_APPDATA_DIR, NS_GET_IID(nsILocalFile), getter_AddRefs(localDir)); if (NS_SUCCEEDED(rv)) rv = localDir->Exists(&exists); if (NS_FAILED(rv) || !exists) { // On some Win95 machines, NS_WIN_APPDATA_DIR does not exist - revert to NS_WIN_WINDOWS_DIR localDir = nsnull; rv = directoryService->Get(NS_WIN_WINDOWS_DIR, NS_GET_IID(nsILocalFile), getter_AddRefs(localDir)); } if (NS_FAILED(rv)) return rv; #elif defined(XP_UNIX) rv = NS_NewNativeLocalFile(nsDependentCString(PR_GetEnv("HOME")), PR_TRUE, getter_AddRefs(localDir)); if (NS_FAILED(rv)) return rv; #elif defined(XP_BEOS) char path[MAXPATHLEN]; find_directory(B_USER_SETTINGS_DIRECTORY, 0, 0, path, MAXPATHLEN); // Need enough space to add the trailing backslash int len = strlen(path); if (len > MAXPATHLEN-2) return NS_ERROR_FAILURE; path[len] = '/'; path[len+1] = '\0'; rv = NS_NewNativeLocalFile(nsDependentCString(path), PR_TRUE, getter_AddRefs(localDir)); if (NS_FAILED(rv)) return rv; #else #error dont_know_how_to_get_product_dir_on_your_platform #endif rv = localDir->AppendRelativeNativePath(DEFAULT_PRODUCT_DIR); if (NS_FAILED(rv)) return rv; rv = localDir->Exists(&exists); if (NS_SUCCEEDED(rv) && !exists) rv = localDir->Create(nsIFile::DIRECTORY_TYPE, 0700); if (NS_FAILED(rv)) return rv; *aLocalFile = localDir; NS_ADDREF(*aLocalFile); return rv; } //---------------------------------------------------------------------------------------- // GetDefaultUserProfileRoot - Gets the directory which contains each user profile dir // // UNIX : ~/.mozilla/ // WIN : \Mozilla\Profiles // Mac : :Documents:Mozilla:Profiles: //---------------------------------------------------------------------------------------- NS_METHOD nsAppFileLocationProvider::GetDefaultUserProfileRoot(nsILocalFile **aLocalFile) { NS_ENSURE_ARG_POINTER(aLocalFile); nsresult rv; nsCOMPtr localDir; rv = GetProductDirectory(getter_AddRefs(localDir)); if (NS_FAILED(rv)) return rv; #if defined(XP_MAC) || defined(XP_MACOSX) || defined(XP_OS2) || defined(XP_WIN) // These 3 platforms share this part of the path - do them as one rv = localDir->AppendRelativeNativePath(NS_LITERAL_CSTRING("Profiles")); if (NS_FAILED(rv)) return rv; PRBool exists; rv = localDir->Exists(&exists); if (NS_SUCCEEDED(rv) && !exists) rv = localDir->Create(nsIFile::DIRECTORY_TYPE, 0775); if (NS_FAILED(rv)) return rv; #endif *aLocalFile = localDir; NS_ADDREF(*aLocalFile); return rv; } //***************************************************************************** // nsAppFileLocationProvider::nsIDirectoryServiceProvider2 //***************************************************************************** class nsAppDirectoryEnumerator : public nsISimpleEnumerator { public: NS_DECL_ISUPPORTS /** * aKeyList is a null-terminated list of properties which are provided by aProvider * They do not need to be publicly defined keys. */ nsAppDirectoryEnumerator(nsIDirectoryServiceProvider *aProvider, const char* aKeyList[]) : mProvider(aProvider), mCurrentKey(aKeyList) { } NS_IMETHOD HasMoreElements(PRBool *result) { while (!mNext && *mCurrentKey) { PRBool dontCare; nsCOMPtr testFile; (void)mProvider->GetFile(*mCurrentKey++, &dontCare, getter_AddRefs(testFile)); // Don't return a file which does not exist. PRBool exists; if (testFile && NS_SUCCEEDED(testFile->Exists(&exists)) && exists) mNext = testFile; } *result = mNext != nsnull; return NS_OK; } NS_IMETHOD GetNext(nsISupports **result) { NS_ENSURE_ARG_POINTER(result); *result = nsnull; PRBool hasMore; HasMoreElements(&hasMore); if (!hasMore) return NS_ERROR_FAILURE; *result = mNext; NS_IF_ADDREF(*result); mNext = nsnull; return *result ? NS_OK : NS_ERROR_FAILURE; } // Virtual destructor since subclass nsPathsDirectoryEnumerator // does not re-implement Release() virtual ~nsAppDirectoryEnumerator() { } protected: nsIDirectoryServiceProvider *mProvider; const char** mCurrentKey; nsCOMPtr mNext; }; NS_IMPL_ISUPPORTS1(nsAppDirectoryEnumerator, nsISimpleEnumerator) /* nsPathsDirectoryEnumerator and PATH_SEPARATOR * are not used on MacOS/X. */ #if defined(XP_WIN) || defined(XP_OS2)/* Win32, Win16, and OS/2 */ #define PATH_SEPARATOR ';' #else /*if defined(XP_UNIX) || defined(XP_BEOS)*/ #define PATH_SEPARATOR ':' #endif class nsPathsDirectoryEnumerator : public nsAppDirectoryEnumerator { public: /** * aKeyList is a null-terminated list. * The first element is a path list. * The remainder are properties provided by aProvider. * They do not need to be publicly defined keys. */ nsPathsDirectoryEnumerator(nsIDirectoryServiceProvider *aProvider, const char* aKeyList[]) : nsAppDirectoryEnumerator(aProvider, aKeyList+1), mEndPath(aKeyList[0]) { } NS_IMETHOD HasMoreElements(PRBool *result) { if (mEndPath) while (!mNext && *mEndPath) { const char *pathVar = mEndPath; do { ++mEndPath; } while (*mEndPath && *mEndPath != PATH_SEPARATOR); nsCOMPtr localFile; NS_NewNativeLocalFile(Substring(pathVar, mEndPath), PR_TRUE, getter_AddRefs(localFile)); if (*mEndPath == PATH_SEPARATOR) ++mEndPath; // Don't return a "file" (directory) which does not exist. PRBool exists; if (localFile && NS_SUCCEEDED(localFile->Exists(&exists)) && exists) mNext = localFile; } if (mNext) *result = PR_TRUE; else nsAppDirectoryEnumerator::HasMoreElements(result); return NS_OK; } protected: const char *mEndPath; }; NS_IMETHODIMP nsAppFileLocationProvider::GetFiles(const char *prop, nsISimpleEnumerator **_retval) { NS_ENSURE_ARG_POINTER(_retval); *_retval = nsnull; nsresult rv = NS_ERROR_FAILURE; if (!nsCRT::strcmp(prop, NS_APP_PLUGINS_DIR_LIST)) { #if (defined(XP_MAC) || defined(XP_MACOSX)) && !defined(VBOX_MACOSX_FOLLOWS_UNIX_IO) static const char* osXKeys[] = { NS_APP_PLUGINS_DIR, NS_MACOSX_USER_PLUGIN_DIR, NS_MACOSX_LOCAL_PLUGIN_DIR, nsnull }; static const char* os9Keys[] = { NS_APP_PLUGINS_DIR, NS_MAC_CLASSIC_PLUGIN_DIR, nsnull }; static const char** keys; if (!keys) { OSErr err; SInt32 response; err = ::Gestalt(gestaltSystemVersion, &response); keys = (!err && response >= 0x00001000) ? osXKeys : os9Keys; } *_retval = new nsAppDirectoryEnumerator(this, keys); #else static const char* keys[] = { nsnull, NS_APP_PLUGINS_DIR, nsnull }; if (!keys[0] && !(keys[0] = PR_GetEnv("VBOX_XPCOM_PLUGIN_PATH"))) { static const char nullstr = 0; keys[0] = &nullstr; } *_retval = new nsPathsDirectoryEnumerator(this, keys); #endif NS_IF_ADDREF(*_retval); rv = *_retval ? NS_OK : NS_ERROR_OUT_OF_MEMORY; } return rv; }