Bug 296430 part "firefox" - Use a firefox-specific dirprovider to provide the <extension>/searchplugins key, r=darin a=asa (at some point in the future I will move the remaining app-specific keys from nsXREDirProvider to nsMailDirectoryProvider)

2005-06-07 19:45:11 +00:00 · 2005-06-07 19:45:11 +00:00 · cc3b2f6846
--- a/browser/components/Makefile.in
+++ b/browser/components/Makefile.in
@ -55,6 +55,7 @@ EXTRA_PP_COMPONENTS = \

 DIRS = \
 	bookmarks \
+	dirprovider \
 	migration \
 	history \
 	preferences \
--- a/browser/components/dirprovider/Makefile.in
+++ b/browser/components/dirprovider/Makefile.in
@ -0,0 +1,62 @@
+# ***** 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 Firefox browser.
+#
+# The Initial Developer of the Original Code is
+# Benjamin Smedberg <benjamin@smedbergs.us>
+#
+# Portions created by the Initial Developer are Copyright (C) 2005
+# the Initial Developer. All Rights Reserved.
+#
+# Contributor(s):
+#
+# Alternatively, the contents of this file may be used under the terms of
+# either 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 *****
+
+DEPTH     = ../../..
+topsrcdir = @top_srcdir@
+srcdir    = @srcdir@
+VPATH     = @srcdir@
+
+include $(DEPTH)/config/autoconf.mk
+
+MODULE               = browsercomps
+LIBRARY_NAME         = browserdirprovider
+IS_COMPONENT         = 1
+MODULE_NAME          = BrowserDirProvider
+EXPORT_LIBRARY       = 1
+MOZILLA_INTERNAL_API = 1
+
+REQUIRES = \
+	xpcom \
+	string \
+	xulapp \
+	$(NULL)
+
+CPPSRCS = nsBrowserDirectoryProvider.cpp
+
+EXTRA_DSO_LDOPTS = $(MOZ_COMPONENT_LIBS)
+
+include $(topsrcdir)/config/rules.mk
--- a/browser/components/dirprovider/nsBrowserDirectoryProvider.cpp
+++ b/browser/components/dirprovider/nsBrowserDirectoryProvider.cpp
@ -0,0 +1,311 @@
+/* ***** 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 the Mozilla Firefox browser.
+ *
+ * The Initial Developer of the Original Code is
+ * Benjamin Smedberg <benjamin@smedbergs.us>
+ *
+ * Portions created by the Initial Developer are Copyright (C) 2005
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either 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 "nsIDirectoryService.h"
+
+#include "nsIFile.h"
+#include "nsISimpleEnumerator.h"
+
+#include "nsAppDirectoryServiceDefs.h"
+#include "nsCategoryManagerUtils.h"
+#include "nsCOMArray.h"
+#include "nsIGenericFactory.h"
+#include "nsString.h"
+#include "nsXULAppAPI.h"
+
+class nsBrowserDirectoryProvider :
+  public nsIDirectoryServiceProvider2
+{
+public:
+  NS_DECL_ISUPPORTS
+  NS_DECL_NSIDIRECTORYSERVICEPROVIDER
+  NS_DECL_NSIDIRECTORYSERVICEPROVIDER2
+
+  static NS_METHOD Register(nsIComponentManager* aCompMgr,
+                            nsIFile* aPath, const char *aLoaderStr,
+                            const char *aType,
+                            const nsModuleComponentInfo *aInfo);
+
+  static NS_METHOD Unregister(nsIComponentManager* aCompMgr,
+                              nsIFile* aPath, const char *aLoaderStr,
+                              const nsModuleComponentInfo *aInfo);
+
+private:
+  void EnsureProfileFile(const nsACString& aLeafName, nsIFile* aProfileDir,
+                         nsIFile* aTarget);
+
+  class AppendingEnumerator : public nsISimpleEnumerator
+  {
+  public:
+    NS_DECL_ISUPPORTS
+    NS_DECL_NSISIMPLEENUMERATOR
+
+    AppendingEnumerator(nsISimpleEnumerator* aBase,
+                        char const *const *aAppendList);
+
+  private:
+    nsCOMPtr<nsISimpleEnumerator> mBase;
+    char const *const *const      mAppendList;
+    nsCOMPtr<nsIFile>             mNext;
+  };
+};
+
+NS_IMPL_ISUPPORTS2(nsBrowserDirectoryProvider,
+                   nsIDirectoryServiceProvider,
+                   nsIDirectoryServiceProvider2)
+
+NS_IMETHODIMP
+nsBrowserDirectoryProvider::GetFile(const char *aKey, PRBool *aPersist,
+                                    nsIFile* *aResult)
+{
+  nsresult rv;
+
+  // NOTE: This function can be reentrant through the NS_GetSpecialDirectory
+  // call, so be careful not to cause infinite recursion.
+
+  char const* leafName;
+
+  if (!strcmp(aKey, NS_APP_USER_PANELS_50_FILE)) {
+    leafName = "panels.rdf";
+  }
+  else if (!strcmp(aKey, NS_APP_BOOKMARKS_50_FILE)) {
+    leafName = "bookmarks.rdf";
+  }
+  else if (!strcmp(aKey, NS_APP_SEARCH_50_FILE)) {
+    leafName = "search.rdf";
+  }
+  else {
+    return NS_ERROR_FAILURE;
+  }
+
+  nsCOMPtr<nsIFile> profile;
+  rv = NS_GetSpecialDirectory(NS_APP_USER_PROFILE_50_DIR, getter_AddRefs(profile));
+  if (NS_FAILED(rv))
+    return rv;
+
+  nsCOMPtr<nsIFile> file;
+  rv = profile->Clone(getter_AddRefs(file));
+  if (NS_FAILED(rv))
+    return rv;
+
+  nsDependentCString leafstr(leafName);
+
+  file->AppendNative(leafstr);
+  EnsureProfileFile(leafstr, profile, file);
+
+  *aPersist = PR_TRUE;
+  NS_ADDREF(*aResult = file);
+
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+nsBrowserDirectoryProvider::GetFiles(const char *aKey,
+                                     nsISimpleEnumerator* *aResult)
+{
+  nsresult rv;
+
+  if (!strcmp(aKey, NS_APP_SEARCH_DIR_LIST)) {
+    nsCOMPtr<nsIProperties> dirSvc
+      (do_GetService(NS_DIRECTORY_SERVICE_CONTRACTID));
+    if (!dirSvc)
+      return NS_ERROR_FAILURE;
+
+    nsCOMPtr<nsISimpleEnumerator> list;
+    rv = dirSvc->Get(XRE_EXTENSIONS_DIR_LIST,
+                     NS_GET_IID(nsISimpleEnumerator), getter_AddRefs(list));
+    if (NS_FAILED(rv))
+      return rv;
+
+    static char const *const kAppendSPlugins[] = {"searchplugins", nsnull};
+
+    *aResult = new AppendingEnumerator(list, kAppendSPlugins);
+    if (!*aResult)
+      return NS_ERROR_OUT_OF_MEMORY;
+
+    NS_ADDREF(*aResult);
+    return NS_SUCCESS_AGGREGATE_RESULT;
+  }
+
+  return NS_ERROR_FAILURE;
+}
+
+static char const kContractID[] = "@mozilla.org/browser/directory-provider;1";
+
+// {6DEB193C-F87D-4078-BC78-5E64655B4D62}
+#define NS_BROWSERDIRECTORYPROVIDER_CID \
+  { 0x6deb193c, 0xf87d, 0x4078, { 0xbc, 0x78, 0x5e, 0x64, 0x65, 0x5b, 0x4d, 0x62 } }
+
+NS_METHOD
+nsBrowserDirectoryProvider::Register(nsIComponentManager* aCompMgr,
+                                     nsIFile* aPath, const char *aLoaderStr,
+                                     const char *aType,
+                                     const nsModuleComponentInfo *aInfo)
+{
+  nsresult rv;
+
+  nsCOMPtr<nsICategoryManager> catMan
+    (do_GetService(NS_CATEGORYMANAGER_CONTRACTID));
+  if (!catMan)
+    return NS_ERROR_FAILURE;
+
+  rv = catMan->AddCategoryEntry(XPCOM_DIRECTORY_PROVIDER_CATEGORY,
+                                "browser-directory-provider",
+                                kContractID, PR_TRUE, PR_TRUE, nsnull);
+  return rv;
+}
+
+
+NS_METHOD
+nsBrowserDirectoryProvider::Unregister(nsIComponentManager* aCompMgr,
+                                       nsIFile* aPath, const char *aLoaderStr,
+                                       const nsModuleComponentInfo *aInfo)
+{
+  nsresult rv;
+
+  nsCOMPtr<nsICategoryManager> catMan
+    (do_GetService(NS_CATEGORYMANAGER_CONTRACTID));
+  if (!catMan)
+    return NS_ERROR_FAILURE;
+
+  rv = catMan->DeleteCategoryEntry(XPCOM_DIRECTORY_PROVIDER_CATEGORY,
+                                   "browser-directory-provider", PR_TRUE);
+  return rv;
+}
+
+NS_GENERIC_FACTORY_CONSTRUCTOR(nsBrowserDirectoryProvider)
+
+static const nsModuleComponentInfo components[] = {
+  {
+    "nsBrowserDirectoryProvider",
+    NS_BROWSERDIRECTORYPROVIDER_CID,
+    kContractID,
+    nsBrowserDirectoryProviderConstructor,
+    nsBrowserDirectoryProvider::Register,
+    nsBrowserDirectoryProvider::Unregister
+  }
+};
+
+NS_IMPL_NSGETMODULE(BrowserDirProivder, components)
+
+void
+nsBrowserDirectoryProvider::EnsureProfileFile(const nsACString& aLeafName,
+                                              nsIFile* aProfile,
+                                              nsIFile* aTarget)
+{
+  nsresult rv;
+
+  PRBool exists;
+  rv = aTarget->Exists(&exists);
+  if (NS_FAILED(rv) || exists)
+    return;
+
+  nsCOMPtr<nsIFile> defaults;
+  rv = NS_GetSpecialDirectory(NS_APP_PROFILE_DEFAULTS_50_DIR,
+                              getter_AddRefs(defaults));
+  if (NS_FAILED(rv))
+    return;
+
+  defaults->AppendNative(aLeafName);
+  rv = defaults->Exists(&exists);
+  if (NS_FAILED(rv) || !exists)
+    return;
+
+  defaults->CopyToNative(aProfile, aLeafName);
+}
+
+NS_IMPL_ISUPPORTS1(nsBrowserDirectoryProvider::AppendingEnumerator,
+                   nsISimpleEnumerator)
+
+NS_IMETHODIMP
+nsBrowserDirectoryProvider::AppendingEnumerator::HasMoreElements(PRBool *aResult)
+{
+  *aResult = mNext ? PR_TRUE : PR_FALSE;
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+nsBrowserDirectoryProvider::AppendingEnumerator::GetNext(nsISupports* *aResult)
+{
+  if (aResult)
+    NS_ADDREF(*aResult = mNext);
+
+  mNext = nsnull;
+
+  nsresult rv;
+
+  // Ignore all errors
+
+  PRBool more;
+  while (NS_SUCCEEDED(mBase->HasMoreElements(&more)) && more) {
+    nsCOMPtr<nsISupports> nextbasesupp;
+    mBase->GetNext(getter_AddRefs(nextbasesupp));
+
+    nsCOMPtr<nsIFile> nextbase(do_QueryInterface(nextbasesupp));
+    if (!nextbase)
+      continue;
+
+    nextbase->Clone(getter_AddRefs(mNext));
+    if (!mNext)
+      continue;
+
+    char const *const * i = mAppendList;
+    while (*i) {
+      mNext->AppendNative(nsDependentCString(*i));
+      ++i;
+    }
+
+    PRBool exists;
+    rv = mNext->Exists(&exists);
+    if (NS_SUCCEEDED(rv) && exists)
+      break;
+
+    mNext = nsnull;
+  }
+
+  return NS_OK;
+}
+
+nsBrowserDirectoryProvider::AppendingEnumerator::AppendingEnumerator
+    (nsISimpleEnumerator* aBase,
+     char const *const *aAppendList) :
+  mBase(aBase),
+  mAppendList(aAppendList)
+{
+  // Initialize mNext to begin.
+  GetNext(nsnull);
+}
--- a/toolkit/xre/nsXREDirProvider.cpp
+++ b/toolkit/xre/nsXREDirProvider.cpp
@ -324,9 +324,6 @@ nsXREDirProvider::GetFile(const char* aProperty, PRBool* aPersistent,
        rv = mProfileDir->Clone(getter_AddRefs(file));
        rv |= file->AppendNative(NS_LITERAL_CSTRING("prefs.js"));
      }
-      // XXXbsmedberg this needs rethinking... many of these are app-specific,
-      // and apps are going to add new stuff. I don't have a good solution,
-      // yet.
      else if (!strcmp(aProperty, NS_APP_LOCALSTORE_50_FILE)) {
        rv = mProfileDir->Clone(getter_AddRefs(file));
        rv |= file->AppendNative(NS_LITERAL_CSTRING("localstore.rdf"));
@ -336,29 +333,20 @@ nsXREDirProvider::GetFile(const char* aProperty, PRBool* aPersistent,
        rv = mProfileDir->Clone(getter_AddRefs(file));
        rv |= file->AppendNative(NS_LITERAL_CSTRING("history.dat"));
      }
-      else if (!strcmp(aProperty, NS_APP_USER_PANELS_50_FILE)) {
-        rv = mProfileDir->Clone(getter_AddRefs(file));
-        rv |= file->AppendNative(NS_LITERAL_CSTRING("panels.rdf"));
-        EnsureProfileFileExists(file);
-      }
      else if (!strcmp(aProperty, NS_APP_USER_MIMETYPES_50_FILE)) {
        rv = mProfileDir->Clone(getter_AddRefs(file));
        rv |= file->AppendNative(NS_LITERAL_CSTRING("mimeTypes.rdf"));
        EnsureProfileFileExists(file);
      }
-      else if (!strcmp(aProperty, NS_APP_BOOKMARKS_50_FILE)) {
+      else if (!strcmp(aProperty, NS_APP_STORAGE_50_FILE)) {
        rv = mProfileDir->Clone(getter_AddRefs(file));
-        rv |= file->AppendNative(NS_LITERAL_CSTRING("bookmarks.html"));
+        rv |= file->AppendNative(NS_LITERAL_CSTRING("storage.sdb"));
      }
      else if (!strcmp(aProperty, NS_APP_DOWNLOADS_50_FILE)) {
        rv = mProfileDir->Clone(getter_AddRefs(file));
        rv |= file->AppendNative(NS_LITERAL_CSTRING("downloads.rdf"));
      }
-      else if (!strcmp(aProperty, NS_APP_SEARCH_50_FILE)) {
-        rv = mProfileDir->Clone(getter_AddRefs(file));
-        rv |= file->AppendNative(NS_LITERAL_CSTRING("search.rdf"));
-        EnsureProfileFileExists(file);
-      }
+      // XXXbsmedberg move these defines into application-specific providers.
      else if (!strcmp(aProperty, NS_APP_MAIL_50_DIR)) {
        rv = mProfileDir->Clone(getter_AddRefs(file));
        rv |= file->AppendNative(NS_LITERAL_CSTRING("Mail"));
@ -375,10 +363,6 @@ nsXREDirProvider::GetFile(const char* aProperty, PRBool* aPersistent,
        rv = mProfileDir->Clone(getter_AddRefs(file));
        rv |= file->AppendNative(NS_LITERAL_CSTRING("panacea.dat"));
      }
-      else if (!strcmp(aProperty, NS_APP_STORAGE_50_FILE)) {
-        rv = mProfileDir->Clone(getter_AddRefs(file));
-        rv |= file->AppendNative(NS_LITERAL_CSTRING("storage.sdb"));
-      }
    }
  }
  if (NS_FAILED(rv)) return NS_ERROR_FAILURE;
@ -449,7 +433,19 @@ nsXREDirProvider::GetFiles(const char* aProperty, nsISimpleEnumerator** aResult)
    profileFile->AppendNative(NS_LITERAL_CSTRING("extensions.ini"));
  }

-  if (!strcmp(aProperty, NS_XPCOM_COMPONENT_DIR_LIST)) {
+  if (!strcmp(aProperty, XRE_EXTENSIONS_DIR_LIST)) {
+    nsCOMArray<nsIFile> directories;
+    
+    if (mProfileDir && !gSafeMode) {
+      static const char *const kAppendNothing[] = { nsnull };
+
+      LoadDirsIntoArray(profileFile, "ExtensionDirs",
+                        kAppendNothing, directories);
+    }
+
+    rv = NS_NewArrayEnumerator(aResult, directories);
+  }
+  else if (!strcmp(aProperty, NS_XPCOM_COMPONENT_DIR_LIST)) {
    nsCOMArray<nsIFile> directories;

    if (mXULAppDir) {
--- a/toolkit/xre/nsXULAppAPI.h
+++ b/toolkit/xre/nsXULAppAPI.h
@ -149,6 +149,16 @@ struct nsXREAppData
 #define XULAPPINFO_SERVICE_CONTRACTID \
  "@mozilla.org/xre/app-info;1"

+/**
+ * A directory service key which provides a list of all enabled extension
+ * directories. The list includes compatible platform-specific extension
+ * subdirectories.
+ *
+ * @note The directory list will have no members when the application is
+ *       launched in safe mode.
+ */
+#define XRE_EXTENSIONS_DIR_LIST "XREExtDL"
+
 /**
 * Begin an XUL application. Does not return until the user exits the
 * application.
--- a/xpcom/io/nsAppDirectoryServiceDefs.h
+++ b/xpcom/io/nsAppDirectoryServiceDefs.h
@ -79,6 +79,7 @@

 #define NS_APP_CHROME_DIR_LIST                  "AChromDL"
 #define NS_APP_PLUGINS_DIR_LIST                 "APluginsDL"
+#define NS_APP_SEARCH_DIR_LIST                  "SrchPluginsDL"

 // --------------------------------------------------------------------------------------
 // Files and directories which exist on a per-profile basis