include/emails.inc.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2011 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 // Checks if an email update is required in MLs and aliases.
  28 // This occurs when the user don't have email permissions and her email has changed.
  29 function require_email_update(User $user, $new_email)
  30 {
  31     Platal::assert(!is_null($user), 'User cannot be null.');
  32
  33     return !$user->checkPerms(User::PERM_MAIL) && $new_email != $user->forlifeEmail();
  34 }
  35
  36 function format_email_alias($email)
  37 {
  38     if ($user = User::getSilent($email)) {
  39         return $user->forlifeEmail();
  40     }
  41     if (isvalid_email($email)) {
  42         return $email;
  43     }
  44     return null;
  45 }
  46
  47 function add_to_list_alias($email, $local_part, $domain, $type = 'alias')
  48 {
  49     $email = format_email_alias($email);
  50     if (is_null($email)) {
  51         return false;
  52     }
  53
  54     XDB::execute('INSERT IGNORE INTO  email_virtual (email, domain, redirect, type)
  55                               SELECT  {?}, id, {?}, {?}
  56                                 FROM  email_virtual_domains
  57                                WHERE  name = {?}',
  58                  $local_part, $email, $type, $domain);
  59     return true;
  60 }
  61
  62 function delete_from_list_alias($email, $local_part, $domain, $type = 'alias')
  63 {
  64     $email = format_email_alias($email);
  65     if (is_null($email)) {
  66         return false;
  67     }
  68
  69     XDB::execute('DELETE  v
  70                     FROM  email_virtual         AS v
  71               INNER JOIN  email_virtual_domains AS m ON (v.domain = m.id)
  72               INNER JOIN  email_virtual_domains AS d ON (d.aliasing = m.id)
  73                    WHERE  v.email = {?} AND d.name = {?} AND v.redirect = {?} AND type = {?}',
  74                  $local_part, $domain, $email, $type);
  75     return true;
  76 }
  77
  78 function update_list_alias($email, $former_email, $local_part, $domain, $type = 'alias')
  79 {
  80     $email = format_email_alias($email);
  81     if (is_null($email)) {
  82         return false;
  83     }
  84
  85     XDB::execute('UPDATE  email_virtual         AS v
  86               INNER JOIN  email_virtual_domains AS d ON (v.domain = d.id)
  87                      SET  v.redirect = {?}
  88                    WHERE  v.redirect = {?} AND d.name = {?} AND v.email = {?} AND v.type = {?}',
  89                  $email, $former_email, $domain, $local_part, $type);
  90     return true;
  91 }
  92
  93 // Updates an email in all aliases (groups and events).
  94 function update_alias_user($former_email, $new_email)
  95 {
  96     XDB::execute('UPDATE  email_virtual
  97                      SET  redirect = {?}
  98                    WHERE  redirect = {?} AND (type = \'alias\' OR type = \'event\')',
  99                  $new_email, $former_email);
 100 }
 101
 102 function list_alias_members($local_part, $domain)
 103 {
 104     $emails = XDB::fetchColumn('SELECT  DISTINCT(redirect)
 105                                   FROM  email_virtual         AS v
 106                             INNER JOIN  email_virtual_domains AS m ON (v.domain = m.id)
 107                             INNER JOIN  email_virtual_domains AS d ON (d.aliasing = m.id)
 108                                  WHERE  v.email = {?} AND d.name = {?} AND type = \'alias\'',
 109                                $local_part, $domain);
 110
 111     $users = array();
 112     $nonusers = array();
 113     foreach ($emails as $email) {
 114         if ($user = User::getSilent($email)) {
 115             $users[] = $user;
 116         } else {
 117             $nonusers[] = $email;
 118         }
 119     }
 120
 121     return array(
 122         'users'    => $users,
 123         'nonusers' => $nonusers
 124     );
 125 }
 126
 127 function delete_list_alias($local_part, $domain)
 128 {
 129     XDB::execute('DELETE  v
 130                     FROM  email_virtual         AS v
 131               INNER JOIN  email_virtual_domains AS m ON (v.domain = m.id)
 132               INNER JOIN  email_virtual_domains AS d ON (d.aliasing = m.id)
 133                    WHERE  v.email = {?} AND d.name = {?} AND type = \'alias\'',
 134                  $local_part, $domain);
 135 }
 136
 137 function iterate_list_alias($domain)
 138 {
 139     return XDB::fetchColumn('SELECT  CONCAT(v.email, \'@\', m.name)
 140                                FROM  email_virtual         AS v
 141                          INNER JOIN  email_virtual_domains AS m ON (v.domain = m.id)
 142                               WHERE  m.name = {?} AND v.type = \'alias\'
 143                            GROUP BY  v.email',
 144                             $domain);
 145 }
 146
 147 function create_list($local_part, $domain)
 148 {
 149     global $globals;
 150
 151     $redirect = $domain . '_' . $local_part . '+';
 152     foreach(array('post', 'owner', 'admin', 'bounces', 'unsubscribe') as $suffix) {
 153         XDB::execute('INSERT IGNORE INTO  email_virtual (email, domain, redirect, type)
 154                                   SELECT  {?}, id, {?}, \'list\'
 155                                     FROM  email_virtual_domains
 156                                    WHERE  name = {?}',
 157                      ($suffix == 'post') ? $local_part : $local_part . '-' . $suffix,
 158                      $redirect . $suffix . '@' . $globals->lists->redirect_domain, $domain);
 159     }
 160 }
 161
 162 function delete_list($local_part, $domain)
 163 {
 164     global $globals;
 165
 166     $redirect = $domain . '_' . $local_part . '+';
 167     foreach(array('post', 'owner', 'admin', 'bounces', 'unsubscribe') as $suffix) {
 168         XDB::execute('DELETE FROM  email_virtual
 169                             WHERE  redirect = {?} AND type = \'list\'',
 170                      $redirect . $suffix . '@' . $globals->lists->redirect_domain);
 171     }
 172 }
 173
 174 function list_exist($local_part, $domain)
 175 {
 176     return XDB::fetchOneCell('SELECT  COUNT(*)
 177                                 FROM  email_virtual         AS v
 178                           INNER JOIN  email_virtual_domains AS m ON (v.domain = m.id)
 179                           INNER JOIN  email_virtual_domains AS d ON (m.id = d.aliasing)
 180                                WHERE  v.email = {?} AND d.name = {?}',
 181                              $local_part, $domain);
 182 }
 183
 184 // function mark_broken_email() {{{1
 185 function mark_broken_email($email, $admin = false)
 186 {
 187     $email = valide_email($email);
 188     if (empty($email) || $email == '@') {
 189         return;
 190     }
 191
 192     $user = XDB::fetchOneAssoc('SELECT  r1.uid, r1.broken_level != 0 AS broken, COUNT(r2.uid) AS nb_mails,
 193                                         s.email AS alias, DATE_ADD(r1.last, INTERVAL 14 DAY) < CURDATE() as notify
 194                                   FROM  email_redirect_account AS r1
 195                             INNER JOIN  accounts               AS a  ON (a.uid = r1.uid)
 196                             INNER JOIN  email_source_account   AS s  ON (a.uid = s.uid AND s.flags = \'bestalias\')
 197                              LEFT JOIN  email_redirect_account AS r2 ON (a.uid = r2.uid AND r1.redirect != r2.redirect AND
 198                                                                          r2.broken_level = 0 AND r2.flags = \'active\' AND
 199                                                                          (r2.type = \'smtp\' OR r2.type = \'googleapps\'))
 200                                  WHERE  r1.redirect = {?}
 201                               GROUP BY  r1.uid', $email);
 202
 203     if ($user) {
 204         // Mark address as broken.
 205         if (!$user['broken']) {
 206             XDB::execute('UPDATE  email_redirect_account
 207                              SET  broken_date = NOW(), last = NOW(), broken_level = 1
 208                            WHERE  redirect = {?}', $email);
 209         } elseif ($admin) {
 210             XDB::execute('UPDATE  email_redirect_account
 211                              SET  last = CURDATE(), broken_level = broken_level + 1
 212                            WHERE  redirect = {?} AND DATE_ADD(last, INTERVAL 14 DAY) < CURDATE()',
 213                          $email);
 214         } else {
 215             XDB::execute('UPDATE  email_redirect_account
 216                              SET  broken_level = 1
 217                            WHERE  redirect = {?} AND broken_level = 0', $email);
 218         }
 219     }
 220
 221     return $user;
 222 }
 223
 224 // function fix_bestalias() {{{1
 225 // Checks for an existing 'bestalias' among the the current user's aliases, and
 226 // eventually selects a new bestalias when required.
 227 function fix_bestalias(User $user)
 228 {
 229     // First check if the bestalias is properly set.
 230     $alias_count = XDB::fetchOneCell('SELECT  COUNT(*)
 231                                         FROM  email_source_account
 232                                        WHERE  uid = {?} AND FIND_IN_SET(\'bestalias\', flags) AND expire IS NULL',
 233                                      $user->id());
 234
 235     if ($alias_count > 1) {
 236         // If too many bestaliases, delete the bestalias flag from all this
 237         // user's emails (this should never happen).
 238         XDB::execute("UPDATE  email_source_account
 239                          SET  flags = TRIM(BOTH ',' FROM REPLACE(CONCAT(',', flags, ','), ',bestalias,', ','))
 240                        WHERE  uid = {?}",
 241                      $user->id());
 242     }
 243      if ($alias_count != 1) {
 244         // If no bestalias is selected, we choose the shortest email which is not
 245         // related to a usage name and contains a '.'.
 246         XDB::execute("UPDATE  email_source_account
 247                          SET  flags = CONCAT_WS(',', IF(flags = '', NULL, flags), 'bestalias')
 248                        WHERE  uid = {?} AND expire IS NULL
 249                     ORDER BY  NOT FIND_IN_SET('usage', flags), email LIKE '%.%', LENGTH(email)
 250                        LIMIT  1",
 251                      $user->id());
 252      }
 253
 254     // First check if best_domain is properly set.
 255     $domain_count = XDB::fetchOneCell('SELECT  COUNT(*)
 256                                          FROM  accounts              AS a
 257                                    INNER JOIN  email_source_account  AS s ON (s.uid = a.uid AND FIND_IN_SET(\'bestalias\', s.flags))
 258                                    INNER JOIN  email_virtual_domains AS d ON (d.id = a.best_domain)
 259                                    INNER JOIN  email_virtual_domains AS m ON (d.aliasing = m.id)
 260                                    INNER JOIN  email_virtual_domains AS v ON (v.aliasing = m.id AND v.id = s.domain)
 261                                         WHERE  a.uid = {?} AND (m.name = {?} OR m.name = {?})',
 262                                       $user->id(), $user->mainEmailDomain(), Platal::globals()->mail->alias_dom);
 263
 264     if ($domain_count == 0) {
 265         XDB::execute('UPDATE  accounts              AS a
 266                   INNER JOIN  email_source_account  AS s ON (s.uid = a.uid AND FIND_IN_SET(\'bestalias\', s.flags))
 267                   INNER JOIN  email_virtual_domains AS d ON (d.aliasing = s.domain AND (d.name = {?} OR d.name = {?}))
 268                          SET  a.best_domain = d.id
 269                        WHERE  a.uid = {?}',
 270                      $user->mainEmailDomain(), Platal::globals()->mail->alias_dom, $user->id());
 271     }
 272
 273
 274 }
 275
 276 // function valide_email() {{{1
 277 // Returns a cleaned-up version of the @p email string. It removes garbage
 278 // characters, and determines the canonical form (without _ and +) for
 279 // Polytechnique.org email addresses.
 280 function valide_email($str)
 281 {
 282     global $globals;
 283
 284     $em = trim(rtrim($str));
 285     $em = str_replace('<', '', $em);
 286     $em = str_replace('>', '', $em);
 287     if (strpos($em, '@') === false) {
 288         return;
 289     }
 290     list($ident, $dom) = explode('@', $em);
 291     if (User::isMainMailDomain($dom)) {
 292         list($ident1) = explode('_', $ident);
 293         list($ident) = explode('+', $ident1);
 294     }
 295     return $ident . '@' . $dom;
 296 }
 297
 298 // function isvalid_email_redirection() {{{1
 299 /** Checks if an email is a suitable redirection.
 300  * @param $email the email to check
 301  * @return BOOL
 302  */
 303 function isvalid_email_redirection($email)
 304 {
 305     return isvalid_email($email) && !preg_match("/@polytechnique\.edu$/", $email) && User::isForeignEmailAddress($email);
 306 }
 307
 308 // function ids_from_mails() {{{1
 309 // Converts an array of emails to an array of email => uid, where email is the
 310 // given email when we found a matching user.
 311 function ids_from_mails(array $emails)
 312 {
 313     // Removes duplicates, if any.
 314     $emails = array_unique($emails);
 315
 316     // Formats and splits by domain type (locally managed or external) emails.
 317     $main_domain_emails = array();
 318     $aux_domain_emails = array();
 319     $other_emails = array();
 320     foreach ($emails as $email) {
 321         if (strpos($email, '@') === false) {
 322             $main_domain_emails[] = $email;
 323         } else {
 324             if (User::isForeignEmailAddress($email)) {
 325                 $other_emails[$email] = strtolower($user . '@' . $domain);
 326             } else {
 327                 list($local_part, $domain) = explode('@', $email);
 328                 list($local_part) = explode('+', $local_part);
 329                 list($local_part) = explode('_', $local_part);
 330                 if (User::isMainMailDomain($domain)) {
 331                     $main_domain_emails[$email] = strtolower($local_part);
 332                 } elseif (User::isAliasMailDomain($domain)) {
 333                     $aux_domain_emails[$email] = strtolower($local_part);
 334                 }
 335             }
 336         }
 337     }
 338
 339     // Retrieves emails from our domains.
 340     $main_domain_uids = XDB::fetchAllAssoc('email',
 341                                            'SELECT  email, uid
 342                                               FROM  email_source_account
 343                                              WHERE  email IN {?} AND type != \'alias_aux\'',
 344                                            array_unique($main_domain_emails));
 345     $aux_domain_uids = XDB::fetchAllAssoc('email',
 346                                           'SELECT  email, uid
 347                                              FROM  email_source_account
 348                                             WHERE  email IN {?} AND type = \'alias_aux\'',
 349                                           array_unique($aux_domain_emails));
 350
 351     // Retrieves emails from redirections.
 352     $other_uids = XDB::fetchAllAssoc('redirect',
 353                                      'SELECT  redirect, uid
 354                                         FROM  email_redirect_account
 355                                        WHERE  redirect IN {?}',
 356                                      array_unique($other_emails));
 357
 358     // Associates given emails with the corresponding uid.
 359     $uids = array();
 360     foreach ($main_domain_emails as $email => $key) {
 361         $uids[$email] = $main_domain_uids[$key];
 362     }
 363     foreach ($aux_domain_emails as $email => $key) {
 364         $uids[$email] = $aux_domain_uids[$key];
 365     }
 366     foreach ($other_emails as $email => $key) {
 367         $uids[$email] = $other_uids[$key];
 368     }
 369
 370     return array_unique($uids);
 371 }
 372
 373 // class Bogo {{{1
 374 // The Bogo class represents a spam filtering level in plat/al architecture.
 375 class Bogo
 376 {
 377     public static $states = array(
 378         0 => 'default',
 379         1 => 'let_spams',
 380         2 => 'tag_spams',
 381         3 => 'tag_and_drop_spams',
 382         4 => 'drop_spams'
 383     );
 384
 385     private $user;
 386     public $state;
 387     public $single_state;
 388     public $redirections;
 389     public $single_redirection;
 390
 391     public function __construct(User $user)
 392     {
 393         if (!$user) {
 394             return;
 395         }
 396
 397         $this->user = &$user;
 398         $res = XDB::fetchOneAssoc('SELECT  COUNT(DISTINCT(action)) AS action_count, COUNT(redirect) AS redirect_count, action
 399                                      FROM  email_redirect_account
 400                                     WHERE  uid = {?} AND (type = \'smtp\' OR type = \'googleapps\') AND flags = \'active\'
 401                                  GROUP BY  uid',
 402                                   $user->id());
 403         if ($res['redirect_count'] == 0) {
 404             return;
 405         }
 406
 407         $this->single_redirection = ($res['redirect_count'] == 1);
 408         $this->redirections = XDB::fetchAllAssoc('SELECT  IF(type = \'googleapps\', type, redirect) AS redirect, type, action
 409                                                     FROM  email_redirect_account
 410                                                    WHERE  uid = {?} AND (type = \'smtp\' OR type = \'googleapps\')
 411                                                 ORDER BY  type, redirect',
 412                                                  $user->id());
 413
 414         foreach ($this->redirections AS &$redirection) {
 415             $redirection['filter'] = array_search($redirection['action'], self::$states);
 416         }
 417         if ($res['action_count'] == 1) {
 418             $this->state = array_search($res['action'], self::$states);
 419             $this->single_state = true;
 420         } else {
 421             $this->single_state = $this->state = false;
 422         }
 423     }
 424
 425     public function changeAll($state)
 426     {
 427         Platal::assert($state >= 0 && $state < count(self::$states), 'Unknown antispam level.');
 428
 429         $this->state = $state;
 430         XDB::execute('UPDATE  email_redirect_account
 431                          SET  action = {?}
 432                        WHERE  uid = {?} AND (type = \'smtp\' OR type = \'googleapps\')',
 433                      self::$states[$this->state], $this->user->id());
 434     }
 435
 436     public function change($redirection, $state)
 437     {
 438         Platal::assert($state >= 0 && $state < count(self::$states), 'Unknown antispam level.');
 439
 440         XDB::execute('UPDATE  email_redirect_account
 441                          SET  action = {?}
 442                        WHERE  uid = {?} AND (type = {?} OR redirect = {?})',
 443                      self::$states[$state], $this->user->id(), $redirection, $redirection);
 444     }
 445 }
 446
 447 // class Email {{{1
 448 // Represents an "email address" used as final recipient for plat/al-managed
 449 // addresses.
 450 class Email
 451 {
 452     // Lists fields to load automatically.
 453     static private $field_names = array('rewrite', 'type', 'action', 'broken_date', 'broken_level', 'last', 'hash', 'allow_rewrite');
 454
 455     // Shortname to realname mapping for known mail storage backends.
 456     static private $display_names = array(
 457         'imap'       => 'Accès de secours aux emails (IMAP)',
 458         'googleapps' => 'Compte Google Apps',
 459     );
 460     static private $storage_domains = array(
 461         'imap'       => 'imap',
 462         'googleapps' => 'g'
 463     );
 464
 465     private $user;
 466
 467     // Basic email properties; $sufficient indicates if the email can be used as
 468     // an unique redirection; $redirect contains the delivery email address.
 469     public $type;
 470     public $sufficient;
 471     public $email;
 472     public $display_email;
 473     public $domain;
 474     public $action;
 475     public $filter_level;
 476
 477     // Redirection status properties.
 478     public $active;
 479     public $inactive;
 480     public $broken;
 481     public $disabled;
 482     public $rewrite;
 483     public $allow_rewrite;
 484     public $hash;
 485
 486     // Redirection bounces stats.
 487     public $last;
 488     public $broken_level;
 489     public $broken_date;
 490
 491     public function __construct(User $user, array $row)
 492     {
 493         foreach (self::$field_names as $field) {
 494             if (array_key_exists($field, $row)) {
 495                 $this->$field = $row[$field];
 496             }
 497         }
 498         $this->email = $row['redirect'];
 499
 500         if (array_key_exists($this->type, Email::$display_names)) {
 501             $this->display_email = self::$display_names[$this->type];
 502         } else {
 503             $this->display_email = $this->email;
 504         }
 505         foreach (array('active', 'inactive', 'broken', 'disabled') as $status) {
 506             $this->$status = ($status == $row['flags']);
 507         }
 508         $this->sufficient = ($this->type == 'smtp' || $this->type == 'googleapps');
 509         $this->filter_level = ($this->type == 'imap') ? null : array_search($this->action, Bogo::$states);
 510         $this->user = &$user;
 511     }
 512
 513     // Activates the email address as a redirection.
 514     public function activate()
 515     {
 516         if ($this->inactive) {
 517             XDB::execute('UPDATE  email_redirect_account
 518                              SET  broken_level = IF(flags = \'broken\', broken_level - 1, broken_level), flags = \'active\'
 519                            WHERE  uid = {?} AND redirect = {?}',
 520                          $this->user->id(), $this->email);
 521             S::logger()->log('email_on', $this->email . ($this->user->id() != S::v('uid') ? "(admin on {$this->user->login()})" : ''));
 522             $this->inactive = false;
 523             $this->active   = true;
 524         }
 525     }
 526
 527     // Deactivates the email address as a redirection.
 528     public function deactivate()
 529     {
 530         if ($this->active) {
 531             XDB::execute('UPDATE  email_redirect_account
 532                              SET  flags = \'inactive\'
 533                            WHERE  uid = {?} AND redirect = {?}',
 534                          $this->user->id(), $this->email);
 535             S::logger()->log('email_off', $this->email . ($this->user->id() != S::v('uid') ? "(admin on {$this->user->login()})" : "") );
 536             $this->inactive = true;
 537             $this->active   = false;
 538         }
 539     }
 540
 541
 542     // Sets the rewrite rule for the given address.
 543     public function set_rewrite($rewrite)
 544     {
 545         if ($this->type != 'smtp' || $this->rewrite == $rewrite) {
 546             return;
 547         }
 548         if (!$rewrite || !isvalid_email($rewrite)) {
 549             $rewrite = '';
 550         }
 551         XDB::execute('UPDATE  email_redirect_account
 552                          SET  rewrite = {?}
 553                        WHERE  uid = {?} AND redirect = {?} AND type = \'smtp\'',
 554                      $rewrite, $this->user->id(), $this->email);
 555         $this->rewrite = $rewrite;
 556         if (!$this->allow_rewrite) {
 557             global $globals;
 558             if (empty($this->hash)) {
 559                 $this->hash = rand_url_id();
 560                 XDB::execute('UPDATE  email_redirect_account
 561                                  SET  hash = {?}
 562                                WHERE  uid = {?} AND redirect = {?} AND type = \'smtp\'',
 563                              $this->hash, $this->user->id(), $this->email);
 564             }
 565             $mail = new PlMailer('emails/rewrite-in.mail.tpl');
 566             $mail->assign('mail', $this);
 567             $mail->assign('user', $this->user);
 568             $mail->assign('baseurl', $globals->baseurl);
 569             $mail->assign('sitename', $globals->core->sitename);
 570             $mail->assign('to', $this->email);
 571             $mail->send($this->user->isEmailFormatHtml());
 572         }
 573     }
 574
 575
 576     // Resets the error counts associated with the redirection.
 577     public function clean_errors()
 578     {
 579         if ($this->type != 'smtp') {
 580             return;
 581         }
 582         if (!S::admin()) {
 583             return false;
 584         }
 585         $this->broken       = 0;
 586         $this->broken_level = 0;
 587         $this->last         = 0;
 588         return XDB::execute('UPDATE  email_redirect_account
 589                                 SET  broken_level = 0, broken_date = 0, last = 0
 590                               WHERE  uid = {?} AND redirect = {?} AND type = \'smtp\'',
 591                             $this->user->id(), $this->email);
 592     }
 593
 594
 595     // Email backend capabilities ('rewrite' refers to From: rewrite for mails
 596     // forwarded by Polytechnique.org's MXs; 'removable' indicates if the email
 597     // can be definitively removed; 'disable' indicates if the email has a third
 598     // status 'disabled' in addition to 'active' and 'inactive').
 599     public function has_rewrite()
 600     {
 601         return ($this->type == 'smtp');
 602     }
 603
 604     public function is_removable()
 605     {
 606         return ($this->type == 'smtp');
 607     }
 608
 609     public function has_disable()
 610     {
 611         return true;
 612     }
 613
 614     public function is_redirection()
 615     {
 616         return ($this->type == 'smtp');
 617     }
 618
 619     // Returns the list of allowed storages for the @p user.
 620     static private function get_allowed_storages(User $user)
 621     {
 622         global $globals;
 623         $storages = array();
 624
 625         // Google Apps storage is available for users with valid Google Apps account.
 626         require_once 'googleapps.inc.php';
 627         if ($user->checkPerms('gapps') &&
 628             $globals->mailstorage->googleapps_domain &&
 629             GoogleAppsAccount::account_status($user->id()) == 'active') {
 630             $storages[] = 'googleapps';
 631         }
 632
 633         // IMAP storage is always visible to administrators, and is allowed for
 634         // everyone when the service is marked as 'active'.
 635         if ($globals->mailstorage->imap_active || S::admin()) {
 636             $storages[] = 'imap';
 637         }
 638
 639         return $storages;
 640     }
 641
 642     static public function activate_storage(User $user, $storage)
 643     {
 644         Platal::assert(in_array($storage, self::get_allowed_storages($user)), 'Unknown storage.');
 645
 646         if (!self::is_active_storage($user, $storage)) {
 647             global $globals;
 648
 649             XDB::execute('INSERT INTO  email_redirect_account (uid, type, redirect, flags)
 650                                VALUES  ({?}, {?}, {?}, \'active\')',
 651                          $user->id(), $storage,
 652                          $user->hruid . '@' . self::$storage_domains[$storage] . '.' . $globals->mail->domain);
 653         }
 654     }
 655
 656     static public function deactivate_storage(User $user, $storage)
 657     {
 658         if (in_array($storage, self::$storage_domains)) {
 659             XDB::execute('DELETE FROM  email_redirect_account
 660                                 WHERE  uid = {?} AND type = {?}',
 661                          $user->id(), $storage);
 662             }
 663     }
 664
 665     static public function is_active_storage(User $user, $storage)
 666     {
 667         if (!in_array($storage, self::$storage_domains)) {
 668             return false;
 669         }
 670         $res = XDB::fetchOneCell('SELECT  COUNT(*)
 671                                     FROM  email_redirect_account
 672                                    WHERE  uid = {?} AND type = {?} AND flags = \'active\'',
 673                                  $user->id(), $storage);
 674         return !is_null($res) && $res > 0;
 675     }
 676 }
 677 // class Redirect {{{1
 678 // Redirect is a placeholder class for an user's active redirections (third-party
 679 // redirection email, or Polytechnique.org mail storages).
 680 class Redirect
 681 {
 682     private $flags = 'active';
 683     private $user;
 684
 685     public $emails;
 686
 687     public function __construct(User $user)
 688     {
 689         $this->user = &$user;
 690
 691         // Adds third-party email redirections.
 692         $res = XDB::iterator('SELECT  redirect, rewrite, type, action, broken_date, broken_level, last, flags, hash, allow_rewrite
 693                                 FROM  email_redirect_account
 694                                WHERE  uid = {?} AND type != \'homonym\'',
 695                             $user->id());
 696         $this->emails = array();
 697         while ($row = $res->next()) {
 698             $this->emails[] = new Email($user, $row);
 699         }
 700     }
 701
 702     public function other_active($email)
 703     {
 704         foreach ($this->emails as $mail) {
 705             if ($mail->email != $email && $mail->active && $mail->sufficient) {
 706                 return true;
 707             }
 708         }
 709         return false;
 710     }
 711
 712     public function delete_email($email)
 713     {
 714         if (!$this->other_active($email)) {
 715             return ERROR_INACTIVE_REDIRECTION;
 716         }
 717         XDB::execute('DELETE FROM  email_redirect_account
 718                             WHERE  uid = {?} AND redirect = {?} AND type != \'homonym\'',
 719                      $this->user->id(), $email);
 720         S::logger()->log('email_del', $email . ($this->user->id() != S::v('uid') ? " (admin on {$this->user->login()})" : ""));
 721         foreach ($this->emails as $i => $mail) {
 722             if ($email == $mail->email) {
 723                 unset($this->emails[$i]);
 724             }
 725         }
 726         check_redirect($this);
 727         $this->update_imap();
 728         return SUCCESS;
 729     }
 730
 731     public function add_email($email)
 732     {
 733         $email_stripped = strtolower(trim($email));
 734         if (!isvalid_email($email_stripped)) {
 735             return ERROR_INVALID_EMAIL;
 736         }
 737         if (!isvalid_email_redirection($email_stripped)) {
 738             return ERROR_LOOP_EMAIL;
 739         }
 740         // We first need to retrieve the value for the antispam filter: it is
 741         // either the user's redirections common value, or if they differ, our
 742         // default value.
 743         $bogo = new Bogo($this->user);
 744         $filter = ($bogo->single_state ? Bogo::$states[$bogo->state] : Bogo::$states[0]);
 745         // If the email was already present for this user, we reset it to the default values, we thus use REPLACE INTO.
 746         XDB::execute('REPLACE INTO  email_redirect_account (uid, redirect, flags, action)
 747                             VALUES  ({?}, {?}, \'active\', {?})',
 748                      $this->user->id(), $email, $filter);
 749         if ($logger = S::v('log', null)) { // may be absent --> step4.php
 750             S::logger()->log('email_add', $email . ($this->user->id() != S::v('uid') ? " (admin on {$this->user->login()})" : ""));
 751         }
 752         foreach ($this->emails as $mail) {
 753             if ($mail->email == $email_stripped) {
 754                 return SUCCESS;
 755             }
 756         }
 757         $this->emails[] = new Email($this->user, array(
 758                 'redirect'      => $email,
 759                 'rewrite'       => '',
 760                 'type'          => 'smtp',
 761                 'action'        => $filter,
 762                 'broken_date'   => '0000-00-00',
 763                 'broken_level'  => 0,
 764                 'last'          => '0000-00-00',
 765                 'flags'         => 'active',
 766                 'hash'          => null,
 767                 'allow_rewrite' => 0
 768         ));
 769
 770         // security stuff
 771         check_email($email, "Ajout d'une adresse surveillée aux redirections de " . $this->user->login());
 772         check_redirect($this);
 773         $this->update_imap();
 774         return SUCCESS;
 775     }
 776
 777     public function modify_email($emails_actifs, $emails_rewrite)
 778     {
 779         foreach ($this->emails as &$email) {
 780             if (in_array($email->email, $emails_actifs)) {
 781                 $email->activate();
 782             } else {
 783                 $email->deactivate();
 784             }
 785             $email->set_rewrite($emails_rewrite[$email->email]);
 786         }
 787         check_redirect($this);
 788         $this->update_imap();
 789         return SUCCESS;
 790     }
 791
 792     public function modify_one_email($email, $activate)
 793     {
 794         $allinactive = true;
 795         $thisone = false;
 796         foreach ($this->emails as $i=>$mail) {
 797             if ($mail->email == $email) {
 798                 $thisone = $i;
 799             }
 800             $allinactive &= !$mail->active || !$mail->sufficient || $mail->email == $email;
 801         }
 802         if ($thisone === false) {
 803             return ERROR_INVALID_EMAIL;
 804         }
 805         if ($allinactive || $activate) {
 806             $this->emails[$thisone]->activate();
 807         } else {
 808             $this->emails[$thisone]->deactivate();
 809         }
 810         check_redirect($this);
 811         $this->update_imap();
 812         if ($allinactive && !$activate) {
 813             return ERROR_INACTIVE_REDIRECTION;
 814         }
 815         return SUCCESS;
 816     }
 817
 818     public function modify_one_email_redirect($email, $redirect)
 819     {
 820         foreach ($this->emails as &$mail) {
 821             if ($mail->email == $email) {
 822                 $mail->set_rewrite($redirect);
 823                 check_redirect($this);
 824                 $this->update_imap();
 825                 return;
 826             }
 827         }
 828     }
 829
 830     public function clean_errors($email)
 831     {
 832         foreach ($this->emails as &$mail) {
 833             if ($mail->email == $email) {
 834                 check_redirect($this);
 835                 $this->update_imap();
 836                 return $mail->clean_errors();
 837             }
 838         }
 839         return false;
 840     }
 841
 842     public function disable()
 843     {
 844         XDB::execute("UPDATE  email_redirect_account
 845                          SET  flags = 'disable'
 846                        WHERE  flags = 'active' AND uid = {?}", $this->user->id());
 847         foreach ($this->emails as &$mail) {
 848             if ($mail->active && $mail->has_disable()) {
 849                 $mail->disabled = true;
 850                 $mail->active   = false;
 851             }
 852         }
 853         check_redirect($this);
 854         $this->update_imap();
 855     }
 856
 857     public function enable()
 858     {
 859         XDB::execute("UPDATE  email_redirect_account
 860                          SET  flags = 'active'
 861                        WHERE  flags = 'disable' AND uid = {?}", $this->user->id());
 862         foreach ($this->emails as &$mail) {
 863             if ($mail->disabled) {
 864                 $mail->disabled = false;
 865                 $mail->active   = true;
 866             }
 867             check_redirect($this);
 868         }
 869         $this->update_imap();
 870     }
 871
 872     public function get_broken_mx()
 873     {
 874         $res = XDB::query("SELECT  host, text
 875                              FROM  mx_watch
 876                             WHERE  state != 'ok'");
 877         if (!$res->numRows()) {
 878             return array();
 879         }
 880         $mxs = $res->fetchAllAssoc();
 881         $mails = array();
 882         foreach ($this->emails as &$mail) {
 883             if ($mail->active && strstr($mail->email, '@') !== false) {
 884                 list(,$domain) = explode('@', $mail->email);
 885                 getmxrr($domain, $lcl_mxs);
 886                 if (empty($lcl_mxs)) {
 887                     $lcl_mxs = array($domain);
 888                 }
 889                 $broken = false;
 890                 foreach ($mxs as &$mx) {
 891                     foreach ($lcl_mxs as $lcl) {
 892                         if (fnmatch($mx['host'], $lcl)) {
 893                             $broken = $mx['text'];
 894                             break;
 895                         }
 896                     }
 897                     if ($broken) {
 898                         $mails[] = array('mail' => $mail->email, 'text' => $broken);
 899                         break;
 900                     }
 901                 }
 902             }
 903         }
 904         return $mails;
 905     }
 906
 907     public function active_emails()
 908     {
 909         $emails = array();
 910         foreach ($this->emails as $mail) {
 911             if ($mail->active) {
 912                 $emails[] = $mail;
 913             }
 914         }
 915         return $emails;
 916     }
 917
 918     public function get_uid()
 919     {
 920         return $this->user->id();
 921     }
 922
 923     private function update_imap()
 924     {
 925         // Imaps must bounce if and only if the user has no active redirection.
 926         if (!$this->other_active('')) {
 927             XDB::execute('UPDATE  email_redirect_account
 928                              SET  action = \'imap_and_bounce\'
 929                            WHERE  type = \'imap\' AND uid = {?}',
 930                          $this->user->id());
 931         } else {
 932             XDB::execute('UPDATE  email_redirect_account
 933                              SET  action = \'let_spams\'
 934                            WHERE  type = \'imap\' AND uid = {?}',
 935                          $this->user->id());
 936         }
 937     }
 938 }
 939
 940 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 941 ?>