home *** CD-ROM | disk | FTP | other *** search
/ PC Advisor 2010 April / PCA177.iso / ESSENTIALS / Firefox Setup.exe / nonlocalized / components / nsPlacesDBFlush.js < prev    next >
Encoding:
Text File  |  2009-07-15  |  11.9 KB  |  338 lines
  1. /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
  2.  * vim: sw=2 ts=2 sts=2 expandtab
  3.  * ***** BEGIN LICENSE BLOCK *****
  4.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  5.  *
  6.  * The contents of this file are subject to the Mozilla Public License Version
  7.  * 1.1 (the "License"); you may not use this file except in compliance with
  8.  * the License. You may obtain a copy of the License at
  9.  * http://www.mozilla.org/MPL/
  10.  *
  11.  * Software distributed under the License is distributed on an "AS IS" basis,
  12.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13.  * for the specific language governing rights and limitations under the
  14.  * License.
  15.  *
  16.  * The Original Code is mozilla.org code.
  17.  *
  18.  * The Initial Developer of the Original Code is
  19.  * Mozilla Corporation.
  20.  * Portions created by the Initial Developer are Copyright (C) 2008
  21.  * the Initial Developer. All Rights Reserved.
  22.  *
  23.  * Contributor(s):
  24.  *   Shawn Wilsher <me@shawnwilsher.com> (Original Author)
  25.  *   Marco Bonardo <mak77@bonardo.net>
  26.  *
  27.  * Alternatively, the contents of this file may be used under the terms of
  28.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  29.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  30.  * in which case the provisions of the GPL or the LGPL are applicable instead
  31.  * of those above. If you wish to allow use of your version of this file only
  32.  * under the terms of either the GPL or the LGPL, and not to allow others to
  33.  * use your version of this file under the terms of the MPL, indicate your
  34.  * decision by deleting the provisions above and replace them with the notice
  35.  * and other provisions required by the GPL or the LGPL. If you do not delete
  36.  * the provisions above, a recipient may use your version of this file under
  37.  * the terms of any one of the MPL, the GPL or the LGPL.
  38.  *
  39.  * ***** END LICENSE BLOCK ***** */
  40.  
  41. Components.utils.import("resource://gre/modules/XPCOMUtils.jsm");
  42.  
  43. ////////////////////////////////////////////////////////////////////////////////
  44. //// Constants
  45.  
  46. const Cc = Components.classes;
  47. const Ci = Components.interfaces;
  48. const Cr = Components.results;
  49. const Cu = Components.utils;
  50.  
  51. const kQuitApplication = "quit-application";
  52. const kSyncFinished = "places-sync-finished";
  53.  
  54. const kSyncPrefName = "syncDBTableIntervalInSecs";
  55. const kDefaultSyncInterval = 120;
  56.  
  57. ////////////////////////////////////////////////////////////////////////////////
  58. //// nsPlacesDBFlush class
  59.  
  60. function nsPlacesDBFlush()
  61. {
  62.   this._prefs = Cc["@mozilla.org/preferences-service;1"].
  63.                 getService(Ci.nsIPrefService).
  64.                 getBranch("places.");
  65.  
  66.   // Get our sync interval
  67.   try {
  68.     // We want to silently fail if the preference does not exist, and use a
  69.     // default to fallback to.
  70.     this._syncInterval = this._prefs.getIntPref(kSyncPrefName);
  71.     if (this._syncInterval <= 0)
  72.       this._syncInterval = kDefaultSyncInterval;
  73.   }
  74.   catch (e) {
  75.     // The preference did not exist, so default to two minutes.
  76.     this._syncInterval = kDefaultSyncInterval;
  77.   }
  78.  
  79.   // Register observers
  80.   this._bs = Cc["@mozilla.org/browser/nav-bookmarks-service;1"].
  81.              getService(Ci.nsINavBookmarksService);
  82.   this._bs.addObserver(this, false);
  83.  
  84.   this._os = Cc["@mozilla.org/observer-service;1"].
  85.              getService(Ci.nsIObserverService);
  86.   this._os.addObserver(this, kQuitApplication, false);
  87.  
  88.   this._prefs.QueryInterface(Ci.nsIPrefBranch2)
  89.              .addObserver("", this, false);
  90.  
  91.   // Create our timer to update everything
  92.   this._timer = this._newTimer();
  93.  
  94.   //////////////////////////////////////////////////////////////////////////////
  95.   //// Smart Getters
  96.  
  97.   this.__defineGetter__("_db", function() {
  98.     delete this._db;
  99.     return this._db = Cc["@mozilla.org/browser/nav-history-service;1"].
  100.                       getService(Ci.nsPIPlacesDatabase).
  101.                       DBConnection;
  102.   });
  103.  
  104. }
  105.  
  106. nsPlacesDBFlush.prototype = {
  107.   //////////////////////////////////////////////////////////////////////////////
  108.   //// nsIObserver
  109.  
  110.   observe: function DBFlush_observe(aSubject, aTopic, aData)
  111.   {
  112.     if (aTopic == kQuitApplication) {
  113.       this._bs.removeObserver(this);
  114.       this._os.removeObserver(this, kQuitApplication);
  115.       this._prefs.QueryInterface(Ci.nsIPrefBranch2).removeObserver("", this);
  116.       this._timer.cancel();
  117.       this._timer = null;
  118.       // Other components could still make changes to history at this point,
  119.       // for example to clear private data on shutdown, so here we dispatch
  120.       // an event to the main thread so that we will sync after
  121.       // quit-application ensuring all data have been saved.
  122.       let tm = Cc["@mozilla.org/thread-manager;1"].
  123.           getService(Ci.nsIThreadManager);
  124.       tm.mainThread.dispatch({
  125.         _self: this,
  126.         run: function() {
  127.           let pip = Cc["@mozilla.org/browser/nav-history-service;1"].
  128.                     getService(Ci.nsPIPlacesDatabase);
  129.           pip.commitPendingChanges();
  130.           this._self._syncTables(["places", "historyvisits"]);
  131.           // Close the database connection, this was the last sync and we can't
  132.           // ensure database coherence from now on.
  133.           pip.finalizeInternalStatements();
  134.           this._self._finalizeInternalStatements();
  135.           this._self._db.close();
  136.         }
  137.       }, Ci.nsIThread.DISPATCH_NORMAL);
  138.  
  139.     }
  140.     else if (aTopic == "nsPref:changed" && aData == kSyncPrefName) {
  141.       // Get the new pref value, and then update our timer
  142.       this._syncInterval = aSubject.getIntPref(kSyncPrefName);
  143.       if (this._syncInterval <= 0)
  144.         this._syncInterval = kDefaultSyncInterval;
  145.  
  146.       // We may have canceled the timer already for batch updates, so we want to
  147.       // exit early.
  148.       if (!this._timer)
  149.         return;
  150.  
  151.       this._timer.cancel();
  152.       this._timer = this._newTimer();
  153.     }
  154.   },
  155.  
  156.   //////////////////////////////////////////////////////////////////////////////
  157.   //// nsINavBookmarkObserver
  158.  
  159.   onBeginUpdateBatch: function DBFlush_onBeginUpdateBatch()
  160.   {
  161.     this._inBatchMode = true;
  162.  
  163.     // We do not want to sync while we are doing batch work.
  164.     this._timer.cancel();
  165.     this._timer = null;
  166.   },
  167.  
  168.   onEndUpdateBatch: function DBFlush_onEndUpdateBatch()
  169.   {
  170.     this._inBatchMode = false;
  171.  
  172.     // Restore our timer
  173.     this._timer = this._newTimer();
  174.  
  175.     // We need to sync now
  176.     this._syncTables(["places", "historyvisits"]);
  177.   },
  178.  
  179.   onItemAdded: function(aItemId, aParentId, aIndex)
  180.   {
  181.     // Sync only if we added a TYPE_BOOKMARK item
  182.     if (!this._inBatchMode &&
  183.         this._bs.getItemType(aItemId) == this._bs.TYPE_BOOKMARK)
  184.       this._syncTables(["places"]);
  185.   },
  186.  
  187.   onItemChanged: function DBFlush_onItemChanged(aItemId, aProperty,
  188.                                                          aIsAnnotationProperty,
  189.                                                          aValue)
  190.   {
  191.     if (!this._inBatchMode && aProperty == "uri")
  192.       this._syncTables(["places"]);
  193.   },
  194.  
  195.   onItemRemoved: function() { },
  196.   onItemVisited: function() { },
  197.   onItemMoved: function() { },
  198.  
  199.   //////////////////////////////////////////////////////////////////////////////
  200.   //// nsITimerCallback
  201.  
  202.   notify: function() this._syncTables(["places", "historyvisits"]),
  203.  
  204.   //////////////////////////////////////////////////////////////////////////////
  205.   //// mozIStorageStatementCallback
  206.  
  207.   handleError: function DBFlush_handleError(aError)
  208.   {
  209.     Cu.reportError("Async statement execution returned with '" +
  210.                    aError.result + "', '" + aError.message + "'");
  211.   },
  212.  
  213.   handleCompletion: function DBFlush_handleCompletion(aReason)
  214.   {
  215.     if (aReason == Ci.mozIStorageStatementCallback.REASON_FINISHED) {
  216.       // Dispatch a notification that sync has finished.
  217.       this._os.notifyObservers(null, kSyncFinished, null);
  218.     }
  219.   },
  220.  
  221.   //////////////////////////////////////////////////////////////////////////////
  222.   //// nsPlacesDBFlush
  223.   _syncInterval: kDefaultSyncInterval,
  224.  
  225.   /**
  226.    * Execute async statements to sync temporary places table.
  227.    * @param aTableNames
  228.    *        array of table names that should be synced, as moz_{TableName}_temp.
  229.    */
  230.   _syncTables: function DBFlush_syncTables(aTableNames)
  231.   {
  232.     // No need to do extra work if we are in batch mode
  233.     if (this._inBatchMode)
  234.       return;
  235.  
  236.     let statements = [];
  237.     for (let i = 0; i < aTableNames.length; i++)
  238.       statements.push(this._getSyncTableStatement(aTableNames[i]));
  239.  
  240.     // Execute sync statements async in a transaction
  241.     this._db.executeAsync(statements, statements.length, this);
  242.   },
  243.  
  244.   /**
  245.    * Finalizes all of our mozIStorageStatements so we can properly close the
  246.    * database.
  247.    */
  248.   _finalizeInternalStatements: function DBFlush_finalizeInternalStatements()
  249.   {
  250.     for each (let stmt in this._cachedStatements)
  251.       if (stmt instanceof Ci.mozIStorageStatement)
  252.         stmt.finalize();
  253.   },
  254.  
  255.   /**
  256.    * Generate the statement to synchronizes the moz_{aTableName} and
  257.    * moz_{aTableName}_temp by copying all the data from the temporary table
  258.    * into the permanent one.
  259.    * Most of the work is done through triggers defined in nsPlacesTriggers.h,
  260.    * they sync back to disk, then delete the data in the temporary table.
  261.    * @param aTableName
  262.    *        name of the table to build statement for, as moz_{TableName}_temp.
  263.    */
  264.   _cachedStatements: {},
  265.   _getSyncTableStatement: function DBFlush_getSyncTableStatement(aTableName)
  266.   {
  267.     // Statement creating can be expensive, so always cache if we can.
  268.     if (aTableName in this._cachedStatements)
  269.       return this._cachedStatements[aTableName];
  270.  
  271.     // Delete all the data in the temp table.
  272.     // We have triggers setup that ensure that the data is transferred over
  273.     // upon deletion.
  274.     let condition = "";
  275.     switch(aTableName) {
  276.       case "historyvisits":
  277.         // For history table we want to leave embed visits in memory, since
  278.         // those are expired with current session, so we are filtering them out.
  279.         condition = "WHERE visit_type <> " + Ci.nsINavHistoryService.TRANSITION_EMBED;
  280.         break;
  281.       case "places":
  282.         // For places table we want to leave places associated with embed visits
  283.         // in memory, they usually have hidden = 1 and at least an embed visit
  284.         // in historyvisits_temp table.
  285.         condition = "WHERE id IN (SELECT id FROM moz_places_temp h " +
  286.                                   "WHERE h.hidden <> 1 OR NOT EXISTS ( " +
  287.                                     "SELECT id FROM moz_historyvisits_temp " +
  288.                                     "WHERE place_id = h.id AND visit_type = " +
  289.                                     Ci.nsINavHistoryService.TRANSITION_EMBED +
  290.                                     " LIMIT 1) " +
  291.                                   ")";
  292.         break;
  293.     }
  294.  
  295.     let sql = "DELETE FROM moz_" + aTableName + "_temp " + condition;
  296.     return this._cachedStatements[aTableName] = this._db.createStatement(sql);
  297.   },
  298.  
  299.   /**
  300.    * Creates a new timer based on this._syncInterval.
  301.    *
  302.    * @returns a REPEATING_SLACK nsITimer that runs every this._syncInterval.
  303.    */
  304.   _newTimer: function DBFlush_newTimer()
  305.   {
  306.     let timer = Cc["@mozilla.org/timer;1"].createInstance(Ci.nsITimer);
  307.     timer.initWithCallback(this, this._syncInterval * 1000,
  308.                            Ci.nsITimer.TYPE_REPEATING_SLACK);
  309.     return timer;
  310.   },
  311.  
  312.   //////////////////////////////////////////////////////////////////////////////
  313.   //// nsISupports
  314.  
  315.   classDescription: "Used to synchronize the temporary and permanent tables of Places",
  316.   classID: Components.ID("c1751cfc-e8f1-4ade-b0bb-f74edfb8ef6a"),
  317.   contractID: "@mozilla.org/places/sync;1",
  318.   _xpcom_categories: [{
  319.     category: "profile-after-change",
  320.   }],
  321.  
  322.   QueryInterface: XPCOMUtils.generateQI([
  323.     Ci.nsIObserver,
  324.     Ci.nsINavBookmarkObserver,
  325.     Ci.nsITimerCallback,
  326.     Ci.mozIStorageStatementCallback,
  327.   ])
  328. };
  329.  
  330. ////////////////////////////////////////////////////////////////////////////////
  331. //// Module Registration
  332.  
  333. let components = [nsPlacesDBFlush];
  334. function NSGetModule(compMgr, fileSpec)
  335. {
  336.   return XPCOMUtils.generateModule(components);
  337. }
  338.