summaryrefslogtreecommitdiffstats
path: root/comm/calendar/base/src/CalAlarmMonitor.jsm
blob: 0412e72850938ff76193edb73ab174a99efb6a9f (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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
/* 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/. */

var EXPORTED_SYMBOLS = ["CalAlarmMonitor"];

var { cal } = ChromeUtils.import("resource:///modules/calendar/calUtils.jsm");

const lazy = {};
ChromeUtils.defineModuleGetter(lazy, "CalEvent", "resource:///modules/CalEvent.jsm");

function peekAlarmWindow() {
  return Services.wm.getMostRecentWindow("Calendar:AlarmWindow");
}

/**
 * The alarm monitor takes care of playing the alarm sound and opening one copy
 * of the calendar-alarm-dialog. Both depend on their respective prefs to be
 * set. This monitor is only used for DISPLAY type alarms.
 */
function CalAlarmMonitor() {
  this.wrappedJSObject = this;
  this.mAlarms = [];
  // A map from itemId to item.
  this._notifyingItems = new Map();

  this.mSound = Cc["@mozilla.org/sound;1"].createInstance(Ci.nsISound);

  Services.obs.addObserver(this, "alarm-service-startup");
  Services.obs.addObserver(this, "alarm-service-shutdown");
}

var calAlarmMonitorClassID = Components.ID("{4b7ae030-ed79-11d9-8cd6-0800200c9a66}");
var calAlarmMonitorInterfaces = [Ci.nsIObserver, Ci.calIAlarmServiceObserver];
CalAlarmMonitor.prototype = {
  mAlarms: null,

  // This is a work-around for the fact that there is a delay between when
  // we call openWindow and when it appears via getMostRecentWindow.  If an
  // alarm is fired in that time-frame, it will actually end up in another window.
  mWindowOpening: null,

  // nsISound instance used for playing all sounds
  mSound: null,

  classID: calAlarmMonitorClassID,
  QueryInterface: cal.generateQI(["nsIObserver", "calIAlarmServiceObserver"]),
  classInfo: cal.generateCI({
    contractID: "@mozilla.org/calendar/alarm-monitor;1",
    classDescription: "Calendar Alarm Monitor",
    classID: calAlarmMonitorClassID,
    interfaces: calAlarmMonitorInterfaces,
    flags: Ci.nsIClassInfo.SINGLETON,
  }),

  /**
   * nsIObserver
   */
  observe(aSubject, aTopic, aData) {
    let alarmService = Cc["@mozilla.org/calendar/alarm-service;1"].getService(Ci.calIAlarmService);
    switch (aTopic) {
      case "alarm-service-startup":
        alarmService.addObserver(this);
        break;
      case "alarm-service-shutdown":
        alarmService.removeObserver(this);
        break;
      case "alertclickcallback": {
        let item = this._notifyingItems.get(aData);
        if (item) {
          let calWindow = cal.window.getCalendarWindow();
          if (calWindow) {
            calWindow.openEventDialogForViewing(item, true);
          }
        }
        break;
      }
      case "alertfinished":
        this._notifyingItems.delete(aData);
        break;
    }
  },

  /**
   * calIAlarmServiceObserver
   */
  onAlarm(aItem, aAlarm) {
    if (aAlarm.action != "DISPLAY") {
      // This monitor only looks for DISPLAY alarms.
      return;
    }

    this.mAlarms.push([aItem, aAlarm]);

    if (Services.prefs.getBoolPref("calendar.alarms.playsound", true)) {
      // We want to make sure the user isn't flooded with alarms so we
      // limit this using a preference. For example, if the user has 20
      // events that fire an alarm in the same minute, then the alarm
      // sound will only play 5 times. All alarms will be shown in the
      // dialog nevertheless.
      let maxAlarmSoundCount = Services.prefs.getIntPref("calendar.alarms.maxsoundsperminute", 5);
      let now = new Date();

      if (!this.mLastAlarmSoundDate || now - this.mLastAlarmSoundDate >= 60000) {
        // Last alarm was long enough ago, reset counters. Note
        // subtracting JSDate results in microseconds.
        this.mAlarmSoundCount = 0;
        this.mLastAlarmSoundDate = now;
      } else {
        // Otherwise increase the counter
        this.mAlarmSoundCount++;
      }

      if (maxAlarmSoundCount > this.mAlarmSoundCount) {
        // Only ring the alarm sound if we haven't hit the max count.
        try {
          let soundURL;
          if (Services.prefs.getIntPref("calendar.alarms.soundType", 0) == 0) {
            soundURL = "chrome://calendar/content/sound.wav";
          } else {
            soundURL = Services.prefs.getStringPref("calendar.alarms.soundURL", null);
          }
          if (soundURL && soundURL.length > 0) {
            soundURL = Services.io.newURI(soundURL);
            this.mSound.play(soundURL);
          } else {
            this.mSound.beep();
          }
        } catch (exc) {
          cal.ERROR("Error playing alarm sound: " + exc);
        }
      }
    }

    if (!Services.prefs.getBoolPref("calendar.alarms.show", true)) {
      return;
    }

    let calAlarmWindow = peekAlarmWindow();
    if (!calAlarmWindow && (!this.mWindowOpening || this.mWindowOpening.closed)) {
      this.mWindowOpening = Services.ww.openWindow(
        null,
        "chrome://calendar/content/calendar-alarm-dialog.xhtml",
        "_blank",
        "chrome,dialog=yes,all,resizable",
        this
      );
    }
    if (!this.mWindowOpening) {
      calAlarmWindow.addWidgetFor(aItem, aAlarm);
    }
  },

  /**
   * @see {calIAlarmServiceObserver}
   * @param {calIItemBase} item - The item to notify about.
   */
  onNotification(item) {
    // Don't notify about canceled events.
    if (item.status == "CANCELLED") {
      return;
    }
    // Don't notify if you declined this event invitation.
    if (
      (item instanceof lazy.CalEvent || item instanceof Ci.calIEvent) &&
      item.calendar instanceof Ci.calISchedulingSupport &&
      item.calendar.isInvitation(item) &&
      item.calendar.getInvitedAttendee(item)?.participationStatus == "DECLINED"
    ) {
      return;
    }

    let alert = Cc["@mozilla.org/alert-notification;1"].createInstance(Ci.nsIAlertNotification);
    let alertsService = Cc["@mozilla.org/alerts-service;1"].getService(Ci.nsIAlertsService);
    alert.init(
      item.id, // name
      "chrome://messenger/skin/icons/new-mail-alert.png",
      item.title,
      item.getProperty("description"),
      true, // clickable
      item.id // cookie
    );
    this._notifyingItems.set(item.id, item);
    alertsService.showAlert(alert, this);
  },

  window_onLoad() {
    let calAlarmWindow = this.mWindowOpening;
    this.mWindowOpening = null;
    if (this.mAlarms.length > 0) {
      for (let [item, alarm] of this.mAlarms) {
        calAlarmWindow.addWidgetFor(item, alarm);
      }
    } else {
      // Uh oh, it seems the alarms were removed even before the window
      // finished loading. Looks like we can close it again
      calAlarmWindow.closeIfEmpty();
    }
  },

  onRemoveAlarmsByItem(aItem) {
    let calAlarmWindow = peekAlarmWindow();
    this.mAlarms = this.mAlarms.filter(([thisItem, alarm]) => {
      let ret = aItem.hashId != thisItem.hashId;
      if (!ret && calAlarmWindow) {
        // window is open
        calAlarmWindow.removeWidgetFor(thisItem, alarm);
      }
      return ret;
    });
  },

  onRemoveAlarmsByCalendar(calendar) {
    let calAlarmWindow = peekAlarmWindow();
    this.mAlarms = this.mAlarms.filter(([thisItem, alarm]) => {
      let ret = calendar.id != thisItem.calendar.id;

      if (!ret && calAlarmWindow) {
        // window is open
        calAlarmWindow.removeWidgetFor(thisItem, alarm);
      }
      return ret;
    });
  },

  onAlarmsLoaded(aCalendar) {
    // the alarm dialog won't close while alarms are loading, check again now
    let calAlarmWindow = peekAlarmWindow();
    if (calAlarmWindow && this.mAlarms.length == 0) {
      calAlarmWindow.closeIfEmpty();
    }
  },
};