2 // $Id: MailNotify.php 7964 2011-03-05 17:05:30Z vargenau $
3 /* Copyright (C) 2006-2007,2009 Reini Urban
4 * Copyright (C) 2009 Marc-Etienne Vargenau, Alcatel-Lucent
6 * This file is part of PhpWiki.
8 * PhpWiki is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * PhpWiki is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 * Handle the pagelist pref[notifyPages] logic for users
25 * and notify => hash ( page => (userid => userhash) ) for pages.
26 * Generate notification emails.
28 * We add WikiDB handlers and register ourself there:
29 * onChangePage, onDeletePage, onRenamePage
30 * Administrative actions:
31 * [Watch] WatchPage - add a page, or delete watch handlers into the users
32 * pref[notifyPages] slot.
33 * My WatchList - view or edit list/regex of pref[notifyPages].
34 * EMailConfirm methods: send and verify
39 * ? handle emailed confirmation links (EmailSignup, ModeratedPage)
45 if (!defined("MAILER_LOG"))
47 define("MAILER_LOG", 'c:/wikimail.log');
49 define("MAILER_LOG", '/var/log/wikimail.log');
53 function MailNotify($pagename) {
54 $this->pagename = $pagename; /* which page */
55 $this->emails = array(); /* to which addresses */
56 $this->userids = array(); /* corresponding array of displayed names,
57 don't display the email addresses */
58 /* From: from whom the mail appears to be */
59 $this->from = $this->fromId();
65 return $request->_user->getId();
67 return $request->_user->getId() . '@' . $request->get('REMOTE_HOST');
71 function userEmail($userid, $doverify = true) {
74 // Disable verification of emails for corporate env.
79 $u = $request->getUser();
80 if ($u->UserName() == $userid) { // lucky: current user
81 $prefs = $u->getPreferences();
82 $email = $prefs->get('email');
83 // do a dynamic emailVerified check update
84 if ($doverify and !$request->_prefs->get('emailVerified'))
86 } else { // not current user
87 if (ENABLE_USER_NEW) {
88 $u = WikiUser($userid);
92 $u = new WikiUser($request, $userid);
93 $prefs = $u->getPreferences();
95 $email = $prefs->get('email');
96 if ($doverify and !$prefs->get('emailVerified')) {
104 * getPageChangeEmails($notify)
105 * @param $notify: hash ( page => (userid => userhash) )
107 * unique array of ($emails, $userids)
109 function getPageChangeEmails($notify) {
111 $emails = array(); $userids = array();
112 foreach ($notify as $page => $users) {
113 if (glob_match($page, $this->pagename)) {
116 $curuser = $request->getUser();
117 $curusername = $curuser->UserName();
118 $curuserprefs = $curuser->getPreferences();
119 $curuserprefsemail = $curuserprefs->get('email');
120 $ownModifications = $curuserprefs->get('ownModifications');
121 $majorModificationsOnly = $curuserprefs->get('majorModificationsOnly');
123 foreach ($users as $userid => $user) {
125 $usermail = $user['email'];
127 if (($usermail == $curuserprefsemail)
128 and ($ownModifications)) {
129 // It's my own modification
130 // and I do not want to receive it
134 if ($majorModificationsOnly) {
135 $backend = &$request->_dbi->_backend;
136 $version = $backend->get_latest_version($this->pagename);
137 $versiondata = $backend->get_versiondata($this->pagename, $version, true);
138 if ($versiondata['is_minor_edit']) {
139 // It's a minor modification
140 // and I do not want to receive it
145 if (!$user) { // handle the case for ModeratePage:
146 // no prefs, just userid's.
147 $emails[] = $this->userEmail($userid, false);
148 $userids[] = $userid;
150 if (!empty($user['verified']) and !empty($user['email'])) {
151 $emails[] = $user['email'];
152 $userids[] = $userid;
153 } elseif (!empty($user['email'])) {
154 // do a dynamic emailVerified check update
155 $email = $this->userEmail($userid, true);
157 $notify[$page][$userid]['verified'] = 1;
158 $request->_dbi->set('notify', $notify);
160 $userids[] = $userid;
163 // ignore verification
166 if (!in_array($user['email'], $emails))
167 $emails[] = $user['email'];
174 $this->emails = array_unique($emails);
175 $this->userids = array_unique($userids);
176 return array($this->emails, $this->userids);
179 function sendMail($subject,
184 // Add WIKI_NAME to Subject
185 $subject = "[".WIKI_NAME."] ".$subject;
186 // Encode $subject if needed
187 $encoded_subject = $this->subject_encode($subject);
188 $emails = $this->emails;
190 // Do not send if modification is from FusionForge admin
191 if (FUSIONFORGE and $from == ADMIN_USER) {
194 if (!$notice) $notice = _("PageChange Notification of %s");
195 $headers = "From: $from\r\n" .
196 "Bcc: ".join(',', $emails)."\r\n" .
197 "MIME-Version: 1.0\r\n" .
198 "Content-Type: text/plain; charset=".CHARSET."; format=flowed\r\n" .
199 "Content-Transfer-Encoding: 8bit";
201 $ok = mail(($to = array_shift($emails)),
203 $subject."\n".$content,
206 if (MAILER_LOG and is_writable(MAILER_LOG)) {
207 $f = fopen(MAILER_LOG, "a");
208 fwrite($f, "\n\nX-MailSentOK: " . $ok ? 'OK' : 'FAILED');
210 global $ErrorManager;
211 // get last error message
213 $ErrorManager->_postponed_errors[count($ErrorHandler->_postponed_errors)-1];
214 fwrite($f, "\nX-MailFailure: " . $last_err);
216 fwrite($f, "\nDate: " . CTime());
217 fwrite($f, "\nSubject: $encoded_subject");
218 fwrite($f, "\nFrom: $from");
219 fwrite($f, "\nTo: $to");
220 fwrite($f, "\nBcc: ".join(',', $emails));
221 fwrite($f, "\n\n". $content);
226 trigger_error(sprintf($notice, $this->pagename)
228 . sprintf(_("sent to %s"), join(',',$this->userids)),
232 trigger_error(sprintf($notice, $this->pagename)
234 . sprintf(_("Error: Couldn't send %s to %s"),
235 $subject."\n".$content, join(',',$this->userids)),
242 * Send udiff for a changed page to multiple users.
243 * See rename and remove methods also
245 function sendPageChangeNotification(&$wikitext, $version, &$meta) {
249 if (@is_array($request->_deferredPageChangeNotification)) {
250 // collapse multiple changes (loaddir) into one email
251 $request->_deferredPageChangeNotification[] =
252 array($this->pagename, $this->emails, $this->userids);
255 $backend = &$request->_dbi->_backend;
256 $subject = _("Page change").' '.($this->pagename);
257 $previous = $backend->get_previous_version($this->pagename, $version);
258 if (!isset($meta['mtime'])) $meta['mtime'] = time();
260 $difflink = WikiURL($this->pagename, array('action'=>'diff'), true);
261 $cache = &$request->_dbi->_cache;
262 $this_content = explode("\n", $wikitext);
263 $prevdata = $cache->get_versiondata($this->pagename, $previous, true);
264 if (empty($prevdata['%content']))
265 $prevdata = $backend->get_versiondata($this->pagename, $previous, true);
266 $other_content = explode("\n", $prevdata['%content']);
268 include_once("lib/difflib.php");
269 $diff2 = new Diff($other_content, $this_content);
270 //$context_lines = max(4, count($other_content) + 1,
271 // count($this_content) + 1);
272 $fmt = new UnifiedDiffFormatter(/*$context_lines*/);
273 $content = $this->pagename . " " . $previous . " " .
274 Iso8601DateTime($prevdata['mtime']) . "\n";
275 $content .= $this->pagename . " " . $version . " " .
276 Iso8601DateTime($meta['mtime']) . "\n";
277 $content .= $fmt->format($diff2);
280 $difflink = WikiURL($this->pagename,array(),true);
281 $content = $this->pagename . " " . $version . " " .
282 Iso8601DateTime($meta['mtime']) . "\n";
283 $content .= _("New page");
285 $content .= $wikitext;
287 $editedby = sprintf(_("Edited by: %s"), $this->from);
288 $summary = sprintf(_("Summary: %s"), $meta['summary']);
289 $this->sendMail($subject,
290 $editedby."\n".$summary."\n".$difflink."\n\n".$content);
294 * Support mass rename / remove (not yet tested)
296 function sendPageRenameNotification ($to, &$meta) {
299 if (@is_array($request->_deferredPageRenameNotification)) {
300 $request->_deferredPageRenameNotification[] =
301 array($this->pagename, $to, $meta, $this->emails, $this->userids);
303 $pagename = $this->pagename;
304 $editedby = sprintf(_("Edited by: %s"), $this->from);
305 $subject = sprintf(_("Page rename %s to %s"), $pagename, $to);
306 $link = WikiURL($to, true);
307 $this->sendMail($subject,
308 $editedby."\n".$link."\n\n"."Renamed $pagename to $to");
315 function onChangePage (&$wikidb, &$wikitext, $version, &$meta) {
317 if (!isa($GLOBALS['request'],'MockRequest')) {
318 $notify = $wikidb->get('notify');
319 /* Generate notification emails? */
320 if (!empty($notify) and is_array($notify)) {
321 if (empty($this->pagename))
322 $this->pagename = $meta['pagename'];
323 // TODO: Should be used for ModeratePage and RSS2 Cloud xml-rpc also.
324 $this->getPageChangeEmails($notify);
325 if (!empty($this->emails)) {
326 $result = $this->sendPageChangeNotification($wikitext, $version, $meta);
333 function onDeletePage (&$wikidb, $pagename) {
335 /* Generate notification emails? */
336 if (! $wikidb->isWikiPage($pagename) and !isa($GLOBALS['request'],'MockRequest')) {
337 $notify = $wikidb->get('notify');
338 if (!empty($notify) and is_array($notify)) {
339 //TODO: deferr it (quite a massive load if you remove some pages).
340 $this->getPageChangeEmails($notify);
341 if (!empty($this->emails)) {
342 $subject = sprintf(_("User %s removed page %s"), $this->from, $pagename);
343 $result = $this->sendMail($subject, $subject."\n\n");
350 function onRenamePage (&$wikidb, $oldpage, $new_pagename) {
352 if (!isa($GLOBALS['request'], 'MockRequest')) {
353 $notify = $wikidb->get('notify');
354 if (!empty($notify) and is_array($notify)) {
355 $this->getPageChangeEmails($notify);
356 if (!empty($this->emails)) {
357 $newpage = $wikidb->getPage($new_pagename);
358 $current = $newpage->getCurrentRevision();
359 $meta = $current->_data;
360 $this->pagename = $oldpage;
361 $result = $this->sendPageRenameNotification($new_pagename, $meta);
368 * Send mail to user and store the cookie in the db
369 * wikiurl?action=ConfirmEmail&id=bla
371 function sendEmailConfirmation ($email, $userid) {
372 $id = rand_ascii_readable(16);
373 $wikidb = $GLOBALS['request']->getDbh();
374 $data = $wikidb->get('ConfirmEmail');
375 while(!empty($data[$id])) { // id collision
376 $id = rand_ascii_readable(16);
378 $subject = _("E-Mail address confirmation");
379 $ip = $request->get('REMOTE_HOST');
380 $expire_date = time() + 7*86400;
381 $content = fmt("Someone, probably you from IP address %s, has registered an
382 account \"%s\" with this e-mail address on %s.
384 To confirm that this account really does belong to you and activate
385 e-mail features on %s, open this link in your browser:
389 If this is *not* you, don't follow the link. This confirmation code
391 $ip, $userid, WIKI_NAME, WIKI_NAME,
392 WikiURL(HOME_PAGE, array('action' => 'ConfirmEmail',
395 CTime($expire_date));
396 $this->sendMail($subject, $content, "", true);
397 $data[$id] = array('email' => $email,
399 'expire' => $expire_date);
400 $wikidb->set('ConfirmEmail', $data);
404 function checkEmailConfirmation () {
406 $wikidb = $request->getDbh();
407 $data = $wikidb->get('ConfirmEmail');
408 $id = $request->getArg('id');
409 if (empty($data[$id])) { // id not found
410 return HTML(HTML::h1("Confirm E-mail address"),
411 HTML::h1("Sorry! Wrong URL"));
414 $userid = $data['userid'];
415 $email = $data['email'];
416 $u = $request->getUser();
417 if ($u->UserName() == $userid) { // lucky: current user (session)
418 $prefs = $u->getPreferences();
419 $request->_user->_level = WIKIAUTH_USER;
420 $request->_prefs->set('emailVerified', true);
421 } else { // not current user
422 if (ENABLE_USER_NEW) {
423 $u = WikiUser($userid);
424 $u->getPreferences();
425 $prefs = &$u->_prefs;
427 $u = new WikiUser($request, $userid);
428 $prefs = $u->getPreferences();
430 $u->_level = WIKIAUTH_USER;
431 $request->setUser($u);
432 $request->_prefs->set('emailVerified', true);
435 $wikidb->set('ConfirmEmail', $data);
436 return HTML(HTML::h1("Confirm E-mail address"),
437 HTML::p("Your e-mail address has now been confirmed."));
440 function subject_encode ($subject) {
441 // We need to encode the subject if it contains non-ASCII characters
442 // The page name may contain non-ASCII characters, as well as
443 // the translation of the messages, e.g. _("PageChange Notification of %s");
445 // If all characters are ASCII, do nothing
446 if (isAsciiString($subject)) {
450 // Let us try quoted printable first
451 if (function_exists('quoted_printable_encode')) { // PHP 5.3
452 return "=?UTF-8?Q?".quoted_printable_encode($subject)."?=";
455 // If not, encode in base64 (less human-readable)
456 return "=?UTF-8?B?".base64_encode($subject)."?=";
464 // c-hanging-comment-ender-p: nil
465 // indent-tabs-mode: nil