home *** CD-ROM | disk | FTP | other *** search
/ PC World 2008 February / PCWorld_2008-02_cd.bin / temacd / songbird / Songbird_0.4_windows-i686.exe / components / nsBrowserGlue.js < prev    next >
Text File  |  2007-12-21  |  17KB  |  482 lines
  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3.  *
  4.  * The contents of this file are subject to the Mozilla Public License Version
  5.  * 1.1 (the "License"); you may not use this file except in compliance with
  6.  * the License. You may obtain a copy of the License at
  7.  * http://www.mozilla.org/MPL/
  8.  *
  9.  * Software distributed under the License is distributed on an "AS IS" basis,
  10.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11.  * for the specific language governing rights and limitations under the
  12.  * License.
  13.  *
  14.  * The Original Code is the Firefox Browser Glue Service.
  15.  *
  16.  * The Initial Developer of the Original Code is
  17.  * Giorgio Maone
  18.  * Portions created by the Initial Developer are Copyright (C) 2005
  19.  * the Initial Developer. All Rights Reserved.
  20.  *
  21.  * Contributor(s):
  22.  *   Giorgio Maone <g.maone@informaction.com>
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37.  
  38. const Ci = Components.interfaces;
  39. const Cc = Components.classes;
  40. const Cr = Components.results;
  41.  
  42. // Constructor
  43.  
  44. function BrowserGlue() {
  45.   this._init();
  46.   this._profileStarted = false;
  47. }
  48.  
  49. BrowserGlue.prototype = {
  50.   _saveSession: false,
  51.  
  52.   QueryInterface: function(iid) 
  53.   {
  54.      xpcomCheckInterfaces(iid, kServiceIIds, Cr.NS_ERROR_NO_INTERFACE);
  55.      return this;
  56.   }
  57. ,
  58.   // nsIObserver implementation 
  59.   observe: function(subject, topic, data) 
  60.   {
  61.     switch(topic) {
  62.       case "xpcom-shutdown":
  63.         this._dispose();
  64.         break;
  65.       case "profile-before-change":
  66.         this._onProfileChange();
  67.         break;
  68.       case "profile-change-teardown": 
  69.         this._onProfileShutdown();
  70.         break;
  71.       case "final-ui-startup":
  72.         this._onProfileStartup();
  73.         break;
  74.       case "browser:purge-session-history":
  75.         // reset the console service's error buffer
  76.         const cs = Cc["@mozilla.org/consoleservice;1"].
  77.                    getService(Ci.nsIConsoleService);
  78.         cs.logStringMessage(null); // clear the console (in case it's open)
  79.         cs.reset();
  80.         break;
  81.       case "quit-application-requested":
  82.         this._onQuitRequest(subject, data);
  83.         break;
  84.       case "quit-application-granted":
  85.         if (this._saveSession) {
  86.           var prefBranch = Cc["@mozilla.org/preferences-service;1"].
  87.                            getService(Ci.nsIPrefBranch);
  88.           prefBranch.setBoolPref("browser.sessionstore.resume_session_once", true);
  89.         }
  90.         break;
  91.     }
  92.   }
  93. , 
  94.   // initialization (called on application startup) 
  95.   _init: function() 
  96.   {
  97.     // observer registration
  98.     const osvr = Cc['@mozilla.org/observer-service;1'].
  99.                  getService(Ci.nsIObserverService);
  100.     osvr.addObserver(this, "profile-before-change", false);
  101.     osvr.addObserver(this, "profile-change-teardown", false);
  102.     osvr.addObserver(this, "xpcom-shutdown", false);
  103.     osvr.addObserver(this, "final-ui-startup", false);
  104.     osvr.addObserver(this, "browser:purge-session-history", false);
  105.     osvr.addObserver(this, "quit-application-requested", false);
  106.     osvr.addObserver(this, "quit-application-granted", false);
  107.   },
  108.  
  109.   // cleanup (called on application shutdown)
  110.   _dispose: function() 
  111.   {
  112.     // observer removal 
  113.     const osvr = Cc['@mozilla.org/observer-service;1'].
  114.                  getService(Ci.nsIObserverService);
  115.     osvr.removeObserver(this, "profile-before-change");
  116.     osvr.removeObserver(this, "profile-change-teardown");
  117.     osvr.removeObserver(this, "xpcom-shutdown");
  118.     osvr.removeObserver(this, "final-ui-startup");
  119.     osvr.removeObserver(this, "browser:purge-session-history");
  120.     osvr.removeObserver(this, "quit-application-requested");
  121.     osvr.removeObserver(this, "quit-application-granted");
  122.   },
  123.  
  124.   // profile startup handler (contains profile initialization routines)
  125.   _onProfileStartup: function() 
  126.   {
  127.     // check to see if the EULA must be shown on startup
  128.     try {
  129.       var mustDisplayEULA = true;
  130.       var prefBranch = Cc["@mozilla.org/preferences-service;1"].
  131.                        getService(Ci.nsIPrefBranch);
  132.       var EULAVersion = prefBranch.getIntPref("browser.EULA.version");
  133.       mustDisplayEULA = !prefBranch.getBoolPref("browser.EULA." + EULAVersion + ".accepted");
  134.     } catch(ex) {
  135.     }
  136.  
  137. /*
  138.  * Songbird handles its own EULA so we don't want to try and show this
  139.  * one. The browser.EULA* preferences do not exist in songbird either.
  140.  */
  141.     mustDisplayEULA = false;
  142.     if (mustDisplayEULA) {
  143.       var ww2 = Cc["@mozilla.org/embedcomp/window-watcher;1"].
  144.                 getService(Ci.nsIWindowWatcher);
  145.       ww2.openWindow(null, "chrome://browser/content/EULA.xul", 
  146.                      "_blank", "chrome,centerscreen,modal,resizable=yes", null);
  147.     }
  148.  
  149.     this.Sanitizer.onStartup();
  150.     // check if we're in safe mode
  151.     var app = Cc["@mozilla.org/xre/app-info;1"].getService(Ci.nsIXULAppInfo).
  152.               QueryInterface(Ci.nsIXULRuntime);
  153.     if (app.inSafeMode) {
  154.       var ww = Cc["@mozilla.org/embedcomp/window-watcher;1"].
  155.                getService(Ci.nsIWindowWatcher);
  156.       ww.openWindow(null, "chrome://browser/content/safeMode.xul", 
  157.                     "_blank", "chrome,centerscreen,modal,resizable=no", null);
  158.     }
  159.  
  160.     // initialize Places
  161.     this._initPlaces();
  162.  
  163.     // indicate that the profile was initialized
  164.     this._profileStarted = true;
  165.   },
  166.  
  167.   _onProfileChange: function()
  168.   {
  169.     // this block is for code that depends on _onProfileStartup() having 
  170.     // been called.
  171.     if (this._profileStarted) {
  172.       // final places cleanup
  173.       this._shutdownPlaces();
  174.     }
  175.   },
  176.  
  177.   // profile shutdown handler (contains profile cleanup routines)
  178.   _onProfileShutdown: function() 
  179.   {
  180.     // here we enter last survival area, in order to avoid multiple
  181.     // "quit-application" notifications caused by late window closings
  182.     const appStartup = Cc['@mozilla.org/toolkit/app-startup;1'].
  183.                        getService(Ci.nsIAppStartup);
  184.     try {
  185.       appStartup.enterLastWindowClosingSurvivalArea();
  186.  
  187.       this.Sanitizer.onShutdown();
  188.  
  189.     } catch(ex) {
  190.     } finally {
  191.       appStartup.exitLastWindowClosingSurvivalArea();
  192.     }
  193.   },
  194.  
  195.   _onQuitRequest: function(aCancelQuit, aQuitType)
  196.   {
  197.     var wm = Cc["@mozilla.org/appshell/window-mediator;1"].
  198.              getService(Ci.nsIWindowMediator);
  199.     var windowcount = 0;
  200.     var pagecount = 0;
  201.     var browserEnum = wm.getEnumerator("navigator:browser");
  202.     while (browserEnum.hasMoreElements()) {
  203.       windowcount++;
  204.  
  205.       var browser = browserEnum.getNext();
  206.       var tabbrowser = browser.document.getElementById("content");
  207.       if (tabbrowser)
  208.         pagecount += tabbrowser.browsers.length;
  209.     }
  210.  
  211.     this._saveSession = false;
  212.     if (pagecount < 2)
  213.       return;
  214.  
  215.     if (aQuitType != "restart")
  216.       aQuitType = "quit";
  217.  
  218.     var prefBranch = Cc["@mozilla.org/preferences-service;1"].
  219.                      getService(Ci.nsIPrefBranch);
  220.     var showPrompt = true;
  221.     try {
  222.       if (prefBranch.getIntPref("browser.startup.page") == 3 ||
  223.           prefBranch.getBoolPref("browser.sessionstore.resume_session_once"))
  224.         showPrompt = false;
  225.       else
  226.         showPrompt = prefBranch.getBoolPref("browser.warnOnQuit");
  227.     } catch (ex) {}
  228.  
  229.     var buttonChoice = 0;
  230.     if (showPrompt) {
  231.       var bundleService = Cc["@mozilla.org/intl/stringbundle;1"].
  232.                           getService(Ci.nsIStringBundleService);
  233.       var quitBundle = bundleService.createBundle("chrome://browser/locale/quitDialog.properties");
  234.       var brandBundle = bundleService.createBundle("chrome://branding/locale/brand.properties");
  235.  
  236.       var appName = brandBundle.GetStringFromName("brandShortName");
  237.       var quitDialogTitle = quitBundle.formatStringFromName(aQuitType + "DialogTitle",
  238.                                                               [appName], 1);
  239.       var quitTitle = quitBundle.GetStringFromName(aQuitType + "Title");
  240.       var cancelTitle = quitBundle.GetStringFromName("cancelTitle");
  241.       var saveTitle = quitBundle.GetStringFromName("saveTitle");
  242.       var neverAskText = quitBundle.GetStringFromName("neverAsk");
  243.  
  244.       var message;
  245.       if (aQuitType == "restart")
  246.         message = quitBundle.formatStringFromName("messageRestart",
  247.                                                   [appName], 1);
  248.       else if (windowcount == 1)
  249.         message = quitBundle.formatStringFromName("messageNoWindows",
  250.                                                   [appName], 1);
  251.       else
  252.         message = quitBundle.formatStringFromName("message",
  253.                                                   [appName], 1);
  254.  
  255.       var promptService = Cc["@mozilla.org/embedcomp/prompt-service;1"].
  256.                           getService(Ci.nsIPromptService);
  257.  
  258.       var flags = promptService.BUTTON_TITLE_IS_STRING * promptService.BUTTON_POS_0 +
  259.                   promptService.BUTTON_TITLE_IS_STRING * promptService.BUTTON_POS_1 +
  260.                   promptService.BUTTON_POS_0_DEFAULT;
  261.       var neverAsk = {value:false};
  262.       if (aQuitType != "restart")
  263.         flags += promptService.BUTTON_TITLE_IS_STRING * promptService.BUTTON_POS_2;
  264.       buttonChoice = promptService.confirmEx(null, quitDialogTitle, message,
  265.                                    flags, quitTitle, cancelTitle, saveTitle,
  266.                                    neverAskText, neverAsk);
  267.  
  268.       switch (buttonChoice) {
  269.       case 0:
  270.         if (neverAsk.value)
  271.           prefBranch.setBoolPref("browser.warnOnQuit", false);
  272.         break;
  273.       case 1:
  274.         aCancelQuit.QueryInterface(Ci.nsISupportsPRBool);
  275.         aCancelQuit.data = true;
  276.         break;
  277.       case 2:
  278.         // could also set browser.warnOnQuit to false here,
  279.         // but not setting it is a little safer.
  280.         if (neverAsk.value)
  281.           prefBranch.setIntPref("browser.startup.page", 3);
  282.         break;
  283.       }
  284.  
  285.       this._saveSession = buttonChoice == 2;
  286.     }
  287.   },
  288.  
  289.   // returns the (cached) Sanitizer constructor
  290.   get Sanitizer() 
  291.   {
  292.     if(typeof(Sanitizer) != "function") { // we should dynamically load the script
  293.       Cc["@mozilla.org/moz/jssubscript-loader;1"].
  294.       getService(Ci.mozIJSSubScriptLoader).
  295.       loadSubScript("chrome://browser/content/sanitize.js", null);
  296.     }
  297.     return Sanitizer;
  298.   },
  299.  
  300.   /**
  301.    * Initialize Places
  302.    * - imports the bookmarks html file if bookmarks datastore is empty
  303.    */
  304.   _initPlaces: function bg__initPlaces() {
  305.     // we need to instantiate the history service before we check the 
  306.     // the browser.places.importBookmarksHTML pref, as 
  307.     // nsNavHistory::ForceMigrateBookmarksDB() will set that pref
  308.     // if we need to force a migration (due to a schema change)
  309.     var histsvc = Cc["@mozilla.org/browser/nav-history-service;1"].
  310.                   getService(Ci.nsINavHistoryService);
  311.  
  312.     var importBookmarks = false;
  313.     try {
  314.       var prefBranch = Cc["@mozilla.org/preferences-service;1"].
  315.                        getService(Ci.nsIPrefBranch);
  316.       importBookmarks = prefBranch.getBoolPref("browser.places.importBookmarksHTML");
  317.     } catch(ex) {}
  318.  
  319.     if (!importBookmarks)
  320.       return;
  321.  
  322.     var dirService = Cc["@mozilla.org/file/directory_service;1"].
  323.                      getService(Ci.nsIProperties);
  324.  
  325.     var bookmarksFile = dirService.get("BMarks", Ci.nsILocalFile);
  326.  
  327.     if (bookmarksFile.exists()) {
  328.       // import the file
  329.       try {
  330.         var importer = 
  331.           Cc["@mozilla.org/browser/places/import-export-service;1"].
  332.           getService(Ci.nsIPlacesImportExportService);
  333.         importer.importHTMLFromFile(bookmarksFile, true);
  334.       } catch(ex) {
  335.       } finally {
  336.         prefBranch.setBoolPref("browser.places.importBookmarksHTML", false);
  337.       }
  338.  
  339.       // backup pre-places bookmarks.html
  340.       // XXXtodo remove this before betas, after import/export is solid
  341.       var profDir = dirService.get("ProfD", Ci.nsILocalFile);
  342.       var bookmarksBackup = profDir.clone();
  343.       bookmarksBackup.append("bookmarks.preplaces.html");
  344.       if (!bookmarksBackup.exists()) {
  345.         // save old bookmarks.html file as bookmarks.preplaces.html
  346.         try {
  347.           bookmarksFile.copyTo(profDir, "bookmarks.preplaces.html");
  348.         } catch(ex) {
  349.           dump("nsBrowserGlue::_initPlaces(): copy of bookmarks.html to bookmarks.preplaces.html failed: " + ex + "\n");
  350.         }
  351.       }
  352.     }
  353.   },
  354.  
  355.   /**
  356.    * Places shut-down tasks
  357.    * - back up and archive bookmarks
  358.    */
  359.   _shutdownPlaces: function bg__shutdownPlaces() {
  360.     // backup bookmarks to bookmarks.html
  361.     var importer =
  362.       Cc["@mozilla.org/browser/places/import-export-service;1"].
  363.       getService(Ci.nsIPlacesImportExportService);
  364.     importer.backupBookmarksFile();
  365.   },
  366.   
  367.   // ------------------------------
  368.   // public nsIBrowserGlue members
  369.   // ------------------------------
  370.   
  371.   sanitize: function(aParentWindow) 
  372.   {
  373.     this.Sanitizer.sanitize(aParentWindow);
  374.   }
  375. }
  376.  
  377.  
  378. // XPCOM Scaffolding code
  379.  
  380. // component defined in this file
  381.  
  382. const kServiceName = "Firefox Browser Glue Service";
  383. const kServiceId = "{eab9012e-5f74-4cbc-b2b5-a590235513cc}";
  384. const kServiceCtrId = "@mozilla.org/browser/browserglue;1";
  385. const kServiceConstructor = BrowserGlue;
  386.  
  387. const kServiceCId = Components.ID(kServiceId);
  388.  
  389. // interfaces implemented by this component
  390. const kServiceIIds = [ 
  391.   Ci.nsIObserver,
  392.   Ci.nsISupports,
  393.   Ci.nsISupportsWeakReference,
  394.   Ci.nsIBrowserGlue
  395.   ];
  396.  
  397. // categories which this component is registered in
  398. const kServiceCats = ["app-startup"];
  399.  
  400. // Factory object
  401. const kServiceFactory = {
  402.   _instance: null,
  403.   createInstance: function (outer, iid) 
  404.   {
  405.     if (outer != null) throw Cr.NS_ERROR_NO_AGGREGATION;
  406.  
  407.     xpcomCheckInterfaces(iid, kServiceIIds, 
  408.                           Cr.NS_ERROR_INVALID_ARG);
  409.     return this._instance == null ?
  410.       this._instance = new kServiceConstructor() : this._instance;
  411.   }
  412. };
  413.  
  414. function xpcomCheckInterfaces(iid, iids, ex) {
  415.   for (var j = iids.length; j-- >0;) {
  416.     if (iid.equals(iids[j])) return true;
  417.   }
  418.   throw ex;
  419. }
  420.  
  421. // Module
  422.  
  423. var Module = {
  424.   registered: false,
  425.   
  426.   registerSelf: function(compMgr, fileSpec, location, type) 
  427.   {
  428.     if (!this.registered) {
  429.       compMgr.QueryInterface(Ci.nsIComponentRegistrar)
  430.              .registerFactoryLocation(kServiceCId,
  431.                                       kServiceName,
  432.                                       kServiceCtrId, 
  433.                                       fileSpec,
  434.                                       location, 
  435.                                       type);
  436.       const catman = Cc['@mozilla.org/categorymanager;1'].
  437.                      getService(Ci.nsICategoryManager);
  438.       var len = kServiceCats.length;
  439.       for (var j = 0; j < len; j++) {
  440.         catman.addCategoryEntry(kServiceCats[j],
  441.           kServiceCtrId, kServiceCtrId, true, true);
  442.       }
  443.       this.registered = true;
  444.     } 
  445.   },
  446.   
  447.   unregisterSelf: function(compMgr, fileSpec, location) 
  448.   {
  449.     compMgr.QueryInterface(Ci.nsIComponentRegistrar)
  450.            .unregisterFactoryLocation(kServiceCId, fileSpec);
  451.     const catman = Cc['@mozilla.org/categorymanager;1'].
  452.                    getService(Ci.nsICategoryManager);
  453.     var len = kServiceCats.length;
  454.     for (var j = 0; j < len; j++) {
  455.       catman.deleteCategoryEntry(kServiceCats[j], kServiceCtrId, true);
  456.     }
  457.   },
  458.   
  459.   getClassObject: function(compMgr, cid, iid) 
  460.   {
  461.     if(cid.equals(kServiceCId))
  462.       return kServiceFactory;
  463.     
  464.     throw Cr[
  465.       iid.equals(Ci.nsIFactory)
  466.       ? "NS_ERROR_NO_INTERFACE"
  467.       : "NS_ERROR_NOT_IMPLEMENTED"
  468.     ];
  469.     
  470.   },
  471.   
  472.   canUnload: function(compMgr) 
  473.   {
  474.     return true;
  475.   }
  476. };
  477.  
  478. // entrypoint
  479. function NSGetModule(compMgr, fileSpec) {
  480.   return Module;
  481. }
  482.