trunk/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     $r=ldap_bind($ds,$this->config->current['ADMINDN'], $this->config->current['ADMINPASSWORD']);
 807     $sr=ldap_read($ds, LDAP::fix($src_dn), "objectClass=*");
 808
 809     /* Fill data from LDAP */
 810     $new= array();
 811     if ($sr) {
 812       $ei=ldap_first_entry($ds, $sr);
 813       if ($ei) {
 814         foreach($attrs as $attr => $val){
 815           if ($info = @ldap_get_values_len($ds, $ei, $attr)){
 816             for ($i= 0; $i<$info['count']; $i++){
 817               if ($info['count'] == 1){
 818                 $new[$attr]= $info[$i];
 819               } else {
 820                 $new[$attr][]= $info[$i];
 821               }
 822             }
 823           }
 824         }
 825       }
 826     }
 827
 828     /* close conncetion */
 829     ldap_unbind($ds);
 830
 831     /* Adapt naming attribute */
 832     $dst_name= preg_replace("/^([^=]+)=.*$/", "\\1", $dst_dn);
 833     $dst_val = preg_replace("/^[^=]+=([^,+]+).*,.*$/", "\\1", $dst_dn);
 834     $new[$dst_name]= LDAP::fix($dst_val);
 835
 836     /* Check if this is a department.
 837      * If it is a dep. && there is a , override in his ou
 838      *  change \2C to , again, else this entry can't be saved ...
 839      */
 840     if((isset($new['ou'])) &&( preg_match("/\\,/",$new['ou']))){
 841       $new['ou'] = str_replace("\\\\,",",",$new['ou']);
 842     }
 843
 844     /* Save copy */
 845     $ldap->connect();
 846     $ldap->cd($this->config->current['BASE']);
 847
 848     $ldap->create_missing_trees(preg_replace('/^[^,]+,/', '', $dst_dn));
 849
 850     /* FAIvariable=.../..., cn=..
 851         could not be saved, because the attribute FAIvariable was different to
 852         the dn FAIvariable=..., cn=... */
 853     if(in_array_ics("FAIdebconfInfo",$new['objectClass'])){
 854       $new['FAIvariable'] = $ldap->fix($new['FAIvariable']);
 855     }
 856     $ldap->cd($dst_dn);
 857     $ldap->add($new);
 858
 859     if (!$ldap->success()){
 860       trigger_error("Trying to save $dst_dn failed.",
 861           E_USER_WARNING);
 862       return(FALSE);
 863     }
 864     return(TRUE);
 865   }
 866
 867
 868   /* This is a workaround function. */
 869   function copy($src_dn, $dst_dn)
 870   {
 871     /* Rename dn in possible object groups */
 872     $ldap= $this->config->get_ldap_link();
 873     $ldap->search('(&(objectClass=gosaGroupOfNames)(member='.@LDAP::prepare4filter($src_dn).'))',
 874         array('cn'));
 875     while ($attrs= $ldap->fetch()){
 876       $og= new ogroup($this->config, $ldap->getDN());
 877       unset($og->member[$src_dn]);
 878       $og->member[$dst_dn]= $dst_dn;
 879       $og->save ();
 880     }
 881
 882     $ldap->cat($dst_dn);
 883     $attrs= $ldap->fetch();
 884     if (count($attrs)){
 885       trigger_error("Trying to overwrite ".LDAP::fix($dst_dn).", which already exists.",
 886           E_USER_WARNING);
 887       return (FALSE);
 888     }
 889
 890     $ldap->cat($src_dn);
 891     $attrs= $ldap->fetch();
 892     if (!count($attrs)){
 893       trigger_error("Trying to move ".LDAP::fix($src_dn).", which does not seem to exist.",
 894           E_USER_WARNING);
 895       return (FALSE);
 896     }
 897
 898     $ldap->cd($src_dn);
 899     $ldap->search("objectClass=*",array("dn"));
 900     while($attrs = $ldap->fetch()){
 901       $src = $attrs['dn'];
 902       $dst = preg_replace("/".preg_quote($src_dn, '/')."$/",$dst_dn,$attrs['dn']);
 903       $this->_copy($src,$dst);
 904     }
 905     return (TRUE);
 906   }
 907
 908
 909
 910   /*! \brief  Move a given ldap object indentified by $src_dn   \
 911                to the given destination $dst_dn   \
 912               * Ensure that all references are updated (ogroups) \
 913               * Update ACLs   \
 914               * Update accessTo   \
 915       @param  String  The source dn.
 916       @param  String  The destination dn.
 917       @return Boolean TRUE on success else FALSE.
 918    */
 919   function rename($src_dn, $dst_dn)
 920   {
 921     $start = microtime(1);
 922
 923     /* Try to move the source entry to the destination position */
 924     $ldap = $this->config->get_ldap_link();
 925     $ldap->cd($this->config->current['BASE']);
 926     $ldap->create_missing_trees(preg_replace("/^[^,]+,/","",$dst_dn));
 927     if (!$ldap->rename_dn($src_dn,$dst_dn)){
 928 #      msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $src_dn, "", get_class()));
 929       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());
 930       @DEBUG(DEBUG_LDAP,__LINE__,__FUNCTION__,__FILE__,"Rename failed FROM: $src_dn  -- TO:  $dst_dn",
 931           "Ldap Protocol v3 implementation error, falling back to maunal method.");
 932       return(FALSE);
 933     }
 934
 935     /* Get list of users,groups and roles within this tree,
 936         maybe we have to update ACL references.
 937      */
 938     $leaf_objs = get_list("(|(objectClass=posixGroup)(objectClass=gosaAccount)(objectClass=gosaRole))",array("all"),$dst_dn,
 939           array("dn","objectClass"),GL_SUBSEARCH | GL_NO_ACL_CHECK);
 940     foreach($leaf_objs as $obj){
 941       $new_dn = $obj['dn'];
 942       $old_dn = preg_replace("/".preg_quote($dst_dn, '/')."$/i",$src_dn,$new_dn);
 943       $this->update_acls($old_dn,$new_dn);
 944     }
 945
 946     /* Get all objectGroups defined in this database.
 947         and check if there is an entry matching the source dn,
 948         if this is the case, then update this objectgroup to use the new dn.
 949      */
 950     $ogroups = get_sub_list("(&(objectClass=gosaGroupOfNames)(member=*))","ogroups",
 951         array(get_ou("ogroupRDN")),$this->config->current['BASE'],array("member"),
 952         GL_SUBSEARCH | GL_NO_ACL_CHECK) ;
 953
 954     /* Walk through all objectGroups and check if there are
 955         members matching the source dn
 956      */
 957     $src_dn=str_replace('\\,', '\\2C', LDAP::fix($src_dn));
 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
 966           $c_mem = $ogroup['member'][$i];
 967
 968           if(preg_match("/".preg_quote($src_dn, '/')."$/i",$c_mem)){
 969
 970             $d_mem = preg_replace("/".preg_quote($src_dn, '/')."$/i",$dst_dn,$ogroup['member'][$i]);
 971
 972             if($o_ogroup == NULL){
 973               $o_ogroup = new ogroup($this->config,$ogroup['dn']);
 974             }
 975
 976             /* Members are stored with their converted names, so convert $c_mem as well
 977                to have it match in case of special characters in its name. */
 978             unset($o_ogroup->member[LDAP::convert($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::global_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 get_gosaUnitTag($dn = "")
1136   {
1137     if ($dn == "") {
1138         $dn = $this->dn;
1139     }
1140
1141     $len = strlen($dn);
1142     @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__, "No tag for $dn - looking for one...", "Tagging");
1143      $relevant= array();
1144         foreach ($this->config->adepartments as $key => $ntag){
1145
1146           /* This one is bigger than our dn, its not relevant... */
1147           if ($len < strlen($key)){
1148             continue;
1149           }
1150
1151           /* This one matches with the latter part. Break and don't fix this entry */
1152           if (preg_match('/(^|,)'.preg_quote($key, '/').'$/', $dn)){
1153             @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__, "DEBUG: Possibly relevant: $key", "Tagging");
1154             $relevant[strlen($key)]= $ntag;
1155             continue;
1156           }
1157
1158         }
1159
1160         /* If we've some relevant tags to set, just get the longest one */
1161         if (count($relevant)){
1162           ksort($relevant);
1163           $tmp= array_keys($relevant);
1164           $idx= end($tmp);
1165           $tag= $relevant[$idx];
1166           return $tag;
1167         }
1168
1169   }
1170
1171   function tag_attrs(&$at, $dn= "", $tag= "", $show= false)
1172   {
1173     /* Skip tagging?
1174        If this is called from departmentGeneric, we have to skip this
1175         tagging procedure.
1176      */
1177     if($this->skipTagging){
1178       return;
1179     }
1180
1181     /* No dn? Self-operation... */
1182     if ($dn == ""){
1183       $dn= $this->dn;
1184
1185       /* No tag? Find it yourself... */
1186       if ($tag == ""){
1187           $tag = $this->get_gosaUnitTag();
1188       }
1189     }
1190
1191     /* Remove tags that may already be here... */
1192     remove_objectClass("gosaAdministrativeUnitTag", $at);
1193     if (isset($at['gosaUnitTag'])){
1194         unset($at['gosaUnitTag']);
1195     }
1196
1197     /* Set tag? */
1198     if ($tag != ""){
1199       add_objectClass("gosaAdministrativeUnitTag", $at);
1200       $at['gosaUnitTag']= $tag;
1201     }
1202
1203     /* Initially this object was tagged.
1204        - But now, it is no longer inside a tagged department.
1205        So force the remove of the tag.
1206        (objectClass was already removed obove)
1207      */
1208     if($tag == "" && $this->gosaUnitTag){
1209       $at['gosaUnitTag'] = array();
1210     }
1211   }
1212
1213
1214   /* Add possibility to stop remove process */
1215   function allow_remove()
1216   {
1217     $reason= "";
1218     return $reason;
1219   }
1220
1221
1222   /* Create a snapshot of the current object */
1223   function create_snapshot($type= "snapshot", $description= array())
1224   {
1225
1226     /* Check if snapshot functionality is enabled */
1227     if(!$this->snapshotEnabled()){
1228       return;
1229     }
1230
1231     /* Get configuration from gosa.conf */
1232     $config = $this->config;
1233
1234     /* Create lokal ldap connection */
1235     $ldap= $this->config->get_ldap_link();
1236     $ldap->cd($this->config->current['BASE']);
1237
1238     /* check if there are special server configurations for snapshots */
1239     if($config->get_cfg_value("snapshotURI") == ""){
1240
1241       /* Source and destination server are both the same, just copy source to dest obj */
1242       $ldap_to      = $ldap;
1243       $snapldapbase = $this->config->current['BASE'];
1244
1245     }else{
1246       $server         = $config->get_cfg_value("snapshotURI");
1247       $user           = $config->get_cfg_value("snapshotAdminDn");
1248       $password       = $config->get_cfg_value("snapshotAdminPassword");
1249       $snapldapbase   = $config->get_cfg_value("snapshotBase");
1250
1251       $ldap_to        = new ldapMultiplexer(new LDAP($user,$password, $server));
1252       $ldap_to -> cd($snapldapbase);
1253
1254       if (!$ldap_to->success()){
1255         msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $snapldapbase, "", get_class()));
1256       }
1257
1258     }
1259
1260     /* check if the dn exists */
1261     if ($ldap->dn_exists($this->dn)){
1262
1263       /* Extract seconds & mysecs, they are used as entry index */
1264       list($usec, $sec)= explode(" ", microtime());
1265
1266       /* Collect some infos */
1267       $base           = $this->config->current['BASE'];
1268       $snap_base      = $config->get_cfg_value("snapshotBase");
1269       $base_of_object = preg_replace ('/^[^,]+,/i', '', $this->dn);
1270       $new_base       = preg_replace("/".preg_quote($base, '/')."$/","",$base_of_object).$snap_base;
1271
1272       /* Create object */
1273 #$data             = preg_replace('/^dn:.*\n/', '', $ldap->gen_ldif($this->dn,"(!(objectClass=gosaDepartment))"));
1274       $data             = $ldap->gen_ldif($this->dn,"(&(!(objectClass=gosaDepartment))(!(objectClass=FAIclass)))");
1275       $newName          = str_replace(".", "", $sec."-".$usec);
1276       $target= array();
1277       $target['objectClass']            = array("top", "gosaSnapshotObject");
1278       $target['gosaSnapshotData']       = gzcompress($data, 6);
1279       $target['gosaSnapshotType']       = $type;
1280       $target['gosaSnapshotDN']         = $this->dn;
1281       $target['description']            = $description;
1282       $target['gosaSnapshotTimestamp']  = $newName;
1283
1284       /* Insert the new snapshot
1285          But we have to check first, if the given gosaSnapshotTimestamp
1286          is already used, in this case we should increment this value till there is
1287          an unused value. */
1288       $new_dn                           = "gosaSnapshotTimestamp=".$newName.",".$new_base;
1289       $ldap_to->cat($new_dn);
1290       while($ldap_to->count()){
1291         $ldap_to->cat($new_dn);
1292         $newName = str_replace(".", "", $sec."-".($usec++));
1293         $new_dn                           = "gosaSnapshotTimestamp=".$newName.",".$new_base;
1294         $target['gosaSnapshotTimestamp']  = $newName;
1295       }
1296
1297       /* Inset this new snapshot */
1298       $ldap_to->cd($snapldapbase);
1299       $ldap_to->create_missing_trees($snapldapbase);
1300       $ldap_to->create_missing_trees($new_base);
1301       $ldap_to->cd($new_dn);
1302       $ldap_to->add($target);
1303       if (!$ldap_to->success()){
1304         msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $new_dn, LDAP_ADD, get_class()));
1305       }
1306
1307       if (!$ldap->success()){
1308         msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $new_base, "", get_class()));
1309       }
1310
1311     }
1312   }
1313
1314   function remove_snapshot($dn)
1315   {
1316     $ui       = get_userinfo();
1317     $old_dn   = $this->dn;
1318     $this->dn = $dn;
1319     $ldap = $this->config->get_ldap_link();
1320     $ldap->cd($this->config->current['BASE']);
1321     $ldap->rmdir_recursive($this->dn);
1322     if(!$ldap->success()){
1323       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $this->dn));
1324     }
1325     $this->dn = $old_dn;
1326   }
1327
1328
1329   /* returns true if snapshots are enabled, and false if it is disalbed
1330      There will also be some errors psoted, if the configuration failed */
1331   function snapshotEnabled()
1332   {
1333     $config = $this->config;
1334     if($config->get_cfg_value("enableSnapshots") == "true"){
1335             /* Check if the snapshot_base is defined */
1336             if ($config->get_cfg_value("snapshotBase") == ""){
1337                     msg_dialog::display(_("Configuration error"), sprintf(_("The snapshot functionality is enabled, but the required variable '%s' is not set."),"snapshotBase"), ERROR_DIALOG);
1338                     return(FALSE);
1339             }
1340
1341             /* check if there are special server configurations for snapshots */
1342             if ($config->get_cfg_value("snapshotURI") != ""){
1343
1344                     /* check if all required vars are available to create a new ldap connection */
1345                     $missing = "";
1346                     foreach(array("snapshotURI","snapshotAdminDn","snapshotAdminPassword","snapshotBase") as $var){
1347                             if($config->get_cfg_value($var) == ""){
1348                                     $missing .= $var." ";
1349                                     msg_dialog::display(_("Configuration error"), sprintf(_("The snapshot functionality is enabled, but the required variable '%s' is not set."), $missing), ERROR_DIALOG);
1350                                     return(FALSE);
1351                             }
1352                     }
1353             }
1354             return(TRUE);
1355     }
1356     return(FALSE);
1357   }
1358
1359
1360   /* Return available snapshots for the given base
1361    */
1362   function Available_SnapsShots($dn,$raw = false)
1363   {
1364     if(!$this->snapshotEnabled()) return(array());
1365
1366     /* Create an additional ldap object which
1367        points to our ldap snapshot server */
1368     $ldap= $this->config->get_ldap_link();
1369     $ldap->cd($this->config->current['BASE']);
1370     $cfg= &$this->config->current;
1371
1372     /* check if there are special server configurations for snapshots */
1373     if($this->config->get_cfg_value("snapshotURI") == ""){
1374       $ldap_to      = $ldap;
1375     }else{
1376       $server         = $this->config->get_cfg_value("snapshotURI");
1377       $user           = $this->config->get_cfg_value("snapshotAdminDn");
1378       $password       = $this->config->get_cfg_value("snapshotAdminPassword");
1379       $snapldapbase   = $this->config->get_cfg_value("snapshotBase");
1380       $ldap_to        = new ldapMultiplexer(new LDAP($user,$password, $server));
1381       $ldap_to -> cd($snapldapbase);
1382       if (!$ldap_to->success()){
1383         msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $snapldapbase, "", get_class()));
1384       }
1385     }
1386
1387     /* Prepare bases and some other infos */
1388     $base           = $this->config->current['BASE'];
1389     $snap_base      = $this->config->get_cfg_value("snapshotBase");
1390     $base_of_object = preg_replace ('/^[^,]+,/i', '', $dn);
1391     $new_base       = preg_replace("/".preg_quote($base, '/')."$/","",$base_of_object).$snap_base;
1392     $tmp            = array();
1393
1394     /* Fetch all objects with  gosaSnapshotDN=$dn */
1395     $ldap_to->cd($new_base);
1396     $ldap_to->ls("(&(objectClass=gosaSnapshotObject)(gosaSnapshotDN=".$dn."))",$new_base,
1397         array("gosaSnapshotType","gosaSnapshotTimestamp","gosaSnapshotDN","description"));
1398
1399     /* Put results into a list and add description if missing */
1400     while($entry = $ldap_to->fetch()){
1401       if(!isset($entry['description'][0])){
1402         $entry['description'][0]  = "";
1403       }
1404       $tmp[] = $entry;
1405     }
1406
1407     /* Return the raw array, or format the result */
1408     if($raw){
1409       return($tmp);
1410     }else{
1411       $tmp2 = array();
1412       foreach($tmp as $entry){
1413         $tmp2[base64_encode($entry['dn'])] = $entry['description'][0];
1414       }
1415     }
1416     return($tmp2);
1417   }
1418
1419
1420   function getAllDeletedSnapshots($base_of_object,$raw = false)
1421   {
1422     if(!$this->snapshotEnabled()) return(array());
1423
1424     /* Create an additional ldap object which
1425        points to our ldap snapshot server */
1426     $ldap= $this->config->get_ldap_link();
1427     $ldap->cd($this->config->current['BASE']);
1428     $cfg= &$this->config->current;
1429
1430     /* check if there are special server configurations for snapshots */
1431     if($this->config->get_cfg_value("snapshotURI") == ""){
1432       $ldap_to      = $ldap;
1433     }else{
1434       $server         = $this->config->get_cfg_value("snapshotURI");
1435       $user           = $this->config->get_cfg_value("snapshotAdminDn");
1436       $password       = $this->config->get_cfg_value("snapshotAdminPassword");
1437       $snapldapbase   = $this->config->get_cfg_value("snapshotBase");
1438       $ldap_to        = new ldapMultiplexer(new LDAP($user,$password, $server));
1439       $ldap_to -> cd($snapldapbase);
1440       if (!$ldap_to->success()){
1441         msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $snapldapbase, "", get_class()));
1442       }
1443     }
1444
1445     /* Prepare bases */
1446     $base           = $this->config->current['BASE'];
1447     $snap_base      = $this->config->get_cfg_value("snapshotBase");
1448     $new_base       = preg_replace("/".preg_quote($base, '/')."$/","",$base_of_object).$snap_base;
1449
1450     /* Fetch all objects and check if they do not exist anymore */
1451     $ui = get_userinfo();
1452     $tmp = array();
1453     $ldap_to->cd($new_base);
1454     $ldap_to->ls("(objectClass=gosaSnapshotObject)",$new_base,array("gosaSnapshotType","gosaSnapshotTimestamp","gosaSnapshotDN","description"));
1455     while($entry = $ldap_to->fetch()){
1456
1457       $chk =  str_replace($new_base,"",$entry['dn']);
1458       if(preg_match("/,ou=/",$chk)) continue;
1459
1460       if(!isset($entry['description'][0])){
1461         $entry['description'][0]  = "";
1462       }
1463       $tmp[] = $entry;
1464     }
1465
1466     /* Check if entry still exists */
1467     foreach($tmp as $key => $entry){
1468       $ldap->cat($entry['gosaSnapshotDN'][0]);
1469       if($ldap->count()){
1470         unset($tmp[$key]);
1471       }
1472     }
1473
1474     /* Format result as requested */
1475     if($raw) {
1476       return($tmp);
1477     }else{
1478       $tmp2 = array();
1479       foreach($tmp as $key => $entry){
1480         $tmp2[base64_encode($entry['dn'])] = $entry['description'][0];
1481       }
1482     }
1483     return($tmp2);
1484   }
1485
1486
1487   /* Restore selected snapshot */
1488   function restore_snapshot($dn)
1489   {
1490     if(!$this->snapshotEnabled()) return(array());
1491
1492     $ldap= $this->config->get_ldap_link();
1493     $ldap->cd($this->config->current['BASE']);
1494     $cfg= &$this->config->current;
1495
1496     /* check if there are special server configurations for snapshots */
1497     if($this->config->get_cfg_value("snapshotURI") == ""){
1498       $ldap_to      = $ldap;
1499     }else{
1500       $server         = $this->config->get_cfg_value("snapshotURI");
1501       $user           = $this->config->get_cfg_value("snapshotAdminDn");
1502       $password       = $this->config->get_cfg_value("snapshotAdminPassword");
1503       $snapldapbase   = $this->config->get_cfg_value("snapshotBase");
1504       $ldap_to        = new ldapMultiplexer(new LDAP($user,$password, $server));
1505       $ldap_to -> cd($snapldapbase);
1506       if (!$ldap_to->success()){
1507         msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $snapldapbase, "", get_class()));
1508       }
1509     }
1510
1511     /* Get the snapshot */
1512     $ldap_to->cat($dn);
1513     $restoreObject = $ldap_to->fetch();
1514
1515     /* Prepare import string */
1516     $data  = gzuncompress($ldap_to->get_attribute($dn,'gosaSnapshotData'));
1517
1518     /* Import the given data */
1519     $err = "";
1520     $ldap->import_complete_ldif($data,$err,false,false);
1521     if (!$ldap->success()){
1522       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $dn, "", get_class()));
1523     }
1524   }
1525
1526
1527   function showSnapshotDialog($base,$baseSuffixe,&$parent)
1528   {
1529     $once = true;
1530     $ui = get_userinfo();
1531     $this->parent = $parent;
1532
1533     foreach($_POST as $name => $value){
1534
1535       /* Create a new snapshot, display a dialog */
1536       if(preg_match("/^CreateSnapShotDialog_[^_]*_[xy]$/",$name) && $once){
1537
1538                           $entry = base64_decode(preg_replace("/^CreateSnapShotDialog_([^_]*)_[xy]$/","\\1",$name));
1539         $once = false;
1540         $entry = preg_replace("/^CreateSnapShotDialog_/","",$entry);
1541
1542         if(!empty($entry) && $ui->allow_snapshot_create($entry,$this->parent->acl_module)){
1543           $this->snapDialog = new SnapShotDialog($this->config,$entry,$this);
1544         }else{
1545           msg_dialog::display(_("Permission"),sprintf(_("You are not allowed to create a snapshot for %s."),$entry),ERROR_DIALOG);
1546         }
1547       }
1548
1549       /* Restore a snapshot, display a dialog with all snapshots of the current object */
1550       if(preg_match("/^RestoreSnapShotDialog_/",$name) && $once){
1551         $once = false;
1552         $entry = base64_decode(preg_replace("/^RestoreSnapShotDialog_([^_]*)_[xy]$/i","\\1",$name));
1553         if(!empty($entry) && $ui->allow_snapshot_restore($this->dn,$this->parent->acl_module)){
1554           $this->snapDialog = new SnapShotDialog($this->config,$entry,$this);
1555           $this->snapDialog->display_restore_dialog = true;
1556         }else{
1557           msg_dialog::display(_("Permission"),sprintf(_("You are not allowed to restore a snapshot for %s."),$entry),ERROR_DIALOG);
1558         }
1559       }
1560
1561       /* Restore one of the already deleted objects */
1562       if(((isset($_POST['menu_action']) && $_POST['menu_action'] == "RestoreDeletedSnapShot")
1563           || preg_match("/^RestoreDeletedSnapShot_/",$name)) && $once){
1564         $once = false;
1565
1566         if($ui->allow_snapshot_restore($this->dn,$this->parent->acl_module)){
1567           $this->snapDialog = new SnapShotDialog($this->config,"",$this);
1568           $this->snapDialog->set_snapshot_bases($baseSuffixe);
1569           $this->snapDialog->display_restore_dialog      = true;
1570           $this->snapDialog->display_all_removed_objects  = true;
1571         }else{
1572           msg_dialog::display(_("Permission"),sprintf(_("You are not allowed to restore a snapshot for %s."),$base),ERROR_DIALOG);
1573         }
1574       }
1575
1576       /* Restore selected snapshot */
1577       if(preg_match("/^RestoreSnapShot_/",$name) && $once){
1578         $once = false;
1579         $entry = base64_decode(preg_replace("/^RestoreSnapShot_([^_]*)_[xy]$/i","\\1",$name));
1580
1581         if(!empty($entry) && $ui->allow_snapshot_restore($this->dn,$this->parent->acl_module)){
1582           $this->restore_snapshot($entry);
1583           $this->snapDialog = NULL;
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
1590     /* Create a new snapshot requested, check
1591        the given attributes and create the snapshot*/
1592     if(isset($_POST['CreateSnapshot']) && is_object($this->snapDialog)){
1593       $this->snapDialog->save_object();
1594       $msgs = $this->snapDialog->check();
1595       if(count($msgs)){
1596         foreach($msgs as $msg){
1597           msg_dialog::display(_("Error"), $msg, ERROR_DIALOG);
1598         }
1599       }else{
1600         $this->dn =  $this->snapDialog->dn;
1601         $this->create_snapshot("snapshot",$this->snapDialog->CurrentDescription);
1602         $this->snapDialog = NULL;
1603       }
1604     }
1605
1606     /* Restore is requested, restore the object with the posted dn .*/
1607     if((isset($_POST['RestoreSnapshot'])) && (isset($_POST['SnapShot']))){
1608     }
1609
1610     if(isset($_POST['CancelSnapshot'])){
1611       $this->snapDialog = NULL;
1612     }
1613
1614     if(is_object($this->snapDialog )){
1615       $this->snapDialog->save_object();
1616       return($this->snapDialog->execute());
1617     }
1618   }
1619
1620
1621   static function plInfo()
1622   {
1623     return array();
1624   }
1625
1626
1627   function set_acl_base($base)
1628   {
1629     $this->acl_base= $base;
1630   }
1631
1632
1633   function set_acl_category($category)
1634   {
1635     $this->acl_category= "$category/";
1636   }
1637
1638
1639   function acl_is_writeable($attribute,$skip_write = FALSE)
1640   {
1641     if($this->read_only) return(FALSE);
1642     $ui= get_userinfo();
1643     return preg_match('/w/', $ui->get_permissions($this->acl_base, $this->acl_category.get_class($this), $attribute, $skip_write));
1644   }
1645
1646
1647   function acl_is_readable($attribute)
1648   {
1649     $ui= get_userinfo();
1650     return preg_match('/r/', $ui->get_permissions($this->acl_base, $this->acl_category.get_class($this), $attribute));
1651   }
1652
1653
1654   function acl_is_createable($base ="")
1655   {
1656     if($this->read_only) return(FALSE);
1657     $ui= get_userinfo();
1658     if($base == "") $base = $this->acl_base;
1659     return preg_match('/c/', $ui->get_permissions($base, $this->acl_category.get_class($this), '0'));
1660   }
1661
1662
1663   function acl_is_removeable($base ="")
1664   {
1665     if($this->read_only) return(FALSE);
1666     $ui= get_userinfo();
1667     if($base == "") $base = $this->acl_base;
1668     return preg_match('/d/', $ui->get_permissions($base, $this->acl_category.get_class($this), '0'));
1669   }
1670
1671
1672   function acl_is_moveable($base = "")
1673   {
1674     if($this->read_only) return(FALSE);
1675     $ui= get_userinfo();
1676     if($base == "") $base = $this->acl_base;
1677     return preg_match('/m/', $ui->get_permissions($base, $this->acl_category.get_class($this), '0'));
1678   }
1679
1680
1681   function acl_have_any_permissions()
1682   {
1683   }
1684
1685
1686   function getacl($attribute,$skip_write= FALSE)
1687   {
1688     $ui= get_userinfo();
1689     $skip_write |= $this->read_only;
1690     return  $ui->get_permissions($this->acl_base, $this->acl_category.get_class($this), $attribute,$skip_write);
1691   }
1692
1693
1694   /*! \brief    Returns a list of all available departments for this object.
1695                 If this object is new, all departments we are allowed to create a new user in are returned.
1696                 If this is an existing object, return all deps. we are allowed to move tis object too.
1697
1698       @return   Array [dn] => "..name"  // All deps. we are allowed to act on.
1699   */
1700   function get_allowed_bases()
1701   {
1702     $ui = get_userinfo();
1703     $deps = array();
1704
1705     /* Is this a new object ? Or just an edited existing object */
1706     if(!$this->initially_was_account && $this->is_account){
1707       $new = true;
1708     }else{
1709       $new = false;
1710     }
1711
1712     foreach($this->config->idepartments as $dn => $name){
1713       if($new && $this->acl_is_createable($dn)){
1714         $deps[$dn] = $name;
1715       }elseif(!$new && $this->acl_is_moveable($dn)){
1716         $deps[$dn] = $name;
1717       }
1718     }
1719
1720     /* Add current base */
1721     if(isset($this->base) && isset($this->config->idepartments[$this->base])){
1722       $deps[$this->base] = $this->config->idepartments[$this->base];
1723     }elseif(strtolower($this->dn) == strtolower($this->config->current['BASE'])){
1724
1725     }else{
1726       trigger_error("Cannot return list of departments, no default base found in class ".get_class($this).". ".$this->base);
1727     }
1728     return($deps);
1729   }
1730
1731
1732   /* This function updates ACL settings if $old_dn was used.
1733    *  $old_dn   specifies the actually used dn
1734    *  $new_dn   specifies the destiantion dn
1735    */
1736   function update_acls($old_dn,$new_dn,$output_changes = FALSE)
1737   {
1738     /* Check if old_dn is empty. This should never happen */
1739     if(empty($old_dn) || empty($new_dn)){
1740       trigger_error("Failed to check acl dependencies, wrong dn given.");
1741       return;
1742     }
1743
1744     /* Update userinfo if necessary */
1745     $ui = session::global_get('ui');
1746     if($ui->dn == $old_dn){
1747       $ui->dn = $new_dn;
1748       session::global_set('ui',$ui);
1749       new log("view","acl/".get_class($this),$this->dn,array(),"Updated current object dn from '".$old_dn."' to '".$new_dn."'");
1750     }
1751
1752     /* Object was moved, ensure that all acls will be moved too */
1753     if($new_dn != $old_dn && $old_dn != "new"){
1754
1755       /* get_ldap configuration */
1756       $update = array();
1757       $ldap = $this->config->get_ldap_link();
1758       $ldap->cd ($this->config->current['BASE']);
1759       $ldap->search("(&(objectClass=gosaAcl)(gosaAclEntry=*".base64_encode($old_dn)."*))",array("cn","gosaAclEntry"));
1760       while($attrs = $ldap->fetch()){
1761         $acls = array();
1762         $found = false;
1763         for($i = 0 ; $i <  $attrs['gosaAclEntry']['count'] ; $i ++ ){
1764           $acl_parts = split(":",$attrs['gosaAclEntry'][$i]);
1765
1766           /* Roles uses antoher data storage order, members are stored int the third part,
1767              while the members in direct ACL assignments are stored in the second part.
1768            */
1769           $id = ($acl_parts[1] == "role") ? 3 : 2;
1770
1771           /* Update member entries to use $new_dn instead of old_dn
1772            */
1773           $members = explode(",",$acl_parts[$id]);
1774           foreach($members as $key => $member){
1775             $member = base64_decode($member);
1776             if($member == $old_dn){
1777               $members[$key] = base64_encode($new_dn);
1778               $found = TRUE;
1779             }
1780           }
1781
1782           /* Check if the selected role has to updated
1783            */
1784           if($acl_parts[1] == "role" && $acl_parts[2] == base64_encode($old_dn)){
1785             $acl_parts[2] = base64_encode($new_dn);
1786             $found = TRUE;
1787           }
1788
1789           /* Build new acl string */
1790           $acl_parts[$id] = implode($members,",");
1791           $acls[] = implode($acl_parts,":");
1792         }
1793
1794         /* Acls for this object must be adjusted */
1795         if($found){
1796
1797           $debug_info=  _("Changing ACL dn")."&nbsp;:&nbsp;<br>&nbsp;-"._("from")."&nbsp;<b>&nbsp;".
1798             $old_dn."</b><br>&nbsp;-"._("to")."&nbsp;<b>".$new_dn."</b><br>";
1799           @DEBUG (DEBUG_ACL, __LINE__, __FUNCTION__, __FILE__,$debug_info,"ACL");
1800
1801           $update[$attrs['dn']] =array();
1802           foreach($acls as $acl){
1803             $update[$attrs['dn']]['gosaAclEntry'][] = $acl;
1804           }
1805         }
1806       }
1807
1808       /* Write updated acls */
1809       foreach($update as $dn => $attrs){
1810         $ldap->cd($dn);
1811         $ldap->modify($attrs);
1812       }
1813     }
1814   }
1815
1816
1817
1818   /* This function enables the entry Serial ID check.
1819    * If an entry was edited while we have edited the entry too,
1820    *  an error message will be shown.
1821    * To configure this check correctly read the FAQ.
1822    */
1823   function enable_CSN_check()
1824   {
1825     $this->CSN_check_active =TRUE;
1826     $this->entryCSN = getEntryCSN($this->dn);
1827   }
1828
1829
1830   /*! \brief  Prepares the plugin to be used for multiple edit
1831    *          Update plugin attributes with given array of attribtues.
1832    *  @param  array   Array with attributes that must be updated.
1833    */
1834   function init_multiple_support($attrs,$all)
1835   {
1836     $ldap= $this->config->get_ldap_link();
1837     $this->multi_attrs    = $attrs;
1838     $this->multi_attrs_all= $all;
1839
1840     /* Copy needed attributes */
1841     foreach ($this->attributes as $val){
1842       $found= array_key_ics($val, $this->multi_attrs);
1843       if ($found != ""){
1844         if(isset($this->multi_attrs["$found"][0])){
1845           $this->$val= $this->multi_attrs["$found"][0];
1846         }
1847       }
1848     }
1849   }
1850
1851
1852   /*! \brief  Enables multiple support for this plugin
1853    */
1854   function enable_multiple_support()
1855   {
1856     $this->ignore_account = TRUE;
1857     $this->multiple_support_active = TRUE;
1858   }
1859
1860
1861   /*! \brief  Returns all values that have been modfied in multiple edit mode.
1862       @return array Cotaining all mdofied values.
1863    */
1864   function get_multi_edit_values()
1865   {
1866     $ret = array();
1867     foreach($this->attributes as $attr){
1868       if(in_array($attr,$this->multi_boxes)){
1869         $ret[$attr] = $this->$attr;
1870       }
1871     }
1872     return($ret);
1873   }
1874
1875
1876   /*! \brief  Update class variables with values collected by multiple edit.
1877    */
1878   function set_multi_edit_values($attrs)
1879   {
1880     foreach($attrs as $name => $value){
1881       $this->$name = $value;
1882     }
1883   }
1884
1885
1886   /*! \brief execute plugin
1887
1888     Generates the html output for this node
1889    */
1890   function multiple_execute()
1891   {
1892     /* This one is empty currently. Fabian - please fill in the docu code */
1893     session::global_set('current_class_for_help',get_class($this));
1894
1895     /* Reset Lock message POST/GET check array, to prevent perg_match errors*/
1896     session::set('LOCK_VARS_TO_USE',array());
1897     session::set('LOCK_VARS_USED',array());
1898
1899     return("Multiple edit is currently not implemented for this plugin.");
1900   }
1901
1902
1903   /*! \brief   Save HTML posted data to object for multiple edit
1904    */
1905   function multiple_save_object()
1906   {
1907     if(empty($this->entryCSN) && $this->CSN_check_active){
1908       $this->entryCSN = getEntryCSN($this->dn);
1909     }
1910
1911     /* Save values to object */
1912     $this->multi_boxes = array();
1913     foreach ($this->attributes as $val){
1914
1915       /* Get selected checkboxes from multiple edit */
1916       if(isset($_POST["use_".$val])){
1917         $this->multi_boxes[] = $val;
1918       }
1919
1920       if ($this->acl_is_writeable($val) && isset ($_POST["$val"])){
1921
1922         /* Check for modifications */
1923         if (get_magic_quotes_gpc()) {
1924           $data= stripcslashes($_POST["$val"]);
1925         } else {
1926           $data= $this->$val = $_POST["$val"];
1927         }
1928         if ($this->$val != $data){
1929           $this->is_modified= TRUE;
1930         }
1931
1932         /* IE post fix */
1933         if(isset($data[0]) && $data[0] == chr(194)) {
1934           $data = "";
1935         }
1936         $this->$val= $data;
1937       }
1938     }
1939   }
1940
1941
1942   /*! \brief  Returns all attributes of this plugin,
1943                to be able to detect multiple used attributes
1944                in multi_plugg::detect_multiple_used_attributes().
1945       @return array Attributes required for intialization of multi_plug
1946    */
1947   public function get_multi_init_values()
1948   {
1949     $attrs = $this->attrs;
1950     return($attrs);
1951   }
1952
1953
1954   /*! \brief  Check given values in multiple edit
1955       @return array Error messages
1956    */
1957   function multiple_check()
1958   {
1959     $message = plugin::check();
1960     return($message);
1961   }
1962
1963
1964   /*! \brief  Returns the snapshot header part for "Actions" menu in management dialogs
1965       @param  $layer_menu
1966    */
1967   function get_snapshot_header($base,$category)
1968   {
1969     $str = "";
1970     $ui = get_userinfo();
1971     if($this->snapshotEnabled() && $ui->allow_snapshot_restore($base,$category)){
1972
1973       $ok = false;
1974       foreach($this->get_used_snapshot_bases() as $base){
1975         $ok |= count($this->getAllDeletedSnapshots($base)) >= 1 ;
1976       }
1977
1978       if($ok){
1979         $str = "..|<img class='center' src='images/lists/restore.png' ".
1980           "alt='"._("Restore")."'>&nbsp;"._("Restore").                       "|RestoreDeletedSnapShot|\n";
1981       }else{
1982         $str = "..|<img class='center' src='images/lists/restore_grey.png' alt=''>&nbsp;"._("Restore")."||\n";
1983       }
1984     }
1985     return($str);
1986   }
1987
1988
1989   function get_snapshot_action($base,$category)
1990   {
1991     $str= "";
1992     $ui = get_userinfo();
1993     if($this->snapshotEnabled()){
1994       if ($ui->allow_snapshot_restore($base,$category)){
1995
1996         if(count($this->Available_SnapsShots($base))){
1997           $str.= "<input class='center' type='image' src='images/lists/restore.png'
1998             alt='"._("Restore snapshot")."' name='RestoreSnapShotDialog_".base64_encode($base)."' title='"._("Restore snapshot")."'>&nbsp;";
1999         } else {
2000           $str = "<img class='center' src='images/lists/restore_grey.png' alt=''>&nbsp;";
2001         }
2002       }
2003       if($ui->allow_snapshot_create($base,$category)){
2004         $str.= "<input class='center' type='image' src='images/snapshot.png'
2005           alt='"._("Create snapshot")."' name='CreateSnapShotDialog_".base64_encode($base)."'
2006           title='"._("Create a new snapshot from this object")."'>&nbsp;";
2007       }else{
2008         $str = "<img class='center' src='images/empty.png' alt=' '>&nbsp;";
2009       }
2010     }
2011
2012     return($str);
2013   }
2014
2015
2016   function get_copypaste_action($base,$category,$class,$copy = TRUE, $cut = TRUE)
2017   {
2018     $ui = get_userinfo();
2019     $action = "";
2020     if($this->CopyPasteHandler){
2021       if($cut){
2022         if($ui->is_cutable($base,$category,$class)){
2023           $action .= "<input class='center' type='image'
2024             src='images/lists/cut.png' alt='"._("cut")."' name='cut_%KEY%' title='"._("Cut this entry")."'>&nbsp;";
2025         }else{
2026           $action.="<img src='images/empty.png' alt=' ' class='center'>&nbsp;";
2027         }
2028       }
2029       if($copy){
2030         if($ui->is_copyable($base,$category,$class)){
2031           $action.= "<input class='center' type='image'
2032             src='images/lists/copy.png' alt='"._("copy")."' name='copy_%KEY%' title='"._("Copy this entry")."'>&nbsp;";
2033         }else{
2034           $action.="<img src='images/empty.png' alt=' ' class='center'>&nbsp;";
2035         }
2036       }
2037     }
2038
2039     return($action);
2040   }
2041
2042
2043   function get_copypaste_header($base,$category,$copy = TRUE, $cut = TRUE)
2044   {
2045     $s = "";
2046     $ui =get_userinfo();
2047
2048     if(!is_array($category)){
2049       $category = array($category);
2050     }
2051
2052     /* Check permissions for each category, if there is at least one category which
2053         support read or paste permissions for the given base, then display the specific actions.
2054      */
2055     $readable = $pasteable = TRUE;
2056     foreach($category as $cat){
2057       $readable |= $ui->get_category_permissions($base,$cat);
2058       $pasteable|= $ui->is_pasteable($base,$cat);
2059     }
2060
2061     if(($cut || $copy) && isset($this->CopyPasteHandler) && is_object($this->CopyPasteHandler)){
2062       if($readable){
2063         $s.= "..|---|\n";
2064         if($copy){
2065           $s.= "..|<img src='images/lists/copy.png' alt='' border='0' class='center'>".
2066             "&nbsp;"._("Copy")."|"."multiple_copy_systems|\n";
2067         }
2068         if($cut){
2069           $s.= "..|<img src='images/lists/cut.png' alt='' border='0' class='center'>".
2070             "&nbsp;"._("Cut")."|"."multiple_cut_systems|\n";
2071         }
2072       }
2073
2074       if($pasteable){
2075         if($this->CopyPasteHandler->entries_queued()){
2076           $img = "<img border='0' class='center' src='images/lists/paste.png' alt=''>";
2077           $s.="..|".$img."&nbsp;"._("Paste")."|editPaste|\n";
2078         }else{
2079           $img = "<img border='0' class='center' src='images/lists/paste-grey.png' alt=''>";
2080           $s.="..|".$img."&nbsp;"._("Paste")."\n";
2081         }
2082       }
2083     }
2084     return($s);
2085   }
2086
2087
2088   function get_used_snapshot_bases()
2089   {
2090      return(array());
2091   }
2092
2093   function is_modal_dialog()
2094   {
2095     return(isset($this->dialog) && $this->dialog);
2096   }
2097 }
2098 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
2099 ?>