gosa-plugins/mail/personal/mail/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 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";
  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     /* 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     }
  67
  68     $this->uattrib = $uattrib;
  69     $this->parent = &$parent;
  70     plugin::plugin($config,$dn);
  71
  72     /* Get sieve, if this fail abort class initialization */
  73     if(!$this->sieve_handle = $this->get_sieve()){
  74       return;
  75     }
  76
  77
  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){
  82
  83           $data = array();
  84           $data['NAME'] = $name;
  85
  86           if($key == "ACTIVE" && $key === "ACTIVE"){
  87             $data['ACTIVE'] = TRUE;
  88           }else{
  89             $data['ACTIVE'] = FALSE;
  90           }
  91           $this->scripts[] = $data;
  92         }
  93       }
  94     }
  95
  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']);
 100
 101       $script = "";
 102       foreach($this->sieve_handle->response as $line){
 103         $script.=$line;
 104       }
 105
 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   }
 125
 126
 127   /* Return a sieve class handle,
 128    *  false if login fails
 129    */
 130   function get_sieve()
 131   {
 132
 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 = "";
 137
 138       $uattrib = $this->uattrib;
 139
 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"],
 147           $cfg["sieve_option"]);
 148
 149       /* Try to login */
 150       if (!@$this->sieve_handle->sieve_login()){
 151         $this->Sieve_Error = $this->sieve_handle->error_raw;
 152         return(FALSE);
 153       }
 154       return($this->sieve_handle);
 155     }else{
 156       $this->Sieve_Error = sprintf(_("The specified mail server '%s' does not exist within the GOsa configuration."),
 157         $this->parent->gosaMailServer);
 158       return(FALSE);
 159     }
 160   }
 161
 162
 163   /* Handle sieve list
 164    */
 165   function execute()
 166   {
 167     plugin::execute();
 168     /***************
 169      * Create a new Script
 170      ***************/
 171
 172     /* Force opening the add script dialog */
 173     if(isset($_POST['create_new_script'])){
 174       $this->create_script = TRUE;
 175     }
 176
 177     /* Close add script dialog, without adding a new one */
 178     if(isset($_POST['create_script_cancel'])){
 179       $this->create_script = FALSE;
 180     }
 181
 182     /* Display create script dialog
 183      *  handle posts, display warnings if specified
 184      *  name is not useable.
 185      * Create a new script with given name
 186      */
 187     if($this->create_script){
 188
 189       /* Set initial name or used posted name if available */
 190       $name = "";
 191       if(isset($_POST['NewScriptName'])){
 192         $name = trim($_POST['NewScriptName']);
 193       }
 194
 195       /* Check given name */
 196       $err = false;
 197
 198       /* Is given name in lower case characters ? */
 199       if(isset($_POST['create_script_save'])){
 200         if(!strlen($name)){
 201           $err =true;
 202           msg_dialog::display(_("Error"), _("No script name specified!"), ERROR_DIALOG);
 203         }
 204         /* Is given name in lower case characters ? */
 205         if($name != strtolower($name)){
 206           $err =true;
 207           msg_dialog::display(_("Error"), _("Please use only lowercase script names!"), ERROR_DIALOG);
 208         }
 209
 210         /* Only chars are allowed here */
 211         if(preg_match("/[^a-z]/i",$name)){
 212           $err =true;
 213           msg_dialog::display(_("Error"), _("Please use only alphabetical characters in script names!"), ERROR_DIALOG);
 214         }
 215
 216         $tmp = $this->get_used_script_names();
 217         if(in_array_ics($name,$tmp)){
 218           $err =true;
 219           msg_dialog::display(_("Error"), _("Script name already in use!"), ERROR_DIALOG);
 220         }
 221       }
 222
 223       /* Create script if everything is ok */
 224       if($this->create_script && isset($_POST['create_script_save']) && !$err){
 225
 226         /* Close dialog */
 227         $this->create_script = FALSE;
 228
 229         /* Script contents to use */
 230         $script = "/*New script */".
 231                   "stop;";
 232
 233         /* Create a new parser and initialize default values */
 234         $p = new My_Parser($this);
 235         $ret = $p->parse($script);
 236         $sc['SCRIPT'] = $script;
 237         $sc['ORIG_SCRIPT'] = $script;
 238         $sc['IS_NEW'] = TRUE;
 239         $sc['MSG']   = "";
 240         if(!$ret){
 241           $sc['STATUS']   = FALSE;
 242           $sc['MODE']    = "Source";
 243           $sc['MSG'] = _("Parse failed")."<font color='red'>".$p->status_text."</font>";
 244         }else{
 245           $sc['STATUS']   = TRUE;
 246           $sc['MODE']    = "Structured";
 247           $sc['MSG'] = _("Parse successful");
 248         }
 249         $sc['PARSER'] = $p;
 250         $sc['EDITED'] = TRUE;
 251         $sc['ACTIVE'] = FALSE;
 252         $sc['NAME']   = $name;
 253
 254         /* Add script */
 255         $this->scripts[$name] = $sc;
 256       }else{
 257
 258         /* Display dialog to enter new script name */
 259         $smarty = get_smarty();
 260         $smarty->assign("NewScriptName",$name);
 261         return($smarty->fetch(get_template_path("templates/create_script.tpl",TRUE,dirname(__FILE__))));
 262       }
 263     }
 264
 265
 266     /*************
 267      * Handle several posts
 268      *************/
 269
 270     $once = TRUE;
 271     foreach($_POST as $name => $value){
 272
 273       /* Edit script requested */
 274       if(preg_match("/^editscript_/",$name) && $once && !$this->current_handler){
 275         $script = preg_replace("/^editscript_/","",$name);
 276         $script = preg_replace("/_(x|y)/","",$script);
 277         $once = FALSE;
 278
 279         $this->current_script = $script;
 280         $this->current_handler = $this->scripts[$script]['PARSER'];
 281         $this->scripts[$script]['SCRIPT_BACKUP'] = $this->scripts[$script]['SCRIPT'];
 282       }
 283
 284       /* remove script requested */
 285       if($this->parent->acl_is_writeable("sieveManagement") && preg_match("/^delscript_/",$name) && $once && !$this->current_handler){
 286         $script = preg_replace("/^delscript_/","",$name);
 287         $script = preg_replace("/_(x|y)/","",$script);
 288         $once = FALSE;
 289         $this->script_to_delete = $script;
 290       }
 291
 292       /* Activate script */
 293       if($this->parent->acl_is_writeable("sieveManagement") && preg_match("/^active_script_/",$name) && $once && !$this->current_handler){
 294         $script = preg_replace("/^active_script_/","",$name);
 295         $script = preg_replace("/_(x|y)/","",$script);
 296         $once = FALSE;
 297
 298         /* We can only activate existing scripts */
 299         if(!$this->scripts[$script]['IS_NEW']){
 300
 301           /* Get sieve */
 302           if(!$this->sieve_handle = $this->get_sieve()){
 303             msg_dialog::display(_("SIEVE error"), sprintf(_("Cannot log into SIEVE server: %s"), '<br><br><i>'.to_string($this->Sieve_Error).'</i>'), ERROR_DIALOG);
 304           }
 305
 306           /* Try to activate the given script and update
 307            *  class script array.
 308            */
 309           if(!$this->sieve_handle->sieve_setactivescript($this->scripts[$script]['NAME'])){
 310             msg_dialog::display(_("SIEVE error"), sprintf(_("Cannot retrieve SIEVE script: %s"), '<br><br><i>'.to_string($this->sieve_handler->error_raw).'</i>'), ERROR_DIALOG);
 311           }else{
 312             foreach($this->scripts as $key => $data){
 313               if($key == $script){
 314                 $this->scripts[$key]['ACTIVE'] = TRUE;
 315               }else{
 316                 $this->scripts[$key]['ACTIVE'] = FALSE;
 317               }
 318             }
 319           }
 320         }
 321       }
 322     }
 323
 324
 325     /*************
 326      * Remove script handling
 327      *************/
 328
 329     /* Remove aborted */
 330     if(isset($_POST['delete_cancel'])){
 331       $this->script_to_delete = -1;
 332     }
 333
 334     /* Remove confirmed */
 335     if($this->parent->acl_is_writeable("sieveManagement") && isset($_POST['delete_script_confirm'])){
 336
 337       $script = $this->scripts[$this->script_to_delete];
 338
 339       /* Just remove from array if it is a new script */
 340       if($script['IS_NEW']){
 341         unset($this->scripts[$this->script_to_delete]);
 342       }else{
 343
 344         /* Get sieve */
 345         if(!$this->sieve_handle = $this->get_sieve()){
 346           msg_dialog::display(_("SIEVE error"), sprintf(_("Cannot log into SIEVE server: %s"), '<br><br><i>'.to_string($this->Sieve_Error).'</i>'), ERROR_DIALOG);
 347         }
 348
 349         if(!$this->sieve_handle->sieve_deletescript($this->scripts[$this->script_to_delete]['NAME'])){
 350           msg_dialog::display(_("SIEVE error"), sprintf(_("Cannot remove SIEVE script: %s"), '<br><br><i>'.to_string($this->sieve_handler->error_raw).'</i>'), ERROR_DIALOG);
 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",msgPool::deleteInfo($this->scripts[$this->script_to_delete]['NAME']));
 362       return($smarty->fetch(get_template_path("templates/remove_script.tpl",TRUE,dirname(__FILE__))));
 363     }
 364
 365
 366     /**************
 367      * Save script changes
 368      **************/
 369
 370     /* Abort saving */
 371     if(isset($_POST['cancel_sieve_changes'])){
 372       $tmp = $this->scripts[$this->current_script]['SCRIPT_BACKUP'];
 373       $this->scripts[$this->current_script]['SCRIPT'] = $tmp;
 374       $this->scripts[$this->current_script]['PARSER']->parse($tmp);
 375       $this->current_handler = NULL;
 376     }
 377
 378     /* Save currently edited sieve script. */
 379     if($this->parent->acl_is_writeable("sieveManagement") &&
 380        isset($_POST['save_sieve_changes']) &&
 381        is_object($this->current_handler)){
 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           msg_dialog::display(_("SIEVE error"), $p->status_text, ERROR_DIALOG);
 400         }
 401       }else{
 402         foreach($chk as $msgs){
 403           msg_dialog::display(_("SIEVE error"), $msgs, ERROR_DIALOG);
 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             msg_dialog::display(_("Error"), _("Uploaded script is empty!"), ERROR_DIALOG);
 431           }elseif(!file_exists($file['tmp_name'])){
 432             msg_dialog::display(_("Internal error"), sprintf(_("Cannot access temporary file '%s'!"), $file['tmp_name']), ERROR_DIALOG);
 433           }elseif(!is_readable ($file['tmp_name'])){
 434             msg_dialog::display(_("SIEVE error"), sprintf(_("Cannot open temporary file '%s'!"), $file['tmp_name']), ERROR_DIALOG);
 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             msg_dialog::display(_("SIEVE error"), _("Cannot add new element!") , ERROR_DIALOG);
 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;".strlen($script['SCRIPT']));
 642
 643       if($this->parent->acl_is_writeable("sieveManagement")){
 644         $del = "<input type='image' name='delscript_".$key."' src='images/lists/trash.png'
 645                   title='"._("Remove script")."'>";
 646       }else{
 647         $del = "<img src='images/empty.png' alt=' '>";
 648       }
 649
 650       if($active || $script['IS_NEW'] || !$this->parent->acl_is_writeable("sieveManagement")){
 651         $activate = "<img src='images/empty.png' 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/lists/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     $List->SetHeight(400);
 664
 665     /* If the uattrib is empty   (Attribute to use for authentification with sieve)
 666      *  Display a message that the connection can't be established.
 667      */
 668     $uattrib = $this->uattrib;
 669     $smarty = get_smarty();
 670
 671     if(!$this->get_sieve()){
 672       $smarty->assign("Sieve_Error",sprintf(
 673         _("Can't log into SIEVE server. Server says '%s'."),
 674           to_string($this->Sieve_Error)));
 675     }else{
 676       $smarty->assign("Sieve_Error","");
 677     }
 678
 679     $smarty->assign("uattrib_empty",empty($this->parent->$uattrib));
 680     $smarty->assign("List",$List->DrawList());
 681     return($smarty->fetch(get_template_path("templates/management.tpl",TRUE,dirname(__FILE__))));
 682   }
 683
 684
 685   /* Add a new element to the currently opened script editor.
 686    * The insert position is specified by
 687    */
 688   function add_new_element_to_current_script($type,$id,$position)
 689   {
 690     /* Test given data */
 691     if(!in_array_ics($position,array("above","below"))){
 692       trigger_error("Can't add new element with \$position=".$position.". Only 'above','below' are allowed here.");
 693       return(FALSE);
 694     }
 695     if(!is_numeric($id)){
 696       trigger_error("Can't add new element, given id is not numeric.");
 697       return(FALSE);
 698     }
 699     if(!class_available($type)){
 700       if(!empty($type)){
 701         trigger_error("Can't add new element, given \$class=".$class." does not exists.");
 702       }
 703       return(FALSE);
 704     }
 705     if(!is_object($this->current_handler) || get_class($this->current_handler) != "My_Parser"){
 706       trigger_error("Can't add new element, there is no valid script editor opened.");
 707       return(FALSE);
 708     }
 709
 710     /* These element types are allowed to be added here */
 711     $element_types= array(
 712         "sieve_keep"      => _("Keep"),
 713         "sieve_comment"   => _("Comment"),
 714         "sieve_fileinto"  => _("File into"),
 715         "sieve_keep"      => _("Keep"),
 716         "sieve_discard"   => _("Discard"),
 717         "sieve_redirect"  => _("Redirect"),
 718         "sieve_reject"    => _("Reject"),
 719         "sieve_require"   => _("Require"),
 720         "sieve_stop"      => _("Stop"),
 721         "sieve_vacation"  => _("Vacation message"),
 722         "sieve_if"        => _("If"));
 723
 724     /* Check if we should add else/elsif to the select box
 725      *  or not. We can't add else twice!.
 726      */
 727
 728     /* Get posistion of the current element
 729      */
 730     foreach($this->current_handler->tree_->pap as $key => $obj){
 731
 732       if($obj->object_id == $id && in_array(get_class($obj),array("sieve_if","sieve_elsif"))){
 733
 734         /* Get block start/end */
 735         $end_id = $this->current_handler->tree_->get_block_end($key);
 736         $else_found = FALSE;
 737         $elsif_found = FALSE;
 738
 739         /* Check if there is already an else in this block
 740          */
 741         for($i =  $key ; $i < $end_id ; $i ++){
 742           if(get_class($this->current_handler->tree_->pap[$i]) == "sieve_else"){
 743             $else_found = TRUE;
 744           }
 745           if(get_class($this->current_handler->tree_->pap[$i]) == "sieve_elsif"){
 746             $elsif_found = TRUE;
 747           }
 748         }
 749
 750         if($this->add_above_below == "below"){
 751
 752           /* Only allow adding 'else' if there is currently
 753            *  no 'else' statement. And don't allow adding
 754            *  'else' before 'elseif'
 755            */
 756           if(!$else_found && (!(get_class($obj) == "sieve_if" && $elsif_found))){
 757             $element_types['sieve_else'] = _("Else");
 758           }
 759           $element_types['sieve_elsif'] = _("Else If");
 760         }else{
 761
 762           /* Allow adding elsif above elsif */
 763           if(in_array(get_class($obj),array("sieve_elsif"))){
 764             $element_types['sieve_elsif'] = _("Else If");
 765           }
 766         }
 767       }
 768     }
 769
 770     if(!isset($element_types[$type])){
 771       msg_dialog::display(_("SIEVE error"), _("Cannot insert element at the requested position!") , ERROR_DIALOG);
 772       return;
 773     }
 774
 775
 776     /* Create elements we should add
 777      * -Some element require also surrounding block elements
 778      */
 779     $parent = $this->current_handler->tree_;
 780     if($this->add_element_type == "sieve_if"){
 781       $ele[] = new $this->add_element_type(NULL, preg_replace("/[^0-9]/","",microtime()),$parent);
 782       $ele[] = new sieve_block_start(NULL,preg_replace("/[^0-9]/","",microtime()),$parent);
 783       $ele[] = new sieve_block_end(NULL,preg_replace("/[^0-9]/","",microtime()),$parent);
 784     }elseif($this->add_element_type == "sieve_else"){
 785       $ele[] = new sieve_block_end(NULL,preg_replace("/[^0-9]/","",microtime()),$parent);
 786       $ele[] = new $this->add_element_type(NULL, preg_replace("/[^0-9]/","",microtime()),$parent);
 787       $ele[] = new sieve_block_start(NULL,preg_replace("/[^0-9]/","",microtime()),$parent);
 788     }elseif($this->add_element_type == "sieve_elsif"){
 789       $ele[] = new sieve_block_end(NULL,preg_replace("/[^0-9]/","",microtime()),$parent);
 790       $ele[] = new $this->add_element_type(NULL, preg_replace("/[^0-9]/","",microtime()),$parent);
 791       $ele[] = new sieve_block_start(NULL,preg_replace("/[^0-9]/","",microtime()),$parent);
 792     }elseif($this->add_element_type == "sieve_vacation"){
 793
 794       /* Automatically add addresses to sieve alternate addresses */
 795       $data = NULL;
 796       $tmp = new $this->add_element_type($data, preg_replace("/[^0-9]/","",microtime()),$parent);
 797       if(isset($this->parent->gosaMailAlternateAddress)){
 798         $tmp->addresses = $this->parent->gosaMailAlternateAddress;
 799       }
 800       $ele[] = $tmp ;
 801     }else{
 802       $ele[] = new $this->add_element_type(NULL, preg_replace("/[^0-9]/","",microtime()),$parent);
 803     }
 804
 805     /* Get index of the element identified by object_id == $id;
 806      */
 807     $index = -1;
 808     $data = $this->current_handler->tree_->pap;
 809     foreach($data as $key => $obj){
 810       if($obj->object_id == $id && $index==-1){
 811         $index = $key;
 812       }
 813     }
 814
 815     /* Tell to user that we couldn't find the given object
 816      *  so we can't add an element.
 817      */
 818     if($index == -1 ){
 819       trigger_error("Can't add new element, specified \$id=".$id." could not be found in object tree.");
 820       return(FALSE);
 821     }
 822
 823     /* We have found the specified object_id
 824      *  and want to detect the next free position
 825      *  to insert the new element.
 826      */
 827     if($position == "above"){
 828       $direction ="up";
 829       $next_free = $this->current_handler->tree_->_get_next_free_move_slot($index,$direction,TRUE);
 830     }else{
 831       $direction = "down";
 832       $next_free = $this->current_handler->tree_->_get_next_free_move_slot($index,$direction,TRUE);
 833     }
 834     /* This is extremly necessary, cause some objects
 835      *  updates the tree objects ... Somehow i should change this ...
 836      */
 837     $data = $this->current_handler->tree_->pap;
 838     $start = $end = array();
 839
 840     if($position == "above"){
 841       $start = array_slice($data,0,$next_free);
 842       $end   = array_slice($data,$next_free);
 843     }else{
 844       $start = array_slice($data,0,$next_free+1);
 845       $end   = array_slice($data,$next_free+1);
 846     }
 847
 848     $new = array();
 849     foreach($start as $obj){
 850       $new[] = $obj;
 851     }
 852     foreach($ele as $el){
 853       $new[] = $el;
 854     }
 855     foreach($end as $obj){
 856       $new[] = $obj;
 857     }
 858     $data= $new;
 859     $this->current_handler->tree_->pap = $data;
 860     return(TRUE);
 861   }
 862
 863
 864
 865   function save_object()
 866   {
 867     if($this->current_handler){
 868
 869       if(isset($_GET['Add_Object_Top_ID'])){
 870         $this->add_new_element    = TRUE;
 871         $this->add_new_id         = $_GET['Add_Object_Top_ID'];
 872         $this->add_above_below    = "above";
 873       }
 874
 875       if(isset($_GET['Add_Object_Bottom_ID'])){
 876         $this->add_new_element    = TRUE;
 877         $this->add_new_id         = $_GET['Add_Object_Bottom_ID'];
 878         $this->add_above_below    = "below";
 879       }
 880
 881       if(isset($_GET['Remove_Object_ID'])){
 882         $found_id = -1;
 883         foreach($this->current_handler->tree_->pap as $key => $element){
 884           if($element->object_id == $_GET['Remove_Object_ID']){
 885             $found_id = $key;
 886           }
 887         }
 888         if($found_id != -1 ){
 889           $this->current_handler->tree_->remove_object($found_id);
 890         }
 891       }
 892
 893       if(isset($_GET['Move_Up_Object_ID'])){
 894         $found_id = -1;
 895         foreach($this->current_handler->tree_->pap as $key => $element){
 896           if($element->object_id == $_GET['Move_Up_Object_ID']){
 897             $found_id = $key;
 898           }
 899         }
 900         if($found_id != -1 ){
 901           $this->current_handler->tree_->move_up_down($found_id,"up");
 902         }
 903       }
 904
 905       if(isset($_GET['Move_Down_Object_ID'])){
 906         $found_id = -1;
 907         foreach($this->current_handler->tree_->pap as $key => $element){
 908           if($element->object_id == $_GET['Move_Down_Object_ID']){
 909             $found_id = $key;
 910           }
 911         }
 912         if($found_id != -1 ){
 913           $this->current_handler->tree_->move_up_down($found_id,"down");
 914         }
 915       }
 916
 917
 918       /* Check if there is an add object requested
 919        */
 920       $data = $this->current_handler->tree_->pap;
 921       $once = TRUE;
 922       foreach($_POST as $name => $value){
 923         foreach($data as $key => $obj){
 924           if(isset($obj->object_id) && preg_match("/^Add_Object_Top_".$obj->object_id."_/",$name) && $once){
 925             $once = FALSE;
 926             $this->add_element_type   =  $_POST['element_type_'.$obj->object_id];
 927             $this->add_new_element    = FALSE;
 928             $this->add_new_id         = $obj->object_id;
 929             $this->add_above_below    = "above";
 930             $this->add_new_element_to_current_script($this->add_element_type,$this->add_new_id,$this->add_above_below);
 931           }
 932           if(isset($obj->object_id) && preg_match("/^Add_Object_Bottom_".$obj->object_id."_/",$name) && $once){
 933             $once = FALSE;
 934             $this->add_element_type   =  $_POST['element_type_'.$obj->object_id];
 935             $this->add_new_element    = FALSE;
 936             $this->add_new_id         = $obj->object_id;
 937             $this->add_above_below    = "below";
 938             $this->add_new_element_to_current_script($this->add_element_type,$this->add_new_id,$this->add_above_below);
 939           }
 940
 941           if(isset($obj->object_id) && preg_match("/^Remove_Object_".$obj->object_id."_/",$name) && $once){
 942             $once = FALSE;
 943             $this->current_handler->tree_->remove_object($key);
 944           }
 945           if(isset($obj->object_id) && preg_match("/^Move_Up_Object_".$obj->object_id."_/",$name) && $once){
 946             $this->current_handler->tree_->move_up_down($key,"up");
 947             $once = FALSE;
 948           }
 949           if(isset($obj->object_id) && preg_match("/^Move_Down_Object_".$obj->object_id."_/",$name) && $once){
 950             $this->current_handler->tree_->move_up_down($key,"down");
 951             $once = FALSE;
 952           }
 953         }
 954       }
 955
 956       /* Skip Mode changes and Parse tests
 957        *  if we are currently in a subdialog
 958        */
 959
 960       $this->current_handler->save_object();
 961       $Mode = $this->scripts[$this->current_script]['MODE'];
 962       $skip_mode_change = false;
 963       if(in_array($Mode,array("Source-Only","Source"))){
 964         if(isset($_POST['script_contents'])){
 965           $sc = stripslashes($_POST['script_contents']);
 966           $this->scripts[$this->current_script]['SCRIPT'] = $sc;
 967           $p = new My_Parser($this);
 968           if($p -> parse($sc)){
 969             $this->Script_Error = "";
 970           } else {
 971             $this->Script_Error = $p->status_text;
 972             $skip_mode_change = TRUE;
 973           }
 974         }
 975       }
 976       if(in_array($Mode,array("Structured"))){
 977         $sc = $this->current_handler->get_sieve_script();
 978         $this->scripts[$this->current_script]['SCRIPT'] = $sc;
 979         $p = new My_Parser($this);
 980         if($p -> parse($sc)){
 981           $this->Script_Error = "";
 982         } else {
 983           $this->Script_Error = $p->status_text;
 984           $skip_mode_change = TRUE;
 985         }
 986       }
 987       if(!$skip_mode_change){
 988         if($this->scripts[$this->current_script]['MODE'] != "Source-Only"){
 989           $old_mode = $this->scripts[$this->current_script]['MODE'];
 990           if(isset($_POST['View_Source'])){
 991             $this->scripts[$this->current_script]['MODE'] = "Source";
 992           }
 993           if(isset($_POST['View_Structured'])){
 994             $this->scripts[$this->current_script]['MODE'] = "Structured";
 995           }
 996           $new_mode = $this->scripts[$this->current_script]['MODE'];
 997
 998           if($old_mode != $new_mode){
 999
1000             $sc = $this->scripts[$this->current_script]['SCRIPT'];
1001             $p = new My_Parser($this);
1002
1003             if($p -> parse($sc)){
1004               $this->current_handler->parse($sc);
1005               $this->Script_Error = "";
1006             } else {
1007               $this->Script_Error = $p->status_text;
1008             }
1009           }
1010         }
1011       }
1012     }
1013   }
1014
1015
1016   function get_used_script_names()
1017   {
1018     $ret = array();
1019     foreach($this->scripts as $script){
1020       $ret[] = $script['NAME'];
1021     }
1022     return($ret);
1023   }
1024
1025
1026
1027   function save()
1028   {
1029     /* Get sieve */
1030     if(!$this->sieve_handle = $this->get_sieve()){
1031       msg_dialog::display(_("SIEVE error"), sprintf(_("Cannot log into SIEVE server: %s"), '<br><br><i>'.to_string($this->Sieve_Error).'</i>'), ERROR_DIALOG);
1032       return;
1033     }
1034
1035     $everything_went_fine = TRUE;
1036
1037     foreach($this->scripts as $key => $script){
1038       if($script['EDITED']){
1039         $data = $this->scripts[$key]['SCRIPT'];
1040         if(!$this->sieve_handle->sieve_sendscript($script['NAME'], addcslashes ($data,"\\"))){
1041           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
1043           $everything_went_fine = FALSE;
1044           msg_dialog::display(_("SIEVE error"), sprintf(_("Cannot store SIEVE script: %s"), '<br><br><i>'.to_string($this->sieve_handle->error_raw).'</i>'), ERROR_DIALOG);
1045           $this->scripts[$key]['MSG'] = "<font color='red'>".
1046                                            _("Failed to save sieve script").": ".
1047                                            to_string($this->sieve_handle->error_raw).
1048                                            "</font>";
1049         }
1050       }
1051     }
1052     return($everything_went_fine);
1053   }
1054 }
1055 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
1056 ?>