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($uid)
  31 {
  32     $res = XDB::query("SELECT  COUNT(*)
  33                          FROM  aliases
  34                         WHERE  id = {?} AND FIND_IN_SET('bestalias', flags) AND type != 'homonyme'",
  35                       $uid);
  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", $uid);
  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 $uid;
  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($uid)
  90     {
  91         if (!$uid) {
  92             return;
  93         }
  94
  95         $this->uid = $uid;
  96         $res = XDB::query('SELECT email FROM emails WHERE uid={?} AND flags="filter"', $uid);
  97         if ($res->numRows()) {
  98             $this->state = $res->fetchOneCell();
  99         } else {
 100             $this->state = 'tag_and_drop_spams';
 101             $res = XDB::query("INSERT INTO emails (uid,email,rewrite,panne,flags)
 102                                     VALUES ({?},'tag_and_drop_spams','','0000-00-00','filter')", $uid);
 103         }
 104     }
 105
 106     // public function change() {{{2
 107
 108     public function change($state)
 109     {
 110         $this->state = is_int($state) ? $this->_states[$state] : $state;
 111         XDB::execute('UPDATE emails SET email={?} WHERE uid={?} AND flags = "filter"',
 112                      $this->state, $this->uid);
 113     }
 114
 115     // pubic function level() {{{2
 116
 117     public function level()
 118     {
 119         return array_search($this->state, $this->_states);
 120     }
 121 }
 122
 123 // class Email {{{1
 124 // Represents an "email address" used as final recipient for plat/al-managed
 125 // addresses; it can be subclasses a Redirection emails (third-party) or as
 126 // Storage emails (Polytechnique.org).
 127 abstract class Email
 128 {
 129     protected $uid;
 130
 131     // Basic email properties; $sufficient indicates if the email can be used as
 132     // an unique redirection; $email contains the delivery email address.
 133     public $type;
 134     public $sufficient;
 135     public $email;
 136     public $display_email;
 137
 138     // Redirection status properties.
 139     public $active;
 140     public $broken;
 141     public $disabled;
 142     public $rewrite;
 143     public $allow_rewrite;
 144     public $hash;
 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($uid, $row)
 180     {
 181         $this->uid = $uid;
 182         $this->sufficient = true;
 183
 184         list($this->email, $flags, $this->rewrite, $this->allow_rewrite, $this->hash, $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->uid, $this->email);
 200             S::logger()->log("email_on", $this->email.($this->uid!=S::v('uid') ? "(admin on {$this->uid})" : ""));
 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->uid, $this->email);
 213             S::logger()->log("email_off",$this->email.($this->uid != S::v('uid') ? "(admin on {$this->uid})" : "") );
 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->uid, $this->email);
 229         $this->rewrite = $rewrite;
 230         if (!$this->allow_rewrite) {
 231             global $globals;
 232             if (empty($this->hash)) {
 233                 $this->hash = rand_url_id();
 234                 XDB::execute("UPDATE emails
 235                                  SET hash = {?}
 236                                WHERE uid = {?} AND email = {?}", $this->hash, $this->uid, $this->email);
 237             }
 238             $res = XDB::query("SELECT  IF(u.nom_usage = '', u.nom, u.nom_usage) AS nom, u.prenom, FIND_IN_SET('femme', u.flags) AS sex,
 239                                        q.core_mail_fmt, a.alias AS forlife, a2.alias AS bestalias
 240                                  FROM  auth_user_md5 AS u
 241                            INNER JOIN  auth_user_quick AS q ON (u.user_id = q.user_id)
 242                            INNER JOIN  aliases         AS a ON (a.id = u.user_id AND a.type = 'a_vie')
 243                            INNER JOIN  aliases         AS a2 ON (a2.id = u.user_id AND FIND_IN_SET('bestalias', a2.flags))
 244                                 WHERE  u.user_id = {?}", $this->uid);
 245             list($nom, $prenom, $sexe, $fmt, $forlife, $bestalias) = $res->fetchOneRow();
 246             $mail = new PlMailer('emails/rewrite-in.mail.tpl');
 247             $mail->assign('mail', $this);
 248             $mail->assign('nom', $nom);
 249             $mail->assign('prenom', $prenom);
 250             $mail->assign('sexe', $sexe);
 251             $mail->assign('forlife', $forlife);
 252             $mail->assign('baseurl', $globals->baseurl);
 253             $mail->assign('sitename', $globals->core->sitename);
 254             $mail->assign('to', $this->email);
 255             $mail->send($fmt == 'html');
 256         }
 257         return;
 258     }
 259
 260     // public function clean_errors() {{{2
 261
 262     public function clean_errors()
 263     {
 264         if (!S::has_perms()) {
 265             return false;
 266         }
 267         $this->panne       = 0;
 268         $this->panne_level = 0;
 269         $this->last        = 0;
 270         return XDB::execute("UPDATE  emails
 271                                 SET  panne_level = 0, panne = 0, last = 0
 272                               WHERE  uid = {?} AND email = {?}",
 273                             $this->uid, $this->email);
 274     }
 275
 276     // public function has_rewrite() {{{2
 277
 278     public function has_rewrite()
 279     {
 280         return true;
 281     }
 282
 283     // public function is_removable() {{{2
 284
 285     public function is_removable()
 286     {
 287         return true;
 288     }
 289
 290     // public function has_disable() {{{2
 291
 292     public function has_disable()
 293     {
 294         return true;
 295     }
 296 }
 297
 298 // class EmailStorage {{{1
 299 // Implementation of Email for email storage backends from Polytechnique.org.
 300 class EmailStorage extends Email
 301 {
 302     // Shortname to realname mapping for known mail storage backends.
 303     private $display_names = array(
 304         'imap'       => 'Accès de secours aux emails (IMAP)',
 305         'googleapps' => 'Compte Google Apps',
 306     );
 307
 308     // Retrieves the current list of actives storages.
 309     private function get_storages()
 310     {
 311         $res = XDB::query("SELECT  mail_storage
 312                              FROM  auth_user_md5
 313                             WHERE  user_id = {?}", $this->uid);
 314         return new PlFlagSet($res->fetchOneCell());
 315     }
 316
 317     // Updates the list of active storages.
 318     private function set_storages($storages)
 319     {
 320         XDB::execute("UPDATE  auth_user_md5
 321                          SET  mail_storage = {?}
 322                        WHERE  user_id = {?}", $storages, $this->uid);
 323     }
 324
 325     // Returns the list of allowed storages for the @p user.
 326     static public function get_allowed_storages($uid)
 327     {
 328         global $globals;
 329         $storages = array();
 330
 331         // Google Apps storage is available for users with valid Google Apps account.
 332         require_once 'googleapps.inc.php';
 333         if ($globals->mailstorage->googleapps_domain &&
 334             GoogleAppsAccount::account_status($uid) == 'active') {
 335             $storages[] = 'googleapps';
 336         }
 337
 338         // IMAP storage is always visible to administrators, and is allowed for
 339         // everyone when the service is marked as 'active'.
 340         if ($globals->mailstorage->imap_active || S::has_perms()) {
 341             $storages[] = 'imap';
 342         }
 343
 344         return $storages;
 345     }
 346
 347
 348     public function __construct($uid, $name)
 349     {
 350         $this->uid = $uid;
 351         $this->email = $name;
 352         $this->display_email = (isset($this->display_names[$name]) ? $this->display_names[$name] : $name);
 353
 354         $storages = $this->get_storages();
 355         $this->sufficient = ($name == 'googleapps');
 356         $this->active = $storages->hasFlag($name);
 357         $this->broken = false;
 358         $this->disabled = false;
 359         $this->rewrite = '';
 360         $this->panne = $this->last = $this->panne_level = 0;
 361     }
 362
 363     public function activate()
 364     {
 365         if (!$this->active) {
 366             $storages = $this->get_storages();
 367             $storages->addFlag($this->email);
 368             $this->set_storages($storages);
 369             $this->active = true;
 370         }
 371     }
 372
 373     public function deactivate()
 374     {
 375         if ($this->active) {
 376             $storages = $this->get_storages();
 377             $storages->rmFlag($this->email);
 378             $this->set_storages($storages);
 379             $this->active = false;
 380         }
 381
 382     }
 383
 384     // Source rewrite can't be enabled for email storage addresses.
 385     public function set_rewrite($rewrite) {}
 386
 387     // Email storage are not supposed to be broken, hence not supposed to be
 388     // cleaned-up.
 389     public function clean_errors() {}
 390
 391     // Capabilities.
 392     public function has_rewrite() { return false; }
 393     public function is_removable() { return false; }
 394     public function has_disable() { return false; }
 395 }
 396
 397 // class Redirect {{{1
 398 // Redirect is a placeholder class for an user's active redirections (third-party
 399 // redirection email, or Polytechnique.org mail storages).
 400 class Redirect
 401 {
 402     // properties {{{2
 403
 404     private $flag_active = 'active';
 405     private $uid;
 406
 407     public $emails;
 408     public $bogo;
 409
 410     // constructor {{{2
 411
 412     public function __construct($_uid)
 413     {
 414         $this->uid = $_uid;
 415         $this->bogo = new Bogo($_uid);
 416
 417         // Adds third-party email redirections.
 418         $res = XDB::iterRow("SELECT  email, flags, rewrite, allow_rewrite, hash, panne, last, panne_level
 419                                FROM  emails
 420                               WHERE  uid = {?} AND flags != 'filter'", $_uid);
 421         $this->emails = Array();
 422         while ($row = $res->next()) {
 423             $this->emails[] = new EmailRedirection($_uid, $row);
 424         }
 425
 426         // Adds local email storage backends.
 427         foreach (EmailStorage::get_allowed_storages($_uid) as $storage) {
 428             $this->emails[] = new EmailStorage($_uid, $storage);
 429         }
 430     }
 431
 432     // public function other_active() {{{2
 433
 434     public function other_active($email)
 435     {
 436         foreach ($this->emails as $mail) {
 437             if ($mail->email != $email && $mail->active && $mail->sufficient) {
 438                 return true;
 439             }
 440         }
 441         return false;
 442     }
 443
 444     // public function delete_email() {{{2
 445
 446     public function delete_email($email)
 447     {
 448         if (!$this->other_active($email)) {
 449             return ERROR_INACTIVE_REDIRECTION;
 450         }
 451         XDB::execute('DELETE FROM emails WHERE uid={?} AND email={?}', $this->uid, $email);
 452         S::logger()->log('email_del',$email.($this->uid!=S::v('uid') ? " (admin on {$this->uid})" : ""));
 453         foreach ($this->emails as $i => $mail) {
 454             if ($email == $mail->email) {
 455                 unset($this->emails[$i]);
 456             }
 457         }
 458         check_redirect($this);
 459         return SUCCESS;
 460     }
 461
 462     // public function add_email() {{{2
 463
 464     public function add_email($email)
 465     {
 466         $email_stripped = strtolower(trim($email));
 467         if (!isvalid_email($email_stripped)) {
 468             return ERROR_INVALID_EMAIL;
 469         }
 470         if (!isvalid_email_redirection($email_stripped)) {
 471             return ERROR_LOOP_EMAIL;
 472         }
 473         XDB::execute('REPLACE INTO emails (uid,email,flags) VALUES({?},{?},"active")', $this->uid, $email);
 474         if ($logger = S::v('log', null)) { // may be absent --> step4.php
 475             S::logger()->log('email_add',$email.($this->uid!=S::v('uid') ? " (admin on {$this->uid})" : ""));
 476         }
 477         foreach ($this->emails as $mail) {
 478             if ($mail->email == $email_stripped) {
 479                 return SUCCESS;
 480             }
 481         }
 482         $this->emails[] = new EmailRedirection($this->uid, array($email, 'active', '', 0, null, '0000-00-00', '0000-00-00', 0));
 483
 484         // security stuff
 485         check_email($email, "Ajout d'une adresse surveillée aux redirections de " . $this->uid);
 486         check_redirect($this);
 487         return SUCCESS;
 488     }
 489
 490     // public function modify_email() {{{2
 491
 492     public function modify_email($emails_actifs, $emails_rewrite)
 493     {
 494         foreach ($this->emails as &$mail) {
 495             if (in_array($mail->email, $emails_actifs)) {
 496                 $mail->activate();
 497             } else {
 498                 $mail->deactivate();
 499             }
 500             $mail->set_rewrite($emails_rewrite[$mail->email]);
 501         }
 502         check_redirect($this);
 503     }
 504
 505     // public function modify_one_email() {{{2
 506
 507     public function modify_one_email($email, $activate)
 508     {
 509         $allinactive = true;
 510         $thisone = false;
 511         foreach ($this->emails as $i=>$mail) {
 512             if ($mail->email == $email) {
 513                 $thisone = $i;
 514             }
 515             $allinactive &= !$mail->active || !$mail->sufficient || $mail->email == $email;
 516         }
 517         if ($thisone === false) {
 518             return ERROR_INVALID_EMAIL;
 519         }
 520         if ($allinactive || $activate) {
 521             $this->emails[$thisone]->activate();
 522         } else {
 523             $this->emails[$thisone]->deactivate();
 524         }
 525         check_redirect($this);
 526         if ($allinactive && !$activate) {
 527             return ERROR_INACTIVE_REDIRECTION;
 528         } else {
 529             return SUCCESS;
 530         }
 531     }
 532
 533     // public function modify_one_email_redirect() {{{2
 534
 535     public function modify_one_email_redirect($email, $redirect)
 536     {
 537         foreach ($this->emails as &$mail) {
 538             if ($mail->email == $email) {
 539                 $mail->set_rewrite($redirect);
 540                 check_redirect($this);
 541                 return;
 542             }
 543         }
 544     }
 545
 546     // function clean_errors() {{{2
 547
 548     public function clean_errors($email)
 549     {
 550         foreach ($this->emails as &$mail) {
 551             if ($mail->email == $email) {
 552                 check_redirect($this);
 553                 return $mail->clean_errors();
 554             }
 555         }
 556         return false;
 557     }
 558
 559     // function disable() {{{2
 560
 561     public function disable()
 562     {
 563         XDB::execute("UPDATE  emails
 564                          SET  flags = 'disable'
 565                        WHERE  flags = 'active' AND uid = {?}", $this->uid);
 566         foreach ($this->emails as &$mail) {
 567             if ($mail->active && $mail->has_disable()) {
 568                 $mail->disabled = true;
 569                 $mail->active   = false;
 570             }
 571         }
 572         check_redirect($this);
 573     }
 574
 575     // function enable() {{{2
 576
 577     public function enable()
 578     {
 579         XDB::execute("UPDATE  emails
 580                          SET  flags = 'active'
 581                        WHERE  flags = 'disable' AND uid = {?}", $this->uid);
 582         foreach ($this->emails as &$mail) {
 583             if ($mail->disabled) {
 584                 $mail->active   = true;
 585                 $mail->disabled = false;
 586             }
 587             check_redirect($this);
 588         }
 589     }
 590
 591     // function get_broken_mx() {{{2
 592
 593     public function get_broken_mx()
 594     {
 595         $res = XDB::query("SELECT  host, text
 596                              FROM  mx_watch
 597                             WHERE  state != 'ok'");
 598         if (!$res->numRows()) {
 599             return array();
 600         }
 601         $mxs = $res->fetchAllAssoc();
 602         $mails = array();
 603         foreach ($this->emails as &$mail) {
 604             if ($mail->active && strstr($mail->email, '@') !== false) {
 605                 list(,$domain) = explode('@', $mail->email);
 606                 getmxrr($domain, $lcl_mxs);
 607                 if (empty($lcl_mxs)) {
 608                     $lcl_mxs = array($domain);
 609                 }
 610                 $broken = false;
 611                 foreach ($mxs as &$mx) {
 612                     foreach ($lcl_mxs as $lcl) {
 613                         if (fnmatch($mx['host'], $lcl)) {
 614                             $broken = $mx['text'];
 615                             break;
 616                         }
 617                     }
 618                     if ($broken) {
 619                         $mails[] = array('mail' => $mail->email, 'text' => $broken);
 620                         break;
 621                     }
 622                 }
 623             }
 624         }
 625         return $mails;
 626     }
 627
 628     // function active_emails() {{{2
 629
 630     public function active_emails()
 631     {
 632         $emails = array();
 633         foreach ($this->emails as $mail) {
 634             if ($mail->active) {
 635                 $emails[] = $mail;
 636             }
 637         }
 638         return $emails;
 639     }
 640
 641     // function get_uid() {{{2
 642
 643     public function get_uid()
 644     {
 645         return $this->uid;
 646     }
 647 }
 648
 649 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 650 ?>