gosa-core/include/class_plugin.inc

   1 <?php
   2 /*
   3  * This code is part of GOsa (http://www.gosa-project.org)
   4  * Copyright (C) 2003-2008 GONICUS GmbH
   5  *
   6  * ID: $$Id$$
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 /*! \brief   The plugin base class
  24   \author  Cajus Pollmeier <pollmeier@gonicus.de>
  25   \version 2.00
  26   \date    24.07.2003
  27
  28   This is the base class for all plugins. It can be used standalone or
  29   can be included by the tabs class. All management should be done
  30   within this class. Extend your plugins from this class.
  31  */
  32
  33 class plugin
  34 {
  35   /*!
  36     \brief Reference to parent object
  37
  38     This variable is used when the plugin is included in tabs
  39     and keeps reference to the tab class. Communication to other
  40     tabs is possible by 'name'. So the 'fax' plugin can ask the
  41     'userinfo' plugin for the fax number.
  42
  43     \sa tab
  44    */
  45   var $parent= NULL;
  46
  47   /*!
  48     \brief Configuration container
  49
  50     Access to global configuration
  51    */
  52   var $config= NULL;
  53
  54   /*!
  55     \brief Mark plugin as account
  56
  57     Defines whether this plugin is defined as an account or not.
  58     This has consequences for the plugin to be saved from tab
  59     mode. If it is set to 'FALSE' the tab will call the delete
  60     function, else the save function. Should be set to 'TRUE' if
  61     the construtor detects a valid LDAP object.
  62
  63     \sa plugin::plugin()
  64    */
  65   var $is_account= FALSE;
  66   var $initially_was_account= FALSE;
  67
  68   /*!
  69     \brief Mark plugin as template
  70
  71     Defines whether we are creating a template or a normal object.
  72     Has conseqences on the way execute() shows the formular and how
  73     save() puts the data to LDAP.
  74
  75     \sa plugin::save() plugin::execute()
  76    */
  77   var $is_template= FALSE;
  78   var $ignore_account= FALSE;
  79   var $is_modified= FALSE;
  80
  81   /*!
  82     \brief Represent temporary LDAP data
  83
  84     This is only used internally.
  85    */
  86   var $attrs= array();
  87
  88   /* Keep set of conflicting plugins */
  89   var $conflicts= array();
  90
  91   /* Save unit tags */
  92   var $gosaUnitTag= "";
  93   var $skipTagging= FALSE;
  94
  95   /*!
  96     \brief Used standard values
  97
  98     dn
  99    */
 100   var $dn= "";
 101   var $uid= "";
 102   var $sn= "";
 103   var $givenName= "";
 104   var $acl= "*none*";
 105   var $dialog= FALSE;
 106   var $snapDialog = NULL;
 107
 108   /* attribute list for save action */
 109   var $attributes= array();
 110   var $objectclasses= array();
 111   var $is_new= TRUE;
 112   var $saved_attributes= array();
 113
 114   var $acl_base= "";
 115   var $acl_category= "";
 116   var $read_only = FALSE; // Used when the entry is opened as "readonly" due to locks.
 117
 118   /* This can be set to render the tabulators in another stylesheet */
 119   var $pl_notify= FALSE;
 120
 121   /* Object entry CSN */
 122   var $entryCSN         = "";
 123   var $CSN_check_active = FALSE;
 124
 125   /* This variable indicates that this class can handle multiple dns at once. */
 126   var $multiple_support = FALSE;
 127   var $multi_attrs      = array();
 128   var $multi_attrs_all  = array();
 129
 130   /* This aviable indicates, that we are currently in multiple edit handle */
 131   var $multiple_support_active = FALSE;
 132   var $selected_edit_values = array();
 133   var $multi_boxes = array();
 134
 135   /*! \brief plugin constructor
 136
 137     If 'dn' is set, the node loads the given 'dn' from LDAP
 138
 139     \param dn Distinguished name to initialize plugin from
 140     \sa plugin()
 141    */
 142   function plugin (&$config, $dn= NULL, $parent= NULL)
 143   {
 144     /* Configuration is fine, allways */
 145     $this->config= &$config;
 146     $this->dn= $dn;
 147
 148     /* Handle new accounts, don't read information from LDAP */
 149     if ($dn == "new"){
 150       return;
 151     }
 152
 153     /* Check if this entry was opened in read only mode */
 154     if(isset($_POST['open_readonly'])){
 155       if(session::global_is_set("LOCK_CACHE")){
 156         $cache = &session::get("LOCK_CACHE");
 157         if(isset($cache['READ_ONLY'][$this->dn])){
 158           $this->read_only = TRUE;
 159         }
 160       }
 161     }
 162
 163     /* Save current dn as acl_base */
 164     $this->acl_base= $dn;
 165
 166     /* Get LDAP descriptor */
 167     if ($dn !== NULL){
 168
 169       /* Load data to 'attrs' and save 'dn' */
 170       if ($parent !== NULL){
 171         $this->attrs= $parent->attrs;
 172       } else {
 173         $ldap= $this->config->get_ldap_link();
 174         $ldap->cat ($dn);
 175         $this->attrs= $ldap->fetch();
 176       }
 177
 178       /* Copy needed attributes */
 179       foreach ($this->attributes as $val){
 180         $found= array_key_ics($val, $this->attrs);
 181         if ($found != ""){
 182           $this->$val= $found[0];
 183         }
 184       }
 185
 186       /* gosaUnitTag loading... */
 187       if (isset($this->attrs['gosaUnitTag'][0])){
 188         $this->gosaUnitTag= $this->attrs['gosaUnitTag'][0];
 189       }
 190
 191       /* Set the template flag according to the existence of objectClass
 192          gosaUserTemplate */
 193       if (isset($this->attrs['objectClass'])){
 194         if (in_array_ics ("gosaUserTemplate", $this->attrs['objectClass'])){
 195           $this->is_template= TRUE;
 196           @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,
 197               "found", "Template check");
 198         }
 199       }
 200
 201       /* Is Account? */
 202       $found= TRUE;
 203       foreach ($this->objectclasses as $obj){
 204         if (preg_match('/top/i', $obj)){
 205           continue;
 206         }
 207         if (!isset($this->attrs['objectClass']) || !in_array_ics ($obj, $this->attrs['objectClass'])){
 208           $found= FALSE;
 209           break;
 210         }
 211       }
 212       if ($found){
 213         $this->is_account= TRUE;
 214         @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,
 215             "found", "Object check");
 216       }
 217
 218       /* Prepare saved attributes */
 219       $this->saved_attributes= $this->attrs;
 220       foreach ($this->saved_attributes as $index => $value){
 221         if (is_numeric($index)){
 222           unset($this->saved_attributes[$index]);
 223           continue;
 224         }
 225
 226         if (!in_array_ics($index, $this->attributes) && strcasecmp('objectClass', $index)){
 227           unset($this->saved_attributes[$index]);
 228           continue;
 229         }
 230
 231         if (isset($this->saved_attributes[$index][0])){
 232           if(!isset($this->saved_attributes[$index]["count"])){
 233             $this->saved_attributes[$index]["count"] = count($this->saved_attributes[$index]);
 234           }
 235           if($this->saved_attributes[$index]["count"] == 1){
 236             $tmp= $this->saved_attributes[$index][0];
 237             unset($this->saved_attributes[$index]);
 238             $this->saved_attributes[$index]= $tmp;
 239             continue;
 240           }
 241         }
 242         unset($this->saved_attributes["$index"]["count"]);
 243       }
 244
 245       if(isset($this->attrs['gosaUnitTag'])){
 246         $this->saved_attributes['gosaUnitTag'] = $this->attrs['gosaUnitTag'][0];
 247       }
 248     }
 249
 250     /* Save initial account state */
 251     $this->initially_was_account= $this->is_account;
 252   }
 253
 254
 255   /*! \brief execute plugin
 256
 257     Generates the html output for this node
 258    */
 259   function execute()
 260   {
 261     /* This one is empty currently. Fabian - please fill in the docu code */
 262     session::global_set('current_class_for_help',get_class($this));
 263
 264     /* Reset Lock message POST/GET check array, to prevent perg_match errors*/
 265     session::set('LOCK_VARS_TO_USE',array());
 266     session::set('LOCK_VARS_USED',array());
 267   }
 268
 269   /*! \brief execute plugin
 270      Removes object from parent
 271    */
 272   function remove_from_parent()
 273   {
 274     /* include global link_info */
 275     $ldap= $this->config->get_ldap_link();
 276
 277     /* Get current objectClasses in order to add the required ones */
 278     $ldap->cat($this->dn);
 279     $tmp= $ldap->fetch ();
 280     $oc= array();
 281     if (isset($tmp['objectClass'])){
 282       $oc= $tmp['objectClass'];
 283       unset($oc['count']);
 284     }
 285
 286     /* Remove objectClasses from entry */
 287     $ldap->cd($this->dn);
 288     $this->attrs= array();
 289     $this->attrs['objectClass']= array_remove_entries_ics($this->objectclasses,$oc);
 290
 291     /* Unset attributes from entry */
 292     foreach ($this->attributes as $val){
 293       $this->attrs["$val"]= array();
 294     }
 295
 296     /* Unset account info */
 297     $this->is_account= FALSE;
 298
 299     /* Do not write in plugin base class, this must be done by
 300        children, since there are normally additional attribs,
 301        lists, etc. */
 302     /*
 303        $ldap->modify($this->attrs);
 304      */
 305   }
 306
 307
 308   /*! \brief   Save HTML posted data to object
 309    */
 310   function save_object()
 311   {
 312     /* Update entry CSN if it is empty. */
 313     if(empty($this->entryCSN) && $this->CSN_check_active){
 314       $this->entryCSN = getEntryCSN($this->dn);
 315     }
 316
 317     /* Save values to object */
 318     foreach ($this->attributes as $val){
 319       if ($this->acl_is_writeable($val) && isset ($_POST["$val"])){
 320         /* Check for modifications */
 321         if (get_magic_quotes_gpc()) {
 322           $data= stripcslashes($_POST["$val"]);
 323         } else {
 324           $data= $this->$val = $_POST["$val"];
 325         }
 326         if ($this->$val != $data){
 327           $this->is_modified= TRUE;
 328         }
 329
 330         /* Okay, how can I explain this fix ...
 331          * In firefox, disabled option fields aren't selectable ... but in IE you can select these fileds.
 332          * So IE posts these 'unselectable' option, with value = chr(194)
 333          * chr(194) seems to be the &nbsp; in between the ...option>&nbsp;</option.. because there is no value=".." specified in these option fields
 334          * This &nbsp; was added for W3c compliance, but now causes these ... ldap errors ...
 335          * So we set these Fields to ""; a normal empty string, and we can check these values in plugin::check() again ...
 336          */
 337         if(isset($data[0]) && $data[0] == chr(194)) {
 338           $data = "";
 339         }
 340         $this->$val= $data;
 341       }
 342     }
 343   }
 344
 345
 346   /* Save data to LDAP, depending on is_account we save or delete */
 347   function save()
 348   {
 349     /* include global link_info */
 350     $ldap= $this->config->get_ldap_link();
 351
 352     /* Save all plugins */
 353     $this->entryCSN = "";
 354
 355     /* Start with empty array */
 356     $this->attrs= array();
 357
 358     /* Get current objectClasses in order to add the required ones */
 359     $ldap->cat($this->dn);
 360
 361     $tmp= $ldap->fetch ();
 362
 363     $oc= array();
 364     if (isset($tmp['objectClass'])){
 365       $oc= $tmp["objectClass"];
 366       $this->is_new= FALSE;
 367       unset($oc['count']);
 368     } else {
 369       $this->is_new= TRUE;
 370     }
 371
 372     /* Load (minimum) attributes, add missing ones */
 373     $this->attrs['objectClass']= gosa_array_merge($oc,$this->objectclasses);
 374
 375     /* Copy standard attributes */
 376     foreach ($this->attributes as $val){
 377       if ($this->$val != ""){
 378         $this->attrs["$val"]= $this->$val;
 379       } elseif (!$this->is_new) {
 380         $this->attrs["$val"]= array();
 381       }
 382     }
 383
 384     /* Handle tagging */
 385     $this->tag_attrs($this->attrs);
 386   }
 387
 388
 389   function cleanup()
 390   {
 391     foreach ($this->attrs as $index => $value){
 392
 393       /* Convert arrays with one element to non arrays, if the saved
 394          attributes are no array, too */
 395       if (is_array($this->attrs[$index]) &&
 396           count ($this->attrs[$index]) == 1 &&
 397           isset($this->saved_attributes[$index]) &&
 398           !is_array($this->saved_attributes[$index])){
 399
 400         $tmp= $this->attrs[$index][0];
 401         $this->attrs[$index]= $tmp;
 402       }
 403
 404       /* Remove emtpy arrays if they do not differ */
 405       if (is_array($this->attrs[$index]) &&
 406           count($this->attrs[$index]) == 0 &&
 407           !isset($this->saved_attributes[$index])){
 408
 409         unset ($this->attrs[$index]);
 410         continue;
 411       }
 412
 413       /* Remove single attributes that do not differ */
 414       if (!is_array($this->attrs[$index]) &&
 415           isset($this->saved_attributes[$index]) &&
 416           !is_array($this->saved_attributes[$index]) &&
 417           $this->attrs[$index] == $this->saved_attributes[$index]){
 418
 419         unset ($this->attrs[$index]);
 420         continue;
 421       }
 422
 423       /* Remove arrays that do not differ */
 424       if (is_array($this->attrs[$index]) &&
 425           isset($this->saved_attributes[$index]) &&
 426           is_array($this->saved_attributes[$index])){
 427
 428         if (!array_differs($this->attrs[$index],$this->saved_attributes[$index])){
 429           unset ($this->attrs[$index]);
 430           continue;
 431         }
 432       }
 433     }
 434
 435     /* Update saved attributes and ensure that next cleanups will be successful too */
 436     foreach($this->attrs as $name => $value){
 437       $this->saved_attributes[$name] = $value;
 438     }
 439   }
 440
 441   /* Check formular input */
 442   function check()
 443   {
 444     $message= array();
 445
 446     /* Skip if we've no config object */
 447     if (!isset($this->config) || !is_object($this->config)){
 448       return $message;
 449     }
 450
 451     /* Find hooks entries for this class */
 452     $command= $this->config->search(get_class($this), "CHECK", array('menu', 'tabs'));
 453
 454     if ($command != ""){
 455
 456       if (!check_command($command)){
 457         $message[]= msgPool::cmdnotfound("CHECK", get_class($this));
 458       } else {
 459
 460         /* Generate "ldif" for check hook */
 461         $ldif= "dn: $this->dn\n";
 462
 463         /* ... objectClasses */
 464         foreach ($this->objectclasses as $oc){
 465           $ldif.= "objectClass: $oc\n";
 466         }
 467
 468         /* ... attributes */
 469         foreach ($this->attributes as $attr){
 470           if ($this->$attr == ""){
 471             continue;
 472           }
 473           if (is_array($this->$attr)){
 474             foreach ($this->$attr as $val){
 475               $ldif.= "$attr: $val\n";
 476             }
 477           } else {
 478               $ldif.= "$attr: ".$this->$attr."\n";
 479           }
 480         }
 481
 482         /* Append empty line */
 483         $ldif.= "\n";
 484
 485         /* Feed "ldif" into hook and retrieve result*/
 486         $descriptorspec = array( 0 => array("pipe", "r"), 1 => array("pipe", "w"), 2 => array("pipe", "w"));
 487         $fh= proc_open($command, $descriptorspec, $pipes);
 488         if (is_resource($fh)) {
 489           fwrite ($pipes[0], $ldif);
 490           fclose($pipes[0]);
 491
 492           $result= stream_get_contents($pipes[1]);
 493           if ($result != ""){
 494             $message[]= $result;
 495           }
 496
 497           fclose($pipes[1]);
 498           fclose($pipes[2]);
 499           proc_close($fh);
 500         }
 501       }
 502
 503     }
 504
 505     /* Check entryCSN */
 506     if($this->CSN_check_active){
 507       $current_csn = getEntryCSN($this->dn);
 508       if($current_csn != $this->entryCSN && !empty($this->entryCSN) && !empty($current_csn)){
 509         $this->entryCSN = $current_csn;
 510         $message[] = _("The object has changed since opened in GOsa. All changes that may be done by others get lost if you save this entry!");
 511       }
 512     }
 513     return ($message);
 514   }
 515
 516   /* Adapt from template, using 'dn' */
 517   function adapt_from_template($dn, $skip= array())
 518   {
 519     /* Include global link_info */
 520     $ldap= $this->config->get_ldap_link();
 521
 522     /* Load requested 'dn' to 'attrs' */
 523     $ldap->cat ($dn);
 524     $this->attrs= $ldap->fetch();
 525
 526     /* Walk through attributes */
 527     foreach ($this->attributes as $val){
 528
 529       /* Skip the ones in skip list */
 530       if (in_array($val, $skip)){
 531         continue;
 532       }
 533
 534       if (isset($this->attrs["$val"][0])){
 535
 536         /* If attribute is set, replace dynamic parts:
 537            %sn, %givenName and %uid. Fill these in our local variables. */
 538         $value= $this->attrs["$val"][0];
 539
 540         foreach (array("sn", "givenName", "uid") as $repl){
 541           if (preg_match("/%$repl/i", $value)){
 542             $value= preg_replace ("/%$repl/i", $this->parent->$repl, $value);
 543           }
 544         }
 545         $this->$val= $value;
 546       }
 547     }
 548
 549     /* Is Account? */
 550     $found= TRUE;
 551     foreach ($this->objectclasses as $obj){
 552       if (preg_match('/top/i', $obj)){
 553         continue;
 554       }
 555       if (!in_array_ics ($obj, $this->attrs['objectClass'])){
 556         $found= FALSE;
 557         break;
 558       }
 559     }
 560     if ($found){
 561       $this->is_account= TRUE;
 562     }
 563   }
 564
 565   /* Indicate whether a password change is needed or not */
 566   function password_change_needed()
 567   {
 568     return FALSE;
 569   }
 570
 571
 572   /* Show header message for tab dialogs */
 573   function show_enable_header($button_text, $text, $disabled= FALSE)
 574   {
 575     if (($disabled == TRUE) || (!$this->acl_is_createable())){
 576       $state= "disabled";
 577     } else {
 578       $state= "";
 579     }
 580     $display= "<table summary=\"\" width=\"100%\"><tr>\n<td colspan=2><p><b>$text</b></p>\n";
 581     $display.= "<input type=submit value=\"$button_text\" name=\"modify_state\" ".$state.
 582       "><p class=\"seperator\">&nbsp;</p></td></tr></table>";
 583
 584     return($display);
 585   }
 586
 587
 588   /* Show header message for tab dialogs */
 589   function show_disable_header($button_text, $text, $disabled= FALSE)
 590   {
 591     if (($disabled == TRUE) || !$this->acl_is_removeable()){
 592       $state= "disabled";
 593     } else {
 594       $state= "";
 595     }
 596     $display= "<table summary=\"\" width=\"100%\"><tr>\n<td colspan=2><p><b>$text</b></p>\n";
 597     $display.= "<input type=submit value=\"$button_text\" name=\"modify_state\" ".$state.
 598       "><p class=\"seperator\">&nbsp;</p></td></tr></table>";
 599
 600     return($display);
 601   }
 602
 603
 604   /* Show header message for tab dialogs */
 605   function show_header($button_text, $text, $disabled= FALSE)
 606   {
 607     echo "FIXME: show_header should be replaced by show_disable_header and show_enable_header<br>";
 608     if ($disabled == TRUE){
 609       $state= "disabled";
 610     } else {
 611       $state= "";
 612     }
 613     $display= "<table summary=\"\" width=\"100%\"><tr>\n<td colspan=2><p><b>$text</b></p>\n";
 614     $display.= "<input type=submit value=\"$button_text\" name=\"modify_state\" ".
 615       ($this->acl_is_createable()?'':'disabled')." ".$state.
 616       "><p class=\"seperator\">&nbsp;</p></td></tr></table>";
 617
 618     return($display);
 619   }
 620
 621
 622   function postcreate($add_attrs= array())
 623   {
 624     /* Find postcreate entries for this class */
 625     $command= $this->config->search(get_class($this), "POSTCREATE",array('menu', 'tabs'));
 626
 627     if ($command != ""){
 628
 629       /* Walk through attribute list */
 630       foreach ($this->attributes as $attr){
 631         if (!is_array($this->$attr)){
 632           $add_attrs[$attr] = $this->$attr;
 633         }
 634       }
 635       $add_attrs['dn']=$this->dn;
 636
 637       $tmp = array();
 638       foreach($add_attrs as $name => $value){
 639         $tmp[$name] =  strlen($name);
 640       }
 641       arsort($tmp);
 642
 643       /* Additional attributes */
 644       foreach ($tmp as $name => $len){
 645         $value = $add_attrs[$name];
 646         $command= str_replace("%$name", "$value", $command);
 647       }
 648
 649       if (check_command($command)){
 650         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,
 651             $command, "Execute");
 652         exec($command,$arr);
 653         foreach($arr as $str){
 654           @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,
 655             $command, "Result: ".$str);
 656         }
 657       } else {
 658         $message= msgPool::cmdnotfound("POSTCREATE", get_class($this));
 659         msg_dialog::display(_("Error"), $message, ERROR_DIALOG);
 660       }
 661     }
 662   }
 663
 664   function postmodify($add_attrs= array())
 665   {
 666     /* Find postcreate entries for this class */
 667     $command= $this->config->search(get_class($this), "POSTMODIFY",array('menu','tabs'));
 668
 669     if ($command != ""){
 670
 671       /* Walk through attribute list */
 672       foreach ($this->attributes as $attr){
 673         if (!is_array($this->$attr)){
 674           $add_attrs[$attr] = $this->$attr;
 675         }
 676       }
 677       $add_attrs['dn']=$this->dn;
 678
 679       $tmp = array();
 680       foreach($add_attrs as $name => $value){
 681         $tmp[$name] =  strlen($name);
 682       }
 683       arsort($tmp);
 684
 685       /* Additional attributes */
 686       foreach ($tmp as $name => $len){
 687         $value = $add_attrs[$name];
 688         $command= str_replace("%$name", "$value", $command);
 689       }
 690
 691       if (check_command($command)){
 692         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,$command, "Execute");
 693         exec($command,$arr);
 694         foreach($arr as $str){
 695           @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,
 696             $command, "Result: ".$str);
 697         }
 698       } else {
 699         $message= msgPool::cmdnotfound("POSTMODIFY", get_class($this));
 700         msg_dialog::display(_("Error"), $message, ERROR_DIALOG);
 701       }
 702     }
 703   }
 704
 705   function postremove($add_attrs= array())
 706   {
 707     /* Find postremove entries for this class */
 708     $command= $this->config->search(get_class($this), "POSTREMOVE",array('menu','tabs'));
 709     if ($command != ""){
 710
 711       /* Walk through attribute list */
 712       foreach ($this->attributes as $attr){
 713         if (!is_array($this->$attr)){
 714           $add_attrs[$attr] = $this->$attr;
 715         }
 716       }
 717       $add_attrs['dn']=$this->dn;
 718
 719       $tmp = array();
 720       foreach($add_attrs as $name => $value){
 721         $tmp[$name] =  strlen($name);
 722       }
 723       arsort($tmp);
 724
 725       /* Additional attributes */
 726       foreach ($tmp as $name => $len){
 727         $value = $add_attrs[$name];
 728         $command= str_replace("%$name", "$value", $command);
 729       }
 730
 731       if (check_command($command)){
 732         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,
 733             $command, "Execute");
 734
 735         exec($command,$arr);
 736         foreach($arr as $str){
 737           @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,
 738             $command, "Result: ".$str);
 739         }
 740       } else {
 741         $message= msgPool::cmdnotfound("POSTREMOVE", get_class($this));
 742         msg_dialog::display(_("Error"), $message, ERROR_DIALOG);
 743       }
 744     }
 745   }
 746
 747   /* Create unique DN */
 748   function create_unique_dn($attribute, $base)
 749   {
 750     $ldap= $this->config->get_ldap_link();
 751     $base= preg_replace("/^,*/", "", $base);
 752
 753     /* Try to use plain entry first */
 754     $dn= "$attribute=".$this->$attribute.",$base";
 755     $ldap->cat ($dn, array('dn'));
 756     if (!$ldap->fetch()){
 757       return ($dn);
 758     }
 759
 760     /* Look for additional attributes */
 761     foreach ($this->attributes as $attr){
 762       if ($attr == $attribute || $this->$attr == ""){
 763         continue;
 764       }
 765
 766       $dn= "$attribute=".$this->$attribute."+$attr=".$this->$attr.",$base";
 767       $ldap->cat ($dn, array('dn'));
 768       if (!$ldap->fetch()){
 769         return ($dn);
 770       }
 771     }
 772
 773     /* None found */
 774     return ("none");
 775   }
 776
 777   function rebind($ldap, $referral)
 778   {
 779     $credentials= LDAP::get_credentials($referral, $this->config->current['REFERRAL']);
 780     if (ldap_bind($ldap, $credentials['ADMIN'], $this->config->get_credentials($credentials['PASSWORD']))) {
 781       $this->error = "Success";
 782       $this->hascon=true;
 783       $this->reconnect= true;
 784       return (0);
 785     } else {
 786       $this->error = "Could not bind to " . $credentials['ADMIN'];
 787       return NULL;
 788     }
 789   }
 790
 791
 792   /* Recursively copy ldap object */
 793   function _copy($src_dn,$dst_dn)
 794   {
 795     $ldap=$this->config->get_ldap_link();
 796     $ldap->cat($src_dn);
 797     $attrs= $ldap->fetch();
 798
 799     /* Grummble. This really sucks. PHP ldap doesn't support rdn stuff. */
 800     $ds= ldap_connect($this->config->current['SERVER']);
 801     ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3);
 802     if (function_exists("ldap_set_rebind_proc") && isset($this->config->current['REFERRAL'])) {
 803       ldap_set_rebind_proc($ds, array(&$this, "rebind"));
 804     }
 805
 806     $pwd = $this->config->get_credentials($this->config->current['ADMINPASSWORD']);
 807     $r=ldap_bind($ds,$this->config->current['ADMINDN'], $pwd);
 808     $sr=ldap_read($ds, LDAP::fix($src_dn), "objectClass=*");
 809
 810     /* Fill data from LDAP */
 811     $new= array();
 812     if ($sr) {
 813       $ei=ldap_first_entry($ds, $sr);
 814       if ($ei) {
 815         foreach($attrs as $attr => $val){
 816           if ($info = @ldap_get_values_len($ds, $ei, $attr)){
 817             for ($i= 0; $i<$info['count']; $i++){
 818               if ($info['count'] == 1){
 819                 $new[$attr]= $info[$i];
 820               } else {
 821                 $new[$attr][]= $info[$i];
 822               }
 823             }
 824           }
 825         }
 826       }
 827     }
 828
 829     /* close conncetion */
 830     ldap_unbind($ds);
 831
 832     /* Adapt naming attribute */
 833     $dst_name= preg_replace("/^([^=]+)=.*$/", "\\1", $dst_dn);
 834     $dst_val = preg_replace("/^[^=]+=([^,+]+).*,.*$/", "\\1", $dst_dn);
 835     $new[$dst_name]= LDAP::fix($dst_val);
 836
 837     /* Check if this is a department.
 838      * If it is a dep. && there is a , override in his ou
 839      *  change \2C to , again, else this entry can't be saved ...
 840      */
 841     if((isset($new['ou'])) &&( preg_match("/\\,/",$new['ou']))){
 842       $new['ou'] = str_replace("\\\\,",",",$new['ou']);
 843     }
 844
 845     /* Save copy */
 846     $ldap->connect();
 847     $ldap->cd($this->config->current['BASE']);
 848
 849     $ldap->create_missing_trees(preg_replace('/^[^,]+,/', '', $dst_dn));
 850
 851     /* FAIvariable=.../..., cn=..
 852         could not be saved, because the attribute FAIvariable was different to
 853         the dn FAIvariable=..., cn=... */
 854     if(in_array_ics("FAIdebconfInfo",$new['objectClass'])){
 855       $new['FAIvariable'] = $ldap->fix($new['FAIvariable']);
 856     }
 857     $ldap->cd($dst_dn);
 858     $ldap->add($new);
 859
 860     if (!$ldap->success()){
 861       trigger_error("Trying to save $dst_dn failed.",
 862           E_USER_WARNING);
 863       return(FALSE);
 864     }
 865     return(TRUE);
 866   }
 867
 868
 869   /* This is a workaround function. */
 870   function copy($src_dn, $dst_dn)
 871   {
 872     /* Rename dn in possible object groups */
 873     $ldap= $this->config->get_ldap_link();
 874     $ldap->search('(&(objectClass=gosaGroupOfNames)(member='.@LDAP::prepare4filter($src_dn).'))',
 875         array('cn'));
 876     while ($attrs= $ldap->fetch()){
 877       $og= new ogroup($this->config, $ldap->getDN());
 878       unset($og->member[$src_dn]);
 879       $og->member[$dst_dn]= $dst_dn;
 880       $og->save ();
 881     }
 882
 883     $ldap->cat($dst_dn);
 884     $attrs= $ldap->fetch();
 885     if (count($attrs)){
 886       trigger_error("Trying to overwrite ".LDAP::fix($dst_dn).", which already exists.",
 887           E_USER_WARNING);
 888       return (FALSE);
 889     }
 890
 891     $ldap->cat($src_dn);
 892     $attrs= $ldap->fetch();
 893     if (!count($attrs)){
 894       trigger_error("Trying to move ".LDAP::fix($src_dn).", which does not seem to exist.",
 895           E_USER_WARNING);
 896       return (FALSE);
 897     }
 898
 899     $ldap->cd($src_dn);
 900     $ldap->search("objectClass=*",array("dn"));
 901     while($attrs = $ldap->fetch()){
 902       $src = $attrs['dn'];
 903       $dst = preg_replace("/".preg_quote($src_dn, '/')."$/",$dst_dn,$attrs['dn']);
 904       $this->_copy($src,$dst);
 905     }
 906     return (TRUE);
 907   }
 908
 909
 910
 911   /*! \brief  Move a given ldap object indentified by $src_dn   \
 912                to the given destination $dst_dn   \
 913               * Ensure that all references are updated (ogroups) \
 914               * Update ACLs   \
 915               * Update accessTo   \
 916       @param  String  The source dn.
 917       @param  String  The destination dn.
 918       @return Boolean TRUE on success else FALSE.
 919    */
 920   function rename($src_dn, $dst_dn)
 921   {
 922     $start = microtime(1);
 923
 924     /* Try to move the source entry to the destination position */
 925     $ldap = $this->config->get_ldap_link();
 926     $ldap->cd($this->config->current['BASE']);
 927     $ldap->create_missing_trees(preg_replace("/^[^,]+,/","",$dst_dn));
 928     if (!$ldap->rename_dn($src_dn,$dst_dn)){
 929 #      msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $src_dn, "", get_class()));
 930       new log("debug","Ldap Protocol v3 implementation error, ldap_rename failed, falling back to manual copy.","FROM: $src_dn  -- TO: $dst_dn",array(),$ldap->get_error());
 931       @DEBUG(DEBUG_LDAP,__LINE__,__FUNCTION__,__FILE__,"Rename failed FROM: $src_dn  -- TO:  $dst_dn",
 932           "Ldap Protocol v3 implementation error, falling back to maunal method.");
 933       return(FALSE);
 934     }
 935
 936     /* Get list of users,groups and roles within this tree,
 937         maybe we have to update ACL references.
 938      */
 939     $leaf_objs = get_list("(|(objectClass=posixGroup)(objectClass=gosaAccount)(objectClass=gosaRole))",array("all"),$dst_dn,
 940           array("dn","objectClass"),GL_SUBSEARCH | GL_NO_ACL_CHECK);
 941     foreach($leaf_objs as $obj){
 942       $new_dn = $obj['dn'];
 943       $old_dn = preg_replace("/".preg_quote($dst_dn, '/')."$/i",$src_dn,$new_dn);
 944       $this->update_acls($old_dn,$new_dn);
 945     }
 946
 947     /* Get all objectGroups defined in this database.
 948         and check if there is an entry matching the source dn,
 949         if this is the case, then update this objectgroup to use the new dn.
 950      */
 951     $ogroups = get_sub_list("(&(objectClass=gosaGroupOfNames)(member=*))","ogroups",
 952         array(get_ou("ogroupRDN")),$this->config->current['BASE'],array("member"),
 953         GL_SUBSEARCH | GL_NO_ACL_CHECK) ;
 954
 955     /* Walk through all objectGroups and check if there are
 956         members matching the source dn
 957      */
 958     foreach($ogroups as $ogroup){
 959       if(isset($ogroup['member'])){
 960
 961         /* Reset class object, this will be initialized with class_ogroup on demand
 962          */
 963         $o_ogroup = NULL;
 964         for($i = 0 ; $i < $ogroup['member']['count'] ; $i ++){
 965           $c_mem = $ogroup['member'][$i];
 966           if(preg_match("/".preg_quote($src_dn, '/')."$/i",$c_mem)){
 967             $d_mem = preg_replace("/".preg_quote($src_dn, '/')."$/i",$dst_dn,$ogroup['member'][$i]);
 968             if($o_ogroup == NULL){
 969               $o_ogroup = new ogroup($this->config,$ogroup['dn']);
 970             }
 971             /* Members are stored with their converted names, so convert $c_mem as well
 972                to have it match in case of special characters in its name. */
 973             unset($o_ogroup->member[LDAP::convert($c_mem)]);
 974             $o_ogroup->member[$d_mem]= $d_mem;
 975           }
 976         }
 977
 978         /* Save object group if there were changes made on the membership */
 979         if($o_ogroup != NULL){
 980           $o_ogroup->save();
 981         }
 982       }
 983     }
 984
 985     /* Update roles to use the new entry dn
 986      */
 987     $ldap = $this->config->get_ldap_link();
 988     $ldap->cd($this->config->current['BASE']);
 989     $ldap->search("(&(objectClass=organizationalRole)".
 990         "(roleOccupant=".LDAP::prepare4filter($src_dn)."))");
 991     while($attrs = $ldap->fetch()){
 992       $role = new roleGeneric($this->config,$attrs['dn']);
 993       $key = array_search($src_dn,$role->roleOccupant);
 994       if($key !== FALSE){
 995         $role->roleOccupant[$key] = $dst_dn;
 996         $role->save();
 997       }
 998     }
 999
1000     /* Check if there are gosa departments moved.
1001        If there were deps moved, the force reload of config->deps.
1002      */
1003     $leaf_deps=  get_list("(objectClass=gosaDepartment)",array("all"),$dst_dn,
1004           array("dn","objectClass"),GL_SUBSEARCH | GL_NO_ACL_CHECK);
1005
1006     if(count($leaf_deps)){
1007       $this->config->get_departments();
1008       $this->config->make_idepartments();
1009       session::global_set("config",$this->config);
1010       $ui =get_userinfo();
1011       $ui->reset_acl_cache();
1012     }
1013
1014     return(TRUE);
1015   }
1016
1017
1018
1019   function move($src_dn, $dst_dn)
1020   {
1021     /* Do not copy if only upper- lowercase has changed */
1022     if(strtolower($src_dn) == strtolower($dst_dn)){
1023       return(TRUE);
1024     }
1025
1026
1027     /* Try to move the entry instead of copy & delete
1028      */
1029     if(TRUE){
1030
1031       /* Try to move with ldap routines, if this was not successfull
1032           fall back to the old style copy & remove method
1033        */
1034       if($this->rename($src_dn, $dst_dn)){
1035         return(TRUE);
1036       }else{
1037         // See code below.
1038       }
1039     }
1040
1041     /* Copy source to destination */
1042     if (!$this->copy($src_dn, $dst_dn)){
1043       return (FALSE);
1044     }
1045
1046     /* Delete source */
1047     $ldap= $this->config->get_ldap_link();
1048     $ldap->rmdir_recursive($src_dn);
1049     if (!$ldap->success()){
1050       trigger_error("Trying to delete $src_dn failed.",
1051           E_USER_WARNING);
1052       return (FALSE);
1053     }
1054
1055     return (TRUE);
1056   }
1057
1058
1059   /* Move/Rename complete trees */
1060   function recursive_move($src_dn, $dst_dn)
1061   {
1062     /* Check if the destination entry exists */
1063     $ldap= $this->config->get_ldap_link();
1064
1065     /* Check if destination exists - abort */
1066     $ldap->cat($dst_dn, array('dn'));
1067     if ($ldap->fetch()){
1068       trigger_error("recursive_move $dst_dn already exists.",
1069           E_USER_WARNING);
1070       return (FALSE);
1071     }
1072
1073     $this->copy($src_dn, $dst_dn);
1074
1075     /* Remove src_dn */
1076     $ldap->cd($src_dn);
1077     $ldap->recursive_remove($src_dn);
1078     return (TRUE);
1079   }
1080
1081
1082   function handle_post_events($mode, $add_attrs= array())
1083   {
1084     switch ($mode){
1085       case "add":
1086         $this->postcreate($add_attrs);
1087       break;
1088
1089       case "modify":
1090         $this->postmodify($add_attrs);
1091       break;
1092
1093       case "remove":
1094         $this->postremove($add_attrs);
1095       break;
1096     }
1097   }
1098
1099
1100   function saveCopyDialog(){
1101   }
1102
1103
1104   function getCopyDialog(){
1105     return(array("string"=>"","status"=>""));
1106   }
1107
1108
1109   function PrepareForCopyPaste($source)
1110   {
1111     $todo = $this->attributes;
1112     if(isset($this->CopyPasteVars)){
1113       $todo = array_merge($todo,$this->CopyPasteVars);
1114     }
1115
1116     if(count($this->objectclasses)){
1117       $this->is_account = TRUE;
1118       foreach($this->objectclasses as $class){
1119         if(!in_array($class,$source['objectClass'])){
1120           $this->is_account = FALSE;
1121         }
1122       }
1123     }
1124
1125     foreach($todo as $var){
1126       if (isset($source[$var])){
1127         if(isset($source[$var]['count'])){
1128           if($source[$var]['count'] > 1){
1129             $this->$var = array();
1130             $tmp = array();
1131             for($i = 0 ; $i < $source[$var]['count']; $i++){
1132               $tmp = $source[$var][$i];
1133             }
1134             $this->$var = $tmp;
1135           }else{
1136             $this->$var = $source[$var][0];
1137           }
1138         }else{
1139           $this->$var= $source[$var];
1140         }
1141       }
1142     }
1143   }
1144
1145   function tag_attrs(&$at, $dn= "", $tag= "", $show= false)
1146   {
1147     /* Skip tagging?
1148        If this is called from departmentGeneric, we have to skip this
1149         tagging procedure.
1150      */
1151     if($this->skipTagging){
1152       return;
1153     }
1154
1155     /* No dn? Self-operation... */
1156     if ($dn == ""){
1157       $dn= $this->dn;
1158
1159       /* No tag? Find it yourself... */
1160       if ($tag == ""){
1161         $len= strlen($dn);
1162
1163         @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__, "No tag for $dn - looking for one...", "Tagging");
1164         $relevant= array();
1165         foreach ($this->config->adepartments as $key => $ntag){
1166
1167           /* This one is bigger than our dn, its not relevant... */
1168           if ($len < strlen($key)){
1169             continue;
1170           }
1171
1172           /* This one matches with the latter part. Break and don't fix this entry */
1173           if (preg_match('/(^|,)'.preg_quote($key, '/').'$/', $dn)){
1174             @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__, "DEBUG: Possibly relevant: $key", "Tagging");
1175             $relevant[strlen($key)]= $ntag;
1176             continue;
1177           }
1178
1179         }
1180
1181         /* If we've some relevant tags to set, just get the longest one */
1182         if (count($relevant)){
1183           ksort($relevant);
1184           $tmp= array_keys($relevant);
1185           $idx= end($tmp);
1186           $tag= $relevant[$idx];
1187           $this->gosaUnitTag= $tag;
1188         }
1189       }
1190     }
1191
1192     /* Remove tags that may already be here... */
1193     remove_objectClass("gosaAdministrativeUnitTag", $at);
1194     if (isset($at['gosaUnitTag'])){
1195         unset($at['gosaUnitTag']);
1196     }
1197
1198     /* Set tag? */
1199     if ($tag != ""){
1200       add_objectClass("gosaAdministrativeUnitTag", $at);
1201       $at['gosaUnitTag']= $tag;
1202     }
1203
1204     /* Initially this object was tagged.
1205        - But now, it is no longer inside a tagged department.
1206        So force the remove of the tag.
1207        (objectClass was already removed obove)
1208      */
1209     if($tag == "" && $this->gosaUnitTag){
1210       $at['gosaUnitTag'] = array();
1211     }
1212   }
1213
1214
1215   /* Add possibility to stop remove process */
1216   function allow_remove()
1217   {
1218     $reason= "";
1219     return $reason;
1220   }
1221
1222
1223   /* Create a snapshot of the current object */
1224   function create_snapshot($type= "snapshot", $description= array())
1225   {
1226
1227     /* Check if snapshot functionality is enabled */
1228     if(!$this->snapshotEnabled()){
1229       return;
1230     }
1231
1232     /* Get configuration from gosa.conf */
1233     $config = $this->config;
1234
1235     /* Create lokal ldap connection */
1236     $ldap= $this->config->get_ldap_link();
1237     $ldap->cd($this->config->current['BASE']);
1238
1239     /* check if there are special server configurations for snapshots */
1240     if($config->get_cfg_value("snapshotURI") == ""){
1241
1242       /* Source and destination server are both the same, just copy source to dest obj */
1243       $ldap_to      = $ldap;
1244       $snapldapbase = $this->config->current['BASE'];
1245
1246     }else{
1247       $server         = $config->get_cfg_value("snapshotURI");
1248       $user           = $config->get_cfg_value("snapshotAdminDn");
1249       $password       = $this->config->get_credentials($config->get_cfg_value("snapshotAdminPassword"));
1250       $snapldapbase   = $config->get_cfg_value("snapshotBase");
1251
1252       $ldap_to        = new ldapMultiplexer(new LDAP($user,$password, $server));
1253       $ldap_to -> cd($snapldapbase);
1254
1255       if (!$ldap_to->success()){
1256         msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $snapldapbase, "", get_class()));
1257       }
1258
1259     }
1260
1261     /* check if the dn exists */
1262     if ($ldap->dn_exists($this->dn)){
1263
1264       /* Extract seconds & mysecs, they are used as entry index */
1265       list($usec, $sec)= explode(" ", microtime());
1266
1267       /* Collect some infos */
1268       $base           = $this->config->current['BASE'];
1269       $snap_base      = $config->get_cfg_value("snapshotBase");
1270       $base_of_object = preg_replace ('/^[^,]+,/i', '', $this->dn);
1271       $new_base       = preg_replace("/".preg_quote($base, '/')."$/","",$base_of_object).$snap_base;
1272
1273       /* Create object */
1274 #$data             = preg_replace('/^dn:.*\n/', '', $ldap->gen_ldif($this->dn,"(!(objectClass=gosaDepartment))"));
1275       $data             = $ldap->gen_ldif($this->dn,"(&(!(objectClass=gosaDepartment))(!(objectClass=FAIclass)))");
1276       $newName          = str_replace(".", "", $sec."-".$usec);
1277       $target= array();
1278       $target['objectClass']            = array("top", "gosaSnapshotObject");
1279       $target['gosaSnapshotData']       = gzcompress($data, 6);
1280       $target['gosaSnapshotType']       = $type;
1281       $target['gosaSnapshotDN']         = $this->dn;
1282       $target['description']            = $description;
1283       $target['gosaSnapshotTimestamp']  = $newName;
1284
1285       /* Insert the new snapshot
1286          But we have to check first, if the given gosaSnapshotTimestamp
1287          is already used, in this case we should increment this value till there is
1288          an unused value. */
1289       $new_dn                           = "gosaSnapshotTimestamp=".$newName.",".$new_base;
1290       $ldap_to->cat($new_dn);
1291       while($ldap_to->count()){
1292         $ldap_to->cat($new_dn);
1293         $newName = str_replace(".", "", $sec."-".($usec++));
1294         $new_dn                           = "gosaSnapshotTimestamp=".$newName.",".$new_base;
1295         $target['gosaSnapshotTimestamp']  = $newName;
1296       }
1297
1298       /* Inset this new snapshot */
1299       $ldap_to->cd($snapldapbase);
1300       $ldap_to->create_missing_trees($snapldapbase);
1301       $ldap_to->create_missing_trees($new_base);
1302       $ldap_to->cd($new_dn);
1303       $ldap_to->add($target);
1304       if (!$ldap_to->success()){
1305         msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $new_dn, LDAP_ADD, get_class()));
1306       }
1307
1308       if (!$ldap->success()){
1309         msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $new_base, "", get_class()));
1310       }
1311
1312     }
1313   }
1314
1315   function remove_snapshot($dn)
1316   {
1317     $ui       = get_userinfo();
1318     $old_dn   = $this->dn;
1319     $this->dn = $dn;
1320     $ldap = $this->config->get_ldap_link();
1321     $ldap->cd($this->config->current['BASE']);
1322     $ldap->rmdir_recursive($this->dn);
1323     if(!$ldap->success()){
1324       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $this->dn));
1325     }
1326     $this->dn = $old_dn;
1327   }
1328
1329
1330   /* returns true if snapshots are enabled, and false if it is disalbed
1331      There will also be some errors psoted, if the configuration failed */
1332   function snapshotEnabled()
1333   {
1334     $config = $this->config;
1335     if($config->get_cfg_value("enableSnapshots") == "true"){
1336
1337             /* Check if the snapshot_base is defined */
1338             if ($config->get_cfg_value("snapshotBase") == ""){
1339
1340         /* Send message if not done already */
1341         if(!session::is_set("snapshotFailMessageSend")){
1342           session::set("snapshotFailMessageSend",TRUE);
1343           msg_dialog::display(_("Configuration error"),
1344               sprintf(_("The snapshot functionality is enabled, but the required variable '%s' is not set."),
1345                 "snapshotBase"), ERROR_DIALOG);
1346         }
1347                     return(FALSE);
1348             }
1349
1350       /* Check if the snapshot_base is defined */
1351       if (!is_callable("gzcompress")){
1352
1353         /* Send message if not done already */
1354         if(!session::is_set("snapshotFailMessageSend")){
1355           session::set("snapshotFailMessageSend",TRUE);
1356           msg_dialog::display(_("Configuration error"),
1357               sprintf(_("The snapshot functionality is enabled, but the required compression module is missing. Please install '%s'."),"php5-zip / php5-gzip"), ERROR_DIALOG);
1358         }
1359         return(FALSE);
1360       }
1361
1362             /* check if there are special server configurations for snapshots */
1363             if ($config->get_cfg_value("snapshotURI") != ""){
1364
1365                     /* check if all required vars are available to create a new ldap connection */
1366                     $missing = "";
1367                     foreach(array("snapshotURI","snapshotAdminDn","snapshotAdminPassword","snapshotBase") as $var){
1368           if($config->get_cfg_value($var) == ""){
1369             $missing .= $var." ";
1370
1371             /* Send message if not done already */
1372             if(!session::is_set("snapshotFailMessageSend")){
1373               session::set("snapshotFailMessageSend",TRUE);
1374               msg_dialog::display(_("Configuration error"),
1375                   sprintf(_("The snapshot functionality is enabled, but the required variable '%s' is not set."),
1376                     $missing), ERROR_DIALOG);
1377             }
1378             return(FALSE);
1379           }
1380                     }
1381             }
1382             return(TRUE);
1383     }
1384     return(FALSE);
1385   }
1386
1387
1388   /* Return available snapshots for the given base
1389    */
1390   function Available_SnapsShots($dn,$raw = false)
1391   {
1392     if(!$this->snapshotEnabled()) return(array());
1393
1394     /* Create an additional ldap object which
1395        points to our ldap snapshot server */
1396     $ldap= $this->config->get_ldap_link();
1397     $ldap->cd($this->config->current['BASE']);
1398     $cfg= &$this->config->current;
1399
1400     /* check if there are special server configurations for snapshots */
1401     if($this->config->get_cfg_value("snapshotURI") == ""){
1402       $ldap_to      = $ldap;
1403     }else{
1404       $server         = $this->config->get_cfg_value("snapshotURI");
1405       $user           = $this->config->get_cfg_value("snapshotAdminDn");
1406       $password       = $this->config->get_credentials($this->config->get_cfg_value("snapshotAdminPassword"));
1407       $snapldapbase   = $this->config->get_cfg_value("snapshotBase");
1408       $ldap_to        = new ldapMultiplexer(new LDAP($user,$password, $server));
1409       $ldap_to -> cd($snapldapbase);
1410       if (!$ldap_to->success()){
1411         msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $snapldapbase, "", get_class()));
1412       }
1413     }
1414
1415     /* Prepare bases and some other infos */
1416     $base           = $this->config->current['BASE'];
1417     $snap_base      = $this->config->get_cfg_value("snapshotBase");
1418     $base_of_object = preg_replace ('/^[^,]+,/i', '', $dn);
1419     $new_base       = preg_replace("/".preg_quote($base, '/')."$/","",$base_of_object).$snap_base;
1420     $tmp            = array();
1421
1422     /* Fetch all objects with  gosaSnapshotDN=$dn */
1423     $ldap_to->cd($new_base);
1424     $ldap_to->ls("(&(objectClass=gosaSnapshotObject)(gosaSnapshotDN=".$dn."))",$new_base,
1425         array("gosaSnapshotType","gosaSnapshotTimestamp","gosaSnapshotDN","description"));
1426
1427     /* Put results into a list and add description if missing */
1428     while($entry = $ldap_to->fetch()){
1429       if(!isset($entry['description'][0])){
1430         $entry['description'][0]  = "";
1431       }
1432       $tmp[] = $entry;
1433     }
1434
1435     /* Return the raw array, or format the result */
1436     if($raw){
1437       return($tmp);
1438     }else{
1439       $tmp2 = array();
1440       foreach($tmp as $entry){
1441         $tmp2[base64_encode($entry['dn'])] = $entry['description'][0];
1442       }
1443     }
1444     return($tmp2);
1445   }
1446
1447
1448   function getAllDeletedSnapshots($base_of_object,$raw = false)
1449   {
1450     if(!$this->snapshotEnabled()) return(array());
1451
1452     /* Create an additional ldap object which
1453        points to our ldap snapshot server */
1454     $ldap= $this->config->get_ldap_link();
1455     $ldap->cd($this->config->current['BASE']);
1456     $cfg= &$this->config->current;
1457
1458     /* check if there are special server configurations for snapshots */
1459     if($this->config->get_cfg_value("snapshotURI") == ""){
1460       $ldap_to      = $ldap;
1461     }else{
1462       $server         = $this->config->get_cfg_value("snapshotURI");
1463       $user           = $this->config->get_cfg_value("snapshotAdminDn");
1464       $password       = $this->config->get_credentials($this->config->get_cfg_value("snapshotAdminPassword"));
1465       $snapldapbase   = $this->config->get_cfg_value("snapshotBase");
1466       $ldap_to        = new ldapMultiplexer(new LDAP($user,$password, $server));
1467       $ldap_to -> cd($snapldapbase);
1468       if (!$ldap_to->success()){
1469         msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $snapldapbase, "", get_class()));
1470       }
1471     }
1472
1473     /* Prepare bases */
1474     $base           = $this->config->current['BASE'];
1475     $snap_base      = $this->config->get_cfg_value("snapshotBase");
1476     $new_base       = preg_replace("/".preg_quote($base, '/')."$/","",$base_of_object).$snap_base;
1477
1478     /* Fetch all objects and check if they do not exist anymore */
1479     $ui = get_userinfo();
1480     $tmp = array();
1481     $ldap_to->cd($new_base);
1482     $ldap_to->ls("(objectClass=gosaSnapshotObject)",$new_base,array("gosaSnapshotType","gosaSnapshotTimestamp","gosaSnapshotDN","description"));
1483     while($entry = $ldap_to->fetch()){
1484
1485       $chk =  str_replace($new_base,"",$entry['dn']);
1486       if(preg_match("/,ou=/",$chk)) continue;
1487
1488       if(!isset($entry['description'][0])){
1489         $entry['description'][0]  = "";
1490       }
1491       $tmp[] = $entry;
1492     }
1493
1494     /* Check if entry still exists */
1495     foreach($tmp as $key => $entry){
1496       $ldap->cat($entry['gosaSnapshotDN'][0]);
1497       if($ldap->count()){
1498         unset($tmp[$key]);
1499       }
1500     }
1501
1502     /* Format result as requested */
1503     if($raw) {
1504       return($tmp);
1505     }else{
1506       $tmp2 = array();
1507       foreach($tmp as $key => $entry){
1508         $tmp2[base64_encode($entry['dn'])] = $entry['description'][0];
1509       }
1510     }
1511     return($tmp2);
1512   }
1513
1514
1515   /* Restore selected snapshot */
1516   function restore_snapshot($dn)
1517   {
1518     if(!$this->snapshotEnabled()) return(array());
1519
1520     $ldap= $this->config->get_ldap_link();
1521     $ldap->cd($this->config->current['BASE']);
1522     $cfg= &$this->config->current;
1523
1524     /* check if there are special server configurations for snapshots */
1525     if($this->config->get_cfg_value("snapshotURI") == ""){
1526       $ldap_to      = $ldap;
1527     }else{
1528       $server         = $this->config->get_cfg_value("snapshotURI");
1529       $user           = $this->config->get_cfg_value("snapshotAdminDn");
1530       $password       = $this->config->get_credentials($this->config->get_cfg_value("snapshotAdminPassword"));
1531       $snapldapbase   = $this->config->get_cfg_value("snapshotBase");
1532       $ldap_to        = new ldapMultiplexer(new LDAP($user,$password, $server));
1533       $ldap_to -> cd($snapldapbase);
1534       if (!$ldap_to->success()){
1535         msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $snapldapbase, "", get_class()));
1536       }
1537     }
1538
1539     /* Get the snapshot */
1540     $ldap_to->cat($dn);
1541     $restoreObject = $ldap_to->fetch();
1542
1543     /* Prepare import string */
1544     $data  = gzuncompress($ldap_to->get_attribute($dn,'gosaSnapshotData'));
1545
1546     /* Import the given data */
1547     $err = "";
1548     $ldap->import_complete_ldif($data,$err,false,false);
1549     if (!$ldap->success()){
1550       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $dn, "", get_class()));
1551     }
1552   }
1553
1554
1555   function showSnapshotDialog($base,$baseSuffixe,&$parent)
1556   {
1557     $once = true;
1558     $ui = get_userinfo();
1559     $this->parent = $parent;
1560
1561     foreach($_POST as $name => $value){
1562
1563       /* Create a new snapshot, display a dialog */
1564       if(preg_match("/^CreateSnapShotDialog_[^_]*_[xy]$/",$name) && $once){
1565
1566                           $entry = base64_decode(preg_replace("/^CreateSnapShotDialog_([^_]*)_[xy]$/","\\1",$name));
1567         $once = false;
1568         $entry = preg_replace("/^CreateSnapShotDialog_/","",$entry);
1569
1570         if(!empty($entry) && $ui->allow_snapshot_create($entry,$this->parent->acl_module)){
1571           $this->snapDialog = new SnapShotDialog($this->config,$entry,$this);
1572         }else{
1573           msg_dialog::display(_("Permission"),sprintf(_("You are not allowed to create a snapshot for %s."),$entry),ERROR_DIALOG);
1574         }
1575       }
1576
1577       /* Restore a snapshot, display a dialog with all snapshots of the current object */
1578       if(preg_match("/^RestoreSnapShotDialog_/",$name) && $once){
1579         $once = false;
1580         $entry = base64_decode(preg_replace("/^RestoreSnapShotDialog_([^_]*)_[xy]$/i","\\1",$name));
1581         if(!empty($entry) && $ui->allow_snapshot_restore($this->dn,$this->parent->acl_module)){
1582           $this->snapDialog = new SnapShotDialog($this->config,$entry,$this);
1583           $this->snapDialog->display_restore_dialog = true;
1584         }else{
1585           msg_dialog::display(_("Permission"),sprintf(_("You are not allowed to restore a snapshot for %s."),$entry),ERROR_DIALOG);
1586         }
1587       }
1588
1589       /* Restore one of the already deleted objects */
1590       if(((isset($_POST['menu_action']) && $_POST['menu_action'] == "RestoreDeletedSnapShot")
1591           || preg_match("/^RestoreDeletedSnapShot_/",$name)) && $once){
1592         $once = false;
1593
1594         if($ui->allow_snapshot_restore($this->dn,$this->parent->acl_module)){
1595           $this->snapDialog = new SnapShotDialog($this->config,"",$this);
1596           $this->snapDialog->set_snapshot_bases($baseSuffixe);
1597           $this->snapDialog->display_restore_dialog      = true;
1598           $this->snapDialog->display_all_removed_objects  = true;
1599         }else{
1600           msg_dialog::display(_("Permission"),sprintf(_("You are not allowed to restore a snapshot for %s."),$base),ERROR_DIALOG);
1601         }
1602       }
1603
1604       /* Restore selected snapshot */
1605       if(preg_match("/^RestoreSnapShot_/",$name) && $once){
1606         $once = false;
1607         $entry = base64_decode(preg_replace("/^RestoreSnapShot_([^_]*)_[xy]$/i","\\1",$name));
1608
1609         if(!empty($entry) && $ui->allow_snapshot_restore($this->dn,$this->parent->acl_module)){
1610           $this->restore_snapshot($entry);
1611           $this->snapDialog = NULL;
1612         }else{
1613           msg_dialog::display(_("Permission"),sprintf(_("You are not allowed to restore a snapshot for %s."),$entry),ERROR_DIALOG);
1614         }
1615       }
1616     }
1617
1618     /* Create a new snapshot requested, check
1619        the given attributes and create the snapshot*/
1620     if(isset($_POST['CreateSnapshot']) && is_object($this->snapDialog)){
1621       $this->snapDialog->save_object();
1622       $msgs = $this->snapDialog->check();
1623       if(count($msgs)){
1624         foreach($msgs as $msg){
1625           msg_dialog::display(_("Error"), $msg, ERROR_DIALOG);
1626         }
1627       }else{
1628         $this->dn =  $this->snapDialog->dn;
1629         $this->create_snapshot("snapshot",$this->snapDialog->CurrentDescription);
1630         $this->snapDialog = NULL;
1631       }
1632     }
1633
1634     /* Restore is requested, restore the object with the posted dn .*/
1635     if((isset($_POST['RestoreSnapshot'])) && (isset($_POST['SnapShot']))){
1636     }
1637
1638     if(isset($_POST['CancelSnapshot'])){
1639       $this->snapDialog = NULL;
1640     }
1641
1642     if(is_object($this->snapDialog )){
1643       $this->snapDialog->save_object();
1644       return($this->snapDialog->execute());
1645     }
1646   }
1647
1648
1649   static function plInfo()
1650   {
1651     return array();
1652   }
1653
1654
1655   function set_acl_base($base)
1656   {
1657     $this->acl_base= $base;
1658   }
1659
1660
1661   function set_acl_category($category)
1662   {
1663     $this->acl_category= "$category/";
1664   }
1665
1666
1667   function acl_is_writeable($attribute,$skip_write = FALSE)
1668   {
1669     if($this->read_only) return(FALSE);
1670     $ui= get_userinfo();
1671     return preg_match('/w/', $ui->get_permissions($this->acl_base, $this->acl_category.get_class($this), $attribute, $skip_write));
1672   }
1673
1674
1675   function acl_is_readable($attribute)
1676   {
1677     $ui= get_userinfo();
1678     return preg_match('/r/', $ui->get_permissions($this->acl_base, $this->acl_category.get_class($this), $attribute));
1679   }
1680
1681
1682   function acl_is_createable($base ="")
1683   {
1684     if($this->read_only) return(FALSE);
1685     $ui= get_userinfo();
1686     if($base == "") $base = $this->acl_base;
1687     return preg_match('/c/', $ui->get_permissions($base, $this->acl_category.get_class($this), '0'));
1688   }
1689
1690
1691   function acl_is_removeable($base ="")
1692   {
1693     if($this->read_only) return(FALSE);
1694     $ui= get_userinfo();
1695     if($base == "") $base = $this->acl_base;
1696     return preg_match('/d/', $ui->get_permissions($base, $this->acl_category.get_class($this), '0'));
1697   }
1698
1699
1700   function acl_is_moveable($base = "")
1701   {
1702     if($this->read_only) return(FALSE);
1703     $ui= get_userinfo();
1704     if($base == "") $base = $this->acl_base;
1705     return preg_match('/m/', $ui->get_permissions($base, $this->acl_category.get_class($this), '0'));
1706   }
1707
1708
1709   function acl_have_any_permissions()
1710   {
1711   }
1712
1713
1714   function getacl($attribute,$skip_write= FALSE)
1715   {
1716     $ui= get_userinfo();
1717     $skip_write |= $this->read_only;
1718     return  $ui->get_permissions($this->acl_base, $this->acl_category.get_class($this), $attribute,$skip_write);
1719   }
1720
1721
1722   /*! \brief    Returns a list of all available departments for this object.
1723                 If this object is new, all departments we are allowed to create a new user in are returned.
1724                 If this is an existing object, return all deps. we are allowed to move tis object too.
1725
1726       @return   Array [dn] => "..name"  // All deps. we are allowed to act on.
1727   */
1728   function get_allowed_bases()
1729   {
1730     $ui = get_userinfo();
1731     $deps = array();
1732
1733     /* Is this a new object ? Or just an edited existing object */
1734     if(!$this->initially_was_account && $this->is_account){
1735       $new = true;
1736     }else{
1737       $new = false;
1738     }
1739
1740     foreach($this->config->idepartments as $dn => $name){
1741       if($new && $this->acl_is_createable($dn)){
1742         $deps[$dn] = $name;
1743       }elseif(!$new && $this->acl_is_moveable($dn)){
1744         $deps[$dn] = $name;
1745       }
1746     }
1747
1748     /* Add current base */
1749     if(isset($this->base) && isset($this->config->idepartments[$this->base])){
1750       $deps[$this->base] = $this->config->idepartments[$this->base];
1751     }elseif(strtolower($this->dn) == strtolower($this->config->current['BASE'])){
1752
1753     }else{
1754       trigger_error("Cannot return list of departments, no default base found in class ".get_class($this).". ".$this->base);
1755     }
1756     return($deps);
1757   }
1758
1759
1760   /* This function updates ACL settings if $old_dn was used.
1761    *  $old_dn   specifies the actually used dn
1762    *  $new_dn   specifies the destiantion dn
1763    */
1764   function update_acls($old_dn,$new_dn,$output_changes = FALSE)
1765   {
1766     /* Check if old_dn is empty. This should never happen */
1767     if(empty($old_dn) || empty($new_dn)){
1768       trigger_error("Failed to check acl dependencies, wrong dn given.");
1769       return;
1770     }
1771
1772     /* Update userinfo if necessary */
1773     $ui = session::global_get('ui');
1774     if($ui->dn == $old_dn){
1775       $ui->dn = $new_dn;
1776       session::global_set('ui',$ui);
1777       new log("view","acl/".get_class($this),$this->dn,array(),"Updated current object dn from '".$old_dn."' to '".$new_dn."'");
1778     }
1779
1780     /* Object was moved, ensure that all acls will be moved too */
1781     if($new_dn != $old_dn && $old_dn != "new"){
1782
1783       /* get_ldap configuration */
1784       $update = array();
1785       $ldap = $this->config->get_ldap_link();
1786       $ldap->cd ($this->config->current['BASE']);
1787       $ldap->search("(&(objectClass=gosaAcl)(gosaAclEntry=*".base64_encode($old_dn)."*))",array("cn","gosaAclEntry"));
1788       while($attrs = $ldap->fetch()){
1789         $acls = array();
1790         $found = false;
1791         for($i = 0 ; $i <  $attrs['gosaAclEntry']['count'] ; $i ++ ){
1792           $acl_parts = split(":",$attrs['gosaAclEntry'][$i]);
1793
1794           /* Roles uses antoher data storage order, members are stored int the third part,
1795              while the members in direct ACL assignments are stored in the second part.
1796            */
1797           $id = ($acl_parts[1] == "role") ? 3 : 2;
1798
1799           /* Update member entries to use $new_dn instead of old_dn
1800            */
1801           $members = explode(",",$acl_parts[$id]);
1802           foreach($members as $key => $member){
1803             $member = base64_decode($member);
1804             if($member == $old_dn){
1805               $members[$key] = base64_encode($new_dn);
1806               $found = TRUE;
1807             }
1808           }
1809
1810           /* Check if the selected role has to updated
1811            */
1812           if($acl_parts[1] == "role" && $acl_parts[2] == base64_encode($old_dn)){
1813             $acl_parts[2] = base64_encode($new_dn);
1814             $found = TRUE;
1815           }
1816
1817           /* Build new acl string */
1818           $acl_parts[$id] = implode($members,",");
1819           $acls[] = implode($acl_parts,":");
1820         }
1821
1822         /* Acls for this object must be adjusted */
1823         if($found){
1824
1825           $debug_info=  _("Changing ACL dn")."&nbsp;:&nbsp;<br>&nbsp;-"._("from")."&nbsp;<b>&nbsp;".
1826             $old_dn."</b><br>&nbsp;-"._("to")."&nbsp;<b>".$new_dn."</b><br>";
1827           @DEBUG (DEBUG_ACL, __LINE__, __FUNCTION__, __FILE__,$debug_info,"ACL");
1828
1829           $update[$attrs['dn']] =array();
1830           foreach($acls as $acl){
1831             $update[$attrs['dn']]['gosaAclEntry'][] = $acl;
1832           }
1833         }
1834       }
1835
1836       /* Write updated acls */
1837       foreach($update as $dn => $attrs){
1838         $ldap->cd($dn);
1839         $ldap->modify($attrs);
1840       }
1841     }
1842   }
1843
1844
1845
1846   /* This function enables the entry Serial ID check.
1847    * If an entry was edited while we have edited the entry too,
1848    *  an error message will be shown.
1849    * To configure this check correctly read the FAQ.
1850    */
1851   function enable_CSN_check()
1852   {
1853     $this->CSN_check_active =TRUE;
1854     $this->entryCSN = getEntryCSN($this->dn);
1855   }
1856
1857
1858   /*! \brief  Prepares the plugin to be used for multiple edit
1859    *          Update plugin attributes with given array of attribtues.
1860    *  @param  array   Array with attributes that must be updated.
1861    */
1862   function init_multiple_support($attrs,$all)
1863   {
1864     $ldap= $this->config->get_ldap_link();
1865     $this->multi_attrs    = $attrs;
1866     $this->multi_attrs_all= $all;
1867
1868     /* Copy needed attributes */
1869     foreach ($this->attributes as $val){
1870       $found= array_key_ics($val, $this->multi_attrs);
1871       if ($found != ""){
1872         if(isset($this->multi_attrs["$found"][0])){
1873           $this->$val= $this->multi_attrs["$found"][0];
1874         }
1875       }
1876     }
1877   }
1878
1879
1880   /*! \brief  Enables multiple support for this plugin
1881    */
1882   function enable_multiple_support()
1883   {
1884     $this->ignore_account = TRUE;
1885     $this->multiple_support_active = TRUE;
1886   }
1887
1888
1889   /*! \brief  Returns all values that have been modfied in multiple edit mode.
1890       @return array Cotaining all mdofied values.
1891    */
1892   function get_multi_edit_values()
1893   {
1894     $ret = array();
1895     foreach($this->attributes as $attr){
1896       if(in_array($attr,$this->multi_boxes)){
1897         $ret[$attr] = $this->$attr;
1898       }
1899     }
1900     return($ret);
1901   }
1902
1903
1904   /*! \brief  Update class variables with values collected by multiple edit.
1905    */
1906   function set_multi_edit_values($attrs)
1907   {
1908     foreach($attrs as $name => $value){
1909       $this->$name = $value;
1910     }
1911   }
1912
1913
1914   /*! \brief execute plugin
1915
1916     Generates the html output for this node
1917    */
1918   function multiple_execute()
1919   {
1920     /* This one is empty currently. Fabian - please fill in the docu code */
1921     session::global_set('current_class_for_help',get_class($this));
1922
1923     /* Reset Lock message POST/GET check array, to prevent perg_match errors*/
1924     session::set('LOCK_VARS_TO_USE',array());
1925     session::set('LOCK_VARS_USED',array());
1926
1927     return("Multiple edit is currently not implemented for this plugin.");
1928   }
1929
1930
1931   /*! \brief   Save HTML posted data to object for multiple edit
1932    */
1933   function multiple_save_object()
1934   {
1935     if(empty($this->entryCSN) && $this->CSN_check_active){
1936       $this->entryCSN = getEntryCSN($this->dn);
1937     }
1938
1939     /* Save values to object */
1940     $this->multi_boxes = array();
1941     foreach ($this->attributes as $val){
1942
1943       /* Get selected checkboxes from multiple edit */
1944       if(isset($_POST["use_".$val])){
1945         $this->multi_boxes[] = $val;
1946       }
1947
1948       if ($this->acl_is_writeable($val) && isset ($_POST["$val"])){
1949
1950         /* Check for modifications */
1951         if (get_magic_quotes_gpc()) {
1952           $data= stripcslashes($_POST["$val"]);
1953         } else {
1954           $data= $this->$val = $_POST["$val"];
1955         }
1956         if ($this->$val != $data){
1957           $this->is_modified= TRUE;
1958         }
1959
1960         /* IE post fix */
1961         if(isset($data[0]) && $data[0] == chr(194)) {
1962           $data = "";
1963         }
1964         $this->$val= $data;
1965       }
1966     }
1967   }
1968
1969
1970   /*! \brief  Returns all attributes of this plugin,
1971                to be able to detect multiple used attributes
1972                in multi_plugg::detect_multiple_used_attributes().
1973       @return array Attributes required for intialization of multi_plug
1974    */
1975   public function get_multi_init_values()
1976   {
1977     $attrs = $this->attrs;
1978     return($attrs);
1979   }
1980
1981
1982   /*! \brief  Check given values in multiple edit
1983       @return array Error messages
1984    */
1985   function multiple_check()
1986   {
1987     $message = plugin::check();
1988     return($message);
1989   }
1990
1991
1992   /*! \brief  Returns the snapshot header part for "Actions" menu in management dialogs
1993       @param  $layer_menu
1994    */
1995   function get_snapshot_header($base,$category)
1996   {
1997     $str = "";
1998     $ui = get_userinfo();
1999     if($this->snapshotEnabled() && $ui->allow_snapshot_restore($base,$category)){
2000
2001       $ok = false;
2002       foreach($this->get_used_snapshot_bases() as $base){
2003         $ok |= count($this->getAllDeletedSnapshots($base)) >= 1 ;
2004       }
2005
2006       if($ok){
2007         $str = "..|<img class='center' src='images/lists/restore.png' ".
2008           "alt='"._("Restore")."'>&nbsp;"._("Restore").                       "|RestoreDeletedSnapShot|\n";
2009       }else{
2010         $str = "..|<img class='center' src='images/lists/restore_grey.png' alt=''>&nbsp;"._("Restore")."||\n";
2011       }
2012     }
2013     return($str);
2014   }
2015
2016
2017   function get_snapshot_action($base,$category)
2018   {
2019     $str= "";
2020     $ui = get_userinfo();
2021     if($this->snapshotEnabled()){
2022       if ($ui->allow_snapshot_restore($base,$category)){
2023
2024         if(count($this->Available_SnapsShots($base))){
2025           $str.= "<input class='center' type='image' src='images/lists/restore.png'
2026             alt='"._("Restore snapshot")."' name='RestoreSnapShotDialog_".base64_encode($base)."' title='"._("Restore snapshot")."'>&nbsp;";
2027         } else {
2028           $str = "<img class='center' src='images/lists/restore_grey.png' alt=''>&nbsp;";
2029         }
2030       }
2031       if($ui->allow_snapshot_create($base,$category)){
2032         $str.= "<input class='center' type='image' src='images/snapshot.png'
2033           alt='"._("Create snapshot")."' name='CreateSnapShotDialog_".base64_encode($base)."'
2034           title='"._("Create a new snapshot from this object")."'>&nbsp;";
2035       }else{
2036         $str = "<img class='center' src='images/empty.png' alt=' '>&nbsp;";
2037       }
2038     }
2039
2040     return($str);
2041   }
2042
2043
2044   function get_copypaste_action($base,$category,$class,$copy = TRUE, $cut = TRUE)
2045   {
2046     $ui = get_userinfo();
2047     $action = "";
2048     if($this->CopyPasteHandler){
2049       if($cut){
2050         if($ui->is_cutable($base,$category,$class)){
2051           $action .= "<input class='center' type='image'
2052             src='images/lists/cut.png' alt='"._("cut")."' name='cut_%KEY%' title='"._("Cut this entry")."'>&nbsp;";
2053         }else{
2054           $action.="<img src='images/empty.png' alt=' ' class='center'>&nbsp;";
2055         }
2056       }
2057       if($copy){
2058         if($ui->is_copyable($base,$category,$class)){
2059           $action.= "<input class='center' type='image'
2060             src='images/lists/copy.png' alt='"._("copy")."' name='copy_%KEY%' title='"._("Copy this entry")."'>&nbsp;";
2061         }else{
2062           $action.="<img src='images/empty.png' alt=' ' class='center'>&nbsp;";
2063         }
2064       }
2065     }
2066
2067     return($action);
2068   }
2069
2070
2071   function get_copypaste_header($base,$category,$copy = TRUE, $cut = TRUE)
2072   {
2073     $s = "";
2074     $ui =get_userinfo();
2075
2076     if(!is_array($category)){
2077       $category = array($category);
2078     }
2079
2080     /* Check permissions for each category, if there is at least one category which
2081         support read or paste permissions for the given base, then display the specific actions.
2082      */
2083     $readable = $pasteable = TRUE;
2084     foreach($category as $cat){
2085       $readable |= $ui->get_category_permissions($base,$cat);
2086       $pasteable|= $ui->is_pasteable($base,$cat);
2087     }
2088
2089     if(($cut || $copy) && isset($this->CopyPasteHandler) && is_object($this->CopyPasteHandler)){
2090       if($readable){
2091         $s.= "..|---|\n";
2092         if($copy){
2093           $s.= "..|<img src='images/lists/copy.png' alt='' border='0' class='center'>".
2094             "&nbsp;"._("Copy")."|"."multiple_copy_systems|\n";
2095         }
2096         if($cut){
2097           $s.= "..|<img src='images/lists/cut.png' alt='' border='0' class='center'>".
2098             "&nbsp;"._("Cut")."|"."multiple_cut_systems|\n";
2099         }
2100       }
2101
2102       if($pasteable){
2103         if($this->CopyPasteHandler->entries_queued()){
2104           $img = "<img border='0' class='center' src='images/lists/paste.png' alt=''>";
2105           $s.="..|".$img."&nbsp;"._("Paste")."|editPaste|\n";
2106         }else{
2107           $img = "<img border='0' class='center' src='images/lists/paste-grey.png' alt=''>";
2108           $s.="..|".$img."&nbsp;"._("Paste")."\n";
2109         }
2110       }
2111     }
2112     return($s);
2113   }
2114
2115
2116   function get_used_snapshot_bases()
2117   {
2118      return(array());
2119   }
2120
2121   function is_modal_dialog()
2122   {
2123     return(isset($this->dialog) && $this->dialog);
2124   }
2125 }
2126
2127 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
2128 ?>