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