Refactors the Email/Redirect classes, to prepare for MailStorage integration.

Signed-off-by: Vincent Zanotti <vincent.zanotti@polytechnique.org>

diff --git a/include/emails.inc.php b/include/emails.inc.php
index 4909b68..357dd0d 100644 (file)
--- a/include/emails.inc.php
+++ b/include/emails.inc.php
@@ -27,13 +27,18 @@ define("ERROR_INVALID_EMAIL", 3);
 define("ERROR_LOOP_EMAIL", 4);
 
 // function fix_bestalias() {{{1
-
+// Checks for an existing 'bestalias' among the the current user's aliases, and
+// eventually selects a new bestalias when required.
 function fix_bestalias($uid)
 {
-    $res = XDB::query("SELECT COUNT(*) FROM aliases WHERE id={?} AND FIND_IN_SET('bestalias',flags) AND type!='homonyme'", $uid);
-    if ($n = $res->fetchOneCell()) {
+    $res = XDB::query("SELECT  COUNT(*)
+                         FROM  aliases
+                        WHERE  id = {?} AND FIND_IN_SET('bestalias', flags) AND type != 'homonyme'",
+                      $uid);
+    if ($res->fetchOneCell()) {
         return;
     }
+
     XDB::execute("UPDATE  aliases
                      SET  flags=CONCAT(flags,',','bestalias')
                    WHERE  id={?} AND type!='homonyme'
@@ -42,7 +47,9 @@ function fix_bestalias($uid)
 }
 
 // function valide_email() {{{1
-
+// Returns a cleaned-up version of the @p email string. It removes garbage
+// characters, and determines the canonical form (without _ and +) for
+// Polytechnique.org email addresses.
 function valide_email($str)
 {
     global $globals;
@@ -59,11 +66,12 @@ function valide_email($str)
 }
 
 // class Bogo {{{1
-
+// The Bogo class represents a spam filtering level in plat/al architecture.
 class Bogo
 {
     // properties {{{2
 
+    private $uid;
     private $state;
     private $_states = Array('let_spams', 'tag_spams', 'tag_and_drop_spams', 'drop_spams');
 
@@ -74,6 +82,8 @@ class Bogo
         if (!$uid) {
             return;
         }
+
+        $this->uid = $uid;
         $res = XDB::query('SELECT email FROM emails WHERE uid={?} AND flags="filter"', $uid);
         if ($res->numRows()) {
             $this->state = $res->fetchOneCell();
@@ -86,11 +96,11 @@ class Bogo
 
     // public function change() {{{2
 
-    public function change($uid, $state)
+    public function change($state)
     {
         $this->state = is_int($state) ? $this->_states[$state] : $state;
         XDB::execute('UPDATE emails SET email={?} WHERE uid={?} AND flags = "filter"',
-            $this->state, $uid);
+                     $this->state, $this->uid);
     }
 
     // pubic function level() {{{2
@@ -102,25 +112,66 @@ class Bogo
 }
 
 // class Email {{{1
-
-class Email
+// Represents an "email address" used as final recipient for plat/al-managed
+// addresses; it can be subclasses a Redirection emails (third-party) or as
+// Storage emails (Polytechnique.org).
+abstract class Email
 {
-    // properties {{{2
+    protected $uid;
 
+    // Basic email properties; $sufficient indicates if the email can be used as
+    // an unique redirection; $email contains the delivery email address.
+    public $type;
+    public $sufficient;
     public $email;
+    public $display_email;
+
+    // Redirection status properties.
     public $active;
     public $broken;
     public $disabled;
     public $rewrite;
+
+    // Redirection bounces stats.
     public $panne;
     public $last;
     public $panne_level;
 
+    // Activates the email address as a redirection.
+    public abstract function activate();
+
+    // Deactivates the email address as a redirection.
+    public abstract function deactivate();
+
+    // Sets the rewrite rule for the given address.
+    public abstract function set_rewrite($rewrite);
+
+    // Resets the error counts associated with the redirection.
+    public abstract function clean_errors();
+
+    // Email backend capabilities ('rewrite' refers to From: rewrite for mails
+    // forwarded by Polytechnique.org's MXs; 'removable' indicates if the email
+    // can be definitively removed; 'disable' indicates if the email has a third
+    // status 'disabled' in addition to 'active' and 'inactive').
+    public abstract function has_rewrite();
+    public abstract function is_removable();
+    public abstract function has_disable();
+}
+
+// class EmailRedirection {{{1
+// Implementation of Email for third-party redirection (redirection of emails to
+// external user-supplied addresses).
+class EmailRedirection extends Email
+{
     // constructor {{{2
 
-    public function __construct($row)
+    public function __construct($uid, $row)
     {
+        $this->uid = $uid;
+        $this->sufficient = true;
+
         list($this->email, $flags, $this->rewrite, $this->panne, $this->last, $this->panne_level) = $row;
+        $this->display_email = $this->email;
         $this->active   = ($flags == 'active');
         $this->broken   = ($flags == 'panne');
         $this->disabled = ($flags == 'disable');
@@ -128,14 +179,14 @@ class Email
 
     // public function activate() {{{2
 
-    public function activate($uid)
+    public function activate()
     {
         if (!$this->active) {
             XDB::execute("UPDATE  emails
                              SET  panne_level = IF(flags = 'panne', panne_level - 1, panne_level),
                                   flags = 'active'
-                           WHERE  uid={?} AND email={?}", $uid, $this->email);
-            $_SESSION['log']->log("email_on", $this->email.($uid!=S::v('uid') ? "(admin on $uid)" : ""));
+                           WHERE  uid={?} AND email={?}", $this->uid, $this->email);
+            $_SESSION['log']->log("email_on", $this->email.($this->uid!=S::v('uid') ? "(admin on {$this->uid})" : ""));
             $this->active = true;
             $this->broken = false;
         }
@@ -143,34 +194,34 @@ class Email
 
     // public function deactivate() {{{2
 
-    public function deactivate($uid)
+    public function deactivate()
     {
         if ($this->active) {
             XDB::execute("UPDATE  emails SET flags =''
-                           WHERE  uid={?} AND email={?}", $uid, $this->email);
-            $_SESSION['log']->log("email_off",$this->email.($uid!=S::v('uid') ? "(admin on $uid)" : "") );
+                           WHERE  uid={?} AND email={?}", $this->uid, $this->email);
+            $_SESSION['log']->log("email_off",$this->email.($this->uid != S::v('uid') ? "(admin on {$this->uid})" : "") );
             $this->active = false;
         }
     }
 
-    // public function rewrite() {{{2
+    // public function set_rewrite() {{{2
 
-    public function rewrite($rew, $uid)
+    public function set_rewrite($rewrite)
     {
-        if ($this->rewrite == $rew) {
+        if ($this->rewrite == $rewrite) {
             return;
         }
-        if (!$rew || !isvalid_email($rew)) {
-            $rew = '';
+        if (!$rewrite || !isvalid_email($rewrite)) {
+            $rewrite = '';
         }
-        XDB::execute('UPDATE emails SET rewrite={?} WHERE uid={?} AND email={?}', $rew, $uid, $this->email);
-        $this->rewrite = $rew;
+        XDB::execute('UPDATE emails SET rewrite={?} WHERE uid={?} AND email={?}', $rewrite, $this->uid, $this->email);
+        $this->rewrite = $rewrite;
         return;
     }
 
-    // function cleanErrors() {{{2
+    // public function clean_errors() {{{2
 
-    public function cleanErrors($uid)
+    public function clean_errors()
     {
         if (!S::has_perms()) {
             return false;
@@ -181,12 +232,34 @@ class Email
         return XDB::execute("UPDATE  emails
                                 SET  panne_level = 0, panne = 0, last = 0
                               WHERE  uid = {?} AND email = {?}",
-                            $uid, $this->email);
+                            $this->uid, $this->email);
+    }
+
+    // public function has_rewrite() {{{2
+
+    public function has_rewrite()
+    {
+        return true;
+    }
+
+    // public function is_removable() {{{2
+
+    public function is_removable()
+    {
+        return true;
+    }
+
+    // public function has_disable() {{{2
+
+    public function has_disable()
+    {
+        return true;
     }
 }
 
 // class Redirect {{{1
-
+// Redirect is a placeholder class for an user's active redirections (third-party
+// redirection email, or Polytechnique.org mail storages).
 class Redirect
 {
     // properties {{{2
@@ -201,13 +274,14 @@ class Redirect
 
     public function __construct($_uid)
     {
-        $this->uid=$_uid;
+        $this->uid = $_uid;
+
         $res = XDB::iterRow("SELECT  email, flags, rewrite, panne, last, panne_level
                                FROM  emails
                               WHERE  uid = {?} AND flags != 'filter'", $_uid);
-        $this->emails=Array();
+        $this->emails = Array();
         while ($row = $res->next()) {
-            $this->emails[] = new Email($row);
+            $this->emails[] = new EmailRedirection($_uid, $row);
         }
         $this->bogo = new Bogo($_uid);
     }
@@ -217,7 +291,7 @@ class Redirect
     public function other_active($email)
     {
         foreach ($this->emails as $mail) {
-            if ($mail->email!=$email && $mail->active) {
+            if ($mail->email != $email && $mail->active && $mail->sufficient) {
                 return true;
             }
         }
@@ -233,8 +307,8 @@ class Redirect
         }
         XDB::execute('DELETE FROM emails WHERE uid={?} AND email={?}', $this->uid, $email);
         $_SESSION['log']->log('email_del',$email.($this->uid!=S::v('uid') ? " (admin on {$this->uid})" : ""));
-        foreach ($this->emails as $i=>$mail) {
-            if ($email==$mail->email) {
+        foreach ($this->emails as $i => $mail) {
+            if ($email == $mail->email) {
                 unset($this->emails[$i]);
             }
         }
@@ -262,7 +336,7 @@ class Redirect
                 return SUCCESS;
             }
         }
-        $this->emails[] = new Email(array($email, 'active', '', '0000-00-00', '0000-00-00', 0));
+        $this->emails[] = new EmailRedirection($this->uid, array($email, 'active', '', '0000-00-00', '0000-00-00', 0));
 
         // security stuff
         check_email($email, "Ajout d'une adresse surveillée aux redirections de " . $this->uid);
@@ -276,11 +350,11 @@ class Redirect
     {
         foreach ($this->emails as &$mail) {
             if (in_array($mail->email, $emails_actifs)) {
-                $mail->activate($this->uid);
+                $mail->activate();
             } else {
-                $mail->deactivate($this->uid);
+                $mail->deactivate();
             }
-            $mail->rewrite($emails_rewrite[$mail->email], $this->uid);
+            $mail->set_rewrite($emails_rewrite[$mail->email]);
         }
         check_redirect($this);
     }
@@ -295,15 +369,15 @@ class Redirect
             if ($mail->email == $email) {
                 $thisone = $i;
             }
-            $allinactive &= !$mail->active || $mail->email == $email;
+            $allinactive &= !$mail->active || !$mail->sufficient || $mail->email == $email;
         }
         if ($thisone === false) {
             return ERROR_INVALID_EMAIL;
         }
         if ($allinactive || $activate) {
-            $this->emails[$thisone]->activate($this->uid);
+            $this->emails[$thisone]->activate();
         } else {
-            $this->emails[$thisone]->deactivate($this->uid);
+            $this->emails[$thisone]->deactivate();
         }
         check_redirect($this);
         if ($allinactive && !$activate) {
@@ -319,21 +393,21 @@ class Redirect
     {
         foreach ($this->emails as &$mail) {
             if ($mail->email == $email) {
-                $mail->rewrite($redirect, $this->uid);
+                $mail->set_rewrite($redirect);
                 check_redirect($this);
                 return;
             }
         }
     }
 
-    // function cleanErrors() {{{2
+    // function clean_errors() {{{2
 
-    public function cleanErrors($email)
+    public function clean_errors($email)
     {
         foreach ($this->emails as &$mail) {
             if ($mail->email == $email) {
                 check_redirect($this);
-                return $mail->cleanErrors($this->uid);
+                return $mail->clean_errors();
             }
         }
         return false;
@@ -347,7 +421,7 @@ class Redirect
                          SET  flags = 'disable'
                        WHERE  flags = 'active' AND uid = {?}", $this->uid);
         foreach ($this->emails as &$mail) {
-            if ($mail->active) {
+            if ($mail->active && $mail->has_disable()) {
                 $mail->disabled = true;
                 $mail->active   = false;
             }
@@ -384,7 +458,7 @@ class Redirect
         $mxs = $res->fetchAllAssoc();
         $mails = array();
         foreach ($this->emails as &$mail) {
-            if ($mail->active) {
+            if ($mail->active && strstr($mail->email, '@') !== false) {
                 list(,$domain) = explode('@', $mail->email);
                 getmxrr($domain, $lcl_mxs);
                 if (empty($lcl_mxs)) {
@@ -462,13 +536,13 @@ class MailStorageGoogleApps extends MailStorage {
     {
         parent::__construct($_uid, 'googleapps');
     }
-    
+
     public function disable() {
         $redirect = new Redirect(S::v('uid'));
         if (!$redirect->other_active(NULL)) {
             return false;
         }
-        
+
         return parent::disable();
     }
 }

diff --git a/modules/admin.php b/modules/admin.php
index c122a7f..206fe72 100644 (file)
--- a/modules/admin.php
+++ b/modules/admin.php
@@ -460,7 +460,7 @@ class AdminModule extends PLModule
                         break;
                     case "clean_fwd":
                         if (!empty($val)) {
-                            $redirect->cleanErrors($val);
+                            $redirect->clean_errors($val);
                         }
                         break;
                     case "add_alias":
@@ -560,7 +560,7 @@ class AdminModule extends PLModule
                             $mailer->assign('old', $old_fields);
                             $mailer->assign('new', $new_fields);
                             $mailer->send();
-                            
+
                             // update number of subscribers (perms or deceased may have changed)
                             update_NbIns();
 

diff --git a/modules/email.php b/modules/email.php
index caff12b..3ed0b7d 100644 (file)
--- a/modules/email.php
+++ b/modules/email.php
@@ -306,7 +306,7 @@ class EmailModule extends PLModule
 
         $bogo = new Bogo(S::v('uid'));
         if (isset($statut_filtre)) {
-            $bogo->change(S::v('uid'), $statut_filtre + 0);
+            $bogo->change($statut_filtre + 0);
         }
         $page->assign('filtre',$bogo->level());
     }

diff --git a/templates/admin/utilisateurs.tpl b/templates/admin/utilisateurs.tpl
index c4bdc62..8950062 100644 (file)
--- a/templates/admin/utilisateurs.tpl
+++ b/templates/admin/utilisateurs.tpl
@@ -374,8 +374,8 @@ Pour ceci changer ses permissions en 'disabled'.
         Redirections
       </th>
     </tr>
-    {assign var=actives value=false} 
-    {assign var=disabled value=false} 
+    {assign var=actives value=false}
+    {assign var=disabled value=false}
     {foreach item=mail from=$emails}
     {cycle assign=class values="impair,pair"}
     <tr class="{$class}">
@@ -398,7 +398,7 @@ Pour ceci changer ses permissions en 'disabled'.
       </td>
       <td>
         {if $mail->broken}<span style="color: #f00">{/if}
-        {$mail->email}
+        {$mail->display_email}
         {if $mail->broken}<em> (en panne)</em></span>{/if}
       </td>
       <td class="action">
@@ -409,7 +409,7 @@ Pour ceci changer ses permissions en 'disabled'.
     <tr class="{$class}">
       <td colspan="3" class="smaller" style="color: #f00">
         {icon name=error title="Panne"}
-        Panne de {$mail->email} le {$mail->panne|date_format}
+        Panne de {$mail->display_email} le {$mail->panne|date_format}
         {if $mail->panne neq $mail->last}confirmée le {$mail->last|date_format}{/if}
       </td>
       <td class="action">

diff --git a/templates/emails/redirect.tpl b/templates/emails/redirect.tpl
index dec1119..db74029 100644 (file)
--- a/templates/emails/redirect.tpl
+++ b/templates/emails/redirect.tpl
@@ -132,16 +132,17 @@
           <strong>
             {if $e->broken}<span class="erreur">{assign var="erreur" value="1"}{/if}
             {if $e->panne neq '0000-00-00'}{assign var="panne" value="1"}{icon name=error title="En panne"}{/if}
-            {$e->email}
+            {$e->display_email}
             {if $e->broken}</span>{/if}
           </strong>
         </td>
         <td>
-          <input type="checkbox" value="{$e->email}" class="active_email"
+          <input type="checkbox" value="{$e->email}" {if $e->sufficient}class="active_email"{/if}
                  {if $e->active}checked="checked"{/if}
                  {if $smarty.foreach.redirect.total eq 1}disabled="disabled"{/if}
                  onchange="Ajax.update_html(null,'{$globals->baseurl}/emails/redirect/'+(this.checked?'':'in')+'active/{$e->email}', redirectUpdate)" /></td>
         <td>
+          {if $e->has_rewrite()}
           <select onchange="Ajax.update_html(null,'emails/redirect/rewrite/{$e->email}/'+this.value, redirectUpdate)">
             <option value=''>--- aucune ---</option>
             {assign var=dom1 value=#globals.mail.domain#}
@@ -153,13 +154,18 @@
               value='{$a.alias}@{#globals.mail.domain2#}'>{$a.alias}@{#globals.mail.domain2#}</option>
             {/foreach}
           </select>
+          {else}
+          <em>pas de réécriture</em>
+          {/if}
         </td>
         <td>
+          {if $e->is_removable()}
           <a href="emails/redirect/remove/{$e->email}"
              class="remove_email"
              onclick="return removeRedirect(this, &quot;{$e->email}&quot;);" >
             {icon name=cross title="Supprimer"}
           </a>
+          {/if}
         </td>
       </tr>
       {/foreach}