gosa-core/include/class_management.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 class management
  24 {
  25   // Public
  26   public $config = null;
  27   public $ui     = null;
  28
  29   // The plugin description
  30   public $plugname      = "unconfigured";
  31   public $plIcon        = "unconfigured";
  32   public $plDescription = "unconfigured";
  33   public $plHeadline    = "unconfigured";
  34
  35   // The currently used object(s) (e.g. in edit, removal)
  36   public $dn = "";  // this is public due to some compatibility problems with class plugin..
  37   protected $dns = array();
  38
  39   // The last used object(s).
  40   protected $last_dn = "";
  41   protected $last_dns = array();
  42
  43   // The common places the displayed objects are stored in. (e.g. array("ou=groups,",".."))
  44   protected $storagePoints = array();
  45
  46   // The tab definitions to use for the current object.
  47   protected $tabClass = "";         // e.g. usertabs
  48   protected $tabType = "";          // e.g. USERTABS
  49   protected $aclPlugin = "";        // e.g. generic
  50   protected $aclCategory = "";      // e.g. users
  51   protected $objectName = "";       // e.g. users
  52
  53   // The opened object.
  54   protected $tabObject = null;
  55   protected $dialogObject = null;
  56
  57   // The last opened object.
  58   protected $last_tabObject = null;
  59   protected $last_dialogObject = null;
  60
  61   // Whether to display the apply button or not
  62   protected $displayApplyBtn = FALSE;
  63
  64   // Whether to display a header or not.
  65   protected $skipHeader = false;
  66
  67   // Whether to display a footer or not.
  68   protected $skipFooter = false;
  69
  70   // Copy&Paste handler
  71   protected $cpHandler = null;
  72
  73   // Indicates that we want to paste objects right now.
  74   protected $cpPastingStarted = FALSE;
  75
  76   // The Snapshot handler class.
  77   protected $snapHandler = null;
  78
  79   // The listing handlers
  80   private $headpage = null;
  81   private $filter = null;
  82
  83   // A list of configured actions/events
  84   protected $actions = array();
  85
  86   // Attributes managed by this plugin, can be used in post events;
  87   public $attributes = array();
  88
  89   function  __construct(&$config,$ui,$plugname, $headpage)
  90   {
  91     $this->plugname = $plugname;
  92     $this->headpage = $headpage;
  93     $this->ui = $ui;
  94     $this->config = $config;
  95
  96     if($this->cpHandler) $this->headpage->setCopyPasteHandler($this->cpHandler);
  97     if($this->snapHandler) $this->headpage->setSnapshotHandler($this->snapHandler);
  98
  99     if(empty($this->plIcon)){
 100       $this->plIcon = "plugins/".$plugname."/images/plugin.png";
 101     }
 102
 103     // Register default actions
 104     $this->registerAction("new",    "newEntry");
 105     $this->registerAction("edit",   "editEntry");
 106     $this->registerAction("apply",  "applyChanges");
 107     $this->registerAction("save",   "saveChanges");
 108     $this->registerAction("cancel", "cancelEdit");
 109     $this->registerAction("cancelDelete", "cancelEdit");
 110     $this->registerAction("remove", "removeEntryRequested");
 111     $this->registerAction("removeConfirmed", "removeEntryConfirmed");
 112
 113     $this->registerAction("copy",   "copyPasteHandler");
 114     $this->registerAction("cut",    "copyPasteHandler");
 115     $this->registerAction("paste",  "copyPasteHandler");
 116
 117     $this->registerAction("snapshot",    "createSnapshotDialog");
 118     $this->registerAction("restore",     "restoreSnapshotDialog");
 119     $this->registerAction("saveSnapshot","saveSnapshot");
 120     $this->registerAction("restoreSnapshot","restoreSnapshot");
 121     $this->registerAction("cancelSnapshot","closeDialogs");
 122   }
 123
 124   /*! \brief  Execute this plugin
 125    *          Handle actions/events, locking, snapshots, dialogs, tabs,...
 126    */
 127   function execute()
 128   {
 129     // Ensure that html posts and gets are kept even if we see a 'Entry islocked' dialog.
 130     $vars = array('/^act$/','/^listing/','/^PID$/','/^FILTER_PID$/');
 131     session::set('LOCK_VARS_TO_USE',$vars);
 132
 133     /* Display the copy & paste dialog, if it is currently open */
 134     $ret = $this->copyPasteHandler("",array());
 135     if($ret){
 136       return($this->getHeader().$ret);
 137     }
 138
 139     // Update filter
 140     if ($this->filter) {
 141       $this->filter->update();
 142       session::global_set(get_class($this)."_filter", $this->filter);
 143       session::set('autocomplete', $this->filter);
 144       if (!$this->filter->isValid()){
 145         msg_dialog::display(_("Filter error"), _("The filter is incomplete!"), ERROR_DIALOG);
 146       }
 147     }
 148
 149     // Handle actions (POSTs and GETs)
 150     $str = $this->handleActions($this->detectPostActions());
 151     if($str) return($this->getHeader().$str);
 152
 153     // Open single dialog objects
 154     if(is_object($this->dialogObject)){
 155       if(method_exists($this->dialogObject,'save_object')) $this->dialogObject->save_object();
 156       if(method_exists($this->dialogObject,'execute')){
 157         $display = $this->dialogObject->execute();
 158         $display.= $this->_getTabFooter();
 159         return($this->getHeader().$display);
 160       }
 161     }
 162
 163     // Display tab object.
 164     if($this->tabObject instanceOf tabs || $this->tabObject instanceOf multi_plug){
 165 #      $this->tabObject->save_object();
 166       $display = $this->tabObject->execute();
 167       $display.= $this->_getTabFooter();
 168       return($this->getHeader().$display);
 169     }
 170
 171     // Set current restore base for snapshot handling.
 172     if(is_object($this->snapHandler)){
 173       $bases = array();
 174       foreach($this->storagePoints as $sp){
 175         $bases[] = $sp.$this->headpage->getBase();
 176       }
 177
 178       // No bases specified? Try base
 179       if(!count($bases)) $bases[] = $this->headpage->getBase();
 180
 181       $this->snapHandler->setSnapshotBases($bases);
 182     }
 183
 184     // Display list
 185     return($this->renderList());
 186   }
 187
 188   function renderList()
 189   {
 190     $this->headpage->update();
 191     $display = $this->headpage->render();
 192     return($this->getHeader().$display);
 193   }
 194
 195   function getHeadpage()
 196   {
 197     return($this->headpage);
 198   }
 199
 200   function getFilter()
 201   {
 202     return($this->filter);
 203   }
 204
 205   /*! \brief  Generates the plugin header which is displayed whenever a tab object is
 206    *           opened.
 207    */
 208   protected function getHeader()
 209   {
 210     if($this->skipHeader) return("");
 211
 212     if (get_object_info() != ""){
 213       $display= print_header(get_template_path($this->plIcon),_($this->plDescription),
 214           "<img alt=\"\" class=\"center\" src=\"".get_template_path('images/lists/locked.png')."\">".
 215           LDAP::fix(get_object_info()));
 216     } else {
 217       $display= print_header(get_template_path($this->plIcon),_($this->plDescription));
 218     }
 219     return($display);
 220   }
 221
 222
 223   /*! \brief  Generates the footer which is used whenever a tab object is
 224    *           displayed.
 225    */
 226   protected function _getTabFooter()
 227   {
 228     // Do not display tab footer for non tab objects
 229     if(!($this->tabObject instanceOf tabs || $this->tabObject instanceOf multi_plug)){
 230       return("");
 231     }
 232
 233     // Check if there is a dialog opened - We don't need any buttons in this case.
 234     if($this->tabObject->by_object[$this->tabObject->current]){
 235       $current = $this->tabObject->by_object[$this->tabObject->current];
 236       if(isset($current->dialog) && (is_object($current->dialog) || $current->dialog)){
 237         return("");
 238       }
 239     }
 240
 241     // Skip footer if requested;
 242     if($this->skipFooter) return("");
 243
 244     // In case an of locked entry, we may have opened a read-only tab.
 245     $str = "";
 246     if(isset($this->tabObject->read_only) && $this->tabObject->read_only == TRUE){
 247       $str.= "<p style=\"text-align:right\">
 248         <input type=submit name=\"edit_cancel\" value=\"".msgPool::cancelButton()."\">
 249         </p>";
 250       return($str);
 251     }else{
 252
 253       // Display ok, (apply) and cancel buttons
 254       $str.= "<p style=\"text-align:right\">\n";
 255       $str.= "<input type=submit name=\"edit_finish\" style=\"width:80px\" value=\"".msgPool::okButton()."\">\n";
 256       $str.= "&nbsp;\n";
 257       if($this->displayApplyBtn){
 258         $str.= "<input type=submit name=\"edit_apply\" value=\"".msgPool::applyButton()."\">\n";
 259         $str.= "&nbsp;\n";
 260       }
 261       $str.= "<input type=submit name=\"edit_cancel\" value=\"".msgPool::cancelButton()."\">\n";
 262       $str.= "</p>";
 263     }
 264     return($str);
 265   }
 266
 267
 268   /*! \brief  Initiates the removal for the given entries
 269    *           and displays a confirmation dialog.
 270    *
 271    *  @param  String  'action'  The name of the action which was the used as trigger.
 272    *  @param  Array   'target'  A list of object dns, which should be affected by this method.
 273    *  @param  Array   'all'     A combination of both 'action' and 'target'.
 274    */
 275   protected function removeEntryRequested($action="",$target=array(),$all=array())
 276   {
 277     $disallowed = array();
 278     $this->dns = array();
 279
 280     @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$target,"Entry removel requested!");
 281
 282     // Check permissons for each target
 283     foreach($target as $dn){
 284       $acl = $this->ui->get_permissions($dn, $this->aclCategory."/".$this->aclPlugin);
 285       if(preg_match("/d/",$acl)){
 286         $this->dns[] = $dn;
 287       }else{
 288         $disallowed[] = $dn;
 289       }
 290     }
 291     if(count($disallowed)){
 292       msg_dialog::display(_("Permission"),msgPool::permDelete($disallowed),INFO_DIALOG);
 293     }
 294
 295     // We've at least one entry to delete.
 296     if(count($this->dns)){
 297
 298       // check locks
 299       if ($user= get_multiple_locks($this->dns)){
 300         return(gen_locked_message($user,$this->dns));
 301       }
 302
 303       // Add locks
 304       $dns_names = array();
 305       foreach($this->dns as $dn){
 306         $dns_names[] =LDAP::fix($dn);
 307       }
 308       add_lock ($this->dns, $this->ui->dn);
 309
 310       // Display confirmation dialog.
 311       $smarty = get_smarty();
 312       $smarty->assign("info", msgPool::deleteInfo($dns_names,_($this->objectName)));
 313       $smarty->assign("multiple", true);
 314       return($smarty->fetch(get_template_path('remove.tpl', TRUE)));
 315     }
 316   }
 317
 318
 319   /*! \brief  Object removal was confirmed, now remove the requested entries.
 320    *
 321    *  @param  String  'action'  The name of the action which was the used as trigger.
 322    *  @param  Array   'target'  A list of object dns, which should be affected by this method.
 323    *  @param  Array   'all'     A combination of both 'action' and 'target'.
 324    */
 325   function removeEntryConfirmed($action="",$target=array(),$all=array(),
 326       $altTabClass="",$altTabType="",$altAclCategory="")
 327   {
 328     $tabType = $this->tabType;
 329     $tabClass = $this->tabClass;
 330     $aclCategory = $this->aclCategory;
 331     if(!empty($altTabClass)) $tabClass = $altTabClass;
 332     if(!empty($altTabType)) $tabType = $altTabType;
 333     if(!empty($altAclCategory)) $aclCategory = $altAclCategory;
 334
 335     @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$target,"Entry removel confirmed!");
 336
 337     foreach($this->dns as $key => $dn){
 338
 339       // Check permissions, are we allowed to remove this object?
 340       $acl = $this->ui->get_permissions($dn, $this->aclCategory."/".$this->aclPlugin);
 341       if(preg_match("/d/",$acl)){
 342
 343         // Delete the object
 344         $this->dn = $dn;
 345         $this->tabObject= new $tabClass($this->config,$this->config->data['TABS'][$tabType], $this->dn, $aclCategory, true, true);
 346         $this->tabObject->set_acl_base($this->dn);
 347         $this->tabObject->parent = &$this;
 348         $this->tabObject->delete ();
 349
 350         // Remove the lock for the current object.
 351         del_lock($this->dn);
 352       } else {
 353         msg_dialog::display(_("Permission error"), msgPool::permDelete(), ERROR_DIALOG);
 354         new log("security","groups/".get_class($this),$dn,array(),"Tried to trick deletion.");
 355       }
 356     }
 357
 358     // Cleanup
 359     $this->remove_lock();
 360     $this->closeDialogs();
 361   }
 362
 363
 364   /*! \brief  Detects actions/events send by the ui
 365    *           and the corresponding targets.
 366    */
 367   function detectPostActions()
 368   {
 369     if(!is_object($this->headpage)){
 370       trigger_error("No valid headpage given....!");
 371       return(array());
 372     }
 373     $action= $this->headpage->getAction();
 374     if(isset($_POST['edit_apply']))  $action['action'] = "apply";
 375     if(isset($_POST['edit_finish'])) $action['action'] = "save";
 376     if(isset($_POST['edit_cancel'])) $action['action'] = "cancel";
 377     if(isset($_POST['delete_confirmed'])) $action['action'] = "removeConfirmed";
 378     if(isset($_POST['delete_cancel'])) $action['action'] = "cancelDelete";
 379
 380     // Detect Snapshot actions
 381     if(isset($_POST['CreateSnapshot'])) $action['action'] = "saveSnapshot";
 382     if(isset($_POST['CancelSnapshot'])) $action['action'] = "cancelSnapshot";
 383     foreach($_POST as $name => $value){
 384       $once =TRUE;
 385       if(preg_match("/^RestoreSnapShot_/",$name) && $once){
 386         $once = FALSE;
 387         $entry = base64_decode(preg_replace("/^RestoreSnapShot_([^_]*)_[xy]$/i","\\1",$name));
 388         $action['action'] = "restoreSnapshot";
 389         $action['targets'] = array($entry);
 390       }
 391     }
 392
 393     return($action);
 394   }
 395
 396
 397   /*! \brief  Calls the registered method for a given action/event.
 398    */
 399   function handleActions($action)
 400   {
 401     // Start action
 402     if(isset($this->actions[$action['action']])){
 403       $func = $this->actions[$action['action']];
 404       if(!isset($action['targets']))$action['targets']= array();
 405       return($this->$func($action['action'],$action['targets'],$action));
 406     }
 407   }
 408
 409
 410   /*! \brief  Opens the snapshot creation dialog for the given target.
 411    *
 412    *  @param  String  'action'  The name of the action which was the used as trigger.
 413    *  @param  Array   'target'  A list of object dns, which should be affected by this method.
 414    *  @param  Array   'all'     A combination of both 'action' and 'target'.
 415    */
 416   function createSnapshotDialog($action="",$target=array(),$all=array())
 417   {
 418     @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$target,"Snaptshot creation initiated!");
 419
 420     foreach($target as $entry){
 421       if(!empty($entry) && $this->ui->allow_snapshot_create($entry,$this->aclCategory)){
 422         $this->dialogObject = new SnapShotDialog($this->config,$entry,$this);
 423         $this->dialogObject->aclCategories = array($this->aclCategory);
 424         $this->dialogObject->parent = &$this;
 425
 426       }else{
 427         msg_dialog::display(_("Permission"),sprintf(_("You are not allowed to create a snapshot for %s."),$entry),
 428             ERROR_DIALOG);
 429       }
 430     }
 431   }
 432
 433
 434   /*! \brief  Creates a snapshot new entry - This method is called when the somebody
 435    *           clicks 'save' in the "Create snapshot dialog" (see ::createSnapshotDialog).
 436    *
 437    *  @param  String  'action'  The name of the action which was the used as trigger.
 438    *  @param  Array   'target'  A list of object dns, which should be affected by this method.
 439    *  @param  Array   'all'     A combination of both 'action' and 'target'.
 440    */
 441   function saveSnapshot($action="",$target=array(),$all=array())
 442   {
 443     if(!is_object($this->dialogObject)) return;
 444     $this->dialogObject->save_object();
 445     $msgs = $this->dialogObject->check();
 446     if(count($msgs)){
 447       foreach($msgs as $msg){
 448         msg_dialog::display(_("Error"), $msg, ERROR_DIALOG);
 449       }
 450     }else{
 451       $this->dn =  $this->dialogObject->dn;
 452       $this->snapHandler->create_snapshot( $this->dn,$this->dialogObject->CurrentDescription);
 453       @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$this->dn,"Snaptshot created!");
 454       $this->closeDialogs();
 455     }
 456   }
 457
 458
 459   /*! \brief  Restores a snapshot object.
 460    *          The dn of the snapshot entry has to be given as ['target'] parameter.
 461    *
 462    *  @param  String  'action'  The name of the action which was the used as trigger.
 463    *  @param  Array   'target'  A list of object dns, which should be affected by this method.
 464    *  @param  Array   'all'     A combination of both 'action' and 'target'.
 465    */
 466   function restoreSnapshot($action="",$target=array(),$all=array())
 467   {
 468     $entry = array_pop($target);
 469     if(!empty($entry) && $this->ui->allow_snapshot_restore($entry,$this->aclCategory)){
 470       $this->snapHandler->restore_snapshot($entry);
 471       @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$this->dn,"Snaptshot restored!");
 472       $this->closeDialogs();
 473     }else{
 474       msg_dialog::display(_("Permission"),sprintf(_("You are not allowed to restore a snapshot for %s."),$entry),
 475           ERROR_DIALOG);
 476     }
 477   }
 478
 479
 480   /*! \brief  Displays the "Restore snapshot dialog" for a given target.
 481    *          If no target is specified, open the restore removed object
 482    *           dialog.
 483    *  @param  String  'action'  The name of the action which was the used as trigger.
 484    *  @param  Array   'target'  A list of object dns, which should be affected by this method.
 485    *  @param  Array   'all'     A combination of both 'action' and 'target'.
 486    */
 487   function restoreSnapshotDialog($action="",$target=array(),$all=array())
 488   {
 489     // Set current restore base for snapshot handling.
 490     if(is_object($this->snapHandler)){
 491       $bases = array();
 492       foreach($this->storagePoints as $sp){
 493         $bases[] = $sp.$this->headpage->getBase();
 494       }
 495     }
 496
 497     // No bases specified? Try base
 498     if(!count($bases)) $bases[] = $this->headpage->getBase();
 499
 500     // No target, open the restore removed object dialog.
 501     if(!count($target)){
 502       $entry = $this->headpage->getBase();
 503       if(!empty($entry) && $this->ui->allow_snapshot_restore($entry,$this->aclCategory)){
 504         @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$entry,"Snaptshot restoring initiated!");
 505         $this->dialogObject = new SnapShotDialog($this->config,$entry,$this);
 506         $this->dialogObject->set_snapshot_bases($bases);
 507         $this->dialogObject->display_all_removed_objects = true;
 508         $this->dialogObject->display_restore_dialog = true;
 509         $this->dialogObject->parent = &$this;
 510       }else{
 511         msg_dialog::display(_("Permission"),sprintf(_("You are not allowed to restore a snapshot for %s."),$entry),
 512             ERROR_DIALOG);
 513       }
 514     }else{
 515
 516       // Display the restore points for a given object.
 517       $entry = array_pop($target);
 518       if(!empty($entry) && $this->ui->allow_snapshot_restore($entry,$this->aclCategory)){
 519         @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$entry,"Snaptshot restoring initiated!");
 520         $this->dialogObject = new SnapShotDialog($this->config,$entry,$this);
 521         $this->dialogObject->set_snapshot_bases($bases);
 522         $this->dialogObject->display_restore_dialog = true;
 523         $this->dialogObject->parent = &$this;
 524       }else{
 525         msg_dialog::display(_("Permission"),sprintf(_("You are not allowed to restore a snapshot for %s."),$entry),
 526             ERROR_DIALOG);
 527       }
 528     }
 529   }
 530
 531
 532   /*! \brief  This method intiates the object creation.
 533    *
 534    *  @param  String  'action'  The name of the action which was the used as trigger.
 535    *  @param  Array   'target'  A list of object dns, which should be affected by this method.
 536    *  @param  Array   'all'     A combination of both 'action' and 'target'.
 537    */
 538   function newEntry($action="",$target=array(),$all=array(), $altTabClass ="", $altTabType = "", $altAclCategory="")
 539   {
 540     /* To handle mutliple object types overload this method.
 541      * ...
 542      *   registerAction('newUser', 'newEntry');
 543      *   registerAction('newGroup','newEntry');
 544      * ...
 545      *
 546      * function newEntry($action="",$target=array(),$all=array(), $altTabClass ="", $altTabType = "", $altAclCategory)
 547      * {
 548      *   switch($action){
 549      *     case 'newUser' : {
 550      *       mangement::newEntry($action,$target,$all,"usertabs","USERTABS","users");
 551      *     }
 552      *     case 'newGroup' : {
 553      *       mangement::newEntry($action,$target,$all,"grouptabs","GROUPTABS","groups");
 554      *     }
 555      *   }
 556      * }
 557      **/
 558     $tabType = $this->tabType;
 559     $tabClass = $this->tabClass;
 560     $aclCategory = $this->aclCategory;
 561     if(!empty($altTabClass)) $tabClass = $altTabClass;
 562     if(!empty($altTabType)) $tabType = $altTabType;
 563     if(!empty($altAclCategory)) $aclCategory = $altAclCategory;
 564
 565     // Check locking & lock entry if required
 566     $this->displayApplyBtn = FALSE;
 567     $this->dn = "new";
 568     $this->is_new = TRUE;
 569     $this->is_single_edit = FALSE;
 570     $this->is_multiple_edit = FALSE;
 571
 572     set_object_info($this->dn);
 573
 574     // Open object.
 575     if(empty($tabClass) || empty($tabType)){
 576       // No tab type defined
 577     }else{
 578       if (isset($this->config->data['TABS'][$tabType])) {
 579         $this->tabObject= new $tabClass($this->config,$this->config->data['TABS'][$tabType], $this->dn, $aclCategory);
 580         $this->tabObject->set_acl_base($this->headpage->getBase());
 581         $this->tabObject->parent = &$this;
 582         @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$this->dn,"Create new entry initiated!");
 583       } else {
 584         msg_dialog::display(_("Error"), sprintf(_("No tab declaration for '%s' found in your configuration file. Cannot create plugin instance!"), $tabType), ERROR_DIALOG);
 585       }
 586     }
 587   }
 588
 589
 590   /*! \brief  This method opens an existing object or a list of existing objects to be edited.
 591    *
 592    *
 593    *  @param  String  'action'  The name of the action which was the used as trigger.
 594    *  @param  Array   'target'  A list of object dns, which should be affected by this method.
 595    *  @param  Array   'all'     A combination of both 'action' and 'target'.
 596    */
 597   function editEntry($action="",$target=array(),$all=array(), $altTabClass ="", $altTabType = "", $altAclCategory="")
 598   {
 599     /* To handle mutliple object types overload this method.
 600      * ...
 601      *   registerAction('editUser', 'editEntry');
 602      *   registerAction('editGroup','editEntry');
 603      * ...
 604      *
 605      * function editEntry($action="",$target=array(),$all=array(), $altTabClass ="", $altTabType = "", $altAclCategory)
 606      * {
 607      *   switch($action){
 608      *     case 'editUser' : {
 609      *       mangement::editEntry($action,$target,$all,"usertabs","USERTABS","users");
 610      *     }
 611      *     case 'editGroup' : {
 612      *       mangement::editEntry($action,$target,$all,"grouptabs","GROUPTABS","groups");
 613      *     }
 614      *   }
 615      * }
 616      **/
 617
 618     // Do not create a new tabObject while there is already one opened,
 619     //  the user may have just pressed F5 to reload the page.
 620     if(is_object($this->tabObject)){
 621       return;
 622     }
 623
 624     $tabType = $this->tabType;
 625     $tabClass = $this->tabClass;
 626     $aclCategory = $this->aclCategory;
 627     if(!empty($altTabClass)) $tabClass = $altTabClass;
 628     if(!empty($altTabType)) $tabType = $altTabType;
 629     if(!empty($altAclCategory)) $aclCategory = $altAclCategory;
 630
 631     $this->displayApplyBtn = count($target) == 1;
 632
 633     // Single edit - we only got one object dn.
 634     if(count($target) == 1){
 635       $this->is_new = FALSE;
 636       $this->is_single_edit = TRUE;
 637       $this->is_multiple_edit = FALSE;
 638
 639       // Get the dn of the object and creates lock
 640       $this->dn = array_pop($target);
 641       set_object_info($this->dn);
 642       $user = get_lock($this->dn);
 643       if ($user != ""){
 644         return(gen_locked_message ($user, $this->dn,TRUE));
 645       }
 646       add_lock ($this->dn, $this->ui->dn);
 647
 648       // Open object.
 649       if(empty($tabClass) || empty($tabType)){
 650         trigger_error("We can't edit any object(s). 'tabClass' or 'tabType' is empty!");
 651       }else{
 652         $tab = $tabClass;
 653         $this->tabObject= new $tab($this->config,$this->config->data['TABS'][$tabType], $this->dn,$aclCategory);
 654         @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$this->dn,"Edit entry initiated!");
 655         $this->tabObject->set_acl_base($this->dn);
 656         $this->tabObject->parent = &$this;
 657       }
 658     }else{
 659
 660       // We've multiple entries to edit.
 661       $this->is_new = FALSE;
 662       $this->is_singel_edit = FALSE;
 663       $this->is_multiple_edit = TRUE;
 664
 665       // Open multiple edit handler.
 666       if(empty($tabClass) || empty($tabType)){
 667         trigger_error("We can't edit any object(s). 'tabClass' or 'tabType' is empty!");
 668       }else{
 669         $this->dns = $target;
 670         $tmp = new multi_plug($this->config,$tabClass,$this->config->data['TABS'][$tabType],
 671             $this->dns,$this->headpage->getBase(),$aclCategory);
 672
 673         // Check for locked entries
 674         if ($tmp->entries_locked()){
 675           return($tmp->display_lock_message());
 676         }
 677
 678         @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$this->dns,"Edit entry initiated!");
 679
 680         // Now lock entries.
 681         if($tmp->multiple_available()){
 682           $tmp->lock_entries($this->ui->dn);
 683           $this->tabObject = $tmp;
 684           set_object_info($this->tabObject->get_object_info());
 685         }
 686       }
 687     }
 688   }
 689
 690
 691   /*! \brief  Save object modifications and closes dialogs (returns to object listing).
 692    *          - Calls '::check' to validate the given input.
 693    *          - Calls '::save' to save back object modifications (e.g. to ldap).
 694    *          - Calls '::remove_locks' to remove eventually created locks.
 695    *          - Calls '::closeDialogs' to return to the object listing.
 696    */
 697   protected function saveChanges()
 698   {
 699     if($this->tabObject instanceOf tabs || $this->tabObject instanceOf multi_plug){
 700       $this->tabObject->save_object();
 701       $msgs = $this->tabObject->check();
 702       if(count($msgs)){
 703         msg_dialog::displayChecks($msgs);
 704         return("");
 705       }else{
 706         $this->tabObject->save();
 707         @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$this->dns,"Entry saved!");
 708         $this->remove_lock();
 709         $this->closeDialogs();
 710       }
 711     }elseif($this->dialogObject instanceOf plugin){
 712       $this->dialogObject->save_object();
 713       $msgs = $this->dialogObject->check();
 714       if(count($msgs)){
 715         msg_dialog::displayChecks($msgs);
 716         return("");
 717       }else{
 718         $this->dialogObject->save();
 719         @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$this->dns,"Entry saved!");
 720         $this->remove_lock();
 721         $this->closeDialogs();
 722       }
 723     }
 724   }
 725
 726
 727   /*! \brief  Save object modifications and keep dialogs opened.
 728    *          - Calls '::check' to validate the given input.
 729    *          - Calls '::save' to save back object modifications (e.g. to ldap).
 730    */
 731   protected function applyChanges()
 732   {
 733     if($this->tabObject instanceOf tabs || $this->tabObject instanceOf multi_plug){
 734       $this->tabObject->save_object();
 735       $msgs = $this->tabObject->check();
 736       if(count($msgs)){
 737         msg_dialog::displayChecks($msgs);
 738         return("");
 739       }else{
 740         $this->tabObject->save();
 741         @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$this->dns,"Modifications applied!");
 742         $this->tabObject->re_init();
 743       }
 744     }
 745   }
 746
 747
 748   /*! \brief  This method closes dialogs
 749    *           and cleans up the cached object info and the ui.
 750    */
 751   protected function closeDialogs()
 752   {
 753     $this->last_dn = $this->dn;
 754     $this->last_dns = $this->dns;
 755     $this->last_tabObject = $this->tabObject;
 756     $this->last_dialogObject = $this->dialogObject;
 757     $this->dn = "";
 758     $this->dns = array();
 759     $this->tabObject = null;
 760     $this->dialogObject = null;
 761     $this->skipFooter = FALSE;
 762     set_object_info();
 763   }
 764
 765
 766   /*! \brief  Editing an object was caneled.
 767    *          Close dialogs/tabs and remove locks.
 768    */
 769   protected function cancelEdit()
 770   {
 771     $this->remove_lock();
 772     $this->closeDialogs();
 773   }
 774
 775
 776   /*! \brief  Every click in the list user interface sends an event
 777    *           here can we connect those events to a method.
 778    *          eg.  ::registerEvent('new','createUser')
 779    *          When the action/event new is send, the method 'createUser'
 780    *           will be called.
 781    */
 782   function registerAction($action,$target)
 783   {
 784     $this->actions[$action] = $target;
 785   }
 786
 787
 788   /*! \brief  Removes ldap object locks created by this class.
 789    *          Whenever an object is edited, we create locks to avoid
 790    *           concurrent modifications.
 791    *          This locks will automatically removed here.
 792    */
 793   function remove_lock()
 794   {
 795     if(!empty($this->dn) && $this->dn != "new"){
 796       del_lock($this->dn);
 797     }
 798     if(count($this->dns)){
 799       del_lock($this->dns);
 800     }
 801   }
 802
 803
 804   /*! \brief  This method is used to queue and process copy&paste actions.
 805    *          Allows to copy, cut and paste mutliple entries at once.
 806    *  @param  String  'action'  The name of the action which was the used as trigger.
 807    *  @param  Array   'target'  A list of object dns, which should be affected by this method.
 808    *  @param  Array   'all'     A combination of both 'action' and 'target'.
 809    */
 810   function copyPasteHandler($action="",$target=array(),$all=array(),
 811       $altTabClass ="", $altTabType = "", $altAclCategory="",$altAclPlugin="")
 812   {
 813     // Return without any actions while copy&paste handler is disabled.
 814     if(!is_object($this->cpHandler))  return("");
 815
 816     $tabType = $this->tabType;
 817     $tabClass = $this->tabClass;
 818     $aclCategory = $this->aclCategory;
 819     $aclPlugin = $this->aclPlugin;
 820     if(!empty($altTabClass)) $tabClass = $altTabClass;
 821     if(!empty($altTabType)) $tabType = $altTabType;
 822     if(!empty($altAclCategory)) $aclCategory = $altAclCategory;
 823     if(!empty($altAclPlugin)) $aclPlugin = $altAclPlugin;
 824
 825     // Save user input
 826     $this->cpHandler->save_object();
 827
 828     // Add entries to queue
 829     if($action == "copy" || $action == "cut"){
 830       $this->cpHandler->cleanup_queue();
 831       foreach($target as $dn){
 832         if($action == "copy" && $this->ui->is_copyable($dn,$aclCategory,$aclPlugin)){
 833           $this->cpHandler->add_to_queue($dn,"copy",$tabClass,$tabType,$aclCategory,$this);
 834           @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$dn,"Entry copied!");
 835         }
 836         if($action == "cut" && $this->ui->is_cutable($dn,$aclCategory,$aclPlugin)){
 837           $this->cpHandler->add_to_queue($dn,"cut",$tabClass,$tabType,$aclCategory,$this);
 838           @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$dn,"Entry cutted!");
 839         }
 840       }
 841     }
 842
 843     // Initiate pasting
 844     if($action == "paste"){
 845       $this->cpPastingStarted = TRUE;
 846     }
 847
 848     // Display any c&p dialogs, eg. object modifications required before pasting.
 849     if($this->cpPastingStarted && $this->cpHandler->entries_queued()){
 850       $this->cpHandler->SetVar("base",$this->headpage->getBase());
 851       $data = $this->cpHandler->execute();
 852       if(!empty($data)){
 853         return($data);
 854       }
 855     }
 856
 857     // Automatically disable pasting process since there is no entry left to paste.
 858     if(!$this->cpHandler->entries_queued()){
 859       $this->cpPastingStarted = FALSE;
 860     }
 861     return("");
 862   }
 863
 864
 865   function setFilter($str) {
 866     $this->filter = $str;
 867   }
 868
 869   function postcreate() {
 870       $this->handle_post_events('add');
 871   }
 872   function postmodify(){
 873       $this->handle_post_events('modify');
 874   }
 875   function postremove(){
 876       $this->handle_post_events('remove');
 877   }
 878
 879   function is_modal_dialog()
 880   {
 881       return(is_object($this->tabObject) || is_object($this->dialogObject));
 882   }
 883
 884   /*! \brief    Forward command execution request
 885    *             to the correct method.
 886    */
 887   function handle_post_events($mode, $addAttrs= array())
 888   {
 889       if(!in_array($mode, array('add','remove','modify'))){
 890           trigger_error(sprintf("Invalid post event type given %s! Valid types are [add,modify,remove].", $mode));
 891           return;
 892       }
 893       switch ($mode){
 894           case "add":
 895               plugin::callHook($this,"POSTCREATE", $addAttrs);
 896           break;
 897
 898           case "modify":
 899               plugin::callHook($this,"POSTMODIFY", $addAttrs);
 900           break;
 901
 902           case "remove":
 903               plugin::callHook($this,"POSTREMOVE", $addAttrs);
 904           break;
 905       }
 906   }
 907 }
 908
 909 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 910 ?>