Bug 511435: add default bookmarks, r=pike/mfinkle

--HG--
extra : rebase_source : 3caa0521b0b62cb280a3e0b853fcd2cea2a932fd

mobile/components/BrowserStartup.js

@@ -0,0 +1,125 @@
+/* ***** 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 Fennec Browser Startup component.
+ *
+ * The Initial Developer of the Original Code is Mozilla Foundation.
+ * Portions created by the Initial Developer are Copyright (C) 2009
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ *   Gavin Sharp <gavin@gavinsharp.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 ***** */
+const Cc = Components.classes;
+const Ci = Components.interfaces;
+const Cu = Components.utils;
+
+Components.utils.import("resource://gre/modules/XPCOMUtils.jsm");
+
+function BrowserStartup() {
+  this._init();
+}
+BrowserStartup.prototype = {
+  // for XPCOM
+  classDescription: "Mobile Browser Glue Service",
+  classID:          Components.ID("{1d542abc-c88b-4636-a4ef-075b49806317}"),
+  contractID:       "@mozilla.org/mobile/browserstartup;1",
+
+  QueryInterface: XPCOMUtils.generateQI([Ci.nsIObserver, Ci.nsISupportsWeakReference]),
+
+  // get this contractID registered for certain categories via XPCOMUtils
+  _xpcom_categories: [
+    // make BrowserStartup a startup observer
+    { category: "app-startup", service: true }
+  ],
+
+  _xpcom_factory: BrowserStartupServiceFactory,
+
+  _init: function () {
+    this._observerService = Cc['@mozilla.org/observer-service;1'].
+                            getService(Ci.nsIObserverService);
+    this._observerService.addObserver(this, "places-init-complete", false);
+  },
+
+  _initDefaultBookmarks: function () {
+    // We must instantiate the history service since it will tell us if we
+    // need to import or restore bookmarks due to first-run, corruption or
+    // forced migration (due to a major schema change).
+    let histsvc = Cc["@mozilla.org/browser/nav-history-service;1"].
+                  getService(Ci.nsINavHistoryService);
+
+    // If the database is corrupt or has been newly created we should
+    // import bookmarks.
+    let databaseStatus = histsvc.databaseStatus;
+    let importBookmarks = databaseStatus == histsvc.DATABASE_STATUS_CREATE ||
+                          databaseStatus == histsvc.DATABASE_STATUS_CORRUPT;
+
+    if (!importBookmarks)
+      return;
+
+    Cu.import("resource://gre/modules/utils.js");
+
+    // Get bookmarks.html file location
+    let dirService = Cc["@mozilla.org/file/directory_service;1"].
+                     getService(Ci.nsIProperties);
+
+    let bookmarksFile = dirService.get("profDef", Ci.nsILocalFile);
+    bookmarksFile.append("bookmarks.json");
+    if (bookmarksFile.exists()) {
+      // import the file
+      try {
+        PlacesUtils.restoreBookmarksFromJSONFile(bookmarksFile);
+      } catch (err) {
+        // Report the error, but ignore it.
+        Cu.reportError("bookmarks.json file could be corrupt. " + err);
+      }
+    } else
+      Cu.reportError("Unable to find default bookmarks.json file.");
+  },
+
+  // nsIObserver
+  observe: function(aSubject, aTopic, aData) {
+    switch (aTopic) {
+      case "places-init-complete":
+        this._initDefaultBookmarks();
+        this._observerService.removeObserver(this, "places-init-complete");
+        break;
+    }
+  }
+};
+
+// Custom factory object to ensure that we're a singleton
+const BrowserStartupServiceFactory = {
+  _instance: null,
+  createInstance: function (outer, iid) {
+    if (outer != null)
+      throw Components.results.NS_ERROR_NO_AGGREGATION;
+    return this._instance || (this._instance = new BrowserGlue());
+  }
+};
+
+function NSGetModule(compMgr, fileSpec)
+  XPCOMUtils.generateModule([BrowserStartup]);

mobile/components/Makefile.in

@@ -49,6 +49,7 @@ XPIDL_MODULE = browsercompsbase
 EXTRA_PP_COMPONENTS = AboutRedirector.js
 
 EXTRA_COMPONENTS = \
+        BrowserStartup.js \
 	geolocationPrompt.js \
 	alertsService.js \
 	xpiDialogService.js \

mobile/locales/Makefile.in

@@ -46,6 +46,13 @@ include $(topsrcdir)/config/config.mk
 
 vpath %.xml @srcdir@/en-US/searchplugins
 vpath %.xml $(LOCALE_SRCDIR)/searchplugins
+ifdef LOCALE_MERGEDIR
+vpath book%.inc $(LOCALE_MERGEDIR)/mobile/profile
+endif
+vpath book%.inc $(LOCALE_SRCDIR)/profile
+ifdef LOCALE_MERGEDIR
+vpath book%.inc @srcdir@/en-US/profile
+endif
 
 SUBMAKEFILES += \
         $(DEPTH)/$(MOZ_BRANDING_DIRECTORY)/Makefile \
@@ -88,6 +95,20 @@ libs-%:
 installers-%: clobber-% langpack-% repackage-zip-%
 	@echo "repackaging done"
 
+NO_JA_JP_MAC_AB_CD := $(if $(filter ja-JP-mac, $(AB_CD)),ja,$(AB_CD))
+
+%/defaults/profile/bookmarks.json: bookmarks.inc generic/profile/bookmarks.json.in
+	$(SYSINSTALL) -D $(dir $@)
+	$(PYTHON) $(topsrcdir)/config/Preprocessor.py \
+	  -I $< \
+	  -DAB_CD=$(NO_JA_JP_MAC_AB_CD) \
+	  $(srcdir)/generic/profile/bookmarks.json.in \
+	  > $@
+
+libs:: $(FINAL_TARGET)/defaults/profile/bookmarks.json ;
+
+install:: $(DESTDIR)$(mozappdir)/defaults/profile/bookmarks.json ;
+
 ifdef MOZ_UPDATER
 ifdef LOCALE_MERGEDIR
 UPDATER_INI := $(firstword $(wildcard $(LOCALE_MERGEDIR)/updater/updater.ini) \

mobile/locales/en-US/profile/bookmarks.inc

@@ -0,0 +1,34 @@
+#filter emptyLines
+
+# LOCALIZATION NOTE: The 'en-US' strings in the URLs will be replaced with
+# your locale code, and link to your translated pages as soon as they're 
+# live.
+
+# LOCALIZATION NOTE: Some of these URLs are currently 404s, but should be coming
+# online shortly.
+
+# LOCALIZATION NOTE (bookmarks_title):
+# title for the folder that will contains the default bookmarks
+#define bookmarks_title Mobile
+
+# LOCALIZATION NOTE (bookmarks_welcome):
+# link title for about:firstrun
+#define bookmarks_welcome Firefox: Welcome
+
+# LOCALIZATION NOTE (bookmarks_about):
+# link title for about:fennec
+#define bookmarks_about Firefox: About
+
+# LOCALIZATION NOTE (bookmarks_weave):
+# link title for https://www.mozilla.com/en-US/mobile/weave
+#define bookmarks_weave Firefox: Synchronize using Weave
+
+# LOCALIZATION NOTE (bookmarks_addons):
+# link title for https://addons.mozilla.org/en-US/mobile
+#define bookmarks_addons Firefox: Customize with add-ons
+
+# LOCALIZATION NOTE (bookmarks_support):
+# link title for https://mobile.support.mozilla.com
+#define bookmarks_support Firefox: Support
+
+#unfilter emptyLines

mobile/locales/generic/profile/bookmarks.json.in

@@ -0,0 +1,14 @@
+#filter substitution
+{"type":"text/x-moz-place-container","root":"placesRoot","children":
+  [{"type":"text/x-moz-place-container","root":"unfiledBookmarksFolder","children":
+     [{"title":"@bookmarks_title@","type":"text/x-moz-place-container","children":
+          [
+            {          "title":"@bookmarks_welcome@",  "type":"text/x-moz-place", "uri":"about:firstrun"},
+            {"index":1,"title":"@bookmarks_about@",    "type":"text/x-moz-place", "uri":"about:fennec"},
+            {"index":2,"title":"@bookmarks_weave@",    "type":"text/x-moz-place", "uri":"https://www.mozilla.com/@AB_CD@/mobile/weave"},
+            {"index":3,"title":"@bookmarks_addons@",   "type":"text/x-moz-place", "uri":"https://addons.mozilla.org/@AB_CD@/mobile"},
+            {"index":4,"title":"@bookmarks_support@",  "type":"text/x-moz-place", "uri":"https://mobile.support.mozilla.com"}
+          ]
+     }]
+  }]
+}