SubscriptionEngine.inc
17.1 KB
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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
<?php
global $default;
require_once(KT_LIB_DIR . "/users/User.inc");
require_once(KT_LIB_DIR . "/documentmanagement/Document.inc");
require_once(KT_LIB_DIR . "/foldermanagement/Folder.inc");
require_once(KT_LIB_DIR . "/subscriptions/Subscription.inc");
require_once(KT_LIB_DIR . "/alert/AlertContent.inc");
require_once(KT_LIB_DIR . "/alert/delivery/EmailAlert.inc");
require_once(KT_LIB_DIR . "/alert/delivery/SMSAlert.inc");
require_once(KT_LIB_DIR . "/dashboard/Notification.inc.php");
/**
* $Id$
*
* Facilitates firing subscription alerts.
*
* Copyright (c) 2003 Jam Warehouse http://www.jamwarehouse.com
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @version $Revision$
* @author Michael Joseph <michael@jamwarehouse.com>, Jam Warehouse (Pty) Ltd, South Africa
* @package lib.subscriptions
*/
class SubscriptionEngine {
/**
* Fires a subscription alert for this subscription content
*
* @param int the id of the subscription content
* @param int the alert type (document change, new folder, etc.)
* @param int the subscription content type (folder, document)
* @param array any dynamic values that should be sent with the alert (eg. document name, path to modified document)
* @param int the original object id (e.g. if fired on a document, and chained to a folder.
*/
function fireSubscription($iExternalID, $iSubscriptionAlertType, $iSubscriptionType, $aValues, $iOriginalId = null) {
global $default;
$default->log->info("fireSubscription ($iExternalID, $iSubscriptionAlertType, $iSubscriptionType, values)");
// get the list of subscriber addresses that we need to alert
$aSubscribers = SubscriptionEngine::retrieveSubscribers($iExternalID, $iSubscriptionType);
// count the number of subscriptions we've sent
$iSubscriptionsSent = 0;
// if the subscription type is document, fire the folder subscriptions also
if ($iSubscriptionType == SubscriptionConstants::subscriptionType("DocumentSubscription")) {
$iSubscriptionsSent = SubscriptionEngine::fireSubscription($aValues["folderID"],
($iSubscriptionAlertType == SubscriptionConstants::subscriptionAlertType("RemoveSubscribedDocument") ?
SubscriptionConstants::subscriptionAlertType("RemoveChildDocument") :
$iSubscriptionAlertType),
SubscriptionConstants::subscriptionType("FolderSubscription"),
$aValues,
$iExternalId);
$default->log->info("SubscriptionEngine::fireSubscription fired folder subscribers, count=$iSubscriptionsSent");
}
// for each subscriber, construct an address based on their notification preferences
for ($i=0; $i<count($aSubscribers); $i++) {
// lookup the subscription
if ($iSubscriptionType == SubscriptionConstants::subscriptionType("FolderSubscription")) {
$oSubscription = & Subscription::getByIDs($aSubscribers[$i]->getID(), $aValues['folderID'], $iSubscriptionType);
if (empty($oSubscription) || PEAR::isError($oSubscription)) {
$oSubscription =& new Subscription($aSubscribers[$i]->getID(), $aValues["folderID"], $iSubscriptionType);
$res = $oSubscription->create();
if (empty($res) || PEAR::isError($res)) {
continue;
}
}
} else {
$oSubscription = & Subscription::getByIDs($aSubscribers[$i]->getID(), $iExternalID, $iSubscriptionType);
}
// update the alerted status
$oSubscription->setIsAlerted(true);
// write it back to the db
if ($oSubscription->update()) {
// get the subscription id
$aValues["subscriptionID"] = $oSubscription->getID();
// and type
$aValues["subscriptionType"] = $iSubscriptionType;
// and subscriber name
$aValues["subscriberName"] = $aSubscribers[$i]->getName();
// retrieve the appropriate content
// using the values array to customise the notification message
$sAlertContent = AlertContent::getSubscriptionAlert($iSubscriptionAlertType, $aValues);
// construct alerts
// dashboard notification.
$aNotificationOptions = array();
$aNotificationOptions['target_user'] = $aSubscribers[$i]->getID();
$aNotificationOptions['actor_id'] = KTUtil::arrayGet($_SESSION,"userID", null); // _won't_ be null.
// location name: ditto.
// target_name: ditto.
//$default->log->debug('subscriptionengine: received ' . print_r($aValues, true));
// sweet lord this is _hideous_. Please, oh please kill the subscriptionsconstants
if (SubscriptionConstants::subscriptionAlertTypeString($iSubscriptionAlertType) == "AddFolder") {
$aNotificationOptions['target_name'] = $aValues["newFolderName"];
$aNotificationOptions['location_name'] = $aValues["parentFolderName"];
$aNotificationOptions['object_id'] = $iExternalId; // parent folder_id, in this case.
$aNotificationOptions['event_type'] = "AddFolder";
} else if (SubscriptionConstants::subscriptionAlertTypeString($iSubscriptionAlertType) == "RemoveSubscribedFolder") {
$aNotificationOptions['target_name'] = $aValues["removedFolderName"];
$aNotificationOptions['location_name'] = $aValues["parentFolderName"];
$aNotificationOptions['object_id'] = $iExternalId; // parent folder_id, in this case.
$aNotificationOptions['event_type'] = "RemoveSubscribedFolder";
} else if (SubscriptionConstants::subscriptionAlertTypeString($iSubscriptionAlertType) == "RemoveChildFolder") {
$aNotificationOptions['target_name'] = $aValues["removedFolderName"];
$aNotificationOptions['location_name'] = $aValues["parentFolderName"];
$aNotificationOptions['object_id'] = $iExternalId; // parent folder_id, in this case, where user is subscribed.
$aNotificationOptions['event_type'] = "RemoveChildFolder";
} else if (SubscriptionConstants::subscriptionAlertTypeString($iSubscriptionAlertType) == "AddDocument") {
$aNotificationOptions['target_name'] = $aValues["newDocumentName"];
$aNotificationOptions['location_name'] = $aValues["parentFolderName"];
if ($iOriginalId !== null) {
$aNotificationOptions['object_id'] = $iOriginalId; // folder subscription, this _was_ the document.
} else {
$aNotificationOptions['object_id'] = $iExternalId; // this path _shouldn't_ be hit since its a new document - user _can't_ be subscribed to it already.
}
$aNotificationOptions['event_type'] = "AddDocument";
} else if (SubscriptionConstants::subscriptionAlertTypeString($iSubscriptionAlertType) == "RemoveChildDocument") {
$aNotificationOptions['target_name'] = $aValues["removedDocumentName"];
$aNotificationOptions['location_name'] = $aValues["folderName"];
$aNotificationOptions['object_id'] = $iExternalId; // parent folder_id, in this case, where user is subscribed... is it?
$aNotificationOptions['event_type'] = "RemoveChildDocument";
} else if (SubscriptionConstants::subscriptionAlertTypeString($iSubscriptionAlertType) == "RemoveSubscribedDocument") {
$aNotificationOptions['target_name'] = $aValues["removedDocumentName"];
$aNotificationOptions['location_name'] = $aValues["folderName"];
$aNotificationOptions['object_id'] = $iExternalId; // not used.
$aNotificationOptions['event_type'] = "RemoveSubscribedDocument";
} else if (SubscriptionConstants::subscriptionAlertTypeString($iSubscriptionAlertType) == "ModifyDocument") {
$aNotificationOptions['target_name'] = $aValues["modifiedDocumentName"];
$aNotificationOptions['location_name'] = null; // not used... why? don't we have the folder name? why not?
if ($iOriginalId !== null) {
$aNotificationOptions['object_id'] = $iOriginalId; // folder subscription, this _was_ the document.
} else {
$aNotificationOptions['object_id'] = $iExternalId; // this path _shouldn't_ be hit since its a new document - user _can't_ be subscribed to it already.
}
$aNotificationOptions['event_type'] = "ModifyDocument";
} else if (SubscriptionConstants::subscriptionAlertTypeString($iSubscriptionAlertType) == "CheckInDocument") {
$aNotificationOptions['target_name'] = $aValues["modifiedDocumentName"];
$aNotificationOptions['location_name'] = null; // not used... why? don't we have the folder name? why not?
if ($iOriginalId !== null) {
$aNotificationOptions['object_id'] = $iOriginalId; // folder subscription, this _was_ the document.
} else {
$aNotificationOptions['object_id'] = $iExternalId; // this path _shouldn't_ be hit since its a new document - user _can't_ be subscribed to it already.
}$aNotificationOptions['event_type'] = "CheckInDocument";
} else if (SubscriptionConstants::subscriptionAlertTypeString($iSubscriptionAlertType) == "CheckOutDocument") {
$aNotificationOptions['target_name'] = $aValues["modifiedDocumentName"];
$aNotificationOptions['location_name'] = null; // not used... why? don't we have the folder name? why not?
if ($iOriginalId !== null) {
$aNotificationOptions['object_id'] = $iOriginalId; // folder subscription, this _was_ the document.
} else {
$aNotificationOptions['object_id'] = $iExternalId; // this path _shouldn't_ be hit since its a new document - user _can't_ be subscribed to it already.
}$aNotificationOptions['event_type'] = "CheckOutDocument";
} else if (SubscriptionConstants::subscriptionAlertTypeString($iSubscriptionAlertType) == "MovedDocument") {
$aNotificationOptions['target_name'] = $aValues["modifiedDocumentName"];
$aNotificationOptions['location_name'] = $aValues["oldFolderName"];
if ($iOriginalId !== null) {
$aNotificationOptions['object_id'] = $iOriginalId; // folder subscription, this _was_ the document.
} else {
$aNotificationOptions['object_id'] = $iExternalId;
}$aNotificationOptions['event_type'] = "MovedDocument";
} else if (SubscriptionConstants::subscriptionAlertTypeString($iSubscriptionAlertType) == "ArchivedDocument") {
$aNotificationOptions['target_name'] = $aValues["modifiedDocumentName"];
$aNotificationOptions['location_name'] = $aValues["folderName"];
if ($iOriginalId !== null) {
$aNotificationOptions['object_id'] = $iOriginalId; // folder subscription, this _was_ the document.
} else {
$aNotificationOptions['object_id'] = $iExternalId;
}
$aNotificationOptions['event_type'] = "ArchivedDocument";
} else if (SubscriptionConstants::subscriptionAlertTypeString($iSubscriptionAlertType) == "RestoredArchivedDocument") {
$aNotificationOptions['target_name'] = $aValues["modifiedDocumentName"];
$aNotificationOptions['location_name'] = null; // $aValues["folderName"]; // not reachable.
if ($iOriginalId !== null) {
$aNotificationOptions['object_id'] = $iOriginalId; // folder subscription, this _was_ the document.
} else {
$aNotificationOptions['object_id'] = $iExternalId;
}
$aNotificationOptions['event_type'] = "RestoredArchivedDocument";
}
$oNotification =& KTSubscriptionNotification::generateSubscriptionNotification($aNotificationOptions);
// email alert.
if ($aSubscribers[$i]->getEmailNotification() && (strlen($aSubscribers[$i]->getEmail()) > 0)) {
$oEmail = new EmailAlert($aSubscribers[$i]->getEmail(), $sAlertContent["subject"], $sAlertContent["text"]);
if ($oEmail->send()) {
$iSubscriptionsSent++;
$default->log->debug("SubscriptionEngine::fireSubscription successfully sent email alert to " . $aSubscribers[$i]->getEmail() . " for subscriptionID=" . $aSubscribers[$i]->getID());
} else {
$default->log->error("SubscriptionEngine::fireSubscription failed sending email alert to " . $aSubscribers[$i]->getEmail() . " for subscriptionID=" . $aSubscribers[$i]->getID() . "; text=$sAlertContent");
}
}
// if sms notification is enabled, sms them
if ($aSubscribers[$i]->getSmsNotification() && strlen($aSubscribers[$i]->getMobile()) > 0) {
$oSms = new SMSAlert($aSubscribers[$i]->getMobile(), $sAlertContent["text"]);
if ($oSms->send()) {
$iSubscriptionsSent++;
$default->log->debug("SubscriptionEngine::fireSubscription successfully sent sms for folderID=$iFolderID, subscriber=" . $aSubscribers[$i]->getID() . "; text=$sNotificationText");
} else {
$default->log->error("SubscriptionEngine::fireSubscription failed sending sms for folderID=$iFolderID, subscriber=" . $aSubscribers[$i]->getID() . "; text=$sNotificationText");
}
}
} else {
$default->log->error("SubscriptionEngine::fireSubscription could not update subscription- db error?");
}
}
if ($iSubscriptionType == SubscriptionConstants::subscriptionType("FolderSubscription")) {
$oFolder =& Folder::get($iExternalID);
if ($oFolder && !PEAR::isError($oFolder)) {
$iThisSubscriptionsSent = SubscriptionEngine::fireSubscription($oFolder->getParentId(),
($iSubscriptionAlertType == SubscriptionConstants::subscriptionAlertType("RemoveSubscribedDocument") ?
SubscriptionConstants::subscriptionAlertType("RemoveChildDocument") :
$iSubscriptionAlertType),
SubscriptionConstants::subscriptionType("FolderSubscription"),
$aValues);
$default->log->info("SubscriptionEngine::fireSubscription fired folder subscribers, count=$iThisSubscriptionsSent");
$iSubscriptionsSent += $iThisSubscriptionsSent;
}
}
// return the number of processed subscriptions
return $iSubscriptionsSent;
}
/**
* Retrieves the users that are subscribed to this subscription content
*
* @param integer the ID of the subscription content to retrieve subscribers for
* @param int the subscription content type (folder, document)
* @return array of users objects representing the subscribers, false on error
*/
function retrieveSubscribers($iExternalID, $iSubscriptionType) {
global $default;
global $aAlreadySent;
if (!isset($aAlreadySent)) {
$aAlreadySent = array();
}
$sql = $default->db;
$aUsers = array();
$default->log->debug("retrieveSubscribers(id=$iExternalID, type=$iSubscriptionType); table=" .Subscription::getTableName($iSubscriptionType). "; id=" .Subscription::getIdFieldName($iSubscriptionType));
$sQuery = "SELECT user_id FROM " . Subscription::getTableName($iSubscriptionType) . " WHERE " . Subscription::getIdFieldName($iSubscriptionType) . " = ?";/*ok*/
$aParams = array($iExternalID);
if ($sql->query(array($sQuery, $aParams))) {
while ($sql->next_record()) {
$iUserID = $sql->f("user_id");
if (in_array($iUserID, $aAlreadySent)) {
continue;
}
$aAlreadySent[] = $iUserID;
$oUser = & User::get($iUserID );
if ($oUser) {
$aUsers[] = $oUser;
} else {
$default->log->error("SubscriptionEngine::fireSubscription subscriber id=$iUserID doesn't exist");
// remove this users subscription
if ($sql->query("DELETE FROM " . Subscription::getTableName($iSubscriptionType) . " " .
"WHERE user_id = $iUserID")) {
$default->log->info("SubscriptionEngine::fireSubscription successfully removed subscription for removed user id=$iUserID");
} else {
$default->log->error("SubscriptionEngine::fireSubscription error removing subscription for user id=$iUserID");
}
}
}
} else {
$_SESSION["errorMessage"] = $lang_err_database;
return false;
}
$default->log->debug('retrieveSubscribers found count=' . count($aUsers));
return $aUsers;
}
}