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 (defined('GFORGE') and 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 (defined('GFORGE') and 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 (defined('GFORGE') and GFORGE) {
 192             if ($from == ADMIN_USER) {
 193                 return;
 194             }
 195         }
 196         if (!$notice) $notice = _("PageChange Notification of %s");
 197         $headers = "From: $from\r\n" .
 198                    "Bcc: ".join(',', $emails)."\r\n" .
 199                    "MIME-Version: 1.0\r\n" .
 200                    "Content-Type: text/plain; charset=".CHARSET."; format=flowed\r\n" .
 201                    "Content-Transfer-Encoding: 8bit";
 202
 203         $ok = mail(($to = array_shift($emails)),
 204                    $encoded_subject,
 205                    $subject."\n".$content,
 206                    $headers
 207                    );
 208         if (MAILER_LOG and is_writable(MAILER_LOG)) {
 209             $f = fopen(MAILER_LOG, "a");
 210             fwrite($f, "\n\nX-MailSentOK: " . $ok ? 'OK' : 'FAILED');
 211             if (!$ok) {
 212                 global $ErrorManager;
 213                 // get last error message
 214                 $last_err =
 215                     $ErrorManager->_postponed_errors[count($ErrorHandler->_postponed_errors)-1];
 216                 fwrite($f, "\nX-MailFailure: " . $last_err);
 217             }
 218             fwrite($f, "\nDate: " . CTime());
 219             fwrite($f, "\nSubject: $encoded_subject");
 220             fwrite($f, "\nFrom: $from");
 221             fwrite($f, "\nTo: $to");
 222             fwrite($f, "\nBcc: ".join(',', $emails));
 223             fwrite($f, "\n\n". $content);
 224             fclose($f);
 225         }
 226         if ($ok) {
 227             if (!$silent)
 228                 trigger_error(sprintf($notice, $this->pagename)
 229                               . " "
 230                               . sprintf(_("sent to %s"), join(',',$this->userids)),
 231                               E_USER_NOTICE);
 232             return true;
 233         } else {
 234             trigger_error(sprintf($notice, $this->pagename)
 235                           . " "
 236                           . sprintf(_("Error: Couldn't send %s to %s"),
 237                                    $subject."\n".$content, join(',',$this->userids)),
 238                           E_USER_WARNING);
 239             return false;
 240         }
 241     }
 242
 243     /**
 244      * Send udiff for a changed page to multiple users.
 245      * See rename and remove methods also
 246      */
 247     function sendPageChangeNotification(&$wikitext, $version, &$meta) {
 248
 249         global $request;
 250
 251         if (@is_array($request->_deferredPageChangeNotification)) {
 252             // collapse multiple changes (loaddir) into one email
 253             $request->_deferredPageChangeNotification[] =
 254                 array($this->pagename, $this->emails, $this->userids);
 255             return;
 256         }
 257         $backend = &$request->_dbi->_backend;
 258         $subject = _("Page change").' '.($this->pagename);
 259         $previous = $backend->get_previous_version($this->pagename, $version);
 260         if (!isset($meta['mtime'])) $meta['mtime'] = time();
 261         if ($previous) {
 262             $difflink = WikiURL($this->pagename, array('action'=>'diff'), true);
 263             $cache = &$request->_dbi->_cache;
 264             $this_content = explode("\n", $wikitext);
 265             $prevdata = $cache->get_versiondata($this->pagename, $previous, true);
 266             if (empty($prevdata['%content']))
 267                 $prevdata = $backend->get_versiondata($this->pagename, $previous, true);
 268             $other_content = explode("\n", $prevdata['%content']);
 269
 270             include_once("lib/difflib.php");
 271             $diff2 = new Diff($other_content, $this_content);
 272             //$context_lines = max(4, count($other_content) + 1,
 273             //                     count($this_content) + 1);
 274             $fmt = new UnifiedDiffFormatter(/*$context_lines*/);
 275             $content  = $this->pagename . " " . $previous . " " .
 276                 Iso8601DateTime($prevdata['mtime']) . "\n";
 277             $content .= $this->pagename . " " . $version . " " .
 278                 Iso8601DateTime($meta['mtime']) . "\n";
 279             $content .= $fmt->format($diff2);
 280
 281         } else {
 282             $difflink = WikiURL($this->pagename,array(),true);
 283             $content = $this->pagename . " " . $version . " " .
 284                 Iso8601DateTime($meta['mtime']) . "\n";
 285             $content .= _("New page");
 286             $content .= "\n\n";
 287             $content .= $wikitext;
 288         }
 289         $editedby = sprintf(_("Edited by: %s"), $this->from);
 290         $this->sendMail($subject,
 291                         $editedby."\n".$difflink."\n\n".$content);
 292     }
 293
 294     /**
 295      * Support mass rename / remove (not yet tested)
 296      */
 297     function sendPageRenameNotification ($to, &$meta) {
 298         global $request;
 299
 300         if (@is_array($request->_deferredPageRenameNotification)) {
 301             $request->_deferredPageRenameNotification[] =
 302                 array($this->pagename, $to, $meta, $this->emails, $this->userids);
 303         } else {
 304             $pagename = $this->pagename;
 305             $editedby = sprintf(_("Edited by: %s"), $this->from);
 306             $subject = sprintf(_("Page rename %s to %s"), $pagename, $to);
 307             $link = WikiURL($to, true);
 308             $this->sendMail($subject,
 309                             $editedby."\n".$link."\n\n"."Renamed $pagename to $to");
 310         }
 311     }
 312
 313     /**
 314      * The handlers:
 315      */
 316     function onChangePage (&$wikidb, &$wikitext, $version, &$meta) {
 317         $result = true;
 318         if (!isa($GLOBALS['request'],'MockRequest')) {
 319             $notify = $wikidb->get('notify');
 320             /* Generate notification emails? */
 321             if (!empty($notify) and is_array($notify)) {
 322                 if (empty($this->pagename))
 323                     $this->pagename = $meta['pagename'];
 324                 // TODO: Should be used for ModeratePage and RSS2 Cloud xml-rpc also.
 325                 $this->getPageChangeEmails($notify);
 326                 if (!empty($this->emails)) {
 327                     $result = $this->sendPageChangeNotification($wikitext, $version, $meta);
 328                 }
 329             }
 330         }
 331         return $result;
 332     }
 333
 334     function onDeletePage (&$wikidb, $pagename) {
 335         $result = true;
 336         /* Generate notification emails? */
 337         if (! $wikidb->isWikiPage($pagename) and !isa($GLOBALS['request'],'MockRequest')) {
 338             $notify = $wikidb->get('notify');
 339             if (!empty($notify) and is_array($notify)) {
 340                 //TODO: deferr it (quite a massive load if you remove some pages).
 341                 $this->getPageChangeEmails($notify);
 342                 if (!empty($this->emails)) {
 343                     $subject = sprintf(_("User %s removed page %s"), $this->from, $pagename);
 344                     $result = $this->sendMail($subject, $subject."\n\n");
 345                 }
 346             }
 347         }
 348         return $result;
 349     }
 350
 351     function onRenamePage (&$wikidb, $oldpage, $new_pagename) {
 352         $result = true;
 353         if (!isa($GLOBALS['request'], 'MockRequest')) {
 354             $notify = $wikidb->get('notify');
 355             if (!empty($notify) and is_array($notify)) {
 356                 $this->getPageChangeEmails($notify);
 357                 if (!empty($this->emails)) {
 358                     $newpage = $wikidb->getPage($new_pagename);
 359                     $current = $newpage->getCurrentRevision();
 360                     $meta = $current->_data;
 361                     $this->pagename = $oldpage;
 362                     $result = $this->sendPageRenameNotification($new_pagename, $meta);
 363                 }
 364             }
 365         }
 366     }
 367
 368     /**
 369      * Send mail to user and store the cookie in the db
 370      * wikiurl?action=ConfirmEmail&id=bla
 371      */
 372     function sendEmailConfirmation ($email, $userid) {
 373         $id = rand_ascii_readable(16);
 374         $wikidb = $GLOBALS['request']->getDbh();
 375         $data = $wikidb->get('ConfirmEmail');
 376         while(!empty($data[$id])) { // id collision
 377             $id = rand_ascii_readable(16);
 378         }
 379         $subject = _("E-Mail address confirmation");
 380         $ip = $request->get('REMOTE_HOST');
 381         $expire_date = time() + 7*86400;
 382         $content = fmt("Someone, probably you from IP address %s, has registered an
 383 account \"%s\" with this e-mail address on %s.
 384
 385 To confirm that this account really does belong to you and activate
 386 e-mail features on %s, open this link in your browser:
 387
 388 %s
 389
 390 If this is *not* you, don't follow the link. This confirmation code
 391 will expire at %s.",
 392                        $ip, $userid, WIKI_NAME, WIKI_NAME,
 393                        WikiURL(HOME_PAGE, array('action' => 'ConfirmEmail',
 394                                                 'id' => $id),
 395                                true),
 396                        CTime($expire_date));
 397         $this->sendMail($subject, $content, "", true);
 398         $data[$id] = array('email' => $email,
 399                            'userid' => $userid,
 400                            'expire' => $expire_date);
 401         $wikidb->set('ConfirmEmail', $data);
 402         return '';
 403     }
 404
 405     function checkEmailConfirmation () {
 406         global $request;
 407         $wikidb = $request->getDbh();
 408         $data = $wikidb->get('ConfirmEmail');
 409         $id = $request->getArg('id');
 410         if (empty($data[$id])) { // id not found
 411             return HTML(HTML::h1("Confirm E-mail address"),
 412                         HTML::h1("Sorry! Wrong URL"));
 413         }
 414         // upgrade the user
 415         $userid = $data['userid'];
 416         $email = $data['email'];
 417         $u = $request->getUser();
 418         if ($u->UserName() == $userid) { // lucky: current user (session)
 419             $prefs = $u->getPreferences();
 420             $request->_user->_level = WIKIAUTH_USER;
 421             $request->_prefs->set('emailVerified', true);
 422         } else {  // not current user
 423             if (ENABLE_USER_NEW) {
 424                 $u = WikiUser($userid);
 425                 $u->getPreferences();
 426                 $prefs = &$u->_prefs;
 427             } else {
 428                 $u = new WikiUser($request, $userid);
 429                 $prefs = $u->getPreferences();
 430             }
 431             $u->_level = WIKIAUTH_USER;
 432             $request->setUser($u);
 433             $request->_prefs->set('emailVerified', true);
 434         }
 435         unset($data[$id]);
 436         $wikidb->set('ConfirmEmail', $data);
 437         return HTML(HTML::h1("Confirm E-mail address"),
 438                     HTML::p("Your e-mail address has now been confirmed."));
 439     }
 440
 441     function subject_encode ($subject) {
 442         // We need to encode the subject if it contains non-ASCII characters
 443         // The page name may contain non-ASCII characters, as well as
 444         // the translation of the messages, e.g. _("PageChange Notification of %s");
 445
 446         // If all characters are ASCII, do nothing
 447         if (isAsciiString($subject)) {
 448             return $subject;
 449         }
 450
 451         // Let us try quoted printable first
 452         if (function_exists('quoted_printable_encode')) { // PHP 5.3
 453             return quoted_printable_encode($subject);
 454         }
 455
 456         // If not, encode in base64 (less human-readable)
 457         return base64_encode($subject);
 458     }
 459 }
 460
 461 // Local Variables:
 462 // mode: php
 463 // tab-width: 8
 464 // c-basic-offset: 4
 465 // c-hanging-comment-ender-p: nil
 466 // indent-tabs-mode: nil
 467 // End:
 468 ?>