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