The Tor Browser: dom/src/notification/NotificationDB.jsm@6474c204b198 (annotated)

dom/src/notification/NotificationDB.jsm@6474c204b198 (annotated)

dom/src/notification/NotificationDB.jsm

Wed, 31 Dec 2014 06:09:35 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Wed, 31 Dec 2014 06:09:35 +0100
changeset 0: 6474c204b198
permissions: -rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
  * You can obtain one at http://mozilla.org/MPL/2.0/. */
 "use strict";
 this.EXPORTED_SYMBOLS = [];
 const DEBUG = false;
 function debug(s) { dump("-*- NotificationDB component: " + s + "\n"); }
 const Cu = Components.utils;
 const Cc = Components.classes;
 const Ci = Components.interfaces;
 Cu.import("resource://gre/modules/XPCOMUtils.jsm");
 Cu.import("resource://gre/modules/osfile.jsm");
 XPCOMUtils.defineLazyServiceGetter(this, "ppmm",
                                    "@mozilla.org/parentprocessmessagemanager;1",
                                    "nsIMessageListenerManager");
 XPCOMUtils.defineLazyGetter(this, "gEncoder", function() {
   return new TextEncoder();
 });
 XPCOMUtils.defineLazyGetter(this, "gDecoder", function() {
   return new TextDecoder();
 });
 const NOTIFICATION_STORE_DIR = OS.Constants.Path.profileDir;
 const NOTIFICATION_STORE_PATH =
         OS.Path.join(NOTIFICATION_STORE_DIR, "notificationstore.json");
 let NotificationDB = {
   init: function() {
     this.notifications = {};
     this.byTag = {};
     this.loaded = false;
     this.tasks = []; // read/write operation queue
     this.runningTask = false;
     ppmm.addMessageListener("Notification:Save", this);
     ppmm.addMessageListener("Notification:Delete", this);
     ppmm.addMessageListener("Notification:GetAll", this);
   },
   // Attempt to read notification file, if it's not there we will create it.
   load: function(callback) {
     var promise = OS.File.read(NOTIFICATION_STORE_PATH);
     promise.then(
       function onSuccess(data) {
         try {
           this.notifications = JSON.parse(gDecoder.decode(data));
         } catch (e) {
           if (DEBUG) { debug("Unable to parse file data " + e); }
         }
         // populate the list of notifications by tag
         if (this.notifications) {
           for (var origin in this.notifications) {
             this.byTag[origin] = {};
             for (var id in this.notifications[origin]) {
               var curNotification = this.notifications[origin][id];
               if (curNotification.tag) {
                 this.byTag[origin][curNotification.tag] = curNotification;
               }
             }
           }
         }
         this.loaded = true;
         callback && callback();
       }.bind(this),
       // If read failed, we assume we have no notifications to load.
       function onFailure(reason) {
         this.loaded = true;
         this.createStore(callback);
       }.bind(this)
     );
   },
   // Creates the notification directory.
   createStore: function(callback) {
     var promise = OS.File.makeDir(NOTIFICATION_STORE_DIR, {
       ignoreExisting: true
     });
     promise.then(
       function onSuccess() {
         this.createFile(callback);
       }.bind(this),
       function onFailure(reason) {
         if (DEBUG) { debug("Directory creation failed:" + reason); }
         callback && callback();
       }
     );
   },
   // Creates the notification file once the directory is created.
   createFile: function(callback) {
     var promise = OS.File.open(NOTIFICATION_STORE_PATH, {create: true});
     promise.then(
       function onSuccess(handle) {
         handle.close();
         callback && callback();
       },
       function onFailure(reason) {
         if (DEBUG) { debug("File creation failed:" + reason); }
         callback && callback();
       }
     );
   },
   // Save current notifications to the file.
   save: function(callback) {
     var data = gEncoder.encode(JSON.stringify(this.notifications));
     var promise = OS.File.writeAtomic(NOTIFICATION_STORE_PATH, data);
     promise.then(
       function onSuccess() {
         callback && callback();
       },
       function onFailure(reason) {
         if (DEBUG) { debug("Save failed:" + reason); }
         callback && callback();
       }
     );
   },
   // Helper function: callback will be called once file exists and/or is loaded.
   ensureLoaded: function(callback) {
     if (!this.loaded) {
       this.load(callback);
     } else {
       callback();
     }
   },
   receiveMessage: function(message) {
     if (DEBUG) { debug("Received message:" + message.name); }
     // sendAsyncMessage can fail if the child process exits during a
     // notification storage operation, so always wrap it in a try/catch.
     function returnMessage(name, data) {
       try {
         message.target.sendAsyncMessage(name, data);
       } catch (e) {
         if (DEBUG) { debug("Return message failed, " + name); }
       }
     }
     switch (message.name) {
       case "Notification:GetAll":
         this.queueTask("getall", message.data, function(notifications) {
           returnMessage("Notification:GetAll:Return:OK", {
             requestID: message.data.requestID,
             origin: message.data.origin,
             notifications: notifications
           });
         });
         break;
       case "Notification:Save":
         this.queueTask("save", message.data, function() {
           returnMessage("Notification:Save:Return:OK", {
             requestID: message.data.requestID
           });
         });
         break;
       case "Notification:Delete":
         this.queueTask("delete", message.data, function() {
           returnMessage("Notification:Delete:Return:OK", {
             requestID: message.data.requestID
           });
         });
         break;
       default:
         if (DEBUG) { debug("Invalid message name" + message.name); }
     }
   },
   // We need to make sure any read/write operations are atomic,
   // so use a queue to run each operation sequentially.
   queueTask: function(operation, data, callback) {
     if (DEBUG) { debug("Queueing task: " + operation); }
     this.tasks.push({
       operation: operation,
       data: data,
       callback: callback
     });
     // Only run immediately if we aren't currently running another task.
     if (!this.runningTask) {
       if (DEBUG) { dump("Task queue was not running, starting now..."); }
       this.runNextTask();
     }
   },
   runNextTask: function() {
     if (this.tasks.length === 0) {
       if (DEBUG) { dump("No more tasks to run, queue depleted"); }
       this.runningTask = false;
       return;
     }
     this.runningTask = true;
     // Always make sure we are loaded before performing any read/write tasks.
     this.ensureLoaded(function() {
       var task = this.tasks.shift();
       // Wrap the task callback to make sure we immediately
       // run the next task after running the original callback.
       var wrappedCallback = function() {
         if (DEBUG) { debug("Finishing task: " + task.operation); }
         task.callback.apply(this, arguments);
         this.runNextTask();
       }.bind(this);
       switch (task.operation) {
         case "getall":
           this.taskGetAll(task.data, wrappedCallback);
           break;
         case "save":
           this.taskSave(task.data, wrappedCallback);
           break;
         case "delete":
           this.taskDelete(task.data, wrappedCallback);
           break;
       }
     }.bind(this));
   },
   taskGetAll: function(data, callback) {
     if (DEBUG) { debug("Task, getting all"); }
     var origin = data.origin;
     var notifications = [];
     // Grab only the notifications for specified origin.
     for (var i in this.notifications[origin]) {
       notifications.push(this.notifications[origin][i]);
     }
     callback(notifications);
   },
   taskSave: function(data, callback) {
     if (DEBUG) { debug("Task, saving"); }
     var origin = data.origin;
     var notification = data.notification;
     if (!this.notifications[origin]) {
       this.notifications[origin] = {};
       this.byTag[origin] = {};
     }
     // We might have existing notification with this tag,
     // if so we need to remove it before saving the new one.
     if (notification.tag && this.byTag[origin][notification.tag]) {
       var oldNotification = this.byTag[origin][notification.tag];
       delete this.notifications[origin][oldNotification.id];
       this.byTag[origin][notification.tag] = notification;
     }
     this.notifications[origin][notification.id] = notification;
     this.save(callback);
   },
   taskDelete: function(data, callback) {
     if (DEBUG) { debug("Task, deleting"); }
     var origin = data.origin;
     var id = data.id;
     if (!this.notifications[origin]) {
       if (DEBUG) { debug("No notifications found for origin: " + origin); }
       return;
     }
     // Make sure we can find the notification to delete.
     var oldNotification = this.notifications[origin][id];
     if (!oldNotification) {
       if (DEBUG) { debug("No notification found with id: " + id); }
       return;
     }
     if (oldNotification.tag) {
       delete this.byTag[origin][oldNotification.tag];
     }
     delete this.notifications[origin][id];
     this.save(callback);
   }
 };
 NotificationDB.init();

The Tor Browser / annotate

dom/src/notification/NotificationDB.jsm@6474c204b198 (annotated)

dom/src/notification/NotificationDB.jsm