f4a3396e05e3feb1d9a0227ff03c83d7b68b4475
1 <?php
2 /*
3 This code is part of GOsa (https://gosa.gonicus.de)
4 Copyright (C) 2003-2007 - Fabian Hickert <hickert@gonicus.de>
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
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
22 /* The sieve management class displays a list of sieve
23 * scripts for the given mail account.
24 * The account is identified by the parents uid attribute.
25 *
26 * $config The config object
27 * $dn The object edited
28 * $parent The parent object that provides the uid attribute
29 */
30 class sieveManagement extends plugin
31 {
32 var $parent = NULL;
33 var $scripts= array();
34 var $uattrib = "uid";
35 var $current_script = -1;
36 var $current_handler = NULL;
37 var $script_to_delete =-1;
38 var $sieve_handle = NULL;
39 var $Script_Error = "";
40 var $Sieve_Error = "";
41 var $create_script = FALSE;
43 /* To add new elements we need to know
44 * Where to add the element -> add_new_id
45 * Whould we add above or below this id -> add_above_below
46 * What kind of element should we add -> add_element_type
47 */
48 var $add_new_element = FALSE;
49 var $add_new_id = -1;
50 var $add_above_below = "below";
51 var $add_element_type = "sieve_comment";
53 /* If this variable is TRUE, this indicates that we have the
54 * import dialog opened.
55 */
56 var $Import_Script = FALSE;
58 /* Initialize the class and load all sieve scripts
59 * try to parse them and display errors
60 */
61 function sieveManagement(&$config,$dn,&$parent,$uattrib)
62 {
63 /* Check given parameter */
64 if(!isset($parent->$uattrib)){
65 trigger_error("Sieve Management implementation error. Parameter 4 (".$uattrib.") must be part of the given parent element (".get_class($parent).").");
66 }
68 $this->uattrib = $uattrib;
69 $this->parent = &$parent;
70 plugin::plugin($config,$dn);
72 /* Get sieve, if this fail abort class initialization */
73 if(!$this->sieve_handle = $this->get_sieve()){
74 return;
75 }
78 /* Get all sieve scripts names */
79 if($this->sieve_handle->sieve_listscripts()){
80 if (is_array($this->sieve_handle->response)){
81 foreach($this->sieve_handle->response as $key => $name){
83 $data = array();
84 $data['NAME'] = $name;
86 if($key == "ACTIVE" && $key === "ACTIVE"){
87 $data['ACTIVE'] = TRUE;
88 }else{
89 $data['ACTIVE'] = FALSE;
90 }
91 $this->scripts[] = $data;
92 }
93 }
94 }
96 /* Get script contents */
97 foreach($this->scripts as $key => $script){
98 $p = new My_Parser($this);
99 $this->sieve_handle->sieve_getscript($script['NAME']);
101 $script = "";
102 foreach($this->sieve_handle->response as $line){
103 $script.=$line;
104 }
106 $this->scripts[$key]['IS_NEW'] = FALSE;;
107 $this->scripts[$key]['SCRIPT'] = $script;
108 $this->scripts[$key]['ORIG_SCRIPT'] = $script;
109 $this->scripts[$key]['MSG'] = "";
110 $ret = $p->parse($script);
111 if(!$ret){
112 $this->scripts[$key]['STATUS'] = FALSE;
113 $this->scripts[$key]['MODE'] = "Source";
114 $this->scripts[$key]['MSG'] = _("Parse failed")."<font color='red'>".$p->status_text."</font>";
115 }else{
116 $this->scripts[$key]['STATUS'] = TRUE;
117 $this->scripts[$key]['MODE'] = "Structured";
118 $this->scripts[$key]['MSG'] = _("Parse successful");
119 }
120 $this->scripts[$key]['PARSER'] = $p;
121 $this->scripts[$key]['EDITED'] = FALSE;
122 }
123 $this->sieve_handle = $this->sieve_handle;
124 }
127 /* Return a sieve class handle,
128 * false if login fails
129 */
130 function get_sieve()
131 {
133 /* Connect to sieve class and try to get all available sieve scripts */
134 if(isset($this->config->data['SERVERS']['IMAP'][$this->parent->gosaMailServer])){
135 $cfg= $this->config->data['SERVERS']['IMAP'][$this->parent->gosaMailServer];
136 $this->Sieve_Error = "";
138 $uattrib = $this->uattrib;
140 /* Log into the mail server */
141 $this->sieve_handle= new sieve(
142 $cfg["sieve_server"],
143 $cfg["sieve_port"],
144 $this->parent->$uattrib,
145 $cfg["password"],
146 $cfg["admin"]);
148 /* Try to login */
149 if (!@$this->sieve_handle->sieve_login()){
150 $this->Sieve_Error = $this->sieve_handle->error_raw;
151 return(FALSE);
152 }
153 return($this->sieve_handle);
154 }else{
155 $this->Sieve_Error = sprintf(_("The specified mail server '%s' does not exist within the GOsa configuration."),
156 $this->parent->gosaMailServer);
157 return(FALSE);
158 }
159 }
162 /* Handle sieve list
163 */
164 function execute()
165 {
166 /***************
167 * Create a new Script
168 ***************/
170 /* Force opening the add script dialog */
171 if(isset($_POST['create_new_script'])){
172 $this->create_script = TRUE;
173 }
175 /* Close add script dialog, without adding a new one */
176 if(isset($_POST['create_script_cancel'])){
177 $this->create_script = FALSE;
178 }
180 /* Display create script dialog
181 * handle posts, display warnings if specified
182 * name is not useable.
183 * Create a new script with given name
184 */
185 if($this->create_script){
187 /* Set initial name or used posted name if available */
188 $name = "";
189 if(isset($_POST['NewScriptName'])){
190 $name = trim($_POST['NewScriptName']);
191 }
193 /* Check given name */
194 $err = false;
196 /* Is given name in lower case characters ? */
197 if(isset($_POST['create_script_save'])){
198 if(!strlen($name)){
199 $err =true;
200 msg_dialog::display(_("Error"), _("No script name specified!"), ERROR_DIALOG);
201 }
202 /* Is given name in lower case characters ? */
203 if($name != strtolower($name)){
204 $err =true;
205 msg_dialog::display(_("Error"), _("Please use only lowercase script names!"), ERROR_DIALOG);
206 }
208 /* Only chars are allowed here */
209 if(preg_match("/[^a-z]/i",$name)){
210 $err =true;
211 msg_dialog::display(_("Error"), _("Please use only alphabetical characters in script names!"), ERROR_DIALOG);
212 }
214 $tmp = $this->get_used_script_names();
215 if(in_array_ics($name,$tmp)){
216 $err =true;
217 msg_dialog::display(_("Error"), _("Script name already in use!"), ERROR_DIALOG);
218 }
219 }
221 /* Create script if everything is ok */
222 if($this->create_script && isset($_POST['create_script_save']) && !$err){
224 /* Close dialog */
225 $this->create_script = FALSE;
227 /* Script contents to use */
228 $script = "/*New script */".
229 "stop;";
231 /* Create a new parser and initialize default values */
232 $p = new My_Parser($this);
233 $ret = $p->parse($script);
234 $sc['SCRIPT'] = $script;
235 $sc['ORIG_SCRIPT'] = $script;
236 $sc['IS_NEW'] = TRUE;
237 $sc['MSG'] = "";
238 if(!$ret){
239 $sc['STATUS'] = FALSE;
240 $sc['MODE'] = "Source";
241 $sc['MSG'] = _("Parse failed")."<font color='red'>".$p->status_text."</font>";
242 }else{
243 $sc['STATUS'] = TRUE;
244 $sc['MODE'] = "Structured";
245 $sc['MSG'] = _("Parse successful");
246 }
247 $sc['PARSER'] = $p;
248 $sc['EDITED'] = TRUE;
249 $sc['ACTIVE'] = FALSE;
250 $sc['NAME'] = $name;
252 /* Add script */
253 $this->scripts[$name] = $sc;
254 }else{
256 /* Display dialog to enter new script name */
257 $smarty = get_smarty();
258 $smarty->assign("NewScriptName",$name);
259 return($smarty->fetch(get_template_path("templates/create_script.tpl",TRUE,dirname(__FILE__))));
260 }
261 }
264 /*************
265 * Handle several posts
266 *************/
268 $once = TRUE;
269 foreach($_POST as $name => $value){
271 /* Edit script requested */
272 if(preg_match("/^editscript_/",$name) && $once && !$this->current_handler){
273 $script = preg_replace("/^editscript_/","",$name);
274 $script = preg_replace("/_(x|y)/","",$script);
275 $once = FALSE;
277 $this->current_script = $script;
278 $this->current_handler = $this->scripts[$script]['PARSER'];
279 $this->scripts[$script]['SCRIPT_BACKUP'] = $this->scripts[$script]['SCRIPT'];
280 }
282 /* remove script requested */
283 if($this->parent->acl_is_writeable("sieveManagement") && preg_match("/^delscript_/",$name) && $once && !$this->current_handler){
284 $script = preg_replace("/^delscript_/","",$name);
285 $script = preg_replace("/_(x|y)/","",$script);
286 $once = FALSE;
287 $this->script_to_delete = $script;
288 }
290 /* Activate script */
291 if($this->parent->acl_is_writeable("sieveManagement") && preg_match("/^active_script_/",$name) && $once && !$this->current_handler){
292 $script = preg_replace("/^active_script_/","",$name);
293 $script = preg_replace("/_(x|y)/","",$script);
294 $once = FALSE;
296 /* We can only activate existing scripts */
297 if(!$this->scripts[$script]['IS_NEW']){
299 /* Get sieve */
300 if(!$this->sieve_handle = $this->get_sieve()){
301 msg_dialog::display(_("SIEVE error"), sprintf(_("Cannot log into SIEVE server: %s"), '<br><br><i>'.to_string($this->Sieve_Error).'</i>'), ERROR_DIALOG);
302 }
304 /* Try to activate the given script and update
305 * class script array.
306 */
307 if(!$this->sieve_handle->sieve_setactivescript($this->scripts[$script]['NAME'])){
308 msg_dialog::display(_("SIEVE error"), sprintf(_("Cannot retrieve SIEVE script: %s"), '<br><br><i>'.to_string($this->sieve_handler->error_raw).'</i>'), ERROR_DIALOG);
309 }else{
310 foreach($this->scripts as $key => $data){
311 if($key == $script){
312 $this->scripts[$key]['ACTIVE'] = TRUE;
313 }else{
314 $this->scripts[$key]['ACTIVE'] = FALSE;
315 }
316 }
317 }
318 }
319 }
320 }
323 /*************
324 * Remove script handling
325 *************/
327 /* Remove aborted */
328 if(isset($_POST['delete_cancel'])){
329 $this->script_to_delete = -1;
330 }
332 /* Remove confirmed */
333 if($this->parent->acl_is_writeable("sieveManagement") && isset($_POST['delete_script_confirm'])){
335 $script = $this->scripts[$this->script_to_delete];
337 /* Just remove from array if it is a new script */
338 if($script['IS_NEW']){
339 unset($this->scripts[$this->script_to_delete]);
340 }else{
342 /* Get sieve */
343 if(!$this->sieve_handle = $this->get_sieve()){
344 msg_dialog::display(_("SIEVE error"), sprintf(_("Cannot log into SIEVE server: %s"), '<br><br><i>'.to_string($this->Sieve_Error).'</i>'), ERROR_DIALOG);
345 }
347 if(!$this->sieve_handle->sieve_deletescript($this->scripts[$this->script_to_delete]['NAME'])){
348 msg_dialog::display(_("SIEVE error"), sprintf(_("Cannot remove SIEVE script: %s"), '<br><br><i>'.to_string($this->sieve_handler->error_raw).'</i>'), ERROR_DIALOG);
349 }else{
350 unset($this->scripts[$this->script_to_delete]);
351 }
352 }
353 $this->script_to_delete = -1;
354 }
356 /* Display confirm dialog */
357 if($this->script_to_delete != -1){
358 $smarty = get_smarty();
359 $smarty->assign("Warning",msgPool::deleteInfo($this->scripts[$this->script_to_delete]['NAME']));
360 return($smarty->fetch(get_template_path("templates/remove_script.tpl",TRUE,dirname(__FILE__))));
361 }
364 /**************
365 * Save script changes
366 **************/
368 /* Abort saving */
369 if(isset($_POST['cancel_sieve_changes'])){
370 $tmp = $this->scripts[$this->current_script]['SCRIPT_BACKUP'];
371 $this->scripts[$this->current_script]['SCRIPT'] = $tmp;
372 $this->scripts[$this->current_script]['PARSER']->parse($tmp);
373 $this->current_handler = NULL;
374 }
376 /* Save currently edited sieve script. */
377 if($this->parent->acl_is_writeable("sieveManagement") &&
378 isset($_POST['save_sieve_changes']) &&
379 is_object($this->current_handler)){
380 $chk = $this->current_handler->check();
381 if(!count($chk)){
383 $sc = $this->scripts[$this->current_script]['SCRIPT'];
384 $p = new My_Parser($this);
385 if($p -> parse($sc)){
387 if($this->scripts[$this->current_script]['MODE'] == "Source-Only"){
388 $this->scripts[$this->current_script]['MODE'] = "Source";
389 }
391 $this->scripts[$this->current_script]['PARSER'] = $p;
392 $this->scripts[$this->current_script]['EDITED'] = TRUE;
393 $this->scripts[$this->current_script]['STATUS'] = TRUE;
394 $this->scripts[$this->current_script]['MSG'] = _("Edited");
395 $this->current_handler = NULL;
396 }else{
397 msg_dialog::display(_("SIEVE error"), $p->status_text, ERROR_DIALOG);
398 }
399 }else{
400 foreach($chk as $msgs){
401 msg_dialog::display(_("SIEVE error"), $msgs, ERROR_DIALOG);
402 }
403 }
404 }
407 /*************
408 * Display edit dialog
409 *************/
411 /* Display edit dialog, depending on Mode display different uis
412 */
413 if($this->current_handler){
415 if(isset($_POST['Import_Script'])){
416 $this->Import_Script = TRUE;
417 }
419 if(isset($_POST['Import_Script_Cancel'])){
420 $this->Import_Script = FALSE;
421 }
423 if(isset($_POST['Import_Script_Save']) && isset($_FILES['Script_To_Import'])){
425 $file = $_FILES['Script_To_Import'];
427 if($file['size'] == 0){
428 msg_dialog::display(_("Error"), _("Uploaded script is empty!"), ERROR_DIALOG);
429 }elseif(!file_exists($file['tmp_name'])){
430 msg_dialog::display(_("Internal error"), sprintf(_("Cannot access temporary file '%s'!"), $file['tmp_name']), ERROR_DIALOG);
431 }elseif(!is_readable ($file['tmp_name'])){
432 msg_dialog::display(_("SIEVE error"), sprintf(_("Cannot open temporary file '%s'!"), $file['tmp_name']), ERROR_DIALOG);
433 }else{
437 $contents = file_get_contents($file['tmp_name']);
439 $this->scripts[$this->current_script]['SCRIPT'] = $contents;
440 if(!$this->current_handler->parse($contents)){
441 $this->scripts[$this->current_script]['MODE'] = "Source";
442 }else{
443 $this->scripts[$this->current_script]['MODE'] = "Structured";
444 }
445 $this->Script_Error = "";
446 $this->Import_Script = FALSE;
447 }
448 }
450 if($this->Import_Script){
451 $smarty = get_smarty();
452 $str = $smarty->fetch(get_template_path("templates/import_script.tpl",TRUE,dirname(__FILE__)));
453 return($str);
454 }
457 /* Create dump of current sieve script */
458 if(isset($_POST['Save_Copy'])){
460 /* force download dialog */
461 header("Content-type: application/tiff\n");
462 if (preg_match('/MSIE 5.5/', $HTTP_USER_AGENT) ||
463 preg_match('/MSIE 6.0/', $HTTP_USER_AGENT)) {
464 header('Content-Disposition: filename="dump.script"');
465 } else {
466 header('Content-Disposition: attachment; filename="dump.script"');
467 }
468 header("Content-transfer-encoding: binary\n");
469 header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
470 header("Last-Modified: ".gmdate("D, d M Y H:i:s")." GMT");
471 header("Cache-Control: no-cache");
472 header("Pragma: no-cache");
473 header("Cache-Control: post-check=0, pre-check=0");
474 echo $this->scripts[$this->current_script]['SCRIPT'];
475 exit();
476 }
479 /****
480 * Add new element to ui
481 ****/
483 /* Abort add dialog */
484 if(isset($_POST['select_new_element_type_cancel'])){
485 $this->add_new_element = FALSE;
486 }
488 /* Add a new element */
489 if($this->add_new_element){
491 $element_types= array(
492 "sieve_keep" => _("Keep"),
493 "sieve_comment" => _("Comment"),
494 "sieve_fileinto" => _("File into"),
495 "sieve_keep" => _("Keep"),
496 "sieve_discard" => _("Discard"),
497 "sieve_redirect" => _("Redirect"),
498 "sieve_reject" => _("Reject"),
499 "sieve_require" => _("Require"),
500 "sieve_stop" => _("Stop"),
501 "sieve_vacation" => _("Vacation message"),
502 "sieve_if" => _("If"));
505 /* Element selected */
506 if(isset($_POST['element_type']) && isset($element_types[$_POST['element_type']])
507 || isset($_POST['element_type']) &&in_array($_POST['element_type'],array("sieve_else","sieve_elsif"))){
508 $this->add_element_type = $_POST['element_type'];
509 }
511 /* Create new element and add it to
512 * the selected position
513 */
514 if(isset($_POST['select_new_element_type'])){
515 if($this->add_new_element_to_current_script($this->add_element_type,$this->add_new_id,$this->add_above_below)){
516 $this->add_new_element = FALSE;
517 }else{
518 msg_dialog::display(_("SIEVE error"), _("Cannot add new element!") , ERROR_DIALOG);
519 }
520 }
521 }
523 /* Only display select dialog if it is necessary */
524 if($this->add_new_element){
525 $smarty = get_smarty();
527 $add_else_elsif = FALSE;
529 /* Check if we should add else/elsif to the select box
530 * or not. We can't add else twice!.
531 */
532 if($this->add_above_below == "below"){
534 /* Get posistion of the current element
535 */
536 foreach($this->current_handler->tree_->pap as $key => $obj){
538 if($obj->object_id == $this->add_new_id && in_array(get_class($obj),array("sieve_if","sieve_elsif"))){
540 /* Get block start/end */
541 $end_id = $this->current_handler->tree_->get_block_end($key);
542 $else_found = FALSE;
543 $elsif_found = FALSE;
545 /* Check if there is already an else in this block
546 */
547 for($i = $key ; $i < $end_id ; $i ++){
548 if(get_class($this->current_handler->tree_->pap[$i]) == "sieve_else"){
549 $else_found = TRUE;
550 }
551 if(get_class($this->current_handler->tree_->pap[$i]) == "sieve_elsif"){
552 $elsif_found = TRUE;
553 }
554 }
556 /* Only allow adding 'else' if there is currently
557 * no 'else' statement. And don't allow adding
558 * 'else' before 'elseif'
559 */
560 if(!$else_found && (!(get_class($obj) == "sieve_if" && $elsif_found))){
561 $element_types['sieve_else'] = _("Else");
562 }
563 $element_types['sieve_elsif'] = _("Else If");
564 }
565 }
566 }
568 $smarty->assign("element_types",$element_types );
569 $smarty->assign("element_type",$this->add_element_type);
570 $str = $smarty->fetch(get_template_path("templates/add_element.tpl",TRUE,dirname(__FILE__)));
571 return($str);
572 }
576 /****************
577 * Handle test posts
578 ****************/
580 /* handle some special posts from test elements
581 */
582 foreach($_POST as $name => $value){
583 if(preg_match("/^Add_Test_Object_/",$name)) {
584 $name = preg_replace("/^Add_Test_Object_/","",$name);
585 $name = preg_replace("/_(x|y)$/","",$name);
587 $test_types_to_add = array(
588 "address" =>_("Address"),
589 "header" =>_("Header"),
590 "envelope"=>_("Envelope"),
591 "size" =>_("Size"),
592 "exists" =>_("Exists"),
593 "allof" =>_("All of"),
594 "anyof" =>_("Any of"),
595 "true" =>_("True"),
596 "false" =>_("False"));
598 $smarty = get_smarty();
599 $smarty->assign("ID",$name);
600 $smarty->assign("test_types_to_add",$test_types_to_add);
601 $ret = $smarty->fetch(get_template_path("templates/select_test_type.tpl",TRUE,dirname(__FILE__)));
602 return($ret);
603 }
604 }
606 $current = $this->scripts[$this->current_script];
608 /* Create html results */
609 $smarty = get_smarty();
610 $smarty->assign("Mode",$current['MODE']);
611 if($current['MODE'] == "Structured"){
612 $smarty->assign("Contents",$this->current_handler->tree_->execute());
613 }else{
614 $smarty->assign("Contents",$current['SCRIPT']);
615 }
616 $smarty->assign("Script_Error",$this->Script_Error);
617 $ret = $smarty->fetch(get_template_path("templates/edit_frame_base.tpl",TRUE,dirname(__FILE__)));
618 return($ret);
619 }
622 /* Create list of available sieve scripts
623 */
624 $List = new divSelectBox("sieveManagement");
625 foreach($this->scripts as $key => $script){
627 $edited = $script['EDITED'];
628 $active = $script['ACTIVE'];
630 $field1 = array("string" => " ",
631 "attach" => "style='width:20px;'");
632 if($active){
633 $field1 = array("string" => "<img src='images/true.png' alt='"._("Active")."'
634 title='"._("This script is marked as active")."'>",
635 "attach" => "style='width:20px;'");
636 }
637 $field2 = array("string" => $script['NAME']);
638 $field3 = array("string" => $script['MSG']);
639 $field4 = array("string" => _("Script length").": ".strlen($script['SCRIPT']));
641 if($this->parent->acl_is_writeable("sieveManagement")){
642 $del = "<input type='image' name='delscript_".$key."' src='images/edittrash.png'
643 title='"._("Remove script")."'>";
644 }else{
645 $del = "<img src='images/empty.png' alt=' '>";
646 }
648 if($active || $script['IS_NEW'] || !$this->parent->acl_is_writeable("sieveManagement")){
649 $activate = "<img src='images/empty.png' alt=' '>";
650 }else{
651 $activate = "<input type='image' name='active_script_".$key."' src='images/true.png'
652 title='"._("Activate script")."'>";
653 }
655 $field6 = array("string" => $activate."<input type='image' name='editscript_".$key."' src='images/edit.png'
656 title='"._("Edit script")."'>".$del,
657 "attach" => "style='border-right:0px; width:70px;'");
658 $List->AddEntry(array($field1,$field2,$field3,$field4,$field6));
659 }
661 $List->SetHeight(400);
663 /* If the uattrib is empty (Attribute to use for authentification with sieve)
664 * Display a message that the connection can't be established.
665 */
666 $uattrib = $this->uattrib;
667 $smarty = get_smarty();
669 if(!$this->get_sieve()){
670 $smarty->assign("Sieve_Error",sprintf(
671 _("Can't log into SIEVE server. Server says '%s'."),
672 to_string($this->Sieve_Error)));
673 }else{
674 $smarty->assign("Sieve_Error","");
675 }
677 $smarty->assign("uattrib_empty",empty($this->parent->$uattrib));
678 $smarty->assign("List",$List->DrawList());
679 return($smarty->fetch(get_template_path("templates/management.tpl",TRUE,dirname(__FILE__))));
680 }
683 /* Add a new element to the currently opened script editor.
684 * The insert position is specified by
685 */
686 function add_new_element_to_current_script($type,$id,$position)
687 {
688 /* Test given data */
689 if(!in_array_ics($position,array("above","below"))){
690 trigger_error("Can't add new element with \$position=".$position.". Only 'above','below' are allowed here.");
691 return(FALSE);
692 }
693 if(!is_numeric($id)){
694 trigger_error("Can't add new element, given id is not numeric.");
695 return(FALSE);
696 }
697 $tmp = get_declared_classes();
698 if(!in_array($type,$tmp)){
699 if(!empty($type)){
700 trigger_error("Can't add new element, given \$class=".$class." does not exists.");
701 }
702 return(FALSE);
703 }
704 if(!is_object($this->current_handler) || get_class($this->current_handler) != "My_Parser"){
705 trigger_error("Can't add new element, there is no valid script editor opened.");
706 return(FALSE);
707 }
709 /* These element types are allowed to be added here */
710 $element_types= array(
711 "sieve_keep" => _("Keep"),
712 "sieve_comment" => _("Comment"),
713 "sieve_fileinto" => _("File into"),
714 "sieve_keep" => _("Keep"),
715 "sieve_discard" => _("Discard"),
716 "sieve_redirect" => _("Redirect"),
717 "sieve_reject" => _("Reject"),
718 "sieve_require" => _("Require"),
719 "sieve_stop" => _("Stop"),
720 "sieve_vacation" => _("Vacation message"),
721 "sieve_if" => _("If"));
723 /* Check if we should add else/elsif to the select box
724 * or not. We can't add else twice!.
725 */
727 /* Get posistion of the current element
728 */
729 foreach($this->current_handler->tree_->pap as $key => $obj){
731 if($obj->object_id == $id && in_array(get_class($obj),array("sieve_if","sieve_elsif"))){
733 /* Get block start/end */
734 $end_id = $this->current_handler->tree_->get_block_end($key);
735 $else_found = FALSE;
736 $elsif_found = FALSE;
738 /* Check if there is already an else in this block
739 */
740 for($i = $key ; $i < $end_id ; $i ++){
741 if(get_class($this->current_handler->tree_->pap[$i]) == "sieve_else"){
742 $else_found = TRUE;
743 }
744 if(get_class($this->current_handler->tree_->pap[$i]) == "sieve_elsif"){
745 $elsif_found = TRUE;
746 }
747 }
749 if($this->add_above_below == "below"){
751 /* Only allow adding 'else' if there is currently
752 * no 'else' statement. And don't allow adding
753 * 'else' before 'elseif'
754 */
755 if(!$else_found && (!(get_class($obj) == "sieve_if" && $elsif_found))){
756 $element_types['sieve_else'] = _("Else");
757 }
758 $element_types['sieve_elsif'] = _("Else If");
759 }else{
761 /* Allow adding elsif above elsif */
762 if(in_array(get_class($obj),array("sieve_elsif"))){
763 $element_types['sieve_elsif'] = _("Else If");
764 }
765 }
766 }
767 }
769 if(!isset($element_types[$type])){
770 msg_dialog::display(_("SIEVE error"), _("Cannot insert element at the requested position!") , ERROR_DIALOG);
771 return;
772 }
775 /* Create elements we should add
776 * -Some element require also surrounding block elements
777 */
778 $parent = $this->current_handler->tree_;
779 if($this->add_element_type == "sieve_if"){
780 $ele[] = new $this->add_element_type(NULL, preg_replace("/[^0-9]/","",microtime()),$parent);
781 $ele[] = new sieve_block_start(NULL,preg_replace("/[^0-9]/","",microtime()),$parent);
782 $ele[] = new sieve_block_end(NULL,preg_replace("/[^0-9]/","",microtime()),$parent);
783 }elseif($this->add_element_type == "sieve_else"){
784 $ele[] = new sieve_block_end(NULL,preg_replace("/[^0-9]/","",microtime()),$parent);
785 $ele[] = new $this->add_element_type(NULL, preg_replace("/[^0-9]/","",microtime()),$parent);
786 $ele[] = new sieve_block_start(NULL,preg_replace("/[^0-9]/","",microtime()),$parent);
787 }elseif($this->add_element_type == "sieve_elsif"){
788 $ele[] = new sieve_block_end(NULL,preg_replace("/[^0-9]/","",microtime()),$parent);
789 $ele[] = new $this->add_element_type(NULL, preg_replace("/[^0-9]/","",microtime()),$parent);
790 $ele[] = new sieve_block_start(NULL,preg_replace("/[^0-9]/","",microtime()),$parent);
791 }elseif($this->add_element_type == "sieve_vacation"){
793 /* Automatically add addresses to sieve alternate addresses */
794 $data = NULL;
795 $tmp = new $this->add_element_type($data, preg_replace("/[^0-9]/","",microtime()),$parent);
796 if(isset($this->parent->gosaMailAlternateAddress)){
797 $tmp->addresses = $this->parent->gosaMailAlternateAddress;
798 }
799 $ele[] = $tmp ;
800 }else{
801 $ele[] = new $this->add_element_type(NULL, preg_replace("/[^0-9]/","",microtime()),$parent);
802 }
804 /* Get index of the element identified by object_id == $id;
805 */
806 $index = -1;
807 $data = $this->current_handler->tree_->pap;
808 foreach($data as $key => $obj){
809 if($obj->object_id == $id && $index==-1){
810 $index = $key;
811 }
812 }
814 /* Tell to user that we couldn't find the given object
815 * so we can't add an element.
816 */
817 if($index == -1 ){
818 trigger_error("Can't add new element, specified \$id=".$id." could not be found in object tree.");
819 return(FALSE);
820 }
822 /* We have found the specified object_id
823 * and want to detect the next free position
824 * to insert the new element.
825 */
826 if($position == "above"){
827 $direction ="up";
828 $next_free = $this->current_handler->tree_->_get_next_free_move_slot($index,$direction,TRUE);
829 }else{
830 $direction = "down";
831 $next_free = $this->current_handler->tree_->_get_next_free_move_slot($index,$direction,TRUE);
832 }
833 /* This is extremly necessary, cause some objects
834 * updates the tree objects ... Somehow i should change this ...
835 */
836 $data = $this->current_handler->tree_->pap;
837 $start = $end = array();
839 if($position == "above"){
840 $start = array_slice($data,0,$next_free);
841 $end = array_slice($data,$next_free);
842 }else{
843 $start = array_slice($data,0,$next_free+1);
844 $end = array_slice($data,$next_free+1);
845 }
847 $new = array();
848 foreach($start as $obj){
849 $new[] = $obj;
850 }
851 foreach($ele as $el){
852 $new[] = $el;
853 }
854 foreach($end as $obj){
855 $new[] = $obj;
856 }
857 $data= $new;
858 $this->current_handler->tree_->pap = $data;
859 return(TRUE);
860 }
864 function save_object()
865 {
866 if($this->current_handler){
868 if(isset($_GET['Add_Object_Top_ID'])){
869 $this->add_new_element = TRUE;
870 $this->add_new_id = $_GET['Add_Object_Top_ID'];
871 $this->add_above_below = "above";
872 }
874 if(isset($_GET['Add_Object_Bottom_ID'])){
875 $this->add_new_element = TRUE;
876 $this->add_new_id = $_GET['Add_Object_Bottom_ID'];
877 $this->add_above_below = "below";
878 }
880 if(isset($_GET['Remove_Object_ID'])){
881 $found_id = -1;
882 foreach($this->current_handler->tree_->pap as $key => $element){
883 if($element->object_id == $_GET['Remove_Object_ID']){
884 $found_id = $key;
885 }
886 }
887 if($found_id != -1 ){
888 $this->current_handler->tree_->remove_object($found_id);
889 }
890 }
892 if(isset($_GET['Move_Up_Object_ID'])){
893 $found_id = -1;
894 foreach($this->current_handler->tree_->pap as $key => $element){
895 if($element->object_id == $_GET['Move_Up_Object_ID']){
896 $found_id = $key;
897 }
898 }
899 if($found_id != -1 ){
900 $this->current_handler->tree_->move_up_down($found_id,"up");
901 }
902 }
904 if(isset($_GET['Move_Down_Object_ID'])){
905 $found_id = -1;
906 foreach($this->current_handler->tree_->pap as $key => $element){
907 if($element->object_id == $_GET['Move_Down_Object_ID']){
908 $found_id = $key;
909 }
910 }
911 if($found_id != -1 ){
912 $this->current_handler->tree_->move_up_down($found_id,"down");
913 }
914 }
917 /* Check if there is an add object requested
918 */
919 $data = $this->current_handler->tree_->pap;
920 $once = TRUE;
921 foreach($_POST as $name => $value){
922 foreach($data as $key => $obj){
923 if(isset($obj->object_id) && preg_match("/^Add_Object_Top_".$obj->object_id."_/",$name) && $once){
924 $once = FALSE;
925 $this->add_element_type = $_POST['element_type_'.$obj->object_id];
926 $this->add_new_element = FALSE;
927 $this->add_new_id = $obj->object_id;
928 $this->add_above_below = "above";
929 $this->add_new_element_to_current_script($this->add_element_type,$this->add_new_id,$this->add_above_below);
930 }
931 if(isset($obj->object_id) && preg_match("/^Add_Object_Bottom_".$obj->object_id."_/",$name) && $once){
932 $once = FALSE;
933 $this->add_element_type = $_POST['element_type_'.$obj->object_id];
934 $this->add_new_element = FALSE;
935 $this->add_new_id = $obj->object_id;
936 $this->add_above_below = "below";
937 $this->add_new_element_to_current_script($this->add_element_type,$this->add_new_id,$this->add_above_below);
938 }
940 if(isset($obj->object_id) && preg_match("/^Remove_Object_".$obj->object_id."_/",$name) && $once){
941 $once = FALSE;
942 $this->current_handler->tree_->remove_object($key);
943 }
944 if(isset($obj->object_id) && preg_match("/^Move_Up_Object_".$obj->object_id."_/",$name) && $once){
945 $this->current_handler->tree_->move_up_down($key,"up");
946 $once = FALSE;
947 }
948 if(isset($obj->object_id) && preg_match("/^Move_Down_Object_".$obj->object_id."_/",$name) && $once){
949 $this->current_handler->tree_->move_up_down($key,"down");
950 $once = FALSE;
951 }
952 }
953 }
955 /* Skip Mode changes and Parse tests
956 * if we are currently in a subdialog
957 */
959 $this->current_handler->save_object();
960 $Mode = $this->scripts[$this->current_script]['MODE'];
961 $skip_mode_change = false;
962 if(in_array($Mode,array("Source-Only","Source"))){
963 if(isset($_POST['script_contents'])){
964 $sc = stripslashes($_POST['script_contents']);
965 $this->scripts[$this->current_script]['SCRIPT'] = $sc;
966 $p = new My_Parser($this);
967 if($p -> parse($sc)){
968 $this->Script_Error = "";
969 } else {
970 $this->Script_Error = $p->status_text;
971 $skip_mode_change = TRUE;
972 }
973 }
974 }
975 if(in_array($Mode,array("Structured"))){
976 $sc = $this->current_handler->get_sieve_script();
977 $this->scripts[$this->current_script]['SCRIPT'] = $sc;
978 $p = new My_Parser($this);
979 if($p -> parse($sc)){
980 $this->Script_Error = "";
981 } else {
982 $this->Script_Error = $p->status_text;
983 $skip_mode_change = TRUE;
984 }
985 }
986 if(!$skip_mode_change){
987 if($this->scripts[$this->current_script]['MODE'] != "Source-Only"){
988 $old_mode = $this->scripts[$this->current_script]['MODE'];
989 if(isset($_POST['View_Source'])){
990 $this->scripts[$this->current_script]['MODE'] = "Source";
991 }
992 if(isset($_POST['View_Structured'])){
993 $this->scripts[$this->current_script]['MODE'] = "Structured";
994 }
995 $new_mode = $this->scripts[$this->current_script]['MODE'];
997 if($old_mode != $new_mode){
999 $sc = $this->scripts[$this->current_script]['SCRIPT'];
1000 $p = new My_Parser($this);
1002 if($p -> parse($sc)){
1003 $this->current_handler->parse($sc);
1004 $this->Script_Error = "";
1005 } else {
1006 $this->Script_Error = $p->status_text;
1007 }
1008 }
1009 }
1010 }
1011 }
1012 }
1015 function get_used_script_names()
1016 {
1017 $ret = array();
1018 foreach($this->scripts as $script){
1019 $ret[] = $script['NAME'];
1020 }
1021 return($ret);
1022 }
1026 function save()
1027 {
1028 /* Get sieve */
1029 if(!$this->sieve_handle = $this->get_sieve()){
1030 msg_dialog::display(_("SIEVE error"), sprintf(_("Cannot log into SIEVE server: %s"), '<br><br><i>'.to_string($this->Sieve_Error).'</i>'), ERROR_DIALOG);
1031 return;
1032 }
1034 $everything_went_fine = TRUE;
1036 foreach($this->scripts as $key => $script){
1037 if($script['EDITED']){
1038 $data = $this->scripts[$key]['SCRIPT'];
1039 if(!$this->sieve_handle->sieve_sendscript($script['NAME'], addcslashes ($data,"\\"))){
1040 new log("modify","users/mailAccount".get_class($this),$script['NAME'],"Failed to save sieve script named '".$script['NAME']."': ".to_string($this->sieve_handle->error_raw));
1042 $everything_went_fine = FALSE;
1043 msg_dialog::display(_("SIEVE error"), sprintf(_("Cannot store SIEVE script: %s"), '<br><br><i>'.to_string($this->sieve_handle->error_raw).'</i>'), ERROR_DIALOG);
1044 $this->scripts[$key]['MSG'] = "<font color='red'>".
1045 _("Failed to save sieve script").": ".
1046 to_string($this->sieve_handle->error_raw).
1047 "</font>";
1048 }
1049 }
1050 }
1051 return($everything_went_fine);
1052 }
1053 }
1054 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
1055 ?>