lib/MailNotify.php

   1 <?php
   2 // rcs_id('$Id$');
   3 /* Copyright (C) 2006-2007,2009 Reini Urban
   4  * Copyright (C) 2009 Marc-Etienne Vargenau, Alcatel-Lucent
   5  *
   6  * This file is part of PhpWiki.
   7  *
   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.
  12  *
  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.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with PhpWiki; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 /**
  24  * Handle the pagelist pref[notifyPages] logic for users
  25  * and notify => hash ( page => (userid => userhash) ) for pages.
  26  * Generate notification emails.
  27  *
  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
  35  *
  36  * Helper functions:
  37  *   getPageChangeEmails
  38  *   MailAdmin
  39  *   ? handle emailed confirmation links (EmailSignup, ModeratedPage)
  40  *
  41  * @package MailNotify
  42  * @author  Reini Urban
  43  */
  44
  45 if (!defined("MAILER_LOG"))
  46     if (isWindows())
  47         define("MAILER_LOG", 'c:/wikimail.log');
  48     else
  49         define("MAILER_LOG", '/var/log/wikimail.log');
  50
  51 class MailNotify {
  52
  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();
  60     }
  61
  62     function fromId() {
  63         global $request;
  64         if (GFORGE) {
  65             return $request->_user->getId();
  66         } else {
  67             return $request->_user->getId() . '@' .  $request->get('REMOTE_HOST');
  68         }
  69     }
  70
  71     function userEmail($userid, $doverify = true) {
  72         global $request;
  73
  74         // Disable verification of emails for corporate env.
  75         if (GFORGE) {
  76             $doverify = false;
  77         }
  78
  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'))
  85                 $email = '';
  86         } else {  // not current user
  87             if (ENABLE_USER_NEW) {
  88                 $u = WikiUser($userid);
  89                 $u->getPreferences();
  90                 $prefs = &$u->_prefs;
  91             } else {
  92                 $u = new WikiUser($request, $userid);
  93                 $prefs = $u->getPreferences();
  94             }
  95             $email = $prefs->get('email');
  96             if ($doverify and !$prefs->get('emailVerified')) {
  97                 $email = '';
  98             }
  99         }
 100         return $email;
 101     }
 102
 103     /**
 104      * getPageChangeEmails($notify)
 105      * @param  $notify: hash ( page => (userid => userhash) )
 106      * @return array
 107      *         unique array of ($emails, $userids)
 108      */
 109     function getPageChangeEmails($notify) {
 110         global $request;
 111         $emails = array(); $userids = array();
 112         foreach ($notify as $page => $users) {
 113             if (glob_match($page, $this->pagename)) {
 114
 115                 global $request;
 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');
 122
 123                 foreach ($users as $userid => $user) {
 124
 125                     $usermail = $user['email'];
 126
 127                     if (($usermail == $curuserprefsemail)
 128                         and ($ownModifications)) {
 129                         // It's my own modification
 130                         // and I do not want to receive it
 131                         continue;
 132                     }
 133
 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
 141                             continue;
 142                         }
 143                     }
 144
 145                     if (!$user) { // handle the case for ModeratePage:
 146                                   // no prefs, just userid's.
 147                         $emails[] = $this->userEmail($userid, false);
 148                         $userids[] = $userid;
 149                     } else {
 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);
 156                             if ($email) {
 157                                 $notify[$page][$userid]['verified'] = 1;
 158                                 $request->_dbi->set('notify', $notify);
 159                                 $emails[] = $email;
 160                                 $userids[] = $userid;
 161                             }
 162                         }
 163                         // ignore verification
 164                         /*
 165                         if (DEBUG) {
 166                             if (!in_array($user['email'], $emails))
 167                                 $emails[] = $user['email'];
 168                         }
 169                         */
 170                     }
 171                 }
 172             }
 173         }
 174         $this->emails = array_unique($emails);
 175         $this->userids = array_unique($userids);
 176         return array($this->emails, $this->userids);
 177     }
 178
 179     function sendMail($subject,
 180                       $content,
 181                       $notice = false,
 182                       $silent = true)
 183     {
 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;
 189         $from = $this->from;
 190         // Do not send if modification is from Gforge admin
 191         if (GFORGE and $from == ADMIN_USER) {
 192             return;
 193         }
 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";
 200
 201         $ok = mail(($to = array_shift($emails)),
 202                    $encoded_subject,
 203                    $subject."\n".$content,
 204                    $headers
 205                    );
 206         if (MAILER_LOG and is_writable(MAILER_LOG)) {
 207             $f = fopen(MAILER_LOG, "a");
 208             fwrite($f, "\n\nX-MailSentOK: " . $ok ? 'OK' : 'FAILED');
 209             if (!$ok) {
 210                 global $ErrorManager;
 211                 // get last error message
 212                 $last_err =
 213                     $ErrorManager->_postponed_errors[count($ErrorHandler->_postponed_errors)-1];
 214                 fwrite($f, "\nX-MailFailure: " . $last_err);
 215             }
 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);
 222             fclose($f);
 223         }
 224         if ($ok) {
 225             if (!$silent)
 226                 trigger_error(sprintf($notice, $this->pagename)
 227                               . " "
 228                               . sprintf(_("sent to %s"), join(',',$this->userids)),
 229                               E_USER_NOTICE);
 230             return true;
 231         } else {
 232             trigger_error(sprintf($notice, $this->pagename)
 233                           . " "
 234                           . sprintf(_("Error: Couldn't send %s to %s"),
 235                                    $subject."\n".$content, join(',',$this->userids)),
 236                           E_USER_WARNING);
 237             return false;
 238         }
 239     }
 240
 241     /**
 242      * Send udiff for a changed page to multiple users.
 243      * See rename and remove methods also
 244      */
 245     function sendPageChangeNotification(&$wikitext, $version, &$meta) {
 246
 247         global $request;
 248
 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);
 253             return;
 254         }
 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();
 259         if ($previous) {
 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']);
 267
 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);
 278
 279         } else {
 280             $difflink = WikiURL($this->pagename,array(),true);
 281             $content = $this->pagename . " " . $version . " " .
 282                 Iso8601DateTime($meta['mtime']) . "\n";
 283             $content .= _("New page");
 284             $content .= "\n\n";
 285             $content .= $wikitext;
 286         }
 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);
 291     }
 292
 293     /**
 294      * Support mass rename / remove (not yet tested)
 295      */
 296     function sendPageRenameNotification ($to, &$meta) {
 297         global $request;
 298
 299         if (@is_array($request->_deferredPageRenameNotification)) {
 300             $request->_deferredPageRenameNotification[] =
 301                 array($this->pagename, $to, $meta, $this->emails, $this->userids);
 302         } else {
 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");
 309         }
 310     }
 311
 312     /**
 313      * The handlers:
 314      */
 315     function onChangePage (&$wikidb, &$wikitext, $version, &$meta) {
 316         $result = true;
 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);
 327                 }
 328             }
 329         }
 330         return $result;
 331     }
 332
 333     function onDeletePage (&$wikidb, $pagename) {
 334         $result = true;
 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");
 344                 }
 345             }
 346         }
 347         return $result;
 348     }
 349
 350     function onRenamePage (&$wikidb, $oldpage, $new_pagename) {
 351         $result = true;
 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);
 362                 }
 363             }
 364         }
 365     }
 366
 367     /**
 368      * Send mail to user and store the cookie in the db
 369      * wikiurl?action=ConfirmEmail&id=bla
 370      */
 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);
 377         }
 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.
 383
 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:
 386
 387 %s
 388
 389 If this is *not* you, don't follow the link. This confirmation code
 390 will expire at %s.",
 391                        $ip, $userid, WIKI_NAME, WIKI_NAME,
 392                        WikiURL(HOME_PAGE, array('action' => 'ConfirmEmail',
 393                                                 'id' => $id),
 394                                true),
 395                        CTime($expire_date));
 396         $this->sendMail($subject, $content, "", true);
 397         $data[$id] = array('email' => $email,
 398                            'userid' => $userid,
 399                            'expire' => $expire_date);
 400         $wikidb->set('ConfirmEmail', $data);
 401         return '';
 402     }
 403
 404     function checkEmailConfirmation () {
 405         global $request;
 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"));
 412         }
 413         // upgrade the user
 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;
 426             } else {
 427                 $u = new WikiUser($request, $userid);
 428                 $prefs = $u->getPreferences();
 429             }
 430             $u->_level = WIKIAUTH_USER;
 431             $request->setUser($u);
 432             $request->_prefs->set('emailVerified', true);
 433         }
 434         unset($data[$id]);
 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."));
 438     }
 439
 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");
 444
 445         // If all characters are ASCII, do nothing
 446         if (isAsciiString($subject)) {
 447             return $subject;
 448         }
 449
 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)."?=";
 453         }
 454
 455         // If not, encode in base64 (less human-readable)
 456         return "=?UTF-8?B?".base64_encode($subject)."?=";
 457     }
 458 }
 459
 460 // Local Variables:
 461 // mode: php
 462 // tab-width: 8
 463 // c-basic-offset: 4
 464 // c-hanging-comment-ender-p: nil
 465 // indent-tabs-mode: nil
 466 // End:
 467 ?>