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
 146     // Redirection bounces stats.
 147     public $panne;
 148     public $last;
 149     public $panne_level;
 150
 151     // Activates the email address as a redirection.
 152     public abstract function activate();
 153
 154     // Deactivates the email address as a redirection.
 155     public abstract function deactivate();
 156
 157     // Sets the rewrite rule for the given address.
 158     public abstract function set_rewrite($rewrite);
 159
 160     // Resets the error counts associated with the redirection.
 161     public abstract function clean_errors();
 162
 163     // Email backend capabilities ('rewrite' refers to From: rewrite for mails
 164     // forwarded by Polytechnique.org's MXs; 'removable' indicates if the email
 165     // can be definitively removed; 'disable' indicates if the email has a third
 166     // status 'disabled' in addition to 'active' and 'inactive').
 167     public abstract function has_rewrite();
 168     public abstract function is_removable();
 169     public abstract function has_disable();
 170 }
 171
 172 // class EmailRedirection {{{1
 173 // Implementation of Email for third-party redirection (redirection of emails to
 174 // external user-supplied addresses).
 175 class EmailRedirection extends Email
 176 {
 177     // constructor {{{2
 178
 179     public function __construct(User &$user, $row)
 180     {
 181         $this->user = &$user;
 182         $this->sufficient = true;
 183
 184         list($this->email, $flags, $this->rewrite, $this->panne, $this->last, $this->panne_level) = $row;
 185         $this->display_email = $this->email;
 186         $this->active   = ($flags == 'active');
 187         $this->broken   = ($flags == 'panne');
 188         $this->disabled = ($flags == 'disable');
 189     }
 190
 191     // public function activate() {{{2
 192
 193     public function activate()
 194     {
 195         if (!$this->active) {
 196             XDB::execute("UPDATE  emails
 197                              SET  panne_level = IF(flags = 'panne', panne_level - 1, panne_level),
 198                                   flags = 'active'
 199                            WHERE  uid = {?} AND email = {?}", $this->user->id(), $this->email);
 200             S::logger()->log("email_on", $this->email . ($this->user->id() != S::v('uid') ? "(admin on {$this->user->login()})" : ""));
 201             $this->active = true;
 202             $this->broken = false;
 203         }
 204     }
 205
 206     // public function deactivate() {{{2
 207
 208     public function deactivate()
 209     {
 210         if ($this->active) {
 211             XDB::execute("UPDATE  emails SET flags =''
 212                            WHERE  uid = {?} AND email = {?}", $this->user->id(), $this->email);
 213             S::logger()->log("email_off", $this->email . ($this->user->id() != S::v('uid') ? "(admin on {$this->user->login()})" : "") );
 214             $this->active = false;
 215         }
 216     }
 217
 218     // public function set_rewrite() {{{2
 219
 220     public function set_rewrite($rewrite)
 221     {
 222         if ($this->rewrite == $rewrite) {
 223             return;
 224         }
 225         if (!$rewrite || !isvalid_email($rewrite)) {
 226             $rewrite = '';
 227         }
 228         XDB::execute('UPDATE emails SET rewrite = {?} WHERE uid = {?} AND email = {?}', $rewrite, $this->user->id(), $this->email);
 229         $this->rewrite = $rewrite;
 230         return;
 231     }
 232
 233     // public function clean_errors() {{{2
 234
 235     public function clean_errors()
 236     {
 237         if (!S::has_perms()) {
 238             return false;
 239         }
 240         $this->panne       = 0;
 241         $this->panne_level = 0;
 242         $this->last        = 0;
 243         return XDB::execute("UPDATE  emails
 244                                 SET  panne_level = 0, panne = 0, last = 0
 245                               WHERE  uid = {?} AND email = {?}",
 246                             $this->user->id(), $this->email);
 247     }
 248
 249     // public function has_rewrite() {{{2
 250
 251     public function has_rewrite()
 252     {
 253         return true;
 254     }
 255
 256     // public function is_removable() {{{2
 257
 258     public function is_removable()
 259     {
 260         return true;
 261     }
 262
 263     // public function has_disable() {{{2
 264
 265     public function has_disable()
 266     {
 267         return true;
 268     }
 269 }
 270
 271 // class EmailStorage {{{1
 272 // Implementation of Email for email storage backends from Polytechnique.org.
 273 class EmailStorage extends Email
 274 {
 275     // Shortname to realname mapping for known mail storage backends.
 276     private $display_names = array(
 277         'imap'       => 'Accès de secours aux emails (IMAP)',
 278         'googleapps' => 'Compte Google Apps',
 279     );
 280
 281     // Retrieves the current list of actives storages.
 282     private function get_storages()
 283     {
 284         $res = XDB::query("SELECT  mail_storage
 285                              FROM  auth_user_md5
 286                             WHERE  user_id = {?}", $this->user->id());
 287         return new PlFlagSet($res->fetchOneCell());
 288     }
 289
 290     // Updates the list of active storages.
 291     private function set_storages($storages)
 292     {
 293         XDB::execute("UPDATE  auth_user_md5
 294                          SET  mail_storage = {?}
 295                        WHERE  user_id = {?}", $storages, $this->user->id());
 296     }
 297
 298     // Returns the list of allowed storages for the @p user.
 299     static public function get_allowed_storages(User &$user)
 300     {
 301         global $globals;
 302         $storages = array();
 303
 304         // Google Apps storage is available for users with valid Google Apps account.
 305         require_once 'googleapps.inc.php';
 306         if ($globals->mailstorage->googleapps_domain &&
 307             GoogleAppsAccount::account_status($user->id()) == 'active') {
 308             $storages[] = 'googleapps';
 309         }
 310
 311         // IMAP storage is always visible to administrators, and is allowed for
 312         // everyone when the service is marked as 'active'.
 313         if ($globals->mailstorage->imap_active || S::has_perms()) {
 314             $storages[] = 'imap';
 315         }
 316
 317         return $storages;
 318     }
 319
 320
 321     public function __construct(User &$user, $name)
 322     {
 323         $this->user = &$user;
 324         $this->email = $name;
 325         $this->display_email = (isset($this->display_names[$name]) ? $this->display_names[$name] : $name);
 326
 327         $storages = $this->get_storages();
 328         $this->sufficient = ($name == 'googleapps');
 329         $this->active = $storages->hasFlag($name);
 330         $this->broken = false;
 331         $this->disabled = false;
 332         $this->rewrite = '';
 333         $this->panne = $this->last = $this->panne_level = 0;
 334     }
 335
 336     public function activate()
 337     {
 338         if (!$this->active) {
 339             $storages = $this->get_storages();
 340             $storages->addFlag($this->email);
 341             $this->set_storages($storages);
 342             $this->active = true;
 343         }
 344     }
 345
 346     public function deactivate()
 347     {
 348         if ($this->active) {
 349             $storages = $this->get_storages();
 350             $storages->rmFlag($this->email);
 351             $this->set_storages($storages);
 352             $this->active = false;
 353         }
 354
 355     }
 356
 357     // Source rewrite can't be enabled for email storage addresses.
 358     public function set_rewrite($rewrite) {}
 359
 360     // Email storage are not supposed to be broken, hence not supposed to be
 361     // cleaned-up.
 362     public function clean_errors() {}
 363
 364     // Capabilities.
 365     public function has_rewrite() { return false; }
 366     public function is_removable() { return false; }
 367     public function has_disable() { return false; }
 368 }
 369
 370 // class Redirect {{{1
 371 // Redirect is a placeholder class for an user's active redirections (third-party
 372 // redirection email, or Polytechnique.org mail storages).
 373 class Redirect
 374 {
 375     // properties {{{2
 376
 377     private $flag_active = 'active';
 378     private $user;
 379
 380     public $emails;
 381     public $bogo;
 382
 383     // constructor {{{2
 384
 385     public function __construct(User &$user)
 386     {
 387         $this->user = &$user;
 388         $this->bogo = new Bogo($user);
 389
 390         // Adds third-party email redirections.
 391         $res = XDB::iterRow("SELECT  email, flags, rewrite, panne, last, panne_level
 392                                FROM  emails
 393                               WHERE  uid = {?} AND flags != 'filter'", $user->id());
 394         $this->emails = Array();
 395         while ($row = $res->next()) {
 396             $this->emails[] = new EmailRedirection($user, $row);
 397         }
 398
 399         // Adds local email storage backends.
 400         foreach (EmailStorage::get_allowed_storages($user) as $storage) {
 401             $this->emails[] = new EmailStorage($user, $storage);
 402         }
 403     }
 404
 405     // public function other_active() {{{2
 406
 407     public function other_active($email)
 408     {
 409         foreach ($this->emails as $mail) {
 410             if ($mail->email != $email && $mail->active && $mail->sufficient) {
 411                 return true;
 412             }
 413         }
 414         return false;
 415     }
 416
 417     // public function delete_email() {{{2
 418
 419     public function delete_email($email)
 420     {
 421         if (!$this->other_active($email)) {
 422             return ERROR_INACTIVE_REDIRECTION;
 423         }
 424         XDB::execute('DELETE FROM emails WHERE uid = {?} AND email = {?}', $this->user->id(), $email);
 425         S::logger()->log('email_del', $email . ($this->user->id() != S::v('uid') ? " (admin on {$this->user->login()})" : ""));
 426         foreach ($this->emails as $i => $mail) {
 427             if ($email == $mail->email) {
 428                 unset($this->emails[$i]);
 429             }
 430         }
 431         check_redirect($this);
 432         return SUCCESS;
 433     }
 434
 435     // public function add_email() {{{2
 436
 437     public function add_email($email)
 438     {
 439         $email_stripped = strtolower(trim($email));
 440         if (!isvalid_email($email_stripped)) {
 441             return ERROR_INVALID_EMAIL;
 442         }
 443         if (!isvalid_email_redirection($email_stripped)) {
 444             return ERROR_LOOP_EMAIL;
 445         }
 446         XDB::execute('REPLACE INTO emails (uid,email,flags) VALUES({?},{?},"active")', $this->user->id(), $email);
 447         if ($logger = S::v('log', null)) { // may be absent --> step4.php
 448             S::logger()->log('email_add', $email . ($this->user->id() != S::v('uid') ? " (admin on {$this->user->login()})" : ""));
 449         }
 450         foreach ($this->emails as $mail) {
 451             if ($mail->email == $email_stripped) {
 452                 return SUCCESS;
 453             }
 454         }
 455         $this->emails[] = new EmailRedirection($this->user, array($email, 'active', '', '0000-00-00', '0000-00-00', 0));
 456
 457         // security stuff
 458         check_email($email, "Ajout d'une adresse surveillée aux redirections de " . $this->user->login());
 459         check_redirect($this);
 460         return SUCCESS;
 461     }
 462
 463     // public function modify_email() {{{2
 464
 465     public function modify_email($emails_actifs, $emails_rewrite)
 466     {
 467         foreach ($this->emails as &$mail) {
 468             if (in_array($mail->email, $emails_actifs)) {
 469                 $mail->activate();
 470             } else {
 471                 $mail->deactivate();
 472             }
 473             $mail->set_rewrite($emails_rewrite[$mail->email]);
 474         }
 475         check_redirect($this);
 476     }
 477
 478     // public function modify_one_email() {{{2
 479
 480     public function modify_one_email($email, $activate)
 481     {
 482         $allinactive = true;
 483         $thisone = false;
 484         foreach ($this->emails as $i=>$mail) {
 485             if ($mail->email == $email) {
 486                 $thisone = $i;
 487             }
 488             $allinactive &= !$mail->active || !$mail->sufficient || $mail->email == $email;
 489         }
 490         if ($thisone === false) {
 491             return ERROR_INVALID_EMAIL;
 492         }
 493         if ($allinactive || $activate) {
 494             $this->emails[$thisone]->activate();
 495         } else {
 496             $this->emails[$thisone]->deactivate();
 497         }
 498         check_redirect($this);
 499         if ($allinactive && !$activate) {
 500             return ERROR_INACTIVE_REDIRECTION;
 501         } else {
 502             return SUCCESS;
 503         }
 504     }
 505
 506     // public function modify_one_email_redirect() {{{2
 507
 508     public function modify_one_email_redirect($email, $redirect)
 509     {
 510         foreach ($this->emails as &$mail) {
 511             if ($mail->email == $email) {
 512                 $mail->set_rewrite($redirect);
 513                 check_redirect($this);
 514                 return;
 515             }
 516         }
 517     }
 518
 519     // function clean_errors() {{{2
 520
 521     public function clean_errors($email)
 522     {
 523         foreach ($this->emails as &$mail) {
 524             if ($mail->email == $email) {
 525                 check_redirect($this);
 526                 return $mail->clean_errors();
 527             }
 528         }
 529         return false;
 530     }
 531
 532     // function disable() {{{2
 533
 534     public function disable()
 535     {
 536         XDB::execute("UPDATE  emails
 537                          SET  flags = 'disable'
 538                        WHERE  flags = 'active' AND uid = {?}", $this->user->id);
 539         foreach ($this->emails as &$mail) {
 540             if ($mail->active && $mail->has_disable()) {
 541                 $mail->disabled = true;
 542                 $mail->active   = false;
 543             }
 544         }
 545         check_redirect($this);
 546     }
 547
 548     // function enable() {{{2
 549
 550     public function enable()
 551     {
 552         XDB::execute("UPDATE  emails
 553                          SET  flags = 'active'
 554                        WHERE  flags = 'disable' AND uid = {?}", $this->user->id);
 555         foreach ($this->emails as &$mail) {
 556             if ($mail->disabled) {
 557                 $mail->active   = true;
 558                 $mail->disabled = false;
 559             }
 560             check_redirect($this);
 561         }
 562     }
 563
 564     // function get_broken_mx() {{{2
 565
 566     public function get_broken_mx()
 567     {
 568         $res = XDB::query("SELECT  host, text
 569                              FROM  mx_watch
 570                             WHERE  state != 'ok'");
 571         if (!$res->numRows()) {
 572             return array();
 573         }
 574         $mxs = $res->fetchAllAssoc();
 575         $mails = array();
 576         foreach ($this->emails as &$mail) {
 577             if ($mail->active && strstr($mail->email, '@') !== false) {
 578                 list(,$domain) = explode('@', $mail->email);
 579                 getmxrr($domain, $lcl_mxs);
 580                 if (empty($lcl_mxs)) {
 581                     $lcl_mxs = array($domain);
 582                 }
 583                 $broken = false;
 584                 foreach ($mxs as &$mx) {
 585                     foreach ($lcl_mxs as $lcl) {
 586                         if (fnmatch($mx['host'], $lcl)) {
 587                             $broken = $mx['text'];
 588                             break;
 589                         }
 590                     }
 591                     if ($broken) {
 592                         $mails[] = array('mail' => $mail->email, 'text' => $broken);
 593                         break;
 594                     }
 595                 }
 596             }
 597         }
 598         return $mails;
 599     }
 600
 601     // function active_emails() {{{2
 602
 603     public function active_emails()
 604     {
 605         $emails = array();
 606         foreach ($this->emails as $mail) {
 607             if ($mail->active) {
 608                 $emails[] = $mail;
 609             }
 610         }
 611         return $emails;
 612     }
 613
 614     // function get_uid() {{{2
 615
 616     public function get_uid()
 617     {
 618         return $this->user->id();
 619     }
 620 }
 621
 622 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 623 ?>