X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=gosa-core%2Finclude%2Fclass_management.inc;h=89f56c163272f825930a41461e8eee52dc472ca4;hb=6ac95cb185bd87219075cd798784ba7b8d792eac;hp=3c920ecdd549ab5843270196aaeceefbb4dfec26;hpb=1713b09e53a09e244de642b51b5a668f9f5eb878;p=gosa.git diff --git a/gosa-core/include/class_management.inc b/gosa-core/include/class_management.inc index 3c920ecdd..89f56c163 100644 --- a/gosa-core/include/class_management.inc +++ b/gosa-core/include/class_management.inc @@ -3,7 +3,7 @@ * This code is part of GOsa (http://www.gosa-project.org) * Copyright (C) 2003-2008 GONICUS GmbH * - * ID: $$Id: class_plugin.inc 14584 2009-10-12 14:04:22Z hickert $$ + * ID: $$Id$$ * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -26,33 +26,67 @@ class management public $config = null; public $ui = null; - public $plIcon = ""; - public $plDescription = ""; - public $plHeadline = ""; + // The plugin description + public $plugname = "unconfigured"; + public $plIcon = "unconfigured"; + public $plDescription = "unconfigured"; + public $plHeadline = "unconfigured"; - // Protected - protected $dn = ""; + // The currently used object(s) (e.g. in edit, removal) + public $dn = ""; // this is public due to some compatibility problems with class plugin.. protected $dns = array(); - protected $tabClass = ""; - protected $tabType = ""; - protected $aclCategory = ""; - protected $objectName = ""; + // The last used object(s). + protected $last_dn = ""; + protected $last_dns = array(); + + // The common places the displayed objects are stored in. (e.g. array("ou=groups,","..")) + protected $storagePoints = array(); + + // The tab definitions to use for the current object. + protected $tabClass = ""; // e.g. usertabs + protected $tabType = ""; // e.g. USERTABS + protected $aclPlugin = ""; // e.g. generic + protected $aclCategory = ""; // e.g. users + protected $objectName = ""; // e.g. users + + // The opened object. protected $tabObject = null; + protected $dialogObject = null; + + // The last opened object. + protected $last_tabObject = null; + protected $last_dialogObject = null; + + // Whether to display the apply button or not + protected $displayApplyBtn = FALSE; + + // Whether to display a header or not. + protected $skipHeader = false; - protected $displayApplyBtn = ""; + // Whether to display a footer or not. + protected $skipFooter = false; + + // Copy&Paste handler protected $cpHandler = null; + + // Indicates that we want to paste objects right now. protected $cpPastingStarted = FALSE; - + + // The Snapshot handler class. protected $snapHandler = null; - // Private - private $plugname = ""; + // The listing handlers private $headpage = null; private $filter = null; - private $actions = array(); - - function __construct($config,$ui,$plugname, $headpage) + + // A list of configured actions/events + protected $actions = array(); + + // Attributes managed by this plugin, can be used in post events; + public $attributes = array(); + + function __construct(&$config,$ui,$plugname, $headpage) { $this->plugname = $plugname; $this->headpage = $headpage; @@ -65,63 +99,151 @@ class management if(empty($this->plIcon)){ $this->plIcon = "plugins/".$plugname."/images/plugin.png"; } + + // Register default actions + $this->registerAction("new", "newEntry"); + $this->registerAction("edit", "editEntry"); + $this->registerAction("apply", "applyChanges"); + $this->registerAction("save", "saveChanges"); + $this->registerAction("cancel", "cancelEdit"); + $this->registerAction("cancelDelete", "cancelEdit"); + $this->registerAction("remove", "removeEntryRequested"); + $this->registerAction("removeConfirmed", "removeEntryConfirmed"); + + $this->registerAction("copy", "copyPasteHandler"); + $this->registerAction("cut", "copyPasteHandler"); + $this->registerAction("paste", "copyPasteHandler"); + + $this->registerAction("snapshot", "createSnapshotDialog"); + $this->registerAction("restore", "restoreSnapshotDialog"); + $this->registerAction("saveSnapshot","saveSnapshot"); + $this->registerAction("restoreSnapshot","restoreSnapshot"); + $this->registerAction("cancelSnapshot","closeDialogs"); + + $this->registerAction("config-filter","editFilter"); + $this->registerAction("saveFilter","saveFilter"); + + // To temporay disable the filter caching UNcomment this line. + #session::global_un_set(get_class($this)."_filter"); } + /*! \brief Execute this plugin + * Handle actions/events, locking, snapshots, dialogs, tabs,... + */ function execute() { // Ensure that html posts and gets are kept even if we see a 'Entry islocked' dialog. $vars = array('/^act$/','/^listing/','/^PID$/','/^FILTER_PID$/'); session::set('LOCK_VARS_TO_USE',$vars); + pathNavigator::registerPlugin($this); + /* Display the copy & paste dialog, if it is currently open */ $ret = $this->copyPasteHandler("",array()); if($ret){ return($this->getHeader().$ret); } + // Update filter + if ($this->filter) { + $this->filter->update(); + session::global_set(get_class($this)."_filter", $this->filter); + session::set('autocomplete', $this->filter); + } + // Handle actions (POSTs and GETs) - $str = $this->detectPostActions(); + $str = $this->handleActions($this->detectPostActions()); if($str) return($this->getHeader().$str); + // Open single dialog objects + if(is_object($this->dialogObject)){ + if(method_exists($this->dialogObject,'save_object')) $this->dialogObject->save_object(); + if(method_exists($this->dialogObject,'execute')){ + $display = $this->dialogObject->execute(); + $display.= $this->_getTabFooter(); + return($this->getHeader().$display); + } + } + // Display tab object. if($this->tabObject instanceOf tabs || $this->tabObject instanceOf multi_plug){ - $this->tabObject->save_object(); +# $this->tabObject->save_object(); $display = $this->tabObject->execute(); $display.= $this->_getTabFooter(); return($this->getHeader().$display); } + // Set current restore base for snapshot handling. + if(is_object($this->snapHandler)){ + $bases = array(); + foreach($this->storagePoints as $sp){ + $bases[] = $sp.$this->headpage->getBase(); + } + + // No bases specified? Try base + if(!count($bases)) $bases[] = $this->headpage->getBase(); + + $this->snapHandler->setSnapshotBases($bases); + } + + // Display list + return($this->renderList()); + } + + function editFilter() + { + $this->dialogObject = new userFilter($this->config,$this->getHeadpage()); + } + + function renderList() + { $this->headpage->update(); $display = $this->headpage->render(); return($this->getHeader().$display); } + function getHeadpage() + { + return($this->headpage); + } + + function getFilter() + { + return($this->filter); + } + + /*! \brief Generates the plugin header which is displayed whenever a tab object is + * opened. + */ protected function getHeader() { - if (get_object_info() != ""){ - $display= print_header(get_template_path($this->plIcon),_($this->plDescription), - "\"\"". - LDAP::fix(get_object_info())); - } else { - $display= print_header(get_template_path($this->plIcon),_($this->plDescription)); - } - return($display); + // We do not display any headers right now. + if(1 || $this->skipHeader) return(""); } + /*! \brief Generates the footer which is used whenever a tab object is + * displayed. + */ protected function _getTabFooter() - { + { + // Do not display tab footer for non tab objects if(!($this->tabObject instanceOf tabs || $this->tabObject instanceOf multi_plug)){ return(""); } - + + // Check if there is a dialog opened - We don't need any buttons in this case. if($this->tabObject->by_object[$this->tabObject->current]){ $current = $this->tabObject->by_object[$this->tabObject->current]; - if(is_object($current->dialog)){ + if(isset($current->dialog) && (is_object($current->dialog) || $current->dialog)){ return(""); } } + // Skip footer if requested; + if($this->skipFooter) return(""); + + // In case an of locked entry, we may have opened a read-only tab. $str = ""; if(isset($this->tabObject->read_only) && $this->tabObject->read_only == TRUE){ $str.= "

@@ -129,25 +251,38 @@ class management

"; return($str); }else{ + + // Display ok, (apply) and cancel buttons $str.= "

\n"; - $str.= "\n"; + $str.= "\n"; $str.= " \n"; if($this->displayApplyBtn){ - $str.= "\n"; + $str.= "\n"; $str.= " \n"; } - $str.= "\n"; + $str.= "\n"; $str.= "

"; } return($str); } - protected function removeEntryRequested($action,$entry,$all) + /*! \brief Initiates the removal for the given entries + * and displays a confirmation dialog. + * + * @param String 'action' The name of the action which was the used as trigger. + * @param Array 'target' A list of object dns, which should be affected by this method. + * @param Array 'all' A combination of both 'action' and 'target'. + */ + protected function removeEntryRequested($action="",$target=array(),$all=array()) { $disallowed = array(); $this->dns = array(); - foreach($entry as $dn){ + + @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$target,"Entry removel requested!"); + + // Check permissons for each target + foreach($target as $dn){ $acl = $this->ui->get_permissions($dn, $this->aclCategory."/".$this->aclPlugin); if(preg_match("/d/",$acl)){ $this->dns[] = $dn; @@ -155,25 +290,26 @@ class management $disallowed[] = $dn; } } - if(count($disallowed)){ msg_dialog::display(_("Permission"),msgPool::permDelete($disallowed),INFO_DIALOG); } + // We've at least one entry to delete. if(count($this->dns)){ - /* Check locks */ + // check locks if ($user= get_multiple_locks($this->dns)){ return(gen_locked_message($user,$this->dns)); } + // Add locks $dns_names = array(); foreach($this->dns as $dn){ $dns_names[] =LDAP::fix($dn); } add_lock ($this->dns, $this->ui->dn); - /* Lock the current entry, so nobody will edit it during deletion */ + // Display confirmation dialog. $smarty = get_smarty(); $smarty->assign("info", msgPool::deleteInfo($dns_names,_($this->objectName))); $smarty->assign("multiple", true); @@ -182,47 +318,90 @@ class management } - protected function removeEntryConfirmed() + /*! \brief Object removal was confirmed, now remove the requested entries. + * + * @param String 'action' The name of the action which was the used as trigger. + * @param Array 'target' A list of object dns, which should be affected by this method. + * @param Array 'all' A combination of both 'action' and 'target'. + */ + function removeEntryConfirmed($action="",$target=array(),$all=array(), + $altTabClass="",$altTabType="",$altAclCategory="") { + $tabType = $this->tabType; + $tabClass = $this->tabClass; + $aclCategory = $this->aclCategory; + if(!empty($altTabClass)) $tabClass = $altTabClass; + if(!empty($altTabType)) $tabType = $altTabType; + if(!empty($altAclCategory)) $aclCategory = $altAclCategory; + + @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$target,"Entry removel confirmed!"); + foreach($this->dns as $key => $dn){ - /* Load permissions for selected 'dn' and check if - we're allowed to remove this 'dn' */ + // Check permissions, are we allowed to remove this object? $acl = $this->ui->get_permissions($dn, $this->aclCategory."/".$this->aclPlugin); if(preg_match("/d/",$acl)){ - /* Delete request is permitted, perform LDAP action */ + // Delete the object $this->dn = $dn; - $tab = $this->tabClass; - $this->tabObject= new $tab($this->config,$this->config->data['TABS'][$this->tabType], $this->dn, $this->aclCategory); + $this->tabObject= new $tabClass($this->config,$this->config->data['TABS'][$tabType], $this->dn, $aclCategory, true, true); $this->tabObject->set_acl_base($this->dn); + $this->tabObject->parent = &$this; $this->tabObject->delete (); - $this->closeDialogs(); + + // Remove the lock for the current object. del_lock($this->dn); } else { - - /* Normally this shouldn't be reached, send some extra - logs to notify the administrator */ msg_dialog::display(_("Permission error"), msgPool::permDelete(), ERROR_DIALOG); new log("security","groups/".get_class($this),$dn,array(),"Tried to trick deletion."); - return; } } - $this->closeDialogs(); + // Cleanup $this->remove_lock(); + $this->closeDialogs(); } + /*! \brief Detects actions/events send by the ui + * and the corresponding targets. + */ function detectPostActions() { + if(!is_object($this->headpage)){ + trigger_error("No valid headpage given....!"); + return(array()); + } $action= $this->headpage->getAction(); - if(isset($_POST['edit_apply'])) $action['action'] = "apply"; if(isset($_POST['edit_finish'])) $action['action'] = "save"; if(isset($_POST['edit_cancel'])) $action['action'] = "cancel"; - if(isset($_POST['delete_confirmed'])) $action['action'] = "removeConfirmed"; + if(isset($_POST['delete_confirmed'])) $action['action'] = "removeConfirmed"; + if(isset($_POST['delete_cancel'])) $action['action'] = "cancelDelete"; + if(isset($_POST['saveFilter'])) $action['action'] = "saveFilter"; + if(isset($_POST['cancelFilter'])) $action['action'] = "cancel"; + + // Detect Snapshot actions + if(isset($_POST['CreateSnapshot'])) $action['action'] = "saveSnapshot"; + if(isset($_POST['CancelSnapshot'])) $action['action'] = "cancelSnapshot"; + foreach($_POST as $name => $value){ + $once =TRUE; + if(preg_match("/^RestoreSnapShot_/",$name) && $once){ + $once = FALSE; + $entry = base64_decode(preg_replace("/^RestoreSnapShot_([^_]*)_[xy]$/i","\\1",$name)); + $action['action'] = "restoreSnapshot"; + $action['targets'] = array($entry); + } + } + + return($action); + } + + /*! \brief Calls the registered method for a given action/event. + */ + function handleActions($action) + { // Start action if(isset($this->actions[$action['action']])){ $func = $this->actions[$action['action']]; @@ -231,8 +410,162 @@ class management } } - function newEntry($action="",$target=array(),$all=array()) + + /*! \brief Opens the snapshot creation dialog for the given target. + * + * @param String 'action' The name of the action which was the used as trigger. + * @param Array 'target' A list of object dns, which should be affected by this method. + * @param Array 'all' A combination of both 'action' and 'target'. + */ + function createSnapshotDialog($action="",$target=array(),$all=array()) { + @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$target,"Snaptshot creation initiated!"); + + foreach($target as $entry){ + if(!empty($entry) && $this->ui->allow_snapshot_create($entry,$this->aclCategory)){ + $this->dialogObject = new SnapShotDialog($this->config,$entry,$this); + $this->dialogObject->aclCategories = array($this->aclCategory); + $this->dialogObject->parent = &$this; + + }else{ + msg_dialog::display(_("Permission"),sprintf(_("You are not allowed to create a snapshot for %s."),$entry), + ERROR_DIALOG); + } + } + } + + + /*! \brief Creates a snapshot new entry - This method is called when the somebody + * clicks 'save' in the "Create snapshot dialog" (see ::createSnapshotDialog). + * + * @param String 'action' The name of the action which was the used as trigger. + * @param Array 'target' A list of object dns, which should be affected by this method. + * @param Array 'all' A combination of both 'action' and 'target'. + */ + function saveSnapshot($action="",$target=array(),$all=array()) + { + if(!is_object($this->dialogObject)) return; + $this->dialogObject->save_object(); + $msgs = $this->dialogObject->check(); + if(count($msgs)){ + foreach($msgs as $msg){ + msg_dialog::display(_("Error"), $msg, ERROR_DIALOG); + } + }else{ + $this->dn = $this->dialogObject->dn; + $this->snapHandler->create_snapshot( $this->dn,$this->dialogObject->CurrentDescription); + @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$this->dn,"Snaptshot created!"); + $this->closeDialogs(); + } + } + + + /*! \brief Restores a snapshot object. + * The dn of the snapshot entry has to be given as ['target'] parameter. + * + * @param String 'action' The name of the action which was the used as trigger. + * @param Array 'target' A list of object dns, which should be affected by this method. + * @param Array 'all' A combination of both 'action' and 'target'. + */ + function restoreSnapshot($action="",$target=array(),$all=array()) + { + $entry = array_pop($target); + if(!empty($entry) && $this->ui->allow_snapshot_restore($entry,$this->aclCategory)){ + $this->snapHandler->restore_snapshot($entry); + @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$this->dn,"Snaptshot restored!"); + $this->closeDialogs(); + }else{ + msg_dialog::display(_("Permission"),sprintf(_("You are not allowed to restore a snapshot for %s."),$entry), + ERROR_DIALOG); + } + } + + + /*! \brief Displays the "Restore snapshot dialog" for a given target. + * If no target is specified, open the restore removed object + * dialog. + * @param String 'action' The name of the action which was the used as trigger. + * @param Array 'target' A list of object dns, which should be affected by this method. + * @param Array 'all' A combination of both 'action' and 'target'. + */ + function restoreSnapshotDialog($action="",$target=array(),$all=array()) + { + // Set current restore base for snapshot handling. + if(is_object($this->snapHandler)){ + $bases = array(); + foreach($this->storagePoints as $sp){ + $bases[] = $sp.$this->headpage->getBase(); + } + } + + // No bases specified? Try base + if(!count($bases)) $bases[] = $this->headpage->getBase(); + + // No target, open the restore removed object dialog. + if(!count($target)){ + $entry = $this->headpage->getBase(); + if(!empty($entry) && $this->ui->allow_snapshot_restore($entry,$this->aclCategory)){ + @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$entry,"Snaptshot restoring initiated!"); + $this->dialogObject = new SnapShotDialog($this->config,$entry,$this); + $this->dialogObject->set_snapshot_bases($bases); + $this->dialogObject->display_all_removed_objects = true; + $this->dialogObject->display_restore_dialog = true; + $this->dialogObject->parent = &$this; + }else{ + msg_dialog::display(_("Permission"),sprintf(_("You are not allowed to restore a snapshot for %s."),$entry), + ERROR_DIALOG); + } + }else{ + + // Display the restore points for a given object. + $entry = array_pop($target); + if(!empty($entry) && $this->ui->allow_snapshot_restore($entry,$this->aclCategory)){ + @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$entry,"Snaptshot restoring initiated!"); + $this->dialogObject = new SnapShotDialog($this->config,$entry,$this); + $this->dialogObject->set_snapshot_bases($bases); + $this->dialogObject->display_restore_dialog = true; + $this->dialogObject->parent = &$this; + }else{ + msg_dialog::display(_("Permission"),sprintf(_("You are not allowed to restore a snapshot for %s."),$entry), + ERROR_DIALOG); + } + } + } + + + /*! \brief This method intiates the object creation. + * + * @param String 'action' The name of the action which was the used as trigger. + * @param Array 'target' A list of object dns, which should be affected by this method. + * @param Array 'all' A combination of both 'action' and 'target'. + */ + function newEntry($action="",$target=array(),$all=array(), $altTabClass ="", $altTabType = "", $altAclCategory="") + { + /* To handle mutliple object types overload this method. + * ... + * registerAction('newUser', 'newEntry'); + * registerAction('newGroup','newEntry'); + * ... + * + * function newEntry($action="",$target=array(),$all=array(), $altTabClass ="", $altTabType = "", $altAclCategory) + * { + * switch($action){ + * case 'newUser' : { + * mangement::newEntry($action,$target,$all,"usertabs","USERTABS","users"); + * } + * case 'newGroup' : { + * mangement::newEntry($action,$target,$all,"grouptabs","GROUPTABS","groups"); + * } + * } + * } + **/ + $tabType = $this->tabType; + $tabClass = $this->tabClass; + $aclCategory = $this->aclCategory; + if(!empty($altTabClass)) $tabClass = $altTabClass; + if(!empty($altTabType)) $tabType = $altTabType; + if(!empty($altAclCategory)) $aclCategory = $altAclCategory; + // Check locking & lock entry if required $this->displayApplyBtn = FALSE; $this->dn = "new"; @@ -243,28 +576,70 @@ class management set_object_info($this->dn); // Open object. - if(empty($this->tabClass) || empty($this->tabType)){ + if(empty($tabClass) || empty($tabType)){ // No tab type defined }else{ - $tab = $this->tabClass; - $this->tabObject= new $tab($this->config,$this->config->data['TABS'][$this->tabType], $this->dn, $this->aclCategory); - $this->tabObject->set_acl_base($this->headpage->getBase()); + if (isset($this->config->data['TABS'][$tabType])) { + $this->tabObject= new $tabClass($this->config,$this->config->data['TABS'][$tabType], $this->dn, $aclCategory); + $this->tabObject->set_acl_base($this->headpage->getBase()); + $this->tabObject->parent = &$this; + @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$this->dn,"Create new entry initiated!"); + } else { + msg_dialog::display(_("Error"), sprintf(_("No tab declaration for '%s' found in your configuration file. Cannot create plugin instance!"), $tabType), ERROR_DIALOG); + } } } - function editEntry($action,$target,$all) - { - if(count($target) == 0){ - //nothing - }elseif(count($target) == 1){ - // Check locking & lock entry if required + /*! \brief This method opens an existing object or a list of existing objects to be edited. + * + * + * @param String 'action' The name of the action which was the used as trigger. + * @param Array 'target' A list of object dns, which should be affected by this method. + * @param Array 'all' A combination of both 'action' and 'target'. + */ + function editEntry($action="",$target=array(),$all=array(), $altTabClass ="", $altTabType = "", $altAclCategory="") + { + /* To handle mutliple object types overload this method. + * ... + * registerAction('editUser', 'editEntry'); + * registerAction('editGroup','editEntry'); + * ... + * + * function editEntry($action="",$target=array(),$all=array(), $altTabClass ="", $altTabType = "", $altAclCategory) + * { + * switch($action){ + * case 'editUser' : { + * mangement::editEntry($action,$target,$all,"usertabs","USERTABS","users"); + * } + * case 'editGroup' : { + * mangement::editEntry($action,$target,$all,"grouptabs","GROUPTABS","groups"); + * } + * } + * } + **/ + + // Do not create a new tabObject while there is already one opened, + // the user may have just pressed F5 to reload the page. + if(is_object($this->tabObject)){ + return; + } + + $tabType = $this->tabType; + $tabClass = $this->tabClass; + $aclCategory = $this->aclCategory; + if(!empty($altTabClass)) $tabClass = $altTabClass; + if(!empty($altTabType)) $tabType = $altTabType; + if(!empty($altAclCategory)) $aclCategory = $altAclCategory; + + // Single edit - we only got one object dn. + if(count($target) == 1){ $this->displayApplyBtn = TRUE; - $this->is_new = FALSE; $this->is_single_edit = TRUE; $this->is_multiple_edit = FALSE; + // Get the dn of the object and creates lock $this->dn = array_pop($target); set_object_info($this->dn); $user = get_lock($this->dn); @@ -274,34 +649,76 @@ class management add_lock ($this->dn, $this->ui->dn); // Open object. - if(empty($this->tabClass) || empty($this->tabType)){ - // No tab type defined + if(empty($tabClass) || empty($tabType)){ + trigger_error("We can't edit any object(s). 'tabClass' or 'tabType' is empty!"); }else{ - $tab = $this->tabClass; - $this->tabObject= new $tab($this->config,$this->config->data['TABS'][$this->tabType], $this->dn,$this->aclCategory); + $tab = $tabClass; + $this->tabObject= new $tab($this->config,$this->config->data['TABS'][$tabType], $this->dn,$aclCategory); + @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$this->dn,"Edit entry initiated!"); $this->tabObject->set_acl_base($this->dn); + $this->tabObject->parent = &$this; } }else{ + // We've multiple entries to edit. $this->is_new = FALSE; $this->is_singel_edit = FALSE; $this->is_multiple_edit = TRUE; - $this->dns = $target; - $tmp = new multi_plug($this->config,$this->tabClass,$this->config->data['TABS'][$this->tabType], - $this->dns,$this->headpage->getBase(),$this->aclCategory); - if ($tmp->entries_locked()){ - return($tmp->display_lock_message()); - } - $tmp->lock_entries($this->ui->dn); - if($tmp->multiple_available()){ - $this->tabObject = $tmp; - set_object_info($this->tabObject->get_object_info()); + // Open multiple edit handler. + if(empty($tabClass) || empty($tabType)){ + trigger_error("We can't edit any object(s). 'tabClass' or 'tabType' is empty!"); + }else{ + $this->dns = $target; + $tmp = new multi_plug($this->config,$tabClass,$this->config->data['TABS'][$tabType], + $this->dns,$this->headpage->getBase(),$aclCategory); + + // Check for locked entries + if ($tmp->entries_locked()){ + return($tmp->display_lock_message()); + } + + @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$this->dns,"Edit entry initiated!"); + + // Now lock entries. + if($tmp->multiple_available()){ + $tmp->lock_entries($this->ui->dn); + $this->tabObject = $tmp; + set_object_info($this->tabObject->get_object_info()); + } } + } + } + + /*! \brief Save filter modifcations. + */ + protected function saveFilter() + { + if($this->dialogObject instanceOf userFilter){ + $msgs = $this->dialogObject->check(); + if(count($msgs)){ + msg_dialog::displayChecks($msgs); + return(""); + }else{ + $this->dialogObject->save(); + @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$this->dns,"Entry saved!"); + $this->remove_lock(); + $this->closeDialogs(); + + // Ask filter to reload information + $this->filter->reloadFilters(); + } } } + + /*! \brief Save object modifications and closes dialogs (returns to object listing). + * - Calls '::check' to validate the given input. + * - Calls '::save' to save back object modifications (e.g. to ldap). + * - Calls '::remove_locks' to remove eventually created locks. + * - Calls '::closeDialogs' to return to the object listing. + */ protected function saveChanges() { if($this->tabObject instanceOf tabs || $this->tabObject instanceOf multi_plug){ @@ -312,49 +729,92 @@ class management return(""); }else{ $this->tabObject->save(); + @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$this->dns,"Entry saved!"); + $this->remove_lock(); $this->closeDialogs(); + } + }elseif($this->dialogObject instanceOf plugin){ + $this->dialogObject->save_object(); + $msgs = $this->dialogObject->check(); + if(count($msgs)){ + msg_dialog::displayChecks($msgs); + return(""); + }else{ + $this->dialogObject->save(); + @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$this->dns,"Entry saved!"); $this->remove_lock(); + $this->closeDialogs(); } } } + + /*! \brief Save object modifications and keep dialogs opened. + * - Calls '::check' to validate the given input. + * - Calls '::save' to save back object modifications (e.g. to ldap). + */ protected function applyChanges() { - if($this->tabObject instanceOf tabs || $this->tabObject instanceOf multi_plug){ - $this->tabObject->save_object(); + if($this->tabObject instanceOf tabs || $this->tabObject instanceOf multi_plug){ + $this->tabObject->save_object(); $msgs = $this->tabObject->check(); if(count($msgs)){ msg_dialog::displayChecks($msgs); return(""); }else{ $this->tabObject->save(); + @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$this->dns,"Modifications applied!"); $this->tabObject->re_init(); } } } - + + + /*! \brief This method closes dialogs + * and cleans up the cached object info and the ui. + */ protected function closeDialogs() { + $this->last_dn = $this->dn; + $this->last_dns = $this->dns; + $this->last_tabObject = $this->tabObject; + $this->last_dialogObject = $this->dialogObject; $this->dn = ""; $this->dns = array(); $this->tabObject = null; + $this->dialogObject = null; + $this->skipFooter = FALSE; set_object_info(); } + + /*! \brief Editing an object was caneled. + * Close dialogs/tabs and remove locks. + */ protected function cancelEdit() { - $this->closeDialogs(); $this->remove_lock(); + $this->closeDialogs(); } - - + /*! \brief Every click in the list user interface sends an event + * here can we connect those events to a method. + * eg. ::registerEvent('new','createUser') + * When the action/event new is send, the method 'createUser' + * will be called. + */ function registerAction($action,$target) { $this->actions[$action] = $target; } + + /*! \brief Removes ldap object locks created by this class. + * Whenever an object is edited, we create locks to avoid + * concurrent modifications. + * This locks will automatically removed here. + */ function remove_lock() { if(!empty($this->dn) && $this->dn != "new"){ @@ -365,52 +825,61 @@ class management } } - function copyPasteHandler($s_action,$s_entry) - { - - /* Check if Copy & Paste is disabled */ - if(!is_object($this->cpHandler)){ - return(""); - } + /*! \brief This method is used to queue and process copy&paste actions. + * Allows to copy, cut and paste mutliple entries at once. + * @param String 'action' The name of the action which was the used as trigger. + * @param Array 'target' A list of object dns, which should be affected by this method. + * @param Array 'all' A combination of both 'action' and 'target'. + */ + function copyPasteHandler($action="",$target=array(),$all=array(), + $altTabClass ="", $altTabType = "", $altAclCategory="",$altAclPlugin="") + { + // Return without any actions while copy&paste handler is disabled. + if(!is_object($this->cpHandler)) return(""); + + $tabType = $this->tabType; + $tabClass = $this->tabClass; + $aclCategory = $this->aclCategory; + $aclPlugin = $this->aclPlugin; + if(!empty($altTabClass)) $tabClass = $altTabClass; + if(!empty($altTabType)) $tabType = $altTabType; + if(!empty($altAclCategory)) $aclCategory = $altAclCategory; + if(!empty($altAclPlugin)) $aclPlugin = $altAclPlugin; + + // Save user input $this->cpHandler->save_object(); - /* Add entries to queue */ - if($s_action == "copy" || $s_action == "cut"){ - - /* Cleanup object queue */ + // Add entries to queue + if($action == "copy" || $action == "cut"){ $this->cpHandler->cleanup_queue(); - - /* Add new entries to CP queue */ - foreach($s_entry as $dn){ - if($s_action == "copy" && $this->ui->is_copyable($dn,$this->aclCategory,$this->aclPlugin)){ - $this->cpHandler->add_to_queue($dn,"copy",$this->tabClass,$this->tabType,$this->aclCategory); + foreach($target as $dn){ + if($action == "copy" && $this->ui->is_copyable($dn,$aclCategory,$aclPlugin)){ + $this->cpHandler->add_to_queue($dn,"copy",$tabClass,$tabType,$aclCategory,$this); + @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$dn,"Entry copied!"); } - if($s_action == "cut" && $this->ui->is_cutable($dn,$this->aclCategory,$this->aclPlugin)){ - $this->cpHandler->add_to_queue($dn,"cut",$this->tabClass,$this->tabType,$this->aclCategory); + if($action == "cut" && $this->ui->is_cutable($dn,$aclCategory,$aclPlugin)){ + $this->cpHandler->add_to_queue($dn,"cut",$tabClass,$tabType,$aclCategory,$this); + @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$dn,"Entry cutted!"); } } } - /* Start pasting entries */ - if($s_action == "paste"){ + // Initiate pasting + if($action == "paste"){ $this->cpPastingStarted = TRUE; } - /* Return C&P dialog */ + // Display any c&p dialogs, eg. object modifications required before pasting. if($this->cpPastingStarted && $this->cpHandler->entries_queued()){ - - /* Get dialog */ $this->cpHandler->SetVar("base",$this->headpage->getBase()); $data = $this->cpHandler->execute(); - - /* Return dialog data */ if(!empty($data)){ return($data); } } - /* Automatically disable status for pasting */ + // Automatically disable pasting process since there is no entry left to paste. if(!$this->cpHandler->entries_queued()){ $this->cpPastingStarted = FALSE; } @@ -418,21 +887,92 @@ class management } - function setDescription($str) { - $this->plDescription = $str; - } - function setHeadpage($str) { - $this->headpage = $str; - } function setFilter($str) { $this->filter = $str; - } - function setIcon($str) { - $this->plIcon = $str; - } - function setHeadline($str) { - $this->plHeadline = $str; - } + } + + + function postcreate() { + $this->_handlePostEvent('POSTCREATE'); + } + function postmodify(){ + $this->_handlePostEvent('POSTMODIFY'); + } + function postremove(){ + $this->_handlePostEvent('POSTREMOVE'); + } + + function _handlePostEvent($type) + { + + /* Find postcreate entries for this class */ + $command= $this->config->search(get_class($this), $type,array('menu', 'tabs')); + if ($command != ""){ + + /* Walk through attribute list */ + foreach ($this->attributes as $attr){ + if (!is_array($this->$attr)){ + $add_attrs[$attr] = $this->$attr; + } + } + $add_attrs['dn']=$this->dn; + + $tmp = array(); + foreach($add_attrs as $name => $value){ + $tmp[$name] = strlen($name); + } + arsort($tmp); + + /* Additional attributes */ + foreach ($tmp as $name => $len){ + $value = $add_attrs[$name]; + $command= str_replace("%$name", "$value", $command); + } + + if (check_command($command)){ + @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, + $command, "Execute"); + exec($command,$arr); + foreach($arr as $str){ + @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, + $command, "Result: ".$str); + } + } else { + $message= msgPool::cmdnotfound($type, get_class($this)); + msg_dialog::display(_("Error"), $message, ERROR_DIALOG); + } + } + } + + function is_modal_dialog() + { + return(is_object($this->tabObject) || is_object($this->dialogObject)); + } + + + /*! \brief Forward command execution request + * to the correct method. + */ + function handle_post_events($mode, $addAttrs= array()) + { + if(!in_array($mode, array('add','remove','modify'))){ + trigger_error(sprintf("Invalid post event type given '%s'! Valid types are [add,modify,remove].", $mode)); + return; + } + switch ($mode){ + case "add": + plugin::callHook($this,"POSTCREATE", $addAttrs); + break; + + case "modify": + plugin::callHook($this,"POSTMODIFY", $addAttrs); + break; + + case "remove": + plugin::callHook($this,"POSTREMOVE", $addAttrs); + break; + } + } } // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler: