113 lines
3.2 KiB
JavaScript
113 lines
3.2 KiB
JavaScript
/* 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";
|
|
|
|
module.metadata = {
|
|
"stability": "stable"
|
|
};
|
|
|
|
const { Cc, Ci, Cr } = require("chrome");
|
|
const apiUtils = require("./deprecated/api-utils");
|
|
const { isString, isUndefined, instanceOf } = require('./lang/type');
|
|
const { URL, isLocalURL } = require('./url');
|
|
const { data } = require('./self');
|
|
|
|
const NOTIFICATION_DIRECTIONS = ["auto", "ltr", "rtl"];
|
|
|
|
try {
|
|
let alertServ = Cc["@mozilla.org/alerts-service;1"].
|
|
getService(Ci.nsIAlertsService);
|
|
|
|
// The unit test sets this to a mock notification function.
|
|
var notify = alertServ.showAlertNotification.bind(alertServ);
|
|
}
|
|
catch (err) {
|
|
// An exception will be thrown if the platform doesn't provide an alert
|
|
// service, e.g., if Growl is not installed on OS X. In that case, use a
|
|
// mock notification function that just logs to the console.
|
|
notify = notifyUsingConsole;
|
|
}
|
|
|
|
exports.notify = function notifications_notify(options) {
|
|
let valOpts = validateOptions(options);
|
|
let clickObserver = !valOpts.onClick ? null : {
|
|
observe: (subject, topic, data) => {
|
|
if (topic === "alertclickcallback") {
|
|
try {
|
|
valOpts.onClick.call(exports, valOpts.data);
|
|
}
|
|
catch(e) {
|
|
console.exception(e);
|
|
}
|
|
}
|
|
}
|
|
};
|
|
function notifyWithOpts(notifyFn) {
|
|
let { iconURL } = valOpts;
|
|
iconURL = iconURL && isLocalURL(iconURL) ? data.url(iconURL) : iconURL;
|
|
|
|
notifyFn(iconURL, valOpts.title, valOpts.text, !!clickObserver,
|
|
valOpts.data, clickObserver, valOpts.tag, valOpts.dir, valOpts.lang);
|
|
}
|
|
try {
|
|
notifyWithOpts(notify);
|
|
}
|
|
catch (err) {
|
|
if (err instanceof Ci.nsIException && err.result == Cr.NS_ERROR_FILE_NOT_FOUND) {
|
|
console.warn("The notification icon named by " + iconURL +
|
|
" does not exist. A default icon will be used instead.");
|
|
delete valOpts.iconURL;
|
|
notifyWithOpts(notify);
|
|
}
|
|
else {
|
|
notifyWithOpts(notifyUsingConsole);
|
|
}
|
|
}
|
|
};
|
|
|
|
function notifyUsingConsole(iconURL, title, text) {
|
|
title = title ? "[" + title + "]" : "";
|
|
text = text || "";
|
|
let str = [title, text].filter(s => s).join(" ");
|
|
console.log(str);
|
|
}
|
|
|
|
function validateOptions(options) {
|
|
return apiUtils.validateOptions(options, {
|
|
data: {
|
|
is: ["string", "undefined"]
|
|
},
|
|
iconURL: {
|
|
is: ["string", "undefined", "object"],
|
|
ok: function(value) {
|
|
return isUndefined(value) || isString(value) || (value instanceof URL);
|
|
},
|
|
msg: "`iconURL` must be a string or an URL instance."
|
|
},
|
|
onClick: {
|
|
is: ["function", "undefined"]
|
|
},
|
|
text: {
|
|
is: ["string", "undefined", "number"]
|
|
},
|
|
title: {
|
|
is: ["string", "undefined", "number"]
|
|
},
|
|
tag: {
|
|
is: ["string", "undefined", "number"]
|
|
},
|
|
dir: {
|
|
is: ["string", "undefined"],
|
|
ok: function(value) {
|
|
return isUndefined(value) || ~NOTIFICATION_DIRECTIONS.indexOf(value);
|
|
},
|
|
msg: '`dir` option must be one of: "auto", "ltr" or "rtl".'
|
|
},
|
|
lang: {
|
|
is: ["string", "undefined"]
|
|
}
|
|
});
|
|
}
|