Bug 392501: Parse distribution.ini at startup. r=bsmedberg, a=mconnor
--- a/browser/base/content/aboutDialog.css
+++ b/browser/base/content/aboutDialog.css
@@ -40,16 +40,30 @@
}
#version {
font-weight: bold;
color: #909090;
margin: 1em 0px 10px 17px;
}
+#distribution {
+ font-weight: bold;
+ color: #909090;
+ display: none;
+ margin: 0em 0px 0px 17px;
+}
+
+#distributionId {
+ font-weight: bold;
+ color: #909090;
+ display: none;
+ margin: 0em 0px 10px 17px;
+}
+
#copyright {
margin: 0px 0px 3px 16px;
}
button[dlgtype="extra2"] {
margin-left: 13px;
}
--- a/browser/base/content/aboutDialog.js
+++ b/browser/base/content/aboutDialog.js
@@ -36,16 +36,35 @@
# ***** END LICENSE BLOCK ***** -->
var gSelectedPage = 0;
function init(aEvent)
{
if (aEvent.target != document)
return;
+
+ var prefSvc = Cc["@mozilla.org/preferences-service;1"].
+ getService(Ci.nsIPrefService);
+ var prefs = prefSvc.getBranch(null);
+
+ var distroId = prefs.getCharPref("distribution.id");
+ if (distroId) {
+ var distroVersion = prefs.getCharPref("distribution.version");
+ var distroAbout = prefs.getComplexValue("distribution.about", Ci.nsISupportsString);
+
+ var distroField = document.getElementById("distribution");
+ distroField.value = distroAbout;
+ distroField.style.display = "block";
+
+ var distroIdField = document.getElementById("distributionId");
+ distroIdField.value = distroId + " - " + distroVersion;
+ distroIdField.style.display = "block";
+ }
+
var userAgentField = document.getElementById("userAgent");
userAgentField.value = navigator.userAgent;
var button = document.documentElement.getButton("extra2");
button.setAttribute("label", document.documentElement.getAttribute("creditslabel"));
button.setAttribute("accesskey", document.documentElement.getAttribute("creditsaccesskey"));
button.addEventListener("command", switchPage, false);
--- a/browser/base/content/aboutDialog.xul
+++ b/browser/base/content/aboutDialog.xul
@@ -68,16 +68,18 @@
aboutlabel="&aboutLink;"
aboutaccesskey="&aboutLink.accesskey;">
<script type="application/x-javascript" src="chrome://browser/content/aboutDialog.js"/>
<deck id="modes" flex="1">
<vbox flex="1" id="clientBox">
#expand <label id="version" value="&aboutVersion; __MOZ_APP_VERSION__"/>
+ <label id="distribution"/>
+ <label id="distributionId"/>
<description id="copyright">©rightText;</description>
<textbox id="userAgent" multiline="true" readonly="true"/>
</vbox>
<vbox flex="1" id="creditsBox">
<iframe id="creditsIframe" flex="1"/>
</vbox>
</deck>
<separator class="groove" id="groove"/>
--- a/browser/components/Makefile.in
+++ b/browser/components/Makefile.in
@@ -50,16 +50,18 @@ XPIDLSRCS = \
nsIBrowserGlue.idl \
$(NULL)
EXTRA_PP_COMPONENTS = \
nsBrowserContentHandler.js \
nsBrowserGlue.js \
$(NULL)
+EXTRA_JS_MODULES = distribution.js
+
DIRS = \
dirprovider \
microsummaries \
migration \
preferences \
search \
sessionstore \
shell \
new file mode 100644
--- /dev/null
+++ b/browser/components/distribution.js
@@ -0,0 +1,331 @@
+/* ***** 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 Firefox Distribution Customizations.
+ *
+ * The Initial Developer of the Original Code is Mozilla Foundation.
+ * Portions created by the Initial Developer are Copyright (C) 2007
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ * Dan Mills <thunder@mozilla.com>
+ *
+ * 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 ***** */
+
+EXPORTED_SYMBOLS = [ "DistributionCustomizer" ];
+
+const Ci = Components.interfaces;
+const Cc = Components.classes;
+const Cr = Components.results;
+const Cu = Components.utils;
+
+function DistributionCustomizer() {
+ this._distroDir = this._dirSvc.get("XCurProcD", Ci.nsIFile);
+ this._distroDir.append("distribution");
+
+ let iniFile = this._distroDir.clone();
+ iniFile.append("distribution.ini");
+ this._iniExists = iniFile.exists();
+
+ if (!this._iniExists)
+ return;
+
+ this._ini = Cc["@mozilla.org/xpcom/ini-parser-factory;1"].
+ getService(Ci.nsIINIParserFactory).createINIParser(iniFile);
+
+ this._prefs = this._prefSvc.getBranch(null);
+ this._locale = this._prefs.getCharPref("general.useragent.locale");
+
+}
+DistributionCustomizer.prototype = {
+ __bmSvc: null,
+ get _bmSvc() {
+ if (!this.__bmSvc)
+ this.__bmSvc = Cc["@mozilla.org/browser/nav-bookmarks-service;1"].
+ getService(Ci.nsINavBookmarksService);
+ return this.__bmSvc;
+ },
+
+ __annoSvc: null,
+ get _annoSvc() {
+ if (!this.__annoSvc)
+ this.__annoSvc = Cc["@mozilla.org/browser/annotation-service;1"].
+ getService(Ci.nsIAnnotationService);
+ return this.__annoSvc;
+ },
+
+ __dirSvc: null,
+ get _dirSvc() {
+ if (!this.__dirSvc)
+ this.__dirSvc = Cc["@mozilla.org/file/directory_service;1"].
+ getService(Ci.nsIProperties);
+ return this.__dirSvc;
+ },
+
+ __prefSvc: null,
+ get _prefSvc() {
+ if (!this.__prefSvc)
+ this.__prefSvc = Cc["@mozilla.org/preferences-service;1"].
+ getService(Ci.nsIPrefService);
+ return this.__prefSvc;
+ },
+
+ __iosvc: null,
+ get _iosvc() {
+ if (!this.__iosvc)
+ this.__iosvc = Cc["@mozilla.org/network/io-service;1"].
+ getService(Ci.nsIIOService);
+ return this.__iosvc;
+ },
+
+ _locale: "en-US",
+ _distroDir: null,
+ _iniExists: false,
+ _ini: null,
+
+
+ _makeURI: function DIST__makeURI(spec) {
+ return this._iosvc.newURI(spec, null, null);
+ },
+ _parseBookmarksSection: function DIST_parseBookmarksSection(parentId, section) {
+ let keys = [];
+ for (let i in enumerate(this._ini.getKeys(section)))
+ keys.push(i);
+ keys.sort();
+ let items = {};
+ let defaultItemId = -1;
+ let maxItemId = -1;
+
+ for (let i = 0; i < keys.length; i++) {
+ let m = /^item\.(\d+)\.(\w+)\.?(\w*)/.exec(keys[i]);
+ if (m) {
+ let [foo, iid, iprop, ilocale] = m;
+
+ if (ilocale)
+ continue;
+
+ if (!items[iid])
+ items[iid] = {};
+ if (keys.indexOf(keys[i] + "." + this._locale) >= 0) {
+ items[iid][iprop] = this._ini.getString(section, keys[i] + "." +
+ this._locale);
+ } else {
+ items[iid][iprop] = this._ini.getString(section, keys[i]);
+ }
+
+ if (iprop == "type" && items[iid]["type"] == "default")
+ defaultItemId = iid;
+
+ if (maxItemId < iid)
+ maxItemId = iid;
+ } else {
+ dump("Key did not match: " + keys[i] + "\n");
+ }
+ }
+
+ let prependIndex = 0;
+ for (let iid = 0; iid <= maxItemId; iid++) {
+ if (!items[iid])
+ continue;
+
+ let index = -1;
+ let newId;
+
+ switch (items[iid]["type"]) {
+ case "default":
+ break;
+
+ case "folder":
+ if (iid < defaultItemId)
+ index = prependIndex++;
+
+ newId = this._bmSvc.createFolder(parentId, items[iid]["title"], index);
+
+ this._parseBookmarksSection(newId, "BookmarksFolder-" +
+ items[iid]["folderId"]);
+
+ if (items[iid]["description"])
+ this._annoSvc.setItemAnnotation(newId, "bookmarkProperties/description",
+ items[iid]["description"], 0,
+ this._annoSvc.EXPIRE_NEVER);
+
+ break;
+
+ case "separator":
+ if (iid < defaultItemId)
+ index = prependIndex++;
+ this._bmSvc.insertSeparator(parentId, index);
+ break;
+
+ case "bookmark":
+ default:
+ if (iid < defaultItemId)
+ index = prependIndex++;
+
+ newId = this._bmSvc.insertBookmark(parentId,
+ this._makeURI(items[iid]["link"]),
+ index, items[iid]["title"]);
+
+ if (items[iid]["description"])
+ this._annoSvc.setItemAnnotation(newId, "bookmarkProperties/description",
+ items[iid]["description"], 0,
+ this._annoSvc.EXPIRE_NEVER);
+
+ break;
+ }
+ }
+ },
+ applyCustomizations: function DIST_applyCustomizations() {
+ if (!this._iniExists)
+ return;
+
+ // nsPrefService loads very early. Reload prefs so we can set
+ // distribution defaults during the prefservice:after-app-defaults
+ // notification (see applyPrefDefaults below)
+ this._prefSvc.QueryInterface(Ci.nsIObserver);
+ this._prefSvc.observe(null, "reload-default-prefs", null);
+
+ let sections = enumToObject(this._ini.getSections());
+
+ // The global section, and several of its fields, is required
+ // (we also check here to be consistent with applyPrefDefaults below)
+ if (!sections["Global"])
+ return;
+ let globalPrefs = enumToObject(this._ini.getKeys("Global"));
+ if (!(globalPrefs["id"] && globalPrefs["version"] && globalPrefs["about"]))
+ return;
+
+ let bmProcessed = false;
+ let bmProcessedPref = "distribution." +
+ this._ini.getString("Global", "id") + ".bookmarksProcessed";
+ try {
+ bmProcessed = this._prefs.getBoolPref(bmProcessedPref);
+ } catch (e) {}
+
+ if (!bmProcessed) {
+ if (sections["BookmarksMenu"])
+ this._parseBookmarksSection(this._bmSvc.bookmarksRoot,
+ "BookmarksMenu");
+ if (sections["BookmarksToolbar"])
+ this._parseBookmarksSection(this._bmSvc.toolbarFolder,
+ "BookmarksToolbar");
+ this._prefs.setBoolPref(bmProcessedPref, true);
+ }
+ },
+ applyPrefDefaults: function DIST_applyPrefDefaults() {
+ if (!this._iniExists)
+ return;
+
+ let sections = enumToObject(this._ini.getSections());
+
+ // The global section, and several of its fields, is required
+ if (!sections["Global"])
+ return;
+ let globalPrefs = enumToObject(this._ini.getKeys("Global"));
+ if (!(globalPrefs["id"] && globalPrefs["version"] && globalPrefs["about"]))
+ return;
+
+ let defaults = this._prefSvc.getDefaultBranch(null);
+
+ // Global really contains info we set as prefs. They're only
+ // separate because they are "special" (read: required)
+
+ defaults.setCharPref("distribution.id", this._ini.getString("Global", "id"));
+ defaults.setCharPref("distribution.version",
+ this._ini.getString("Global", "version"));
+
+ let partnerAbout = Cc["@mozilla.org/supports-string;1"].
+ createInstance(Ci.nsISupportsString);
+ if (globalPrefs["about." + this._locale]) {
+ partnerAbout.data = this._ini.getString("Global", "about." + this._locale);
+ } else {
+ partnerAbout.data = this._ini.getString("Global", "about");
+ }
+ defaults.setComplexValue("distribution.about",
+ Ci.nsISupportsString, partnerAbout);
+
+ if (sections["Preferences"]) {
+ for (let key in enumerate(this._ini.getKeys("Preferences"))) {
+ try {
+ let value = eval(this._ini.getString("Preferences", key));
+ switch (typeof value) {
+ case "bool":
+ defaults.setBoolPref(key, value);
+ break;
+ case "int":
+ defaults.setIntPref(key, value);
+ break;
+ case "string":
+ defaults.setCharPref(key, value);
+ break;
+ case "undefined":
+ defaults.setCharPref(key, value);
+ break;
+ }
+ } catch (e) { /* ignore bad prefs and move on */ }
+ }
+ }
+
+ // We eval() the localizable prefs as well (even though they'll
+ // always get set as a string) to keep the INI format consistent:
+ // string prefs always need to be in quotes
+
+ let localizedStr = Cc["@mozilla.org/pref-localizedstring;1"].
+ createInstance(Ci.nsIPrefLocalizedString);
+
+ if (sections["LocalizablePreferences"]) {
+ for (let key in enumerate(this._ini.getKeys("LocalizablePreferences"))) {
+ try {
+ let value = eval(this._ini.getString("LocalizablePreferences", key));
+ value = value.replace("%LOCALE%", this._locale, "g");
+ localizedStr.data = "data:text/plain," + key + "=" + value;
+ defaults.setComplexValue(key, Ci.nsIPrefLocalizedString, localizedStr);
+ } catch (e) { /* ignore bad prefs and move on */ }
+ }
+ }
+
+ if (sections["LocalizablePreferences-" + this._locale]) {
+ for (let key in enumerate(this._ini.getKeys("LocalizablePreferences-" + this._locale))) {
+ try {
+ let value = eval(this._ini.getString("LocalizablePreferences-" + this._locale, key));
+ localizedStr.data = "data:text/plain," + key + "=" + value;
+ defaults.setComplexValue(key, Ci.nsIPrefLocalizedString, localizedStr);
+ } catch (e) { /* ignore bad prefs and move on */ }
+ }
+ }
+ }
+};
+
+function enumerate(UTF8Enumerator) {
+ while (UTF8Enumerator.hasMore())
+ yield UTF8Enumerator.getNext();
+}
+
+function enumToObject(UTF8Enumerator) {
+ let ret = {};
+ for (let i in enumerate(UTF8Enumerator))
+ ret[i] = 1;
+ return ret;
+}
--- a/browser/components/nsBrowserGlue.js
+++ b/browser/components/nsBrowserGlue.js
@@ -33,17 +33,20 @@
# 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 *****
const Ci = Components.interfaces;
const Cc = Components.classes;
const Cr = Components.results;
-Components.utils.import("resource://gre/modules/XPCOMUtils.jsm");
+const Cu = Components.utils;
+
+Cu.import("resource://gre/modules/XPCOMUtils.jsm");
+Cu.import("resource:///modules/distribution.js");
// Factory object
const BrowserGlueServiceFactory = {
_instance: null,
createInstance: function (outer, iid)
{
if (outer != null)
throw Components.results.NS_ERROR_NO_AGGREGATION;
@@ -70,16 +73,19 @@ BrowserGlue.prototype = {
this._dispose();
break;
case "profile-before-change":
this._onProfileChange();
break;
case "profile-change-teardown":
this._onProfileShutdown();
break;
+ case "prefservice:after-app-defaults":
+ this._onAppDefaults();
+ break;
case "final-ui-startup":
this._onProfileStartup();
break;
case "browser:purge-session-history":
// reset the console service's error buffer
const cs = Cc["@mozilla.org/consoleservice;1"].
getService(Ci.nsIConsoleService);
cs.logStringMessage(null); // clear the console (in case it's open)
@@ -102,37 +108,47 @@ BrowserGlue.prototype = {
_init: function()
{
// observer registration
const osvr = Cc['@mozilla.org/observer-service;1'].
getService(Ci.nsIObserverService);
osvr.addObserver(this, "profile-before-change", false);
osvr.addObserver(this, "profile-change-teardown", false);
osvr.addObserver(this, "xpcom-shutdown", false);
+ osvr.addObserver(this, "prefservice:after-app-defaults", false);
osvr.addObserver(this, "final-ui-startup", false);
osvr.addObserver(this, "browser:purge-session-history", false);
osvr.addObserver(this, "quit-application-requested", false);
osvr.addObserver(this, "quit-application-granted", false);
},
// cleanup (called on application shutdown)
_dispose: function()
{
// observer removal
const osvr = Cc['@mozilla.org/observer-service;1'].
getService(Ci.nsIObserverService);
osvr.removeObserver(this, "profile-before-change");
osvr.removeObserver(this, "profile-change-teardown");
osvr.removeObserver(this, "xpcom-shutdown");
+ osvr.removeObserver(this, "prefservice:after-app-defaults");
osvr.removeObserver(this, "final-ui-startup");
osvr.removeObserver(this, "browser:purge-session-history");
osvr.removeObserver(this, "quit-application-requested");
osvr.removeObserver(this, "quit-application-granted");
},
+ _onAppDefaults: function()
+ {
+ // apply distribution customizations (prefs)
+ // other customizations are applied in _onProfileStartup()
+ var distro = new DistributionCustomizer();
+ distro.applyPrefDefaults();
+ },
+
// profile startup handler (contains profile initialization routines)
_onProfileStartup: function()
{
// check to see if the EULA must be shown on startup
try {
var mustDisplayEULA = true;
var prefBranch = Cc["@mozilla.org/preferences-service;1"].
getService(Ci.nsIPrefBranch);
@@ -157,16 +173,21 @@ BrowserGlue.prototype = {
getService(Ci.nsIWindowWatcher);
ww.openWindow(null, "chrome://browser/content/safeMode.xul",
"_blank", "chrome,centerscreen,modal,resizable=no", null);
}
// initialize Places
this._initPlaces();
+ // apply distribution customizations
+ // prefs are applied in _onAppDefaults()
+ var distro = new DistributionCustomizer();
+ distro.applyCustomizations();
+
// indicate that the profile was initialized
this._profileStarted = true;
},
_onProfileChange: function()
{
// this block is for code that depends on _onProfileStartup() having
// been called.