gosa-core/include/class_plugin.inc

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