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
|
<?php
/**
* Notifications
* This file contains classes and functions which allow plugins to register and send notifications.
*
* There are notification methods which are provided out of the box (see notification_init() ). Each method
* is identified by a string, e.g. "email".
*
* To register an event use register_notification_handler() and pass the method name and a handler function.
*
* To send a notification call notify() passing it the method you wish to use combined with a number of method
* specific addressing parameters.
*
* Catch NotificationException to trap errors.
*
* @package Elgg
* @subpackage API
* @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU Public License version 2
* @author Marcus Povey
* @copyright Curverider Ltd 2008
* @link http://elgg.org/
*/
/** Notification handlers */
$NOTIFICATION_HANDLERS = array();
/**
* This function registers a handler for a given notification type (eg "email")
*
* @param string $method The method
* @param string $handler The handler function, in the format "handler(ElggEntity $from, ElggUser $to, $subject, $message, array $params = NULL)". This function should return false on failure, and true/a tracking message ID on success.
* @param array $params A associated array of other parameters for this handler defining some properties eg. supported message length or rich text support.
*/
function register_notification_handler($method, $handler, $params = NULL)
{
global $NOTIFICATION_HANDLERS;
if (is_callable($handler))
{
$NOTIFICATION_HANDLERS[$method] = new stdClass;
$NOTIFICATION_HANDLERS[$method]->handler = $handler;
if ($params)
{
foreach ($params as $k => $v)
$NOTIFICATION_HANDLERS[$method]->$k = $v;
}
return true;
}
return false;
}
/**
* Notify a user via their preferences.
*
* @param mixed $to Either a guid or an array of guid's to notify.
* @param int $from GUID of the sender, which may be a user, site or object.
* @param string $subject Message subject.
* @param string $message Message body.
* @param array $params Misc additional parameters specific to various methods.
* @param mixed $methods_override A string, or an array of strings specifying the delivery methods to use - or leave blank
* for delivery using the user's chosen delivery methods.
* @return array Compound array of each delivery user/delivery method's success or failure.
* @throws NotificationException
*/
function notify_user($to, $from, $subject, $message, array $params = NULL, $methods_override = "")
{
global $NOTIFICATION_HANDLERS, $CONFIG;
// Sanitise
if (!is_array($to))
$to = array((int)$to);
$from = (int)$from;
$subject = sanitise_string($subject);
// Get notification methods
if (($methods_override) && (!is_array($methods_override)))
$methods_override = array($methods_override);
$result = array();
foreach ($to as $guid)
{
// Results for a user are...
$result[$guid] = array();
// Are we overriding delivery?
$methods = $methods_override;
if (!$methods)
{
$tmp = (array)get_user_notification_settings($guid);
$methods = array();
foreach($tmp as $k => $v)
if ($v) $methods[] = $k; // Add method if method is turned on for user!
}
if ((!$methods) || (count($methods)==0))
throw new NotificationException(elgg_echo('NotificationException:NoNotificationMethod'));
// Deliver
foreach ($methods as $method)
{
// Extract method details from list
$details = $NOTIFICATION_HANDLERS[$method];
$handler = $details->handler;
if ((!$NOTIFICATION_HANDLERS[$method]) || (!$handler))
throw new NotificationException(sprintf(elgg_echo('NotificationException:NoHandlerFound'), $method));
if ($CONFIG->debug)
error_log("Sending message to $guid using $method");
// Trigger handler and retrieve result.
$result[$guid][$method] = $handler(
$from ? get_entity($from) : NULL, // From entity
get_entity($guid), // To entity
$subject, // The subject
$message, // Message
$params // Params
);
}
}
return $result;
}
/**
* Get the notification settings for a given user.
*
* @param int $user_guid The user id
* @return stdClass
*/
function get_user_notification_settings($user_guid = 0)
{
$user_guid = (int)$user_guid;
if ($user_guid == 0)
$user_guid = $_SESSION['user']->guid;
$all_metadata = get_metadata_for_entity($user_guid);
if ($all_metadata)
{
$prefix = "notification:method:";
$return = new stdClass;
foreach ($all_metadata as $meta)
{
$name = substr($meta->name, strlen($prefix));
$value = $meta->value;
if (strpos($meta->name, $prefix) === 0)
$return->$name = $value;
}
return $return;
}
return false;
}
/**
* Set a user notification pref.
*
* @param int $user_guid The user id.
* @param string $method The delivery method (eg. email)
* @param bool $value On(true) or off(false).
* @return bool
*/
function set_user_notification_setting($user_guid, $method, $value)
{
$user_guid = (int)$user_guid;
$method = sanitise_string($method);
if ($user_guid == 0)
$user_guid = $_SESSION['user']->guid;
$user = get_entity($user_guid);
if (($user) && ($user instanceof ElggUser))
{
$prefix = "notification:method:$method";
$user->$prefix = $value;
$user->save();
return true;
}
return false;
}
/**
* Notification exception.
* @author Marcus Povey
*/
class NotificationException extends Exception {}
/**
* Send a notification via email.
*
* @param ElggEntity $from The from user/site/object
* @param ElggUser $to To which user?
* @param string $subject The subject of the message.
* @param string $message The message body
* @param array $params Optional parameters (none taken in this instance)
* @return bool
*/
function email_notify_handler(ElggEntity $from, ElggUser $to, $subject, $message, array $params = NULL)
{
global $CONFIG;
if (!$from)
throw new NotificationException(sprintf(elgg_echo('NotificationException:MissingParameter'), 'from'));
if (!$to)
throw new NotificationException(sprintf(elgg_echo('NotificationException:MissingParameter'), 'to'));
if ($to->email=="")
throw new NotificationException(sprintf(elgg_echo('NotificationException:NoEmailAddress'), $to->guid));
$to = $to->email;
if ($from->email)
$from = $from->email; // Handle users
else if ($from->url)
{
$breakdown = parse_url($from->url);
$from = 'noreply@' . $breakdown['host']; // Handle anything with a url
}
else {
$from = 'noreply@' . get_site_domain($CONFIG->site_guid); // Handle a fallback
}
$headers = "From: $from\r\n";
return mail($to, $subject, $message, $headers);
}
/**
* Correctly initialise notifications and register the email handler.
*
*/
function notification_init()
{
// Register a notification handler for the default email method
register_notification_handler("email", "email_notify_handler");
// Add email settings
extend_elgg_settings_page('notifications/settings/email', 'usersettings/user');
register_action("email/save");
// Add settings view to user settings & register action
extend_elgg_settings_page('notifications/settings/usersettings', 'usersettings/user');
register_action("notifications/settings/usersettings/save");
}
// Register a startup event
register_elgg_event_handler('init','system','notification_init',0);
?>
|
