gecko-dev/mobile/android/components/DirectoryProvider.js
Florian Quèze 37bbced84d Bug 1344711 - hand cleanup of remaining useless try blocks around get*Pref calls identified by eslint, r=jaws.
--HG--
extra : rebase_source : 18c027010838faba91f0ac699f9bde07f85500e7
2017-03-07 15:29:48 +01:00

216 lines
7.2 KiB
JavaScript

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
const Cc = Components.classes;
const Ci = Components.interfaces;
const Cu = Components.utils;
Cu.import("resource://gre/modules/AppConstants.jsm");
Cu.import("resource://gre/modules/FileUtils.jsm");
Cu.import("resource://gre/modules/Services.jsm");
Cu.import("resource://gre/modules/XPCOMUtils.jsm");
XPCOMUtils.defineLazyModuleGetter(this, "JNI", "resource://gre/modules/JNI.jsm");
// -----------------------------------------------------------------------
// Directory Provider for special browser folders and files
// -----------------------------------------------------------------------
const NS_APP_CACHE_PARENT_DIR = "cachePDir";
const NS_APP_SEARCH_DIR = "SrchPlugns";
const NS_APP_SEARCH_DIR_LIST = "SrchPluginsDL";
const NS_APP_DISTRIBUTION_SEARCH_DIR_LIST = "SrchPluginsDistDL";
const NS_APP_USER_SEARCH_DIR = "UsrSrchPlugns";
const NS_XPCOM_CURRENT_PROCESS_DIR = "XCurProcD";
const XRE_APP_DISTRIBUTION_DIR = "XREAppDist";
const XRE_UPDATE_ROOT_DIR = "UpdRootD";
const ENVVAR_UPDATE_DIR = "UPDATES_DIRECTORY";
const WEBAPPS_DIR = "webappsDir";
const SYSTEM_DIST_PATH = `/system/${AppConstants.ANDROID_PACKAGE_NAME}/distribution`;
function DirectoryProvider() {}
DirectoryProvider.prototype = {
classID: Components.ID("{ef0f7a87-c1ee-45a8-8d67-26f586e46a4b}"),
QueryInterface: XPCOMUtils.generateQI([Ci.nsIDirectoryServiceProvider,
Ci.nsIDirectoryServiceProvider2]),
getFile: function(prop, persistent) {
if (prop == NS_APP_CACHE_PARENT_DIR) {
let dirsvc = Cc["@mozilla.org/file/directory_service;1"].getService(Ci.nsIProperties);
let profile = dirsvc.get("ProfD", Ci.nsIFile);
return profile;
} else if (prop == WEBAPPS_DIR) {
// returns the folder that should hold the webapps database file
// For fennec we will store that in the root profile folder so that all
// webapps can easily access it
let dirsvc = Cc["@mozilla.org/file/directory_service;1"].getService(Ci.nsIProperties);
let profile = dirsvc.get("ProfD", Ci.nsIFile);
return profile.parent;
} else if (prop == XRE_APP_DISTRIBUTION_DIR) {
let distributionDirectories = this._getDistributionDirectories();
for (let i = 0; i < distributionDirectories.length; i++) {
if (distributionDirectories[i].exists()) {
return distributionDirectories[i];
}
}
// Fallback: Return default data distribution directory
return FileUtils.getDir(NS_XPCOM_CURRENT_PROCESS_DIR, ["distribution"], false);
} else if (prop == XRE_UPDATE_ROOT_DIR) {
let env = Cc["@mozilla.org/process/environment;1"].getService(Ci.nsIEnvironment);
if (env.exists(ENVVAR_UPDATE_DIR)) {
let path = env.get(ENVVAR_UPDATE_DIR);
if (path) {
return new FileUtils.File(path);
}
}
return new FileUtils.File(env.get("DOWNLOADS_DIRECTORY"));
}
// We are retuning null to show failure instead for throwing an error. The
// interface is called quite a bit and throwing an error is noisy. Returning
// null works with the way the interface is called [see bug 529077]
return null;
},
/**
* Appends the distribution-specific search engine directories to the array.
* The distribution directory structure is as follows:
*
* \- distribution/
* \- searchplugins/
* |- common/
* \- locale/
* |- <locale 1>/
* ...
* \- <locale N>/
*
* Common engines are loaded for all locales. If there is no locale directory for
* the current locale, there is a pref: "distribution.searchplugins.defaultLocale",
* which specifies a default locale to use.
*/
_appendDistroSearchDirs: function(array) {
let distro = this.getFile(XRE_APP_DISTRIBUTION_DIR);
if (!distro.exists())
return;
let searchPlugins = distro.clone();
searchPlugins.append("searchplugins");
if (!searchPlugins.exists())
return;
let commonPlugins = searchPlugins.clone();
commonPlugins.append("common");
if (commonPlugins.exists())
array.push(commonPlugins);
let localePlugins = searchPlugins.clone();
localePlugins.append("locale");
if (!localePlugins.exists())
return;
let curLocale = "";
try {
curLocale = Services.prefs.getComplexValue("general.useragent.locale", Ci.nsIPrefLocalizedString).data;
} catch (e) {
// eslint-disable-next-line mozilla/use-default-preference-values
try {
curLocale = Services.prefs.getCharPref("general.useragent.locale");
} catch (ee) {
}
}
if (curLocale) {
let curLocalePlugins = localePlugins.clone();
curLocalePlugins.append(curLocale);
if (curLocalePlugins.exists()) {
array.push(curLocalePlugins);
return;
}
}
// We didn't append the locale dir - try the default one.
try {
let defLocale = Services.prefs.getCharPref("distribution.searchplugins.defaultLocale");
let defLocalePlugins = localePlugins.clone();
defLocalePlugins.append(defLocale);
if (defLocalePlugins.exists())
array.push(defLocalePlugins);
} catch(e) {
}
},
getFiles: function(prop) {
if (prop != NS_APP_SEARCH_DIR_LIST &&
prop != NS_APP_DISTRIBUTION_SEARCH_DIR_LIST)
return null;
let result = [];
if (prop == NS_APP_DISTRIBUTION_SEARCH_DIR_LIST) {
this._appendDistroSearchDirs(result);
}
else {
/**
* We want to preserve the following order, since the search service
* loads engines in first-loaded-wins order.
* - distro search plugin locations (loaded separately by the search
* service)
* - user search plugin locations (profile)
* - app search plugin location (shipped engines)
*/
let appUserSearchDir = FileUtils.getDir(NS_APP_USER_SEARCH_DIR, [], false);
if (appUserSearchDir.exists())
result.push(appUserSearchDir);
let appSearchDir = FileUtils.getDir(NS_APP_SEARCH_DIR, [], false);
if (appSearchDir.exists())
result.push(appSearchDir);
}
return {
QueryInterface: XPCOMUtils.generateQI([Ci.nsISimpleEnumerator]),
hasMoreElements: function() {
return result.length > 0;
},
getNext: function() {
return result.shift();
}
};
},
_getDistributionDirectories: function() {
let directories = [];
let jenv = null;
try {
jenv = JNI.GetForThread();
let jDistribution = JNI.LoadClass(jenv, "org.mozilla.gecko.distribution.Distribution", {
static_methods: [
{ name: "getDistributionDirectories", sig: "()[Ljava/lang/String;" }
],
});
let jDirectories = jDistribution.getDistributionDirectories();
for (let i = 0; i < jDirectories.length; i++) {
directories.push(new FileUtils.File(
JNI.ReadString(jenv, jDirectories.get(i))
));
}
} finally {
if (jenv) {
JNI.UnloadClasses(jenv);
}
}
return directories;
}
};
this.NSGetFactory = XPCOMUtils.generateNSGetFactory([DirectoryProvider]);