Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Unified Diff: lib/notification.js

Issue 5538776168267776: Implemented anti-adblock message notification (Closed)
Patch Set: Created Feb. 12, 2014, 6:22 p.m.
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « defaults/prefs.js ('k') | lib/ui.js » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: lib/notification.js
===================================================================
--- a/lib/notification.js
+++ b/lib/notification.js
@@ -25,15 +25,24 @@
let {Prefs} = require("prefs");
let {Downloader, Downloadable, MILLIS_IN_MINUTE, MILLIS_IN_HOUR, MILLIS_IN_DAY} = require("downloader");
let {Utils} = require("utils");
+let {Matcher} = require("matcher");
+let {Filter} = require("filterClasses");
let INITIAL_DELAY = 12 * MILLIS_IN_MINUTE;
let CHECK_INTERVAL = 1 * MILLIS_IN_HOUR;
let EXPIRATION_INTERVAL = 1 * MILLIS_IN_DAY;
+let TYPES = {
Felix Dahlke 2014/02/13 10:22:04 Maybe we should call this TYPE_SEVERITY since it's
Thomas Greiner 2014/02/13 12:57:54 I don't think we need to make it overly specific g
+ information: 0,
+ question: 1,
+ critical: 2
+};
+
+let listeners = {};
function getNumericalSeverity(notification)
{
- let levels = {information: 0, critical: 1};
- return (notification.severity in levels ? levels[notification.severity] : levels.information);
+ let type = ("type" in notification) ? notification.type : notification.severity;
+ return (type in TYPES ? TYPES[type] : TYPES.information);
}
function saveNotificationData()
@@ -60,6 +69,7 @@
* @type Downloader
*/
let downloader = null;
+let localData = [];
/**
* Regularly fetches notifications and decides which to show.
@@ -142,10 +152,10 @@
/**
* Determines which notification is to be shown next.
- * @param {Array of Object} notifications active notifications
+ * @param {String} url URL to match notifications to (optional)
* @return {Object} notification to be shown, or null if there is none
*/
- getNextToShow: function()
+ getNextToShow: function(url)
{
function checkTarget(target, parameter, name, version)
{
@@ -154,11 +164,11 @@
return !((parameter in target && target[parameter] != name) ||
(minVersionKey in target && Services.vc.compare(version, target[minVersionKey]) < 0) ||
(maxVersionKey in target && Services.vc.compare(version, target[maxVersionKey]) > 0));
-
}
- if (typeof Prefs.notificationdata.data != "object" || !(Prefs.notificationdata.data.notifications instanceof Array))
- return null;
+ let remoteData = [];
+ if (typeof Prefs.notificationdata.data == "object" && Prefs.notificationdata.data.notifications instanceof Array)
+ remoteData = Prefs.notificationdata.data.notifications;
if (!(Prefs.notificationdata.shown instanceof Array))
{
@@ -166,15 +176,32 @@
saveNotificationData();
}
+ let notifications = localData.concat(remoteData);
+ if (notifications.length === 0)
+ return null;
+
let {addonName, addonVersion, application, applicationVersion, platform, platformVersion} = require("info");
- let notifications = Prefs.notificationdata.data.notifications;
let notificationToShow = null;
for each (let notification in notifications)
{
- if ((typeof notification.severity === "undefined" || notification.severity === "information")
+ if ((typeof notification.type === "undefined" || notification.type !== "critical")
Felix Dahlke 2014/02/13 10:22:04 I'm sorry, my suggestion for being downwards compa
Thomas Greiner 2014/02/13 12:57:54 Done.
&& Prefs.notificationdata.shown.indexOf(notification.id) !== -1)
continue;
+ if (typeof url === "string" || notification.urlFilters instanceof Array)
+ {
+ if (typeof url === "string" && notification.urlFilters instanceof Array)
+ {
+ let matcher = new Matcher();
+ for each (let urlFilter in notification.urlFilters)
+ matcher.add(Filter.fromText(urlFilter));
+ if (!matcher.matchesAny(url, "DOCUMENT", url))
+ continue;
+ }
+ else
+ continue;
+ }
+
if (notification.targets instanceof Array)
{
let match = false;
@@ -199,13 +226,22 @@
if (notificationToShow && "id" in notificationToShow)
{
- Prefs.notificationdata.shown.push(notificationToShow.id);
- saveNotificationData();
+ if (notificationToShow.type !== "question")
+ this.markAsShown(notificationToShow.id);
}
return notificationToShow;
},
+ markAsShown: function(id)
+ {
+ if (Prefs.notificationdata.shown.indexOf(id) > -1)
+ return;
+
+ Prefs.notificationdata.shown.push(id);
+ saveNotificationData();
+ },
+
/**
* Localizes the texts of the supplied notification.
* @param {Object} notification notification to translate
@@ -221,9 +257,73 @@
for each (let key in textKeys)
{
if (key in notification)
- localizedTexts[key] = localize(notification[key], locale);
+ {
+ if (typeof notification[key] == "string")
+ localizedTexts[key] = notification[key];
+ else
+ localizedTexts[key] = localize(notification[key], locale);
+ }
}
return localizedTexts;
+ },
+
+ /**
+ * Adds a local notification.
+ * @param {Object} notification notification to add
+ */
+ addNotification: function(notification)
+ {
+ if (localData.indexOf(notification) == -1)
+ localData.push(notification);
+ },
+
+ /**
+ * Removes an existing local notification.
+ * @param {Object} notification notification to remove
+ */
+ removeNotification: function(notification)
+ {
+ let index = localData.indexOf(notification);
+ if (index > -1)
+ localData.splice(index, 1);
+ },
+
+ /**
+ * Adds a listener for question-type notifications
+ */
+ addQuestionListener: function(/**string*/ id, /**function(approved)*/ listener)
+ {
+ if (!(id in listeners))
+ listeners[id] = [];
+ if (listeners[id].indexOf(listener) === -1)
+ listeners[id].push(listener);
+ },
+
+ /**
+ * Removes a listener that was previously added via addQuestionListener
+ */
+ removeQuestionListener: function(/**string*/ id, /**function(approved)*/ listener)
+ {
+ if (!(id in listeners))
+ return;
+ let index = listeners[id].indexOf(listener);
+ if (index > -1)
+ listeners[id].splice(index, 1);
+ if (listeners[id].length === 0)
+ delete listeners[id];
+ },
+
+ /**
+ * Notifies listeners about interactions with a notification
+ * @param {String} id notification ID
+ * @param {Boolean} approved indicator whether notification has been approved or not
+ */
+ triggerQuestionListeners: function(id, approved)
+ {
+ if (!(id in listeners))
+ return;
+ for each (let listener in listeners[id])
+ listener(approved);
}
};
Notification.init();
« no previous file with comments | « defaults/prefs.js ('k') | lib/ui.js » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld