aboutsummaryrefslogtreecommitdiffstats
path: root/packages/notificationbox/lib/notification-box.js
blob: 94b26cd2658a7af74e14cc6e411365769ebf3c61 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
/* 
 * Copyrights Loic J. Duros 2012
 * lduros@member.fsf.org
 * 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";

const { Cc, Ci } = require("chrome");
const { getMostRecentBrowserWindow } = require('sdk/window/utils');
/* I haven't found this sort of validation functions in the SDK,
except for the deprecated api-utils module. */
let isString = function (str) {
  return typeof(str) == 'string' || str instanceof String;
};

let isArray = function (obj) {
  return Object.prototype.toString.call(obj) === '[object Array]';
};

exports.NotificationBox = function (options) {
  options = options || {};
  let mainWindow = getWindow();
  let nb = mainWindow.gBrowser.getNotificationBox();
  let notification, priority, label, image, value, buttons = [];

  if (options.value && isString(options.value)) {
    notification = nb.getNotificationWithValue(options.value);
    value = options.value;
  }
  else {
    notification = nb.getNotificationWithValue('');
    value = '';
  }
  
  // Add label or create empty notification.
  if (options.label && isString(options.label))
    label = options.label;
  else
    label = "";

  // Set priority of the notification (from info low, to critical
  // block.
  if (options.priority && options.priority in PRIORITY)
    priority = nb[PRIORITY[options.priority]];
  else
    priority = nb[PRIORITY.INFO_LOW];

  // Set a custom icon for the notification or use the regular info
  // icon.
  if (options.image && isString(options.image))
    image = options.image;
  else
    image = 'chrome://browser/skin/Info.png';
  
  // Add buttons.
  if (isArray(options.buttons)) {
    for (let i = 0, length = options.buttons.length; i < length; i++) {
      buttons.push(NotificationButton(options.buttons[i]));
    }
  } 
  else if (typeof(options.buttons) === 'object') {
    // If it's not an array of buttons, then it should be a single button.
    buttons.push(NotificationButton(options.buttons));
  }
  else {
    buttons = null;
  }

  // add new notification to notificationbox.
  nb.appendNotification(label, value,
                        image,
                        priority, buttons);
  
  return {'notificationbox': nb, 'notification': notification};
};



var NotificationButton = function (options) {

  options = options || {};
  let accessKey, onClick, label, popup;

  if (options.accessKey)
    accessKey = options.accessKey;
  else
    accessKey = '';

  if (options.onClick)
    onClick = options.onClick;
  else
    onClick = function () {};

  if (options.label)
    label = options.label;
  else
    label = "";
  
  // no popup for now... maybe we can use a panel later.
  popup = null;
  
  return {label: label, 
          accessKey: accessKey,
          callback: onClick,
          popup: popup};

};

const PRIORITY = {
    'INFO_LOW': 'PRIORITY_INFO_LOW',
    'INFO_MEDIUM': 'PRIORITY_INFO_MEDIUM',
    'INFO_HIGH': 'PRIORITY_INFO_HIGH',
    'WARNING_LOW': 'PRIORITY_WARNING_LOW',
    'WARNING_MEDIUM': 'PRIORITY_WARNING_MEDIUM',
    'WARNING_HIGH': 'PRIORITY_WARNING_HIGH',
    'CRITICAL_LOW': 'PRIORITY_CRITICAL_LOW',
    'CRITICAL_MEDIUM': 'PRIORITY_CRITICAL_MEDIUM',
    'CRITICAL_HIGH': 'PRIORITY_CRITICAL_HIGH',
    'CRITICAL_BLOCK': 'PRIORITY_CRITICAL_BLOCK'
};

let getWindow = function () {
  return getMostRecentBrowserWindow();
};

exports.PRIORITY = PRIORITY;