Code

Inluding tuned version of patch from #808
[gosa.git] / gosa-plugins / mail / personal / mail / class_mail-methods-cyrus.inc
1 <?php
4 class mailMethodCyrus extends mailMethod{
6   protected $ServerList = array();
7   protected $imap_handle = NULL;
8   protected $quota_loaded = FALSE;
9    
10   /* Allow modification of account_ids for existing mail accounts */
11   protected $modifyableMail   = FALSE;
13   /* Allow modification of the mail server attribute existing mail accounts */
14   protected $modifyableServer = FALSE;
16   /* Enforces same value for 'mail' as used for 'cn' */
17   protected $mailEqualsCN   = FALSE; 
19   protected $enableDomainSelection= FALSE;
20   protected $enableQuota          = TRUE;
21   protected $enableSieveManager   = TRUE;
22   protected $enableVacationRange  = TRUE;
23   protected $enableFolderTypes    = FALSE;
25   protected function init()
26   {
27     mailMethod::init();
28     if(isset($this->config->data['SERVERS']['IMAP'])){
29       $this->ServerList = $this->config->data['SERVERS']['IMAP']; 
30     }
31   }
33   
34   public function connect()
35   {
36     mailMethod::connect();
38     if(!count($this->ServerList)){
39       $this->error = _("There are no IMAP compatible mail servers defined!");
40       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,
41           "<b>IMAP: No mail servers configured, check systems->server->service->imap.</b>","");
42       return(FALSE);
43     }elseif (!isset($this->ServerList[$this->MailServer])){
44       $this->error = _("Mail server for this account is invalid!");
45       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,
46           "<b>IMAP: The selected mail server '".$this->MailServer."' is invalid.</b>",""); 
47       return(FALSE);
48     } else {
49       $cfg= $this->ServerList[$this->MailServer];
50     }
52     /* For some reason, hiding errors with @ does not wor here... */
53     if(!isset($cfg['connect']))   $cfg['connect']="";
54     if(!isset($cfg['admin']))     $cfg['admin']="";
55     if(!isset($cfg['password']))  $cfg['password']="";
57     /* Setting connect timeout to 10 seconds,
58         else the GOsa UI may freeze for 60 seconds.
59        (PHP default is 'default_socket_timeout = 60') */
60     $timeout = $this->config->get_cfg_value("imapTimeout",10);
61     @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,$timeout,
62           "<b>IMAP: Setting imap connect timeout to</b> (seconds)");
63     imap_timeout(1, $timeout);
65     $this->imap_handle = @imap_open($cfg['connect'], $cfg['admin'], $cfg['password'], OP_HALFOPEN);
67     /* Mailbox reachable? */
68     if ($this->imap_handle === FALSE){
69       $this->error = imap_last_error();
71       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"<b>Failed</b> :".imap_last_error(),
72         "<b>IMAP:</b> ".$cfg['admin']."@".$cfg['connect']);
74       return (FALSE);
75       $this->connected = FALSE;
76     }
77     @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"<b>successful</b>",
78         "<b>IMAP:</b> ".$cfg['admin']."@".$cfg['connect']);
79     $this->connected = TRUE;
81     return (TRUE);
82   }
85   public function account_exists()
86   {
87     if(!$this->is_connected() || !$this->imap_handle){
88       trigger_error("Method not connected, catch error.");
89       return(array());
90     }
92     /* Get server config */
93     $cfg= $this->ServerList[$this->MailServer];
94     $list = @imap_listmailbox($this->imap_handle, $cfg["connect"], $this->account_id);
95     $res = is_array($list) && count($list);
96     if($res){
97       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"","<b>IMAP: Account exists in imap server.</b>"); 
98     }else{
99       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"","<b>IMAP: Account seems NOT to exists in imap server.</b>"); 
100     }
101     return($res);
102   }
104   public function disconnect()
105   {
106     mailMethod::disconnect();
107     if($this->is_connected()){
108       @imap_close ($this->imap_handle);
109     }
110   }
113   public function is_connected()
114   {
115     $ret =    mailMethod::is_connected();
116     return($ret && $this->imap_handle);
117   }
119   protected function loadQuota()
120   {
121     if(!$this->quotaEnabled()) return(TRUE);
122     if(!$this->is_connected() || !$this->imap_handle){
123       trigger_error("Method not connected, catch error.");
124       return(FALSE);
125     }
127     $this->reset_error();
129     /* Load quota settings */
130     $result = array("quotaUsage"=>"","gosaMailQuota"=>"");
131     $quota_value = @imap_get_quota($this->imap_handle, $this->account_id);
133     /* Reset error queue, imap_qet_quota() will fail if the quota wasn't set yet.
134      */
135     imap_errors();
137     if(is_array($quota_value) && count($quota_value)) {
138       if (isset($quota_value["STORAGE"]) && is_array($quota_value["STORAGE"])){
140         /* use for PHP >= 4.3 */
141         if($quota_value["STORAGE"]['limit'] == 2147483647){
142           $result['quotaUsage']=    (int) ($quota_value["STORAGE"]['usage'] / 1024);
143           $result['gosaMailQuota']=  "";
144         }else{
145           $result['quotaUsage']=    (int) ($quota_value["STORAGE"]['usage'] / 1024);
146           $result['gosaMailQuota']= (int) ($quota_value["STORAGE"]['limit'] / 1024);
147         }
148       } else {
150         /* backward icompatible */
151         if($quota_value['usage'] == 2147483647){
152           $result['quotaUsage']=    (int) ($quota_value['usage'] / 1024);
153           $result['gosaMailQuota']= "";
154         }else{
155           $result['quotaUsage']=    (int) ($quota_value['usage'] / 1024);
156           $result['gosaMailQuota']= (int) ($quota_value['limit'] / 1024);
157         }
158       }
159     }
160     $this->quotaValue = $result['gosaMailQuota'];
161     $this->quotaUsage = $result['quotaUsage'];
163     /* Write debug output */
164     if(is_array($quota_value)){
165       if($this->quotaValue == ""){
166         $quota = "(".$this->quotaUsage." / unlimited)";
167       }else{
168         $quota = "(".$this->quotaUsage." / ".$this->quotaValue.")";
169       }
170       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__, $quota , 
171           "<b>IMAP: Successfully received account quota</b>");
172     }else{
173       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__, imap_last_error() , 
174           "<b>IMAP: Failed to receive account quota</b>");
175     }
176   }
178   public function getQuota($quota)
179   {
180     mailMethod::getQuota($quota);
181     if(!$this->quota_loaded){
182       $this->quota_loaded = TRUE;
183       $this->loadQuota();
184     }
185     return($this->quotaValue);
186   }
188   public function getQuotaUsage()
189   {
190     mailMethod::getQuotaUsage();
191     if(!$this->quota_loaded){
192       $this->quota_loaded = TRUE;
193       $this->loadQuota();
194     }
195     return($this->quotaUsage);
196   }
198   public function setQuota($number)
199   {
200     mailMethod::setQuota($number);    
202     if(!$this->quotaEnabled()) return(TRUE);
203     if(!$this->is_connected() || !$this->imap_handle){
204       trigger_error("Method not connected, catch error.");
205       return(FALSE);
206     }
208     $this->build_account_id();
210     /* Workaround for the php imap extension */
211     if (($this->quotaValue == "") || ($this->quotaValue== "2147483647")){
212       $this->quotaValue= "2147483647";
213     }elseif($this->quotaValue > 0){
214       $this->quotaValue = $this->quotaValue *1024;
215     }
216     $debug_number = $this->quotaValue." KB";
217     if($this->quotaValue == "2147483647"){
218       $debug_number .= "<i>Unlimited</i>";
219     }
221     if (!imap_set_quota($this->imap_handle, $this->account_id, $this->quotaValue)){
222       msg_dialog::display(_("IMAP error"), sprintf(_("Cannot modify IMAP mailbox quota: %s"),
223             '<br><br><i>'.imap_last_error().'</i>'), ERROR_DIALOG);
224       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__, "<b>".$this->account_id.": (".$debug_number.")</b>" , 
225           "<b>IMAP: Set account quota</b> on server '".$this->MailServer."' <b>".imap_last_error()."</b>");
226       return (FALSE);
227     }
228     @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__, "<b>".$this->account_id.": (".$debug_number.")</b>" , 
229         "<b>IMAP: Set account quota</b> on server :".$this->MailServer);
230     return (TRUE);
231   }
234   public function updateMailbox()
235   {
236     mailMethod::updateMailbox();
238     if(!$this->is_connected() || !$this->imap_handle){
239       trigger_error("Method not connected, catch error.");
240       return(FALSE);
241     }
242   
243     $this->build_account_id ();
244     if($this->is_connected()){
245       $cfg= $this->ServerList[$this->MailServer];
246       $list = imap_listmailbox($this->imap_handle, $cfg["connect"], $this->account_id);
247       if ($list === FALSE){
248         @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__, "<b>".$this->account_id."</b>" , 
249           "<b>IMAP: Add/Update account</b> on server :".$this->MailServer);
250         if (!imap_createmailbox($this->imap_handle, $cfg["connect"].$this->account_id)){
251           $this->error = imap_last_error();
252           return(FALSE);
253         }
255         /* Autocreate configured default folders */ 
256         $folders= $this->config->get_cfg_value("cyrusAutocreateFolders", null);
257         if ($folders) {
258           $foldersToCreate= explode(",", $folders);
259           $cyrus_delim= $this->cyrusUseSlashes?"/":".";
261           // Walk thru list of specified folders
262           foreach ($foldersToCreate as $folder) {
263             if(!imap_createmailbox($this->imap_handle, $cfg["connect"].$this->account_id.$cyrus_delim.$folder)) {
264               $this->error= imap_last_error();
265               return(FALSE);
266             }
267           }
269         }
270       }
271     }
272     return(TRUE);
273   }
276   public function deleteMailbox()
277   {
278     mailMethod::deleteMailbox();
280     if(!$this->is_connected() || !$this->imap_handle){
281       trigger_error("Method not connected, catch error.");
282       return(FALSE);
283     }
285     $this->build_account_id ();
287     $cfg= $this->ServerList[$this->MailServer];
288     @imap_setacl ($this->imap_handle, $this->account_id, $cfg["admin"], "lrswipcda");
290     if ($this->config->get_cfg_value("cyrusDeleteMailbox", "true") == "true"){
291       if (!imap_deletemailbox($this->imap_handle, $cfg["connect"].$this->account_id)){
292         $this->error = imap_last_error();
293         return (FALSE);
294       }
295     } else{ 
296       msg_dialog::display(_("Mail info"),
297         sprintf(_("LDAP entry has been removed but cyrus mailbox (%s) is kept.\nPlease delete it manually!"),
298         $this->account_id), INFO_DIALOG);
299     }
300     return (TRUE);
301   }
303   
304   public function getMailboxList()
305   {
306     mailMethod::getMailboxList();
308     if(!$this->is_connected() || !$this->imap_handle){
309       trigger_error("Method not connected, catch error.");
310       return(array());
311     }
313     $result = array();
315     /* Get server config */
316     $cfg= $this->ServerList[$this->MailServer];
318     /* Create search string
319        And prepare replacements 
320      */ 
321     if(preg_match("/\@/",$this->account_id)){
322       $search = preg_replace("/\@/","/*@",$this->account_id);
323       $with_domain = TRUE;
324     }else{
325       $search = $this->account_id."/*";
326       $with_domain = FALSE;
327     }
328     $folder = $this->account_id;
329     if(preg_match("/\@/",$folder)){
330       $folder = preg_replace("/\@.*$/","",$folder);
331     }
333     /* Contact imap server */
334     $list = @imap_listmailbox($this->imap_handle, $cfg["connect"], $this->account_id);
335     $list2 = @imap_listmailbox($this->imap_handle, $cfg["connect"], $search);
337     /* Create list of returned folder names */
338     if (is_array($list)){
340       /* Merge in subfolders */
341       if(is_array($list2)){
342         $list = array_merge($list,$list2);
343       }
345       foreach ($list as $val){
346         $str = trim(preg_replace("/^\{[^\}]*+\}/","",$val));
347         if($with_domain){
348           $str = trim(preg_replace("/\@.*$/","",$str));
349         }
350         $str = preg_replace ("/^.*".preg_quote($folder, '/')."/","INBOX", 
351           mb_convert_encoding($str, "UTF-8", "UTF7-IMAP"));
352         $result[] = $str;      
353       }
354       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,trim(implode($result,", "),", "),
355           "<b>IMAP: Received mailbox folders.</b>");
356       $this->error = imap_last_error();
357     }else{
358       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,imap_last_error(),
359           "<b>IMAP: Cannot receive mailbox folders.</b>");
360       $this->error = imap_last_error();
361       return(array());
362     }
364     /* Append "INBOX" to the folder array if result is empty and request comes from user dialog */
365     if(!count($result)){
366       $result[] = "INBOX";
367     }
369     return($result);
370   }
373   /*! \brief  Returns configured acls
374    */
375   public function  getFolderACLs($folder_acls)
376   {
377     $this->reset_error();
379     /* imap_getacl available? */
380     if (!function_exists('imap_getacl')){
381       $this->error = _("The module imap_getacl is not implemented!");
382       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"The imap_getacl module is missing!",
383           "<b>IMAP: Cannot set folder acls.</b>");
384       return($folder_acls);
385     }
387     /* Get ACLs and merge them with the already given acls (ldap)
388      */
389     $this->build_account_id();
390     $acls = imap_getacl ($this->imap_handle, $this->account_id);
391     foreach($acls as $user => $acl){
392       if($user == "anyone") $user = "__anyone__"; // Map to internal placeholder
393       $folder_acls[$user] = $acl;
394     }
396     /* Merge given ACL with acl mapping
397        This ensures that no ACL will accidentally overwritten by gosa.
398      */
399     foreach($folder_acls as $user => $acl){
400       if(!isset($this->acl_mapping[$acl])){
401         $this->acl_mapping[$acl] = $acl;
402       }
403     }
405     return($folder_acls);
406   }
410   /*! \brief  Write ACLs back to imap or what ever
411    */
412   public function  setFolderACLs($permissions)
413   {
414     $this->reset_error();
416     /* imap_getacl available? */
417     if (!function_exists('imap_getacl')){
418       $this->error = _("The module imap_getacl is not implemented!");
419       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"The imap_getacl module is missing!",
420           "<b>IMAP: Cannot set folder acls.</b>");
421       return(FALSE);
422     }
424     /* Get list of subfolders */
425     $folders= $this->getMailboxList();
426     foreach ($folders as $subfolder){
427       $folder_id = $this->create_folder_id($subfolder);
429       /* Remove all acl's for this folder */
430       $users= @imap_getacl ($this->imap_handle, $folder_id);
431       
432       if(is_array($users)){
433         foreach ($users as $userid => $perms){
434           $userid = strtolower($userid);
435           imap_setacl ($this->imap_handle, $folder_id, $userid, "");
436           @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,$folder_id." -> ".$userid,
437               "<b>IMAP: Removing folder permissions.</b>");
438         }
439       }
440     }
442     /* Set permissions for this folder */
443     foreach($folders as $subfolder){
444       $folder_id = $this->create_folder_id($subfolder);
446       foreach ($permissions as $user => $acl){
447         imap_setacl ($this->imap_handle, $folder_id, $user, $acl);
448         @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,$folder_id." -> ".$user.": ".$acl,
449             "<b>IMAP: Setting new folder permissions.</b>");
450       }
451     }
452     return(TRUE);
453   }
456   public function saveSieveSettings()
457   {
458     mailMethod::saveSieveSettings();
460     // Check file integrity 
461     $files = array();
462     foreach(array("sieve-header.txt","sieve-spam.txt","sieve-mailsize.txt","sieve-vacation.txt","sieve-discard.txt") as $file){
463       if(!file_exists(CONFIG_DIR."/".$file) || ! is_readable(CONFIG_DIR."/".$file)){
464         $files[] = CONFIG_DIR."/".$file;
465         @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__ , CONFIG_DIR."/".$file,
466             "<b>Sieve template missing, please locate and move the template file: </b>");
467       }
468     }
469     if(count($files)){
470       $msg = sprintf(_("File '%s' does not exist!"),implode($files,", "));
471       $msg .= "&nbsp;"._("The sieve script may not be written correctly.");
472       msg_dialog::display(_("Warning"),$msg,WARNING_DIALOG);
473     }
475     /* Map attribute from parent class 
476      */
477     $mail = $this->parent->mail;
478     $gosaMailDeliveryMode = $this->parent->gosaMailDeliveryMode;
479     $gosaMailAlternateAddress = $this->parent->gosaMailAlternateAddress;
480     $gosaMailMaxSize = $this->parent->gosaMailMaxSize;
481     $gosaSpamMailbox = $this->parent->gosaSpamMailbox;
482     $gosaSpamSortLevel = $this->parent->gosaSpamSortLevel;
483     $gosaVacationMessage = $this->parent->gosaVacationMessage;
485     /* Try to login into sieve
486      */ 
487     $cfg = $this->ServerList[$this->MailServer];
488     $sieve= new sieve($cfg["sieve_server"], $cfg["sieve_port"], $this->getUAttribValue(),
489         $cfg["password"], $cfg["admin"],$cfg["sieve_option"]);
490     if (!$sieve->sieve_login()){
491       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,$sieve->error_raw ,"<b>SIEVE: login failed.</b>");
492       $this->error = $sieve->error_raw;
493       return(FALSE);
494     }
496     /* Build spamlevel. Spamassassin tags mails with "*" for each integer
497        point of spam. So a spam level of 5.3 gets "*****" which can be
498        checked easily by spam filters */
499     $spamlevel= str_pad("",(int) $gosaSpamSortLevel,"*");
501     /* Get current sieve script named 'gosa'.
502         Check if it valid ("###GOSA" must be the first string).
503         If it is valid just replace it, if it is NOT valid
504          create a backup of the old 
505      */
506     $script= "";
507     if($sieve->sieve_listscripts()){
508       if (in_array("gosa", $sieve->response)){
509         if(!$sieve->sieve_getscript("gosa")){
510           $this->error = sprintf(_("Cannot retrieve SIEVE script: %s"),to_string($sieve->error_raw));
511           @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,$sieve->error_raw ,
512               "<b>SIEVE: Connot read 'gosa' sieve script.</b>");
513           $this->error = $sieve->error_raw;
514           return(FALSE);
515         }
517         $is_valid_script = FALSE;
518         foreach ($sieve->response as $line){
519           if(empty($line)) continue;
520           if (preg_match ("/^###GOSA/", $line) && strlen($script) == 0){
521             $is_valid_script = TRUE;
522           }
523           $line= rtrim($line);
524           $script .= $line;
525         }
527         if($is_valid_script || strlen($script) == 0 || empty($script)){
528           @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"" ,
529               "<b>SIEVE</b>: Sieve script 'gosa' was a valid GOsa script and will be replaced.");
530         }else{
531           $new_name = "non_gosa_".date("Ymd_H-i-s");
532           $sieve->sieve_sendscript($new_name, $script);
533           @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,$this->sieve->error_raw ,
534               "<b>SIEVE</b>: Non GOsa sieve script. <b>Creating backup of the current sieve script '".$new_name."'.</b>");
535         }
536       }
537     }
540     /*****
541       Build up new sieve script here.
542      *****/
545     /* Only create a new one, if it is not empty */
546     $script= "";
547     if (is_integer(strpos($gosaMailDeliveryMode, "R")) ||
548         is_integer(strpos($gosaMailDeliveryMode, "C")) ||
549         !is_integer(strpos($gosaMailDeliveryMode, "L")) ||
550         is_integer(strpos($gosaMailDeliveryMode, "V")) ||
551         is_integer(strpos($gosaMailDeliveryMode, "S"))){
553       $text= preg_replace('/"/', '\\"', implode ("", file(CONFIG_DIR."/sieve-header.txt")));
554       eval ("\$script.=\"$text\";");
555     }
557     /* Add anti-spam code */
558     if (is_integer(strpos($gosaMailDeliveryMode, "S"))){
559       $spambox= $gosaSpamMailbox;
560       $text= preg_replace('/"/', '\\"', implode ("", file(CONFIG_DIR."/sieve-spam.txt")));
561       eval ("\$script.=\"$text\";");
562     }
564     /* Add "reject due to mailsize" code, message is currently not
565        adjustable through GOsa. */
566     if (is_integer(strpos($gosaMailDeliveryMode, "R"))){
567       $maxsize= $gosaMailMaxSize;
568       $text= preg_replace('/"/', '\\"', implode ("", file(CONFIG_DIR."/sieve-mailsize.txt")));
569       eval ("\$script.=\"$text\";");
570     }
572     /* Add vacation information */
573     if (is_integer(strpos($gosaMailDeliveryMode, "V"))){
575       /* Sieve wants all destination addresses for the
576          vacation message, so we've to assemble them from
577          mail and mailAlternateAddress */
578       $addrlist= "\"".$mail."\"";
579       foreach ($gosaMailAlternateAddress as $val){
580         $addrlist .= ", \"$val\"";
581       }
582       $vacmsg= $gosaVacationMessage;
583       $text= preg_replace('/"/', '\\"', implode ("", file(CONFIG_DIR."/sieve-vacation.txt")));
584       eval ("\$script.=\"$text\";");
585     }
587     /* If no local delivery is wanted, tell the script to discard the mail */
588     if (!is_integer(strpos($gosaMailDeliveryMode, "L"))){
589       $text= preg_replace('/"/', '\\"', implode ("", file(CONFIG_DIR."/sieve-discard.txt")));
590       eval ("\$script.=\"$text\";");
591     }
593     /****
594       Sieve script build complete
595      ****/
597     /* Upload script and make it the default one */
598     if (!$sieve->sieve_sendscript("gosa", $script)){
599       $this->error = sprintf(_("Cannot store SIEVE script: %s"), to_string($sieve->error_raw));
600       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__, "Error was: ".to_string($sieve->error_raw) ,
601         "<b>SIEVE: Writing new Sieve script failed!</b>");
602       return(FALSE);
603     }
605     if(!$sieve->sieve_setactivescript("gosa")){
606       $this->error = sprintf(_("Cannot activate SIEVE script: %s"), to_string($sieve->error_raw));
607       return(FALSE);
608     }
610     $sieve->sieve_logout();
611   }
614 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
615 ?>