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