include/emails.inc.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2008 Polytechnique.org                              *
   4  *  http://opensource.polytechnique.org/                                   *
   5  *                                                                         *
   6  *  This program is free software; you can redistribute it and/or modify   *
   7  *  it under the terms of the GNU General Public License as published by   *
   8  *  the Free Software Foundation; either version 2 of the License, or      *
   9  *  (at your option) any later version.                                    *
  10  *                                                                         *
  11  *  This program is distributed in the hope that it will be useful,        *
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
  14  *  GNU General Public License for more details.                           *
  15  *                                                                         *
  16  *  You should have received a copy of the GNU General Public License      *
  17  *  along with this program; if not, write to the Free Software            *
  18  *  Foundation, Inc.,                                                      *
  19  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
  20  ***************************************************************************/
  21
  22 define("SUCCESS", 1);
  23 define("ERROR_INACTIVE_REDIRECTION", 2);
  24 define("ERROR_INVALID_EMAIL", 3);
  25 define("ERROR_LOOP_EMAIL", 4);
  26
  27 // function fix_bestalias() {{{1
  28 // Checks for an existing 'bestalias' among the the current user's aliases, and
  29 // eventually selects a new bestalias when required.
  30 function fix_bestalias(User &$user)
  31 {
  32     $res = XDB::query("SELECT  COUNT(*)
  33                          FROM  aliases
  34                         WHERE  id = {?} AND FIND_IN_SET('bestalias', flags) AND type != 'homonyme'",
  35                       $user->id());
  36     if ($res->fetchOneCell()) {
  37         return;
  38     }
  39
  40     XDB::execute("UPDATE  aliases
  41                      SET  flags=CONCAT(flags,',','bestalias')
  42                    WHERE  id={?} AND type!='homonyme'
  43                 ORDER BY  !FIND_IN_SET('usage',flags),alias LIKE '%.%', LENGTH(alias)
  44                    LIMIT  1", $user->id());
  45 }
  46
  47 // function valide_email() {{{1
  48 // Returns a cleaned-up version of the @p email string. It removes garbage
  49 // characters, and determines the canonical form (without _ and +) for
  50 // Polytechnique.org email addresses.
  51 function valide_email($str)
  52 {
  53     global $globals;
  54
  55     $em = trim(rtrim($str));
  56     $em = str_replace('<', '', $em);
  57     $em = str_replace('>', '', $em);
  58     list($ident, $dom) = explode('@', $em);
  59     if ($dom == $globals->mail->domain or $dom == $globals->mail->domain2) {
  60         list($ident1) = explode('_', $ident);
  61         list($ident) = explode('+', $ident1);
  62     }
  63     return $ident . '@' . $dom;
  64 }
  65
  66 // function isvalid_email_redirection() {{{1
  67 /** vérifie si une adresse email convient comme adresse de redirection
  68  * @param $email l'adresse email a verifier
  69  * @return BOOL
  70  */
  71 function isvalid_email_redirection($email)
  72 {
  73     return isvalid_email($email) &&
  74         !preg_match("/@(polytechnique\.(org|edu)|melix\.(org|net)|m4x\.org)$/", $email);
  75 }
  76
  77 // class Bogo {{{1
  78 // The Bogo class represents a spam filtering level in plat/al architecture.
  79 class Bogo
  80 {
  81     // properties {{{2
  82
  83     private $user;
  84     private $state;
  85     private $_states = Array('let_spams', 'tag_spams', 'tag_and_drop_spams', 'drop_spams');
  86
  87     // constructor {{{2
  88
  89     public function __construct(User &$user)
  90     {
  91         if (!$user) {
  92             return;
  93         }
  94
  95         $this->user = &$user;
  96         $res = XDB::query('SELECT email FROM emails WHERE uid = {?} AND flags = "filter"', $user->id());
  97         if ($res->numRows()) {
  98             $this->state = $res->fetchOneCell();
  99         } else {
 100             $this->state = 'tag_and_drop_spams';
 101             $res = XDB::query(
 102                     "INSERT INTO  emails (uid, email, rewrite, panne, flags)
 103                           VALUES  ({?}, 'tag_and_drop_spams', '', '0000-00-00', 'filter')",
 104                     $user->id());
 105         }
 106     }
 107
 108     // public function change() {{{2
 109
 110     public function change($state)
 111     {
 112         $this->state = is_int($state) ? $this->_states[$state] : $state;
 113         XDB::execute('UPDATE emails SET email = {?} WHERE uid = {?} AND flags = "filter"',
 114                      $this->state, $this->user->id());
 115     }
 116
 117     // pubic function level() {{{2
 118
 119     public function level()
 120     {
 121         return array_search($this->state, $this->_states);
 122     }
 123 }
 124
 125 // class Email {{{1
 126 // Represents an "email address" used as final recipient for plat/al-managed
 127 // addresses; it can be subclasses a Redirection emails (third-party) or as
 128 // Storage emails (Polytechnique.org).
 129 abstract class Email
 130 {
 131     protected $user;
 132
 133     // Basic email properties; $sufficient indicates if the email can be used as
 134     // an unique redirection; $email contains the delivery email address.
 135     public $type;
 136     public $sufficient;
 137     public $email;
 138     public $display_email;
 139
 140     // Redirection status properties.
 141     public $active;
 142     public $broken;
 143     public $disabled;
 144     public $rewrite;
 145     public $allow_rewrite;
 146     public $hash;
 147
 148     // Redirection bounces stats.
 149     public $panne;
 150     public $last;
 151     public $panne_level;
 152
 153     // Activates the email address as a redirection.
 154     public abstract function activate();
 155
 156     // Deactivates the email address as a redirection.
 157     public abstract function deactivate();
 158
 159     // Sets the rewrite rule for the given address.
 160     public abstract function set_rewrite($rewrite);
 161
 162     // Resets the error counts associated with the redirection.
 163     public abstract function clean_errors();
 164
 165     // Email backend capabilities ('rewrite' refers to From: rewrite for mails
 166     // forwarded by Polytechnique.org's MXs; 'removable' indicates if the email
 167     // can be definitively removed; 'disable' indicates if the email has a third
 168     // status 'disabled' in addition to 'active' and 'inactive').
 169     public abstract function has_rewrite();
 170     public abstract function is_removable();
 171     public abstract function has_disable();
 172 }
 173
 174 // class EmailRedirection {{{1
 175 // Implementation of Email for third-party redirection (redirection of emails to
 176 // external user-supplied addresses).
 177 class EmailRedirection extends Email
 178 {
 179     // constructor {{{2
 180
 181     public function __construct(User &$user, $row)
 182     {
 183         $this->user = &$user;
 184         $this->sufficient = true;
 185
 186         list($this->email, $flags, $this->rewrite, $this->allow_rewrite, $this->hash, $this->panne, $this->last, $this->panne_level) = $row;
 187         $this->display_email = $this->email;
 188         $this->active   = ($flags == 'active');
 189         $this->broken   = ($flags == 'panne');
 190         $this->disabled = ($flags == 'disable');
 191     }
 192
 193     // public function activate() {{{2
 194
 195     public function activate()
 196     {
 197         if (!$this->active) {
 198             XDB::execute("UPDATE  emails
 199                              SET  panne_level = IF(flags = 'panne', panne_level - 1, panne_level),
 200                                   flags = 'active'
 201                            WHERE  uid = {?} AND email = {?}", $this->user->id(), $this->email);
 202             S::logger()->log("email_on", $this->email . ($this->user->id() != S::v('uid') ? "(admin on {$this->user->login()})" : ""));
 203             $this->active = true;
 204             $this->broken = false;
 205         }
 206     }
 207
 208     // public function deactivate() {{{2
 209
 210     public function deactivate()
 211     {
 212         if ($this->active) {
 213             XDB::execute("UPDATE  emails SET flags =''
 214                            WHERE  uid = {?} AND email = {?}", $this->user->id(), $this->email);
 215             S::logger()->log("email_off", $this->email . ($this->user->id() != S::v('uid') ? "(admin on {$this->user->login()})" : "") );
 216             $this->active = false;
 217         }
 218     }
 219
 220     // public function set_rewrite() {{{2
 221
 222     public function set_rewrite($rewrite)
 223     {
 224         if ($this->rewrite == $rewrite) {
 225             return;
 226         }
 227         if (!$rewrite || !isvalid_email($rewrite)) {
 228             $rewrite = '';
 229         }
 230         XDB::execute('UPDATE emails SET rewrite = {?} WHERE uid = {?} AND email = {?}', $rewrite, $this->user->id(), $this->email);
 231         $this->rewrite = $rewrite;
 232         if (!$this->allow_rewrite) {
 233             global $globals;
 234             if (empty($this->hash)) {
 235                 $this->hash = rand_url_id();
 236                 XDB::execute("UPDATE emails
 237                                  SET hash = {?}
 238                                WHERE uid = {?} AND email = {?}", $this->hash, $this->user->id(), $this->email);
 239             }
 240             $mail = new PlMailer('emails/rewrite-in.mail.tpl');
 241             $mail->assign('mail', $this);
 242             $mail->assign('user', $this->user);
 243             $mail->assign('baseurl', $globals->baseurl);
 244             $mail->assign('sitename', $globals->core->sitename);
 245             $mail->assign('to', $this->email);
 246             $mail->send($this->user->isEmailFormatHtml());
 247         }
 248         return;
 249     }
 250
 251     // public function clean_errors() {{{2
 252
 253     public function clean_errors()
 254     {
 255         if (!S::has_perms()) {
 256             return false;
 257         }
 258         $this->panne       = 0;
 259         $this->panne_level = 0;
 260         $this->last        = 0;
 261         return XDB::execute("UPDATE  emails
 262                                 SET  panne_level = 0, panne = 0, last = 0
 263                               WHERE  uid = {?} AND email = {?}",
 264                             $this->user->id(), $this->email);
 265     }
 266
 267     // public function has_rewrite() {{{2
 268
 269     public function has_rewrite()
 270     {
 271         return true;
 272     }
 273
 274     // public function is_removable() {{{2
 275
 276     public function is_removable()
 277     {
 278         return true;
 279     }
 280
 281     // public function has_disable() {{{2
 282
 283     public function has_disable()
 284     {
 285         return true;
 286     }
 287 }
 288
 289 // class EmailStorage {{{1
 290 // Implementation of Email for email storage backends from Polytechnique.org.
 291 class EmailStorage extends Email
 292 {
 293     // Shortname to realname mapping for known mail storage backends.
 294     private $display_names = array(
 295         'imap'       => 'Accès de secours aux emails (IMAP)',
 296         'googleapps' => 'Compte Google Apps',
 297     );
 298
 299     // Retrieves the current list of actives storages.
 300     private function get_storages()
 301     {
 302         return new PlFlagSet(XDB::fetchOneCell('SELECT  storage
 303                                                   FROM  email_options
 304                                                  WHERE  uid = {?}',
 305                                                 $this->user->id()));
 306     }
 307
 308     // Updates the list of active storages.
 309     private function set_storages($storages)
 310     {
 311         XDB::execute("UPDATE  email_options
 312                          SET  storage = {?}
 313                        WHERE  uid = {?}", $storages, $this->user->id());
 314     }
 315
 316     // Returns the list of allowed storages for the @p user.
 317     static public function get_allowed_storages(User &$user)
 318     {
 319         global $globals;
 320         $storages = array();
 321
 322         // Google Apps storage is available for users with valid Google Apps account.
 323         require_once 'googleapps.inc.php';
 324         if ($globals->mailstorage->googleapps_domain &&
 325             GoogleAppsAccount::account_status($user->id()) == 'active') {
 326             $storages[] = 'googleapps';
 327         }
 328
 329         // IMAP storage is always visible to administrators, and is allowed for
 330         // everyone when the service is marked as 'active'.
 331         if ($globals->mailstorage->imap_active || S::has_perms()) {
 332             $storages[] = 'imap';
 333         }
 334
 335         return $storages;
 336     }
 337
 338
 339     public function __construct(User &$user, $name)
 340     {
 341         $this->user = &$user;
 342         $this->email = $name;
 343         $this->display_email = (isset($this->display_names[$name]) ? $this->display_names[$name] : $name);
 344
 345         $storages = $this->get_storages();
 346         $this->sufficient = ($name == 'googleapps');
 347         $this->active = $storages->hasFlag($name);
 348         $this->broken = false;
 349         $this->disabled = false;
 350         $this->rewrite = '';
 351         $this->panne = $this->last = $this->panne_level = 0;
 352     }
 353
 354     public function activate()
 355     {
 356         if (!$this->active) {
 357             $storages = $this->get_storages();
 358             $storages->addFlag($this->email);
 359             $this->set_storages($storages);
 360             $this->active = true;
 361         }
 362     }
 363
 364     public function deactivate()
 365     {
 366         if ($this->active) {
 367             $storages = $this->get_storages();
 368             $storages->rmFlag($this->email);
 369             $this->set_storages($storages);
 370             $this->active = false;
 371         }
 372
 373     }
 374
 375     // Source rewrite can't be enabled for email storage addresses.
 376     public function set_rewrite($rewrite) {}
 377
 378     // Email storage are not supposed to be broken, hence not supposed to be
 379     // cleaned-up.
 380     public function clean_errors() {}
 381
 382     // Capabilities.
 383     public function has_rewrite() { return false; }
 384     public function is_removable() { return false; }
 385     public function has_disable() { return false; }
 386 }
 387
 388 // class Redirect {{{1
 389 // Redirect is a placeholder class for an user's active redirections (third-party
 390 // redirection email, or Polytechnique.org mail storages).
 391 class Redirect
 392 {
 393     // properties {{{2
 394
 395     private $flag_active = 'active';
 396     private $user;
 397
 398     public $emails;
 399     public $bogo;
 400
 401     // constructor {{{2
 402
 403     public function __construct(User &$user)
 404     {
 405         $this->user = &$user;
 406         $this->bogo = new Bogo($user);
 407
 408         // Adds third-party email redirections.
 409         $res = XDB::iterRow("SELECT  email, flags, rewrite, allow_rewrite, hash, panne, last, panne_level
 410                                FROM  emails
 411                               WHERE  uid = {?} AND flags != 'filter'", $user->id());
 412         $this->emails = Array();
 413         while ($row = $res->next()) {
 414             $this->emails[] = new EmailRedirection($user, $row);
 415         }
 416
 417         // Adds local email storage backends.
 418         foreach (EmailStorage::get_allowed_storages($user) as $storage) {
 419             $this->emails[] = new EmailStorage($user, $storage);
 420         }
 421     }
 422
 423     // public function other_active() {{{2
 424
 425     public function other_active($email)
 426     {
 427         foreach ($this->emails as $mail) {
 428             if ($mail->email != $email && $mail->active && $mail->sufficient) {
 429                 return true;
 430             }
 431         }
 432         return false;
 433     }
 434
 435     // public function delete_email() {{{2
 436
 437     public function delete_email($email)
 438     {
 439         if (!$this->other_active($email)) {
 440             return ERROR_INACTIVE_REDIRECTION;
 441         }
 442         XDB::execute('DELETE FROM emails WHERE uid = {?} AND email = {?}', $this->user->id(), $email);
 443         S::logger()->log('email_del', $email . ($this->user->id() != S::v('uid') ? " (admin on {$this->user->login()})" : ""));
 444         foreach ($this->emails as $i => $mail) {
 445             if ($email == $mail->email) {
 446                 unset($this->emails[$i]);
 447             }
 448         }
 449         check_redirect($this);
 450         return SUCCESS;
 451     }
 452
 453     // public function add_email() {{{2
 454
 455     public function add_email($email)
 456     {
 457         $email_stripped = strtolower(trim($email));
 458         if (!isvalid_email($email_stripped)) {
 459             return ERROR_INVALID_EMAIL;
 460         }
 461         if (!isvalid_email_redirection($email_stripped)) {
 462             return ERROR_LOOP_EMAIL;
 463         }
 464         XDB::execute('REPLACE INTO emails (uid,email,flags) VALUES({?},{?},"active")', $this->user->id(), $email);
 465         if ($logger = S::v('log', null)) { // may be absent --> step4.php
 466             S::logger()->log('email_add', $email . ($this->user->id() != S::v('uid') ? " (admin on {$this->user->login()})" : ""));
 467         }
 468         foreach ($this->emails as $mail) {
 469             if ($mail->email == $email_stripped) {
 470                 return SUCCESS;
 471             }
 472         }
 473         $this->emails[] = new EmailRedirection($this->user, array($email, 'active', '', 0, null, '0000-00-00', '0000-00-00', 0));
 474
 475         // security stuff
 476         check_email($email, "Ajout d'une adresse surveillée aux redirections de " . $this->user->login());
 477         check_redirect($this);
 478         return SUCCESS;
 479     }
 480
 481     // public function modify_email() {{{2
 482
 483     public function modify_email($emails_actifs, $emails_rewrite)
 484     {
 485         foreach ($this->emails as &$mail) {
 486             if (in_array($mail->email, $emails_actifs)) {
 487                 $mail->activate();
 488             } else {
 489                 $mail->deactivate();
 490             }
 491             $mail->set_rewrite($emails_rewrite[$mail->email]);
 492         }
 493         check_redirect($this);
 494     }
 495
 496     // public function modify_one_email() {{{2
 497
 498     public function modify_one_email($email, $activate)
 499     {
 500         $allinactive = true;
 501         $thisone = false;
 502         foreach ($this->emails as $i=>$mail) {
 503             if ($mail->email == $email) {
 504                 $thisone = $i;
 505             }
 506             $allinactive &= !$mail->active || !$mail->sufficient || $mail->email == $email;
 507         }
 508         if ($thisone === false) {
 509             return ERROR_INVALID_EMAIL;
 510         }
 511         if ($allinactive || $activate) {
 512             $this->emails[$thisone]->activate();
 513         } else {
 514             $this->emails[$thisone]->deactivate();
 515         }
 516         check_redirect($this);
 517         if ($allinactive && !$activate) {
 518             return ERROR_INACTIVE_REDIRECTION;
 519         } else {
 520             return SUCCESS;
 521         }
 522     }
 523
 524     // public function modify_one_email_redirect() {{{2
 525
 526     public function modify_one_email_redirect($email, $redirect)
 527     {
 528         foreach ($this->emails as &$mail) {
 529             if ($mail->email == $email) {
 530                 $mail->set_rewrite($redirect);
 531                 check_redirect($this);
 532                 return;
 533             }
 534         }
 535     }
 536
 537     // function clean_errors() {{{2
 538
 539     public function clean_errors($email)
 540     {
 541         foreach ($this->emails as &$mail) {
 542             if ($mail->email == $email) {
 543                 check_redirect($this);
 544                 return $mail->clean_errors();
 545             }
 546         }
 547         return false;
 548     }
 549
 550     // function disable() {{{2
 551
 552     public function disable()
 553     {
 554         XDB::execute("UPDATE  emails
 555                          SET  flags = 'disable'
 556                        WHERE  flags = 'active' AND uid = {?}", $this->user->id);
 557         foreach ($this->emails as &$mail) {
 558             if ($mail->active && $mail->has_disable()) {
 559                 $mail->disabled = true;
 560                 $mail->active   = false;
 561             }
 562         }
 563         check_redirect($this);
 564     }
 565
 566     // function enable() {{{2
 567
 568     public function enable()
 569     {
 570         XDB::execute("UPDATE  emails
 571                          SET  flags = 'active'
 572                        WHERE  flags = 'disable' AND uid = {?}", $this->user->id);
 573         foreach ($this->emails as &$mail) {
 574             if ($mail->disabled) {
 575                 $mail->active   = true;
 576                 $mail->disabled = false;
 577             }
 578             check_redirect($this);
 579         }
 580     }
 581
 582     // function get_broken_mx() {{{2
 583
 584     public function get_broken_mx()
 585     {
 586         $res = XDB::query("SELECT  host, text
 587                              FROM  mx_watch
 588                             WHERE  state != 'ok'");
 589         if (!$res->numRows()) {
 590             return array();
 591         }
 592         $mxs = $res->fetchAllAssoc();
 593         $mails = array();
 594         foreach ($this->emails as &$mail) {
 595             if ($mail->active && strstr($mail->email, '@') !== false) {
 596                 list(,$domain) = explode('@', $mail->email);
 597                 getmxrr($domain, $lcl_mxs);
 598                 if (empty($lcl_mxs)) {
 599                     $lcl_mxs = array($domain);
 600                 }
 601                 $broken = false;
 602                 foreach ($mxs as &$mx) {
 603                     foreach ($lcl_mxs as $lcl) {
 604                         if (fnmatch($mx['host'], $lcl)) {
 605                             $broken = $mx['text'];
 606                             break;
 607                         }
 608                     }
 609                     if ($broken) {
 610                         $mails[] = array('mail' => $mail->email, 'text' => $broken);
 611                         break;
 612                     }
 613                 }
 614             }
 615         }
 616         return $mails;
 617     }
 618
 619     // function active_emails() {{{2
 620
 621     public function active_emails()
 622     {
 623         $emails = array();
 624         foreach ($this->emails as $mail) {
 625             if ($mail->active) {
 626                 $emails[] = $mail;
 627             }
 628         }
 629         return $emails;
 630     }
 631
 632     // function get_uid() {{{2
 633
 634     public function get_uid()
 635     {
 636         return $this->user->id();
 637     }
 638 }
 639
 640 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 641 ?>