6bfde61c709364bea1e9103c39ec6d025e9c2ca8
1 <?php
4 class mailMethodCyrus extends mailMethod{
6 protected $ServerList = array();
7 protected $imap_handle = NULL;
8 protected $quota_loaded = FALSE;
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 }
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 }
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 }
254 }
255 }
256 return(TRUE);
257 }
260 public function deleteMailbox()
261 {
262 mailMethod::deleteMailbox();
264 if(!$this->is_connected() || !$this->imap_handle){
265 trigger_error("Method not connected, catch error.");
266 return(FALSE);
267 }
269 $this->build_account_id ();
271 $cfg= $this->ServerList[$this->MailServer];
272 @imap_setacl ($this->imap_handle, $this->account_id, $cfg["admin"], "lrswipcda");
273 if (!imap_deletemailbox($this->imap_handle, $cfg["connect"].$this->account_id)){
274 $this->error = imap_last_error();
275 return (FALSE);
276 }
277 return (TRUE);
278 }
281 public function getMailboxList()
282 {
283 mailMethod::getMailboxList();
285 if(!$this->is_connected() || !$this->imap_handle){
286 trigger_error("Method not connected, catch error.");
287 return(array());
288 }
290 $result = array();
292 /* Get server config */
293 $cfg= $this->ServerList[$this->MailServer];
295 /* Create search string
296 And prepare replacements
297 */
298 if(preg_match("/\@/",$this->account_id)){
299 $search = preg_replace("/\@/","/*@",$this->account_id);
300 $with_domain = TRUE;
301 }else{
302 $search = $this->account_id."/*";
303 $with_domain = FALSE;
304 }
305 $folder = $this->account_id;
306 if(preg_match("/\@/",$folder)){
307 $folder = preg_replace("/\@.*$/","",$folder);
308 }
310 /* Contact imap server */
311 $list = @imap_listmailbox($this->imap_handle, $cfg["connect"], $this->account_id);
312 $list2 = @imap_listmailbox($this->imap_handle, $cfg["connect"], $search);
314 /* Create list of returned folder names */
315 if (is_array($list)){
317 /* Merge in subfolders */
318 if(is_array($list2)){
319 $list = array_merge($list,$list2);
320 }
322 foreach ($list as $val){
323 $str = trim(preg_replace("/^\{[^\}]*+\}/","",$val));
324 if($with_domain){
325 $str = trim(preg_replace("/\@.*$/","",$str));
326 }
327 $str = preg_replace ("/^.*".preg_quote($folder, '/')."/","INBOX",
328 mb_convert_encoding($str, "UTF-8", "UTF7-IMAP"));
329 $result[] = $str;
330 }
331 @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,trim(implode($result,", "),", "),
332 "<b>IMAP: Received mailbox folders.</b>");
333 $this->error = imap_last_error();
334 }else{
335 @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,imap_last_error(),
336 "<b>IMAP: Cannot receive mailbox folders.</b>");
337 $this->error = imap_last_error();
338 return(array());
339 }
341 /* Append "INBOX" to the folder array if result is empty and request comes from user dialog */
342 if(!count($result)){
343 $result[] = "INBOX";
344 }
346 return($result);
347 }
350 /*! \brief Returns configured acls
351 */
352 public function getFolderACLs($folder_acls)
353 {
354 $this->reset_error();
356 /* imap_getacl available? */
357 if (!function_exists('imap_getacl')){
358 $this->error = _("The module imap_getacl is not implemented!");
359 @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"The imap_getacl module is missing!",
360 "<b>IMAP: Cannot set folder acls.</b>");
361 return($folder_acls);
362 }
364 /* Get ACLs and merge them with the already given acls (ldap)
365 */
366 $this->build_account_id();
367 $acls = imap_getacl ($this->imap_handle, $this->account_id);
368 foreach($acls as $user => $acl){
369 if($user == "anyone") $user = "__anyone__"; // Map to internal placeholder
370 $folder_acls[$user] = $acl;
371 }
373 /* Merge given ACL with acl mapping
374 This ensures that no ACL will accidentally overwritten by gosa.
375 */
376 foreach($folder_acls as $user => $acl){
377 if(!isset($this->acl_mapping[$acl])){
378 $this->acl_mapping[$acl] = $acl;
379 }
380 }
382 return($folder_acls);
383 }
387 /*! \brief Write ACLs back to imap or what ever
388 */
389 public function setFolderACLs($permissions)
390 {
391 $this->reset_error();
393 /* imap_getacl available? */
394 if (!function_exists('imap_getacl')){
395 $this->error = _("The module imap_getacl is not implemented!");
396 @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"The imap_getacl module is missing!",
397 "<b>IMAP: Cannot set folder acls.</b>");
398 return(FALSE);
399 }
401 /* Get list of subfolders */
402 $folders= $this->getMailboxList();
403 foreach ($folders as $subfolder){
404 $folder_id = $this->create_folder_id($subfolder);
406 /* Remove all acl's for this folder */
407 $users= @imap_getacl ($this->imap_handle, $folder_id);
409 if(is_array($users)){
410 foreach ($users as $userid => $perms){
411 $userid = strtolower($userid);
412 imap_setacl ($this->imap_handle, $folder_id, $userid, "");
413 @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,$folder_id." -> ".$userid,
414 "<b>IMAP: Removing folder permissions.</b>");
415 }
416 }
417 }
419 /* Set permissions for this folder */
420 foreach($folders as $subfolder){
421 $folder_id = $this->create_folder_id($subfolder);
423 foreach ($permissions as $user => $acl){
424 imap_setacl ($this->imap_handle, $folder_id, $user, $acl);
425 @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,$folder_id." -> ".$user.": ".$acl,
426 "<b>IMAP: Setting new folder permissions.</b>");
427 }
428 }
429 return(TRUE);
430 }
433 public function saveSieveSettings()
434 {
435 mailMethod::saveSieveSettings();
437 /* Map attribute from parent class
438 */
439 $mail = $this->parent->mail;
440 $gosaMailDeliveryMode = $this->parent->gosaMailDeliveryMode;
441 $gosaMailAlternateAddress = $this->parent->gosaMailAlternateAddress;
442 $gosaMailMaxSize = $this->parent->gosaMailMaxSize;
443 $gosaSpamMailbox = $this->parent->gosaSpamMailbox;
444 $gosaSpamSortLevel = $this->parent->gosaSpamSortLevel;
445 $gosaVacationMessage = $this->parent->gosaVacationMessage;
447 /* Try to login into sieve
448 */
449 $cfg = $this->ServerList[$this->MailServer];
450 $sieve= new sieve($cfg["sieve_server"], $cfg["sieve_port"], $this->getUAttribValue(),
451 $cfg["password"], $cfg["admin"],$cfg["sieve_option"]);
452 if (!$sieve->sieve_login()){
453 @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,$sieve->error_raw ,"<b>SIEVE: login failed.</b>");
454 $this->error = $sieve->error_raw;
455 return(FALSE);
456 }
458 /* Build spamlevel. Spamassassin tags mails with "*" for each integer
459 point of spam. So a spam level of 5.3 gets "*****" which can be
460 checked easily by spam filters */
461 $spamlevel= str_pad("",(int) $gosaSpamSortLevel,"*");
463 /* Get current sieve script named 'gosa'.
464 Check if it valid ("###GOSA" must be the first string).
465 If it is valid just replace it, if it is NOT valid
466 create a backup of the old
467 */
468 $script= "";
469 if($sieve->sieve_listscripts()){
470 if (in_array("gosa", $sieve->response)){
471 if(!$sieve->sieve_getscript("gosa")){
472 $this->error = sprintf(_("Cannot retrieve SIEVE script: %s"),to_string($sieve->error_raw));
473 @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,$sieve->error_raw ,
474 "<b>SIEVE: Connot read 'gosa' sieve script.</b>");
475 $this->error = $sieve->error_raw;
476 return(FALSE);
477 }
479 $is_valid_script = FALSE;
480 foreach ($sieve->response as $line){
481 if(empty($line)) continue;
482 if (preg_match ("/^###GOSA/", $line) && strlen($script) == 0){
483 $is_valid_script = TRUE;
484 }
485 $line= rtrim($line);
486 $script .= $line;
487 }
489 if($is_valid_script || strlen($script) == 0 || empty($script)){
490 @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"" ,
491 "<b>SIEVE</b>: Sieve script 'gosa' was a valid GOsa script and will be replaced.");
492 }else{
493 $new_name = "non_gosa_".date("Ymd_H-i-s");
494 $sieve->sieve_sendscript($new_name, $script);
495 @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,$this->sieve->error_raw ,
496 "<b>SIEVE</b>: Non GOsa sieve script. <b>Creating backup of the current sieve script '".$new_name."'.</b>");
497 }
498 }
499 }
502 /*****
503 Build up new sieve script here.
504 *****/
506 /* Only create a new one, if it is not empty */
507 $script= "";
508 if (is_integer(strpos($gosaMailDeliveryMode, "R")) ||
509 is_integer(strpos($gosaMailDeliveryMode, "C")) ||
510 !is_integer(strpos($gosaMailDeliveryMode, "L")) ||
511 is_integer(strpos($gosaMailDeliveryMode, "V")) ||
512 is_integer(strpos($gosaMailDeliveryMode, "S"))){
514 $text= preg_replace('/"/', '\\"', implode ("", file(CONFIG_DIR."/sieve-header.txt")));
515 eval ("\$script.=\"$text\";");
516 }
518 /* Add anti-spam code */
519 if (is_integer(strpos($gosaMailDeliveryMode, "S"))){
520 $spambox= $gosaSpamMailbox;
521 $text= preg_replace('/"/', '\\"', implode ("", file(CONFIG_DIR."/sieve-spam.txt")));
522 eval ("\$script.=\"$text\";");
523 }
525 /* Add "reject due to mailsize" code, message is currently not
526 adjustable through GOsa. */
527 if (is_integer(strpos($gosaMailDeliveryMode, "R"))){
528 $maxsize= $gosaMailMaxSize;
529 $text= preg_replace('/"/', '\\"', implode ("", file(CONFIG_DIR."/sieve-mailsize.txt")));
530 eval ("\$script.=\"$text\";");
531 }
533 /* Add vacation information */
534 if (is_integer(strpos($gosaMailDeliveryMode, "V"))){
536 /* Sieve wants all destination addresses for the
537 vacation message, so we've to assemble them from
538 mail and mailAlternateAddress */
539 $addrlist= "\"".$mail."\"";
540 foreach ($gosaMailAlternateAddress as $val){
541 $addrlist .= ", \"$val\"";
542 }
543 $vacmsg= $gosaVacationMessage;
544 $text= preg_replace('/"/', '\\"', implode ("", file(CONFIG_DIR."/sieve-vacation.txt")));
545 eval ("\$script.=\"$text\";");
546 }
548 /* If no local delivery is wanted, tell the script to discard the mail */
549 if (!is_integer(strpos($gosaMailDeliveryMode, "L"))){
550 $text= preg_replace('/"/', '\\"', implode ("", file(CONFIG_DIR."/sieve-discard.txt")));
551 eval ("\$script.=\"$text\";");
552 }
554 /****
555 Sieve script build complete
556 ****/
558 /* Upload script and make it the default one */
559 if (!$sieve->sieve_sendscript("gosa", $script)){
560 $this->error = sprintf(_("Cannot store SIEVE script: %s"), to_string($sieve->error_raw));
561 @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__, "Error was: ".to_string($sieve->error_raw) ,
562 "<b>SIEVE: Writing new Sieve script failed!</b>");
563 return(FALSE);
564 }
566 if(!$sieve->sieve_setactivescript("gosa")){
567 $this->error = sprintf(_("Cannot activate SIEVE script: %s"), to_string($sieve->error_raw));
568 return(FALSE);
569 }
571 $sieve->sieve_logout();
572 }
573 }
575 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
576 ?>