2 /***************************************************************************
3 * Copyright (C) 2003-2008 Polytechnique.org *
4 * http://opensource.polytechnique.org/ *
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. *
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. *
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 *
19 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
20 ***************************************************************************/
23 define("ERROR_INACTIVE_REDIRECTION", 2);
24 define("ERROR_INVALID_EMAIL", 3);
25 define("ERROR_LOOP_EMAIL", 4);
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)
32 $res = XDB
::query("SELECT COUNT(*)
34 WHERE id = {?} AND FIND_IN_SET('bestalias', flags) AND type != 'homonyme'",
36 if ($res->fetchOneCell()) {
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());
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)
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);
63 return $ident . '@' . $dom;
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
71 function isvalid_email_redirection($email)
73 return isvalid_email($email) &&
74 !preg_match("/@(polytechnique\.(org|edu)|melix\.(org|net)|m4x\.org)$/", $email);
78 // The Bogo class represents a spam filtering level in plat/al architecture.
85 private $_states = Array('let_spams', 'tag_spams', 'tag_and_drop_spams', 'drop_spams');
89 public function __construct(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();
100 $this->state
= 'tag_and_drop_spams';
102 "INSERT INTO emails (uid, email, rewrite, panne, flags)
103 VALUES ({?}, 'tag_and_drop_spams', '', '0000-00-00', 'filter')",
108 // public function change() {{{2
110 public function change($state)
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());
117 // pubic function level() {{{2
119 public function level()
121 return array_search($this->state
, $this->_states
);
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).
133 // Basic email properties; $sufficient indicates if the email can be used as
134 // an unique redirection; $email contains the delivery email address.
138 public $display_email;
140 // Redirection status properties.
146 // Redirection bounces stats.
151 // Activates the email address as a redirection.
152 public abstract function activate();
154 // Deactivates the email address as a redirection.
155 public abstract function deactivate();
157 // Sets the rewrite rule for the given address.
158 public abstract function set_rewrite($rewrite);
160 // Resets the error counts associated with the redirection.
161 public abstract function clean_errors();
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();
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
179 public function __construct(User
&$user, $row)
181 $this->user
= &$user;
182 $this->sufficient
= true
;
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');
191 // public function activate() {{{2
193 public function activate()
195 if (!$this->active
) {
196 XDB
::execute("UPDATE emails
197 SET panne_level = IF(flags = 'panne', panne_level - 1, panne_level),
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
;
206 // public function deactivate() {{{2
208 public function deactivate()
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
;
218 // public function set_rewrite() {{{2
220 public function set_rewrite($rewrite)
222 if ($this->rewrite
== $rewrite) {
225 if (!$rewrite ||
!isvalid_email($rewrite)) {
228 XDB
::execute('UPDATE emails SET rewrite = {?} WHERE uid = {?} AND email = {?}', $rewrite, $this->user
->id(), $this->email
);
229 $this->rewrite
= $rewrite;
233 // public function clean_errors() {{{2
235 public function clean_errors()
237 if (!S
::has_perms()) {
241 $this->panne_level
= 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
);
249 // public function has_rewrite() {{{2
251 public function has_rewrite()
256 // public function is_removable() {{{2
258 public function is_removable()
263 // public function has_disable() {{{2
265 public function has_disable()
271 // class EmailStorage {{{1
272 // Implementation of Email for email storage backends from Polytechnique.org.
273 class EmailStorage
extends Email
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',
281 // Retrieves the current list of actives storages.
282 private function get_storages()
284 $res = XDB
::query("SELECT mail_storage
286 WHERE user_id = {?}", $this->user
->id());
287 return new PlFlagSet($res->fetchOneCell());
290 // Updates the list of active storages.
291 private function set_storages($storages)
293 XDB
::execute("UPDATE auth_user_md5
294 SET mail_storage = {?}
295 WHERE user_id = {?}", $storages, $this->user
->id());
298 // Returns the list of allowed storages for the @p user.
299 static public function get_allowed_storages(User
&$user)
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';
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';
321 public function __construct(User
&$user, $name)
323 $this->user
= &$user;
324 $this->email
= $name;
325 $this->display_email
= (isset($this->display_names
[$name]) ?
$this->display_names
[$name] : $name);
327 $storages = $this->get_storages();
328 $this->sufficient
= ($name == 'googleapps');
329 $this->active
= $storages->hasFlag($name);
330 $this->broken
= false
;
331 $this->disabled
= false
;
333 $this->panne
= $this->last
= $this->panne_level
= 0;
336 public function activate()
338 if (!$this->active
) {
339 $storages = $this->get_storages();
340 $storages->addFlag($this->email
);
341 $this->set_storages($storages);
342 $this->active
= true
;
346 public function deactivate()
349 $storages = $this->get_storages();
350 $storages->rmFlag($this->email
);
351 $this->set_storages($storages);
352 $this->active
= false
;
357 // Source rewrite can't be enabled for email storage addresses.
358 public function set_rewrite($rewrite) {}
360 // Email storage are not supposed to be broken, hence not supposed to be
362 public function clean_errors() {}
365 public function has_rewrite() { return false
; }
366 public function is_removable() { return false
; }
367 public function has_disable() { return false
; }
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).
377 private $flag_active = 'active';
385 public function __construct(User
&$user)
387 $this->user
= &$user;
388 $this->bogo
= new Bogo($user);
390 // Adds third-party email redirections.
391 $res = XDB
::iterRow("SELECT email, flags, rewrite, panne, last, panne_level
393 WHERE uid = {?} AND flags != 'filter'", $user->id());
394 $this->emails
= Array();
395 while ($row = $res->next()) {
396 $this->emails
[] = new EmailRedirection($user, $row);
399 // Adds local email storage backends.
400 foreach (EmailStorage
::get_allowed_storages($user) as $storage) {
401 $this->emails
[] = new EmailStorage($user, $storage);
405 // public function other_active() {{{2
407 public function other_active($email)
409 foreach ($this->emails
as $mail) {
410 if ($mail->email
!= $email && $mail->active
&& $mail->sufficient
) {
417 // public function delete_email() {{{2
419 public function delete_email($email)
421 if (!$this->other_active($email)) {
422 return ERROR_INACTIVE_REDIRECTION
;
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]);
431 check_redirect($this);
435 // public function add_email() {{{2
437 public function add_email($email)
439 $email_stripped = strtolower(trim($email));
440 if (!isvalid_email($email_stripped)) {
441 return ERROR_INVALID_EMAIL
;
443 if (!isvalid_email_redirection($email_stripped)) {
444 return ERROR_LOOP_EMAIL
;
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()})" : ""));
450 foreach ($this->emails
as $mail) {
451 if ($mail->email
== $email_stripped) {
455 $this->emails
[] = new EmailRedirection($this->user
, array($email, 'active', '', '0000-00-00', '0000-00-00', 0));
458 check_email($email, "Ajout d'une adresse surveillée aux redirections de " . $this->user
->login());
459 check_redirect($this);
463 // public function modify_email() {{{2
465 public function modify_email($emails_actifs, $emails_rewrite)
467 foreach ($this->emails
as &$mail) {
468 if (in_array($mail->email
, $emails_actifs)) {
473 $mail->set_rewrite($emails_rewrite[$mail->email
]);
475 check_redirect($this);
478 // public function modify_one_email() {{{2
480 public function modify_one_email($email, $activate)
484 foreach ($this->emails
as $i=>$mail) {
485 if ($mail->email
== $email) {
488 $allinactive &= !$mail->active ||
!$mail->sufficient ||
$mail->email
== $email;
490 if ($thisone === false
) {
491 return ERROR_INVALID_EMAIL
;
493 if ($allinactive ||
$activate) {
494 $this->emails
[$thisone]->activate();
496 $this->emails
[$thisone]->deactivate();
498 check_redirect($this);
499 if ($allinactive && !$activate) {
500 return ERROR_INACTIVE_REDIRECTION
;
506 // public function modify_one_email_redirect() {{{2
508 public function modify_one_email_redirect($email, $redirect)
510 foreach ($this->emails
as &$mail) {
511 if ($mail->email
== $email) {
512 $mail->set_rewrite($redirect);
513 check_redirect($this);
519 // function clean_errors() {{{2
521 public function clean_errors($email)
523 foreach ($this->emails
as &$mail) {
524 if ($mail->email
== $email) {
525 check_redirect($this);
526 return $mail->clean_errors();
532 // function disable() {{{2
534 public function disable()
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
;
545 check_redirect($this);
548 // function enable() {{{2
550 public function enable()
552 XDB
::execute("UPDATE emails
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
;
560 check_redirect($this);
564 // function get_broken_mx() {{{2
566 public function get_broken_mx()
568 $res = XDB
::query("SELECT host, text
570 WHERE state != 'ok'");
571 if (!$res->numRows()) {
574 $mxs = $res->fetchAllAssoc();
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);
584 foreach ($mxs as &$mx) {
585 foreach ($lcl_mxs as $lcl) {
586 if (fnmatch($mx['host'], $lcl)) {
587 $broken = $mx['text'];
592 $mails[] = array('mail' => $mail->email
, 'text' => $broken);
601 // function active_emails() {{{2
603 public function active_emails()
606 foreach ($this->emails
as $mail) {
614 // function get_uid() {{{2
616 public function get_uid()
618 return $this->user
->id();
622 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: