initial checkin of offline startup prompt extension, NPOB 221734

mailnews/extensions/offline-startup/Makefile.in

@@ -0,0 +1,50 @@
+#
+# 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 JavaScript Debugger
+# 
+# The Initial Developer of the Original Code is
+# Netscape Communications Corporation
+# Portions created by Netscape are
+# Copyright (C) 1998 Netscape Communications Corporation.
+#
+# Alternatively, the contents of this file may be used under the
+# terms of the GNU Public License (the "GPL"), in which case the
+# provisions of the GPL are applicable instead of those above.
+# If you wish to allow use of your version of this file only
+# under the terms of the GPL and not to allow others to use your
+# version of this file under the MPL, indicate your decision by
+# deleting the provisions above and replace them with the notice
+# and other provisions required by the GPL.  If you do not delete
+# the provisions above, a recipient may use your version of this
+# file under either the MPL or the GPL.
+#
+# Contributor(s):
+#  David Bienvenu, <bienvenu@nventure.com>, original author
+#
+
+DEPTH		= ../../..
+topsrcdir	= @top_srcdir@
+srcdir		= @srcdir@
+VPATH		= @srcdir@
+
+include $(DEPTH)/config/autoconf.mk
+
+MODULE		= offline-startup
+
+DIRS        = resources
+
+EXTRA_COMPONENTS = js/offlineStartup.js
+
+include $(topsrcdir)/config/rules.mk
+
+install::
+	@$(REGCHROME_INSTALL) locale en-US/offlineStartup en-US.jar

mailnews/extensions/offline-startup/jar.mn

@@ -0,0 +1,3 @@
+en-US.jar:
+  locale/en-US/offline-startup/contents.rdf                (resources/locale/en-US/contents.rdf)
+  locale/en-US/offline-startup/offlineStartup.properties      (resources/locale/en-US/offlineStartup.properties)

mailnews/extensions/offline-startup/js/offlineStartup.js

@@ -0,0 +1,260 @@
+/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ * ***** 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 Offline Startup Handler
+ *
+ *
+ * Contributor(s):
+ *  David Bienvenu <bienvenu@nventure.com> (Original Author) 
+ *
+ * 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 kDebug               = false;
+const kUNBundleURI         = "chrome://messenger/locale/offlineStartup.properties";
+const kOfflineStartupPref = "offline.startup_state";
+var gShuttingDown = false;
+var gOfflineStartupMode; //0 = remember last state, 1 = ask me, 2 == online, 3 == offline
+////////////////////////////////////////////////////////////////////////
+// 
+//   nsOfflineStartup : nsIProfileStartupListener, nsIObserver
+//
+//   Check if the user has set the pref to be prompted for
+//   online/offline startup mode. If so, prompt the user. Also,
+//   check if the user wants to remember their offline state
+//   the next time they start up.
+//
+////////////////////////////////////////////////////////////////////////
+
+var nsOfflineStartup = 
+{
+  onProfileStartup: function(aProfileName)
+  {
+    debug("onProfileStartup");
+
+      var prefs = Components.classes["@mozilla.org/preferences-service;1"].
+        getService(Components.interfaces.nsIPrefBranch);
+  
+      gOfflineStartupMode = prefs.getIntPref(kOfflineStartupPref);
+
+    if (gOfflineStartupMode == 0)
+    {    
+      var prefs = Components.classes["@mozilla.org/preferences-service;1"].
+        getService(Components.interfaces.nsIPrefBranch);
+      var offline = prefs.getBoolPref("network.offline");
+        var ioService = Components.classes["@mozilla.org/network/io-service;1"].getService(Components.interfaces.nsIIOService);
+        ioService.offline = offline;
+      var observerService = Components.
+        classes["@mozilla.org/observer-service;1"].
+        getService(Components.interfaces.nsIObserverService);
+      observerService.addObserver(this, "network:offline-status-changed", false);
+      observerService.addObserver(this, "quit-application", false);
+    }
+    else if (gOfflineStartupMode == 1)
+    {
+      var promptService = Components.
+        classes["@mozilla.org/embedcomp/prompt-service;1"].
+        getService(Components.interfaces.nsIPromptService);
+      
+      var unBundle = getBundle(kUNBundleURI);
+      if (!unBundle)
+        return;
+
+      var title = unBundle.GetStringFromName("title");
+      var desc = unBundle.GetStringFromName("desc");
+      var button0Text = unBundle.GetStringFromName("workOnline");
+      var button1Text = unBundle.GetStringFromName("workOffline");
+      var checkVal = {value:0};
+
+      var result = promptService.confirmEx(null, title, desc, 
+        (promptService.BUTTON_POS_0 * promptService.BUTTON_TITLE_IS_STRING) +
+        (promptService.BUTTON_POS_1 * promptService.BUTTON_TITLE_IS_STRING),
+        button0Text, button1Text, null, null, checkVal);
+      debug ("result = " + result + "\n");
+      if (result == 1)
+      {
+        var ioService = Components.classes["@mozilla.org/network/io-service;1"].getService(Components.interfaces.nsIIOService);
+        ioService.offline = true;
+      }
+
+    }
+  },
+
+  observe: function(aSubject, aTopic, aData)
+  {
+    debug("observe: " + aTopic);
+
+    if (aTopic == "domwindowopened")
+    {
+    }
+    else if (aTopic == "network:offline-status-changed")
+    {
+      debug("network:offline-status-changed: " + aData);
+      // if we're not shutting down, and startup mode is "remember online state"
+      if (!gShuttingDown && gOfflineStartupMode == 0)
+      {
+        debug("remembering offline state: ");
+        var prefs = Components.classes["@mozilla.org/preferences-service;1"].
+          getService(Components.interfaces.nsIPrefBranch);
+        prefs.setBoolPref("network.offline", aData != "online");
+      }
+
+    }
+    else if (aTopic == "xpcom-shutdown" || aTopic == "quit-application")
+    {
+      gShuttingDown = true;
+    }
+  },
+
+
+  QueryInterface: function(aIID)
+  {
+    if (!aIID.equals(Components.interfaces.nsIObserver) &&
+        !aIID.equals(Components.interfaces.nsIProfileStartupListener) &&
+        !aIID.equals(Components.interfaces.nsISupports))
+      throw Components.results.NS_ERROR_NO_INTERFACE;
+
+    return this;
+  }
+}
+
+
+var nsOfflineStartupModule = 
+{
+  mClassName:     "Offline Startup",
+  mContractID:    "@mozilla.org/offline-startup;1",
+  mClassID:       Components.ID("3028a3c8-2165-42a4-b878-398da5d32736"),
+
+  getClassObject: function(aCompMgr, aCID, aIID)
+  {
+    if (!aCID.equals(this.mClassID))
+      throw Components.results.NS_ERROR_NO_INTERFACE;
+    if (!aIID.equals(Components.interfaces.nsIFactory))
+      throw Components.results.NS_ERROR_NOT_IMPLEMENTED;
+
+    return this.mFactory;
+  },
+
+  registerSelf: function(aCompMgr, aFileSpec, aLocation, aType)
+  {
+    if (kDebug)
+      dump("*** Registering nsOfflineStartupModule (a JavaScript Module)\n");
+
+    aCompMgr = aCompMgr.QueryInterface(
+                 Components.interfaces.nsIComponentRegistrar);
+    aCompMgr.registerFactoryLocation(this.mClassID, this.mClassName, 
+      this.mContractID, aFileSpec, aLocation, aType);
+
+    // receive startup notification from the profile manager
+    // (we get |createInstance()|d at startup-notification time)
+    this.getCategoryManager().addCategoryEntry("profile-startup-category", 
+      this.mContractID, "", true, true);
+  },
+
+  unregisterSelf: function(aCompMgr, aFileSpec, aLocation)
+  {
+    aCompMgr = aCompMgr.QueryInterface(
+                 Components.interfaces.nsIComponentRegistrar);
+    aCompMgr.unregisterFactoryLocation(this.mClassID, aFileSpec);
+
+    this.getCategoryManager().deleteCategoryEntry("profile-startup-category", 
+      this.mContractID, true);
+  },
+
+  canUnload: function(aCompMgr)
+  {
+    return true;
+  },
+
+  getCategoryManager: function()
+  {
+    return Components.classes["@mozilla.org/categorymanager;1"].
+      getService(Components.interfaces.nsICategoryManager);
+  },
+
+  //////////////////////////////////////////////////////////////////////
+  //
+  //   mFactory : nsIFactory
+  //
+  //////////////////////////////////////////////////////////////////////
+  mFactory:
+  {
+    createInstance: function(aOuter, aIID)
+    {
+      if (aOuter != null)
+        throw Components.results.NS_ERROR_NO_AGGREGATION;
+      if (!aIID.equals(Components.interfaces.nsIObserver) &&
+          !aIID.equals(Components.interfaces.nsIProfileStartupListener) &&
+          !aIID.equals(Components.interfaces.nsISupports))
+        throw Components.results.NS_ERROR_INVALID_ARG;
+
+      // return the singleton 
+      return nsOfflineStartup.QueryInterface(aIID);
+    },
+
+    lockFactory: function(aLock)
+    {
+      // quiten warnings
+    }
+  }
+};
+
+function NSGetModule(aCompMgr, aFileSpec)
+{
+  return nsOfflineStartupModule;
+}
+
+function getBundle(aURI)
+{
+  if (!aURI)
+    return null;
+
+  debug(aURI);
+  var bundle = null;
+  try
+  {
+    var strBundleService = Components.
+      classes["@mozilla.org/intl/stringbundle;1"].
+      getService(Components.interfaces.nsIStringBundleService);
+    bundle = strBundleService.createBundle(aURI);
+  }
+  catch (ex)
+  {
+    bundle = null;
+    debug("Exception getting bundle " + aURI + ": " + ex);
+  }
+
+  return bundle;
+}
+
+
+////////////////////////////////////////////////////////////////////////
+//
+//   Debug helper
+//
+////////////////////////////////////////////////////////////////////////
+if (!kDebug)
+  debug = function(m) {};
+else
+  debug = function(m) {dump("\t *** nsOfflineStartup: " + m + "\n");};

mailnews/extensions/offline-startup/resources/Makefile.in

@@ -0,0 +1,37 @@
+#
+# 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 Offline Startup
+# 
+# Alternatively, the contents of this file may be used under the
+# terms of the GNU Public License (the "GPL"), in which case the
+# provisions of the GPL are applicable instead of those above.
+# If you wish to allow use of your version of this file only
+# under the terms of the GPL and not to allow others to use your
+# version of this file under the MPL, indicate your decision by
+# deleting the provisions above and replace them with the notice
+# and other provisions required by the GPL.  If you do not delete
+# the provisions above, a recipient may use your version of this
+# file under either the MPL or the GPL.
+#
+# Contributor(s):
+#  David Bienvenu, <bienvenu@nventure.com>, original author
+#
+
+DEPTH		= ../../../..
+topsrcdir	= @top_srcdir@
+srcdir		= @srcdir@
+VPATH		= @srcdir@
+
+include $(DEPTH)/config/autoconf.mk
+
+include $(topsrcdir)/config/rules.mk
+

mailnews/extensions/offline-startup/resources/locale/en-US/contents.rdf.in

@@ -0,0 +1,23 @@
+<?xml version="1.0"?>
+<RDF:RDF xmlns:RDF="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+         xmlns:chrome="http://www.mozilla.org/rdf/chrome#">
+
+  <!-- list all the skins being supplied by this package -->
+  <RDF:Seq about="urn:mozilla:locale:root">
+    <RDF:li resource="urn:mozilla:locale:en-US"/>
+  </RDF:Seq>
+
+  <!-- locale information -->
+  <RDF:Description about="urn:mozilla:locale:en-US">
+    <chrome:packages>
+      <RDF:Seq about="urn:mozilla:locale:en-US:packages">
+        <RDF:li resource="urn:mozilla:locale:en-US:offline-startup"/>
+      </RDF:Seq>
+    </chrome:packages>
+  </RDF:Description>
+
+  <!-- Version Information.  State that we work only with major version of this
+       package. -->
+  <RDF:Description about="urn:mozilla:locale:en-US:offline-startup"
+	chrome:localeVersion="@MOZILLA_VERSION@"/>
+</RDF:RDF>

mailnews/extensions/offline-startup/resources/locale/en-US/offlineStartup.properties

@@ -0,0 +1,4 @@
+title=Work Online
+desc=Would you like to go online now?\n\n(If you choose to work offline, you can go online later by choosing `Work Online' from the `File' menu.)
+workOnline=Work Online
+workOffline=Work Offline