include/sieve/class_sieveManagement.inc

   1 <?php
   2 /*
   3    This code is part of GOsa (https://gosa.gonicus.de)
   4    Copyright (C) 2003-2007 - Fabian Hickert <hickert@gonicus.de>
   5
   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.
  10
  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.
  15
  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  */
  20
  21
  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;
  42
  43   /* To add new elements we need to know
  44    *  Where to 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";
  52
  53   /* If this variable is TRUE, this indicates that we have the
  54    *  import dialog opened.
  55    */
  56   var $Import_Script = FALSE;
  57
  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     $this->uattrib = $uattrib;
  64     $this->parent = $parent;
  65     plugin::plugin($config,$dn);
  66
  67     /* Get sieve */
  68     if(!$this->sieve_handle = $this->get_sieve()){
  69       print_red(
  70         sprintf(
  71           _("Can't log into SIEVE server. Server says '%s'."),
  72           to_string($this->Sieve_Error)));
  73       return;
  74     }
  75
  76
  77     /* Get all sieve scripts names */
  78     if($this->sieve_handle->sieve_listscripts()){
  79       if (is_array($this->sieve_handle->response)){
  80         foreach($this->sieve_handle->response as $key => $name){
  81
  82           $data = array();
  83           $data['NAME'] = $name;
  84
  85           if($key == "ACTIVE" && $key === "ACTIVE"){
  86             $data['ACTIVE'] = TRUE;
  87           }else{
  88             $data['ACTIVE'] = FALSE;
  89           }
  90           $this->scripts[] = $data;
  91         }
  92       }
  93     }
  94
  95     /* Get script contents */
  96     foreach($this->scripts as $key => $script){
  97       $p = new My_Parser($this);
  98       $this->sieve_handle->sieve_getscript($script['NAME']);
  99
 100       $script = "";
 101       foreach($this->sieve_handle->response as $line){
 102         $script.=$line;
 103       }
 104
 105       $this->scripts[$key]['IS_NEW'] = FALSE;;
 106       $this->scripts[$key]['SCRIPT'] = $script;
 107       $this->scripts[$key]['ORIG_SCRIPT'] = $script;
 108       $this->scripts[$key]['MSG']   = "";
 109       $ret = $p->parse($script);
 110       if(!$ret){
 111         $this->scripts[$key]['STATUS']   = FALSE;
 112         $this->scripts[$key]['MODE']    = "Source";
 113         $this->scripts[$key]['MSG'] = _("Parse failed")."<font color='red'>".$p->status_text."</font>";
 114       }else{
 115         $this->scripts[$key]['STATUS']   = TRUE;
 116         $this->scripts[$key]['MODE']    = "Structured";
 117         $this->scripts[$key]['MSG'] = _("Parse successful");
 118       }
 119       $this->scripts[$key]['PARSER'] = $p;
 120       $this->scripts[$key]['EDITED'] = FALSE;
 121     }
 122     $this->sieve_handle = $this->sieve_handle;
 123   }
 124
 125
 126   /* Return a sieve class hanlde,
 127    *  false if login fails
 128    */
 129   function get_sieve()
 130   {
 131
 132     /* Connect to sieve class and try to get all available sieve scripts */
 133     if(isset($this->config->data['SERVERS']['IMAP'][$this->parent->gosaMailServer])){
 134       $cfg=  $this->config->data['SERVERS']['IMAP'][$this->parent->gosaMailServer];
 135       $this->Sieve_Error = "";
 136
 137       $uattrib = $this->uattrib;
 138
 139       /* Log into the mail server */
 140       $this->sieve_handle= new sieve(
 141           $cfg["sieve_server"],
 142           $cfg["sieve_port"],
 143           $this->parent->$uattrib,
 144           $cfg["password"],
 145           $cfg["admin"]);
 146
 147       /* Try to login */
 148       if (!$this->sieve_handle->sieve_login()){
 149         $this->Sieve_Error = $this->sieve_handle->error_raw;
 150         return(FALSE);
 151       }
 152       return($this->sieve_handle);
 153     }else{
 154       $this->Sieve_Error = sprintf(_("The specified mail server '%s' does not exist within the GOsa configuration."),
 155         $this->parent->gosaMailServer);
 156       return(FALSE);
 157     }
 158   }
 159
 160
 161   /* Handle sieve list
 162    */
 163   function execute()
 164   {
 165     /***************
 166      * Create a new Script
 167      ***************/
 168
 169     /* Force opening the add script dialog */
 170     if(isset($_POST['create_new_script'])){
 171       $this->create_script = TRUE;
 172     }
 173
 174     /* Close add script dialog, without adding a new one */
 175     if(isset($_POST['create_script_cancel'])){
 176       $this->create_script = FALSE;
 177     }
 178
 179     /* Display create script dialog
 180      *  handle posts, display warnings if specified
 181      *  name is not useable.
 182      * Create a new script with given name
 183      */
 184     if($this->create_script){
 185
 186       /* Set initial name or used posted name if available */
 187       $name = "";
 188       if(isset($_POST['NewScriptName'])){
 189         $name = trim($_POST['NewScriptName']);
 190       }
 191
 192       /* Check given name */
 193       $err = "";
 194
 195       /* Is given name in lower case characters ? */
 196       if(isset($_POST['create_script_save'])){
 197         if(!strlen($name)){
 198           $err = _("You should specify a name for your new script.");
 199         }
 200         /* Is given name in lower case characters ? */
 201         if($name != strtolower($name)){
 202           $err = _("Only lower case names are allowed here.");
 203         }
 204
 205         /* Only chars are allowed here */
 206         if(preg_match("/[^a-z]/i",$name)){
 207           $err = _("Only a-z are allowed in script names.");
 208         }
 209
 210         $tmp = $this->get_used_script_names();
 211         if(in_array_ics($name,$tmp)){
 212           $err =_("The specified name is already in use.");
 213         }
 214       }
 215
 216       /* Create script if everything is ok */
 217       if($this->create_script && isset($_POST['create_script_save']) && $err == "" ){
 218
 219         /* Close dialog */
 220         $this->create_script = FALSE;
 221
 222         /* Script contents to use */
 223         $script = "/*New script */".
 224                   "stop;";
 225
 226         /* Create a new parser and initialize default values */
 227         $p = new My_Parser($this);
 228         $ret = $p->parse($script);
 229         $sc['SCRIPT'] = $script;
 230         $sc['ORIG_SCRIPT'] = $script;
 231         $sc['IS_NEW'] = TRUE;
 232         $sc['MSG']   = "";
 233         if(!$ret){
 234           $sc['STATUS']   = FALSE;
 235           $sc['MODE']    = "Source";
 236           $sc['MSG'] = _("Parse failed")."<font color='red'>".$p->status_text."</font>";
 237         }else{
 238           $sc['STATUS']   = TRUE;
 239           $sc['MODE']    = "Structured";
 240           $sc['MSG'] = _("Parse successful");
 241         }
 242         $sc['PARSER'] = $p;
 243         $sc['EDITED'] = TRUE;
 244         $sc['ACTIVE'] = FALSE;
 245         $sc['NAME']   = $name;
 246
 247         /* Add script */
 248         $this->scripts[$name] = $sc;
 249       }else{
 250
 251         /* Display dialog to enter new script name */
 252         $smarty = get_smarty();
 253         $smarty->assign("NewScriptName",$name);
 254         $smarty->assign("Error",$err);
 255         return($smarty->fetch(get_template_path("templates/create_script.tpl",TRUE,dirname(__FILE__))));
 256       }
 257     }
 258
 259
 260     /*************
 261      * Handle several posts
 262      *************/
 263
 264     $once = TRUE;
 265     foreach($_POST as $name => $value){
 266
 267       /* Edit script requested */
 268       if(preg_match("/^editscript_/",$name) && $once && !$this->current_handler){
 269         $script = preg_replace("/^editscript_/","",$name);
 270         $script = preg_replace("/_(x|y)/","",$script);
 271         $once = FALSE;
 272
 273         $this->current_script = $script;
 274         $this->current_handler = $this->scripts[$script]['PARSER'];
 275         $this->scripts[$script]['SCRIPT_BACKUP'] = $this->scripts[$script]['SCRIPT'];
 276       }
 277
 278       /* remove script requested */
 279       if($this->parent->acl_is_writeable("sieveManagement") && preg_match("/^delscript_/",$name) && $once && !$this->current_handler){
 280         $script = preg_replace("/^delscript_/","",$name);
 281         $script = preg_replace("/_(x|y)/","",$script);
 282         $once = FALSE;
 283         $this->script_to_delete = $script;
 284       }
 285
 286       /* Activate script */
 287       if($this->parent->acl_is_writeable("sieveManagement") && preg_match("/^active_script_/",$name) && $once && !$this->current_handler){
 288         $script = preg_replace("/^active_script_/","",$name);
 289         $script = preg_replace("/_(x|y)/","",$script);
 290         $once = FALSE;
 291
 292         /* We can only activate existing scripts */
 293         if(!$this->scripts[$script]['IS_NEW']){
 294
 295           /* Get sieve */
 296           if(!$this->sieve_handle = $this->get_sieve()){
 297             print_red(
 298                 sprintf(
 299                   _("Can't log into SIEVE server. Server says '%s'."),
 300                   to_string($this->Sieve_Error)));
 301           }
 302
 303           /* Try to activate the given script and update
 304            *  class script array.
 305            */
 306           if(!$this->sieve_handle->sieve_setactivescript($this->scripts[$script]['NAME'])){
 307             print_red(sprintf(_("Can't activate sieve script on server. Server says '%s'."),to_string($this->sieve_handle->error_raw)));
 308           }else{
 309             foreach($this->scripts as $key => $data){
 310               if($key == $script){
 311                 $this->scripts[$key]['ACTIVE'] = TRUE;
 312               }else{
 313                 $this->scripts[$key]['ACTIVE'] = FALSE;
 314               }
 315             }
 316           }
 317         }
 318       }
 319     }
 320
 321
 322     /*************
 323      * Remove script handling
 324      *************/
 325
 326     /* Remove aborted */
 327     if(isset($_POST['delete_cancel'])){
 328       $this->script_to_delete = -1;
 329     }
 330
 331     /* Remove confirmed */
 332     if($this->parent->acl_is_writeable("sieveManagement") && isset($_POST['delete_script_confirm'])){
 333
 334       $script = $this->scripts[$this->script_to_delete];
 335
 336       /* Just remove from array if it is a new script */
 337       if($script['IS_NEW']){
 338         unset($this->scripts[$this->script_to_delete]);
 339       }else{
 340
 341         /* Get sieve */
 342         if(!$this->sieve_handle = $this->get_sieve()){
 343           print_red(
 344               sprintf(
 345                 _("Can't log into SIEVE server. Server says '%s'."),
 346                 to_string($this->Sieve_Error)));
 347         }
 348
 349         if(!$this->sieve_handle->sieve_deletescript($this->scripts[$this->script_to_delete]['NAME'])){
 350           print_red(sprintf(_("Can't remove sieve script from server. Server says '%s'."),to_string($this->sieve_handle->error_raw)));
 351         }else{
 352           unset($this->scripts[$this->script_to_delete]);
 353         }
 354       }
 355       $this->script_to_delete = -1;
 356     }
 357
 358     /* Display confirm dialog */
 359     if($this->script_to_delete != -1){
 360       $smarty = get_smarty();
 361       $smarty->assign("Warning",
 362           sprintf(_("You are going to remove the sieve script '%s' from your mail server."),
 363             $this->scripts[$this->script_to_delete]['NAME']));
 364       return($smarty->fetch(get_template_path("templates/remove_script.tpl",TRUE,dirname(__FILE__))));
 365     }
 366
 367
 368     /**************
 369      * Save script changes
 370      **************/
 371
 372     /* Abort saving */
 373     if(isset($_POST['cancel_sieve_changes'])){
 374       $tmp = $this->scripts[$this->current_script]['SCRIPT_BACKUP'];
 375       $this->scripts[$this->current_script]['SCRIPT'] = $tmp;
 376       $this->scripts[$this->current_script]['PARSER']->parse($tmp);
 377       $this->current_handler = NULL;
 378     }
 379
 380     /* Save currently edited sieve script. */
 381     if($this->parent->acl_is_writeable("sieveManagement") && isset($_POST['save_sieve_changes'])){
 382       $chk = $this->current_handler->check();
 383       if(!count($chk)){
 384
 385         $sc = $this->scripts[$this->current_script]['SCRIPT'];
 386         $p = new My_Parser($this);
 387         if($p -> parse($sc)){
 388
 389           if($this->scripts[$this->current_script]['MODE'] == "Source-Only"){
 390             $this->scripts[$this->current_script]['MODE'] = "Source";
 391           }
 392
 393           $this->scripts[$this->current_script]['PARSER'] = $p;
 394           $this->scripts[$this->current_script]['EDITED'] = TRUE;
 395           $this->scripts[$this->current_script]['STATUS'] = TRUE;
 396           $this->scripts[$this->current_script]['MSG'] = _("Edited");
 397           $this->current_handler = NULL;
 398         }else{
 399           print_red($p->status_text);;
 400         }
 401       }else{
 402         foreach($chk as $msgs){
 403           print_red(sprintf(_("Please fix all errors before saving. Last error was : %s"),$msgs));
 404         }
 405       }
 406     }
 407
 408
 409     /*************
 410      * Display edit dialog
 411      *************/
 412
 413     /* Display edit dialog, depending on Mode display different uis
 414      */
 415     if($this->current_handler){
 416
 417         if(isset($_POST['Import_Script'])){
 418           $this->Import_Script = TRUE;
 419         }
 420
 421         if(isset($_POST['Import_Script_Cancel'])){
 422           $this->Import_Script = FALSE;
 423         }
 424
 425         if(isset($_POST['Import_Script_Save']) && isset($_FILES['Script_To_Import'])){
 426
 427           $file     = $_FILES['Script_To_Import'];
 428
 429           if($file['size'] == 0){
 430             print_red(_("Specified file seams to empty."));
 431           }elseif(!file_exists($file['tmp_name'])){
 432             print_red(_("Upload failed, somehow nothing was uploaded or the temporary file can't be accessed."));
 433           }elseif(!is_readable ($file['tmp_name'])){
 434             print_red(sprintf(_("Can't open file '%s' to read uploaded file contents."),$file['tmp_name']));
 435           }else{
 436
 437
 438
 439             $contents = file_get_contents($file['tmp_name']);
 440
 441             $this->scripts[$this->current_script]['SCRIPT'] = $contents;
 442             if(!$this->current_handler->parse($contents)){
 443               $this->scripts[$this->current_script]['MODE'] = "Source";
 444             }else{
 445               $this->scripts[$this->current_script]['MODE'] = "Structured";
 446             }
 447             $this->Script_Error = "";
 448             $this->Import_Script = FALSE;
 449           }
 450         }
 451
 452         if($this->Import_Script){
 453           $smarty = get_smarty();
 454           $str = $smarty->fetch(get_template_path("templates/import_script.tpl",TRUE,dirname(__FILE__)));
 455           return($str);
 456         }
 457
 458
 459         /* Create dump of current sieve script */
 460         if(isset($_POST['Save_Copy'])){
 461
 462             /* force download dialog */
 463             header("Content-type: application/tiff\n");
 464             if (preg_match('/MSIE 5.5/', $HTTP_USER_AGENT) ||
 465                     preg_match('/MSIE 6.0/', $HTTP_USER_AGENT)) {
 466                 header('Content-Disposition: filename="dump.script"');
 467             } else {
 468                 header('Content-Disposition: attachment; filename="dump.script"');
 469             }
 470             header("Content-transfer-encoding: binary\n");
 471             header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
 472             header("Last-Modified: ".gmdate("D, d M Y H:i:s")." GMT");
 473             header("Cache-Control: no-cache");
 474             header("Pragma: no-cache");
 475             header("Cache-Control: post-check=0, pre-check=0");
 476             echo $this->scripts[$this->current_script]['SCRIPT'];
 477             exit();
 478         }
 479
 480
 481       /****
 482        * Add new element to ui
 483        ****/
 484
 485       /* Abort add dialog */
 486       if(isset($_POST['select_new_element_type_cancel'])){
 487         $this->add_new_element = FALSE;
 488       }
 489
 490       /* Add a new element */
 491       if($this->add_new_element){
 492
 493         $element_types= array(
 494             "sieve_keep"      => _("Keep"),
 495             "sieve_comment"   => _("Comment"),
 496             "sieve_fileinto"  => _("File into"),
 497             "sieve_keep"      => _("Keep"),
 498             "sieve_discard"   => _("Discard"),
 499             "sieve_redirect"  => _("Redirect"),
 500             "sieve_reject"    => _("Reject"),
 501             "sieve_require"   => _("Require"),
 502             "sieve_stop"      => _("Stop"),
 503             "sieve_vacation"  => _("Vacation message"),
 504             "sieve_if"        => _("If"));
 505
 506
 507         /* Element selected */
 508         if(isset($_POST['element_type']) && isset($element_types[$_POST['element_type']])
 509            || isset($_POST['element_type']) &&in_array($_POST['element_type'],array("sieve_else","sieve_elsif"))){
 510           $this->add_element_type = $_POST['element_type'];
 511         }
 512
 513         /* Create new element and add it to
 514          *  the selected position
 515          */
 516         if(isset($_POST['select_new_element_type'])){
 517           if($this->add_new_element_to_current_script($this->add_element_type,$this->add_new_id,$this->add_above_below)){
 518             $this->add_new_element = FALSE;
 519           }else{
 520             print_red(_("Failed to add new element."));
 521           }
 522         }
 523       }
 524
 525       /* Only display select dialog if it is necessary */
 526       if($this->add_new_element){
 527         $smarty = get_smarty();
 528
 529         $add_else_elsif = FALSE;
 530
 531         /* Check if we should add else/elsif to the select box
 532          *  or not. We can't add else twice!.
 533          */
 534         if($this->add_above_below == "below"){
 535
 536           /* Get posistion of the current element
 537            */
 538           foreach($this->current_handler->tree_->pap as $key => $obj){
 539
 540             if($obj->object_id == $this->add_new_id && in_array(get_class($obj),array("sieve_if","sieve_elsif"))){
 541
 542               /* Get block start/end */
 543               $end_id = $this->current_handler->tree_->get_block_end($key);
 544               $else_found = FALSE;
 545               $elsif_found = FALSE;
 546
 547               /* Check if there is already an else in this block
 548                */
 549               for($i =  $key ; $i < $end_id ; $i ++){
 550                 if(get_class($this->current_handler->tree_->pap[$i]) == "sieve_else"){
 551                   $else_found = TRUE;
 552                 }
 553                 if(get_class($this->current_handler->tree_->pap[$i]) == "sieve_elsif"){
 554                   $elsif_found = TRUE;
 555                 }
 556               }
 557
 558               /* Only allow adding 'else' if there is currently
 559                *  no 'else' statement. And don't allow adding
 560                *  'else' before 'elseif'
 561                */
 562               if(!$else_found && (!(get_class($obj) == "sieve_if" && $elsif_found))){
 563                 $element_types['sieve_else'] = _("Else");
 564               }
 565               $element_types['sieve_elsif'] = _("Else if");
 566             }
 567           }
 568         }
 569
 570         $smarty->assign("element_types",$element_types );
 571         $smarty->assign("element_type",$this->add_element_type);
 572         $str = $smarty->fetch(get_template_path("templates/add_element.tpl",TRUE,dirname(__FILE__)));
 573         return($str);
 574       }
 575
 576
 577
 578       /****************
 579        * Handle test posts
 580        ****************/
 581
 582       /* handle some special posts from test elements
 583        */
 584       foreach($_POST as $name => $value){
 585         if(preg_match("/^Add_Test_Object_/",$name)) {
 586           $name = preg_replace("/^Add_Test_Object_/","",$name);
 587           $name = preg_replace("/_(x|y)$/","",$name);
 588
 589           $test_types_to_add = array(
 590               "address" =>_("Address"),
 591               "header"  =>_("Header"),
 592               "envelope"=>_("Envelope"),
 593               "size"    =>_("Size"),
 594               "exists"  =>_("Exists"),
 595               "allof"   =>_("All of"),
 596               "anyof"   =>_("Any of"),
 597               "true"    =>_("True"),
 598               "false"   =>_("False"));
 599
 600           $smarty = get_smarty();
 601           $smarty->assign("ID",$name);
 602           $smarty->assign("test_types_to_add",$test_types_to_add);
 603           $ret = $smarty->fetch(get_template_path("templates/select_test_type.tpl",TRUE,dirname(__FILE__)));
 604           return($ret);
 605         }
 606       }
 607
 608       $current = $this->scripts[$this->current_script];
 609
 610       /* Create html results */
 611       $smarty = get_smarty();
 612       $smarty->assign("Mode",$current['MODE']);
 613       if($current['MODE'] == "Structured"){
 614         $smarty->assign("Contents",$this->current_handler->tree_->execute());
 615       }else{
 616         $smarty->assign("Contents",$current['SCRIPT']);
 617       }
 618       $smarty->assign("Script_Error",$this->Script_Error);
 619       $ret = $smarty->fetch(get_template_path("templates/edit_frame_base.tpl",TRUE,dirname(__FILE__)));
 620       return($ret);
 621     }
 622
 623
 624     /* Create list of available sieve scripts
 625      */
 626     $List = new divSelectBox("sieveManagement");
 627     foreach($this->scripts as $key => $script){
 628
 629       $edited =  $script['EDITED'];
 630       $active =  $script['ACTIVE'];
 631
 632       $field1 = array("string" => "&nbsp;",
 633                       "attach" => "style='width:20px;'");
 634       if($active){
 635         $field1 = array("string" => "<img src='images/true.png' alt='"._("Active")."'
 636                                       title='"._("This script is marked as active")."'>",
 637                         "attach" => "style='width:20px;'");
 638       }
 639       $field2 = array("string" => $script['NAME']);
 640       $field3 = array("string" => $script['MSG']);
 641       $field4 = array("string" => _("Script length")."&nbsp;:&nbsp;".strlen($script['SCRIPT']));
 642
 643       if($this->parent->acl_is_writeable("sieveManagement")){
 644         $del = "<input type='image' name='delscript_".$key."' src='images/edittrash.png'
 645                   title='"._("Remove script")."'>";
 646       }else{
 647         $del = "<img src='images/empty' alt=' '>";
 648       }
 649
 650       if($active || $script['IS_NEW'] || !$this->parent->acl_is_writeable("sieveManagement")){
 651         $activate = "<img src='images/empty' alt=' '>";
 652       }else{
 653         $activate = "<input type='image' name='active_script_".$key."' src='images/true.png'
 654                        title='"._("Activate script")."'>";
 655       }
 656
 657       $field6 = array("string" => $activate."<input type='image' name='editscript_".$key."' src='images/edit.png'
 658                         title='"._("Edit script")."'>".$del,
 659                       "attach" => "style='border-right:0px; width:70px;'");
 660       $List ->AddEntry(array($field1,$field2,$field3,$field4,$field6));
 661     }
 662
 663     $display ="<h2>Sieve script management</h2>";
 664     $display .= _("Be careful. All your changes will be saved directly to sieve, if you use the save button below.");
 665     $display .= "<br><input type='submit' name='create_new_script' value='"._("Create new script")."'>";
 666     $display .=  $List->DrawList();
 667
 668     $display .= "<p style=\"text-align:right\">\n";
 669     $display .= "<input type=submit name=\"sieve_finish\" style=\"width:80px\" value=\""._("Ok")."\">\n";
 670     $display .= "&nbsp;\n";
 671     $display .= "<input type=submit name=\"sieve_cancel\" value=\""._("Cancel")."\">\n";
 672     $display .= "</p>";
 673     return($display);;
 674   }
 675
 676
 677   /* Add a new element to the currently opened script editor.
 678    * The insert position is specified by
 679    */
 680   function add_new_element_to_current_script($type,$id,$position)
 681   {
 682     /* Test given data */
 683     if(!in_array_ics($position,array("above","below"))){
 684       trigger_error("Can't add new element with \$position=".$position.". Only 'above','below' are allowed here.");
 685       return(FALSE);
 686     }
 687     if(!is_numeric($id)){
 688       trigger_error("Can't add new element, given id is not numeric.");
 689       return(FALSE);
 690     }
 691     $tmp = get_declared_classes();
 692     if(!in_array($type,$tmp)){
 693       trigger_error("Can't add new element, given \$class=".$class." does not exists.");
 694       return(FALSE);
 695     }
 696     if(!is_object($this->current_handler) || get_class($this->current_handler) != "My_Parser"){
 697       trigger_error("Can't add new element, there is no valid script editor opened.");
 698       return(FALSE);
 699     }
 700
 701     /* Create elements we should add
 702      * -Some element require also surrounding block elements
 703      */
 704     $parent = $this->current_handler->tree_;
 705     if($this->add_element_type == "sieve_if"){
 706       $ele[] = new $this->add_element_type(NULL, preg_replace("/[^0-9]/","",microtime()),$parent);
 707       $ele[] = new sieve_block_start(NULL,preg_replace("/[^0-9]/","",microtime()),$parent);
 708       $ele[] = new sieve_block_end(NULL,preg_replace("/[^0-9]/","",microtime()),$parent);
 709     }elseif($this->add_element_type == "sieve_else"){
 710       $ele[] = new sieve_block_end(NULL,preg_replace("/[^0-9]/","",microtime()),$parent);
 711       $ele[] = new $this->add_element_type(NULL, preg_replace("/[^0-9]/","",microtime()),$parent);
 712       $ele[] = new sieve_block_start(NULL,preg_replace("/[^0-9]/","",microtime()),$parent);
 713     }elseif($this->add_element_type == "sieve_elsif"){
 714       $ele[] = new sieve_block_end(NULL,preg_replace("/[^0-9]/","",microtime()),$parent);
 715       $ele[] = new $this->add_element_type(NULL, preg_replace("/[^0-9]/","",microtime()),$parent);
 716       $ele[] = new sieve_block_start(NULL,preg_replace("/[^0-9]/","",microtime()),$parent);
 717     }else{
 718       $ele[] = new $this->add_element_type(NULL, preg_replace("/[^0-9]/","",microtime()),$parent);
 719     }
 720
 721     /* Get index of the element identified by object_id == $id;
 722      */
 723     $index = -1;
 724     $data = $this->current_handler->tree_->pap;
 725     foreach($data as $key => $obj){
 726       if($obj->object_id == $id && $index==-1){
 727         $index = $key;
 728       }
 729     }
 730
 731     /* Tell to user that we couldn't find the given object
 732      *  so we can't add an element.
 733      */
 734     if($index == -1 ){
 735       trigger_error("Can't add new element, specified \$id=".$id." could not be found in object tree.");
 736       return(FALSE);
 737     }
 738
 739     /* We have found the specified object_id
 740      *  and want to detect the next free position
 741      *  to insert the new element.
 742      */
 743     if($position == "above"){
 744       $direction ="up";
 745       $next_free = $this->current_handler->tree_->_get_next_free_move_slot($index,$direction,TRUE);
 746     }else{
 747       $direction = "down";
 748       $next_free = $this->current_handler->tree_->_get_next_free_move_slot($index,$direction,TRUE);
 749     }
 750     /* This is extremly necessary, cause some objects
 751      *  updates the tree objects ... Somehow i should change this ...
 752      */
 753     $data = $this->current_handler->tree_->pap;
 754     $start = $end = array();
 755
 756     if($position == "above"){
 757       $start = array_slice($data,0,$next_free);
 758       $end   = array_slice($data,$next_free);
 759     }else{
 760       $start = array_slice($data,0,$next_free+1);
 761       $end   = array_slice($data,$next_free+1);
 762     }
 763
 764     $new = array();
 765     foreach($start as $obj){
 766       $new[] = $obj;
 767     }
 768     foreach($ele as $el){
 769       $new[] = $el;
 770     }
 771     foreach($end as $obj){
 772       $new[] = $obj;
 773     }
 774     $data= $new;
 775     $this->current_handler->tree_->pap = $data;
 776     return(TRUE);
 777   }
 778
 779
 780
 781   function save_object()
 782   {
 783     if($this->current_handler){
 784
 785       if(isset($_GET['Add_Object_Top_ID'])){
 786         $this->add_new_element    = TRUE;
 787         $this->add_new_id         = $_GET['Add_Object_Top_ID'];
 788         $this->add_above_below    = "above";
 789       }
 790
 791       if(isset($_GET['Add_Object_Bottom_ID'])){
 792         $this->add_new_element    = TRUE;
 793         $this->add_new_id         = $_GET['Add_Object_Bottom_ID'];
 794         $this->add_above_below    = "below";
 795       }
 796
 797       if(isset($_GET['Remove_Object_ID'])){
 798         $found_id = -1;
 799         foreach($this->current_handler->tree_->pap as $key => $element){
 800           if($element->object_id == $_GET['Remove_Object_ID']){
 801             $found_id = $key;
 802           }
 803         }
 804         if($found_id != -1 ){
 805           $this->current_handler->tree_->remove_object($found_id);
 806         }
 807       }
 808
 809       if(isset($_GET['Move_Up_Object_ID'])){
 810         $found_id = -1;
 811         foreach($this->current_handler->tree_->pap as $key => $element){
 812           if($element->object_id == $_GET['Move_Up_Object_ID']){
 813             $found_id = $key;
 814           }
 815         }
 816         if($found_id != -1 ){
 817           $this->current_handler->tree_->move_up_down($found_id,"up");
 818         }
 819       }
 820
 821       if(isset($_GET['Move_Down_Object_ID'])){
 822         $found_id = -1;
 823         foreach($this->current_handler->tree_->pap as $key => $element){
 824           if($element->object_id == $_GET['Move_Down_Object_ID']){
 825             $found_id = $key;
 826           }
 827         }
 828         if($found_id != -1 ){
 829           $this->current_handler->tree_->move_up_down($found_id,"down");
 830         }
 831       }
 832
 833
 834       /* Check if there is an add object requested
 835        */
 836       $data = $this->current_handler->tree_->pap;
 837       $once = TRUE;
 838       foreach($_POST as $name => $value){
 839         foreach($data as $key => $obj){
 840           if(isset($obj->object_id) && preg_match("/^Add_Object_Top_".$obj->object_id."_/",$name) && $once){
 841             $once = FALSE;
 842             $this->add_new_element    = TRUE;
 843             $this->add_new_id         = $obj->object_id;
 844             $this->add_above_below    = "above";
 845           }
 846           if(isset($obj->object_id) && preg_match("/^Add_Object_Bottom_".$obj->object_id."_/",$name) && $once){
 847             $once = FALSE;
 848             $this->add_new_element    = TRUE;
 849             $this->add_new_id         = $obj->object_id;
 850             $this->add_above_below    = "below";
 851           }
 852
 853           if(isset($obj->object_id) && preg_match("/^Remove_Object_".$obj->object_id."_/",$name) && $once){
 854             $once = FALSE;
 855             $this->current_handler->tree_->remove_object($key);
 856           }
 857           if(isset($obj->object_id) && preg_match("/^Move_Up_Object_".$obj->object_id."_/",$name) && $once){
 858             $this->current_handler->tree_->move_up_down($key,"up");
 859             $once = FALSE;
 860           }
 861           if(isset($obj->object_id) && preg_match("/^Move_Down_Object_".$obj->object_id."_/",$name) && $once){
 862             $this->current_handler->tree_->move_up_down($key,"down");
 863             $once = FALSE;
 864           }
 865         }
 866       }
 867
 868       /* Skip Mode changes and Parse tests
 869        *  if we are currently in a subdialog
 870        */
 871
 872       $this->current_handler->save_object();
 873       $Mode = $this->scripts[$this->current_script]['MODE'];
 874       $skip_mode_change = false;
 875       if(in_array($Mode,array("Source-Only","Source"))){
 876         if(isset($_POST['script_contents'])){
 877           $sc = stripslashes($_POST['script_contents']);
 878           $this->scripts[$this->current_script]['SCRIPT'] = $sc;
 879           $p = new My_Parser($this);
 880           if($p -> parse($sc)){
 881             $this->Script_Error = "";
 882           } else {
 883             $this->Script_Error = $p->status_text;
 884             $skip_mode_change = TRUE;
 885           }
 886         }
 887       }
 888       if(in_array($Mode,array("Structured"))){
 889         $sc = $this->current_handler->get_sieve_script();
 890         $this->scripts[$this->current_script]['SCRIPT'] = $sc;
 891         $p = new My_Parser($this);
 892         if($p -> parse($sc)){
 893           $this->Script_Error = "";
 894         } else {
 895           $this->Script_Error = $p->status_text;
 896           $skip_mode_change = TRUE;
 897         }
 898       }
 899       if(!$skip_mode_change){
 900         if($this->scripts[$this->current_script]['MODE'] != "Source-Only"){
 901           $old_mode = $this->scripts[$this->current_script]['MODE'];
 902           if(isset($_POST['View_Source'])){
 903             $this->scripts[$this->current_script]['MODE'] = "Source";
 904           }
 905           if(isset($_POST['View_Structured'])){
 906             $this->scripts[$this->current_script]['MODE'] = "Structured";
 907           }
 908           $new_mode = $this->scripts[$this->current_script]['MODE'];
 909
 910           if($old_mode != $new_mode){
 911
 912             $sc = $this->scripts[$this->current_script]['SCRIPT'];
 913             $p = new My_Parser($this);
 914
 915             if($p -> parse($sc)){
 916               $this->current_handler->parse($sc);
 917               $this->Script_Error = "";
 918             } else {
 919               $this->Script_Error = $p->status_text;
 920             }
 921           }
 922         }
 923       }
 924     }
 925   }
 926
 927
 928   function get_used_script_names()
 929   {
 930     $ret = array();
 931     foreach($this->scripts as $script){
 932       $ret[] = $script['NAME'];
 933     }
 934     return($ret);
 935   }
 936
 937
 938
 939   function save()
 940   {
 941     /* Get sieve */
 942     if(!$this->sieve_handle = $this->get_sieve()){
 943       print_red(
 944           sprintf(
 945             _("Can't log into SIEVE server. Server says '%s'."),
 946             to_string($this->Sieve_Error)));
 947     }
 948
 949     $everything_went_fine = TRUE;
 950
 951     foreach($this->scripts as $key => $script){
 952       if($script['EDITED']){
 953         $data = $this->scripts[$key]['SCRIPT'];
 954         if(!$this->sieve_handle->sieve_sendscript($script['NAME'], addcslashes ($data,"\\"))){
 955           gosa_log("Failed to save sieve script named '".$script['NAME']."': ".to_string($this->sieve_handle->error_raw));
 956           $everything_went_fine = FALSE;
 957           print_red(to_string($this->sieve_handle->error_raw));
 958           $this->scripts[$key]['MSG'] = "<font color='red'>".
 959                                            _("Failed to save sieve script").": ".
 960                                            to_string($this->sieve_handle->error_raw).
 961                                            "</font>";
 962         }
 963       }
 964     }
 965     return($everything_went_fine);
 966   }
 967 }
 968 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 969 ?>