gosa-core/include/class_multi_plug.inc

   1 <?php
   2 /*
   3    This code is part of GOsa (https://oss.gonicus.de/labs/gosa/)
   4    Copyright (C) 2007 Fabian Hickert
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 /*
  22
  23 Data structure :
  24 ================
  25   |->o_tab                      <-- dummy object, collects HTML posts, displays ui
  26   |->a_handles                  <-- tab object for each given dn
  27      |->tab object for dn 1
  28      |->tab object for dn 2
  29       ...
  30      |->tab object for dn n
  31
  32 Using this class:
  33 =================
  34   Simple Example:
  35
  36     $dn   = array(dn1,dn2,dn3);
  37     $tmp  = new multi_plug($config,"usertabs",$config->data['TABS']['USERTABS'],$dn);
  38     echo $tmp->execute();
  39
  40   $tmp can now be used like the normal tab class, execute, save_object ...
  41
  42   To enable multipe edit for a specific plugin,
  43   just set the plugin variable 'multiple_support' to true:
  44
  45     var $multiple_support = TRUE;
  46
  47   If plugin::multiple_support is true, the member function
  48   multiple_execute() will be called and displayed, NOT execute().
  49
  50   (I will put this in the wiki, later. This are just notes for me.)
  51
  52 */
  53
  54
  55 /*! \brief   Handles multiple edits for a given set of dns.
  56     \author  Fabian Hickert
  57     \version 1.01
  58     \date    2007/12/07
  59
  60     This class edits multiple tab objects at once.
  61     1. There is a dummy tab object initialized that collects the user input.
  62     2. All given objects specified by '$dn' will be initialized and the collected
  63      data from the dummy object will be populated to them.
  64  */
  65 class multi_plug
  66 {
  67   /* Tab handler for each given dn entry */
  68         public $a_handles = array();
  69
  70   /* Dummy handler which collects the data */
  71   private $o_tab     = NULL;
  72
  73   public $dn      = array();
  74   public $config  = NULL;
  75   private $s_class= "";
  76   public $current = "";
  77
  78   /*! \brief    Creates a multi_plug object
  79      @param   object  $config GOsa Configuration object
  80      @param   string  $class  The class name of the tab we want to edit. e.g. usertabs
  81      @param   string  $tab    The config tab name e.g. USERTABS
  82      @param   array   $dns    The object dns we want to edit.
  83      @return  object  multi_plug
  84    */
  85   public function __construct($config,$class,$tab,$dns,$acl_base,$acl_category)
  86   {
  87     if(!count($dns)){
  88       return;
  89     }
  90
  91     $this->dn       = $dns;
  92     $this->config   = $config;
  93     $this->s_class  = $class;
  94
  95     /* Initialize collector object
  96      * Used to display the ui and to collect the user input.
  97      */
  98     $this->o_tab    = new $class($config,$tab,"new",$acl_category);
  99     $this->o_tab->set_acl_base($acl_base);
 100
 101     /* Check if the specified tab object supports multiple edits
 102      */
 103     if($this->o_tab->multiple_support_available()){
 104
 105       /* Enable multiple actions for the collector object
 106        */
 107       $this->o_tab->enable_multiple_support();
 108
 109       /* Initialize the objects we want to edit at once
 110        */
 111       foreach($dns as $dn){
 112         $obj = new $class($config,$tab,$dn,$acl_category);
 113         $obj->set_acl_base($acl_base);
 114         $this->a_handles[] = $obj;
 115       }
 116     }
 117
 118     /* Detect attributes used by all plugins and set
 119      *  those values as default in edit handle
 120      */
 121     $this->detect_multiple_used_attributes();
 122   }
 123
 124
 125   /*! \brief    Detect values that are used in all edited objects.
 126    * @returns   array   All multiple used attributes
 127    */
 128   private function detect_multiple_used_attributes()
 129   {
 130     $attrs = array();
 131     $all   = array();
 132     $first = $this->o_tab->current;
 133     foreach($this->a_handles as $handle){
 134       if(count($attrs) == 0){
 135         $attrs = $handle->by_object[$first]->attrs;
 136       }else{
 137         foreach($attrs as $key => $attr){
 138           if(!isset($handle->by_object[$first]->attrs[$key]) || !($attr === $handle->by_object[$first]->attrs[$key])){
 139             unset($attrs[$key]);
 140           }
 141           if(!is_numeric($key)){
 142             if(!isset($all[$key])){
 143               $all[$key] = $attr;
 144             }elseif(isset($attr['count'])){
 145               for($i = 0; $i < $attr['count'] ; $i ++){
 146                 $all[$key][] = $attr[$i];
 147               }
 148               $all[$key] = array_unique($all[$key]);
 149             }
 150           }
 151         }
 152       }
 153     }
 154     foreach($this->o_tab->by_object as $name => $obj){
 155       $this->o_tab->by_object[$name]->init_multiple_support($attrs,$all);
 156     }
 157   }
 158
 159
 160   /*! \brief    Returns the edit ui for multiple edit.
 161      @return    string  HTML User interface for given tab object.
 162    */
 163   public function execute()
 164   {
 165     return($this->o_tab->execute());
 166   }
 167
 168
 169   /*! \brief    Checks if one of the objects we want to edit is locked.
 170      @return    boolean   Returns TRUE if at least one entry is locked, else false.
 171    */
 172   public function entries_locked()
 173   {
 174     $ui = get_userinfo();
 175     foreach($this->dn as $dn){
 176       if(get_lock($dn) != ""){
 177         return(TRUE);
 178       }
 179     }
 180     return(FALSE);
 181   }
 182
 183
 184   /*! \brief    Generates a lock message that can be displayed if an entry is locked.
 185      @return    string  Returns a list of locked entries
 186    */
 187   public function display_lock_message()
 188   {
 189     $ui = get_userinfo();
 190     $lock_msg = "";
 191     $lock_msg.=  gen_locked_message ($ui->dn, $this->dn);
 192     return($lock_msg);
 193   }
 194
 195
 196   /*! \brief    Locks all currently managed objects (array $this->dn)
 197      @return    boolean   Returns TRUE
 198    */
 199   public function lock_entries($uid)
 200   {
 201     foreach($this->dn as $dn)
 202     add_lock($dn,$uid);
 203     return(TRUE);
 204   }
 205
 206
 207   /*! \brief    Checks if the given tab object supports multiple edit.
 208      @return    boolean   Returns TRUE if the given tab objects supports multiple edit else FALSE.
 209    */
 210   public function multiple_available()
 211   {
 212     if(isset($this->o_tab) && is_object($this->o_tab)){
 213       return($this->o_tab->multiple_support_available());
 214     }else{
 215       return(FALSE);
 216     }
 217   }
 218
 219
 220   /*! \brief    Sets the currently active tab. The tab that will be displayed by $this->execute().
 221    */
 222   public function set_active_tab($str)
 223   {
 224     $this->current = $str;
 225   }
 226
 227
 228   /*! \brief    Returns the object info string, that can be displayed in the tab header.
 229       @return   string  Returns an information string, containing the list of currently edited dns.
 230    */
 231   public function get_object_info()
 232   {
 233     return(_("You are currently editing mutliple entries."));
 234   }
 235
 236
 237   /*! \brief    Handles all HTML posts from the dummy tab object.
 238    */
 239   public function save_object()
 240   {
 241     $this->o_tab->save_object();
 242   }
 243
 244
 245   /*! \brief    Checks if the values fetched by $this->save_object() are valid.
 246       @param    array Returns an array containig all error messages.
 247    */
 248   public function check()
 249   {
 250     $this->populate_values();
 251     $messages = $this->o_tab->check();
 252     return($messages);
 253   }
 254
 255
 256   /*! \brief    Currently not implemented, later be used to trigger password changes.
 257       @param    boolean Returns TRUE if a password change is needed.
 258    */
 259   public function password_change_needed()
 260   {
 261     foreach($this->a_handles as $i_id => $o_handle){
 262       if($o_handle->password_change_needed() && isset($o_handle->by_object['user'])){
 263         new msg_dialog(_("Password reset"),_("The user password was resetted, please set a new password value!"),WARNING_DIALOG);
 264         change_password ($o_handle->dn, "",0, $o_handle->by_object['user']->pw_storage);
 265       }
 266     }
 267     return(FALSE);
 268   }
 269
 270
 271   /*! \brief    Populate all collected values to the target tab objects ($this->o_handles)
 272    */
 273   public function populate_values()
 274   {
 275
 276     if($this->multiple_available() && is_array($this->a_handles)){
 277       foreach($this->o_tab->by_object as $name => $obj){
 278
 279         $values = $this->o_tab->by_object[$name]->get_multi_edit_values();
 280         foreach($this->a_handles as $i_id => $o_handle){
 281           foreach($values as $a_name => $a_value){
 282             $this->a_handles[$i_id]->by_object[$name]->$a_name = $a_value;
 283           }
 284         }
 285       }
 286     }
 287   }
 288
 289
 290   /*! \brief    Save all edited tab objects ($this->o_handles).
 291    */
 292   public function save()
 293   {
 294     if($this->multiple_available() && is_array($this->a_handles)){
 295       $this->populate_values();
 296       foreach($this->a_handles as $i_id => $o_handle){
 297         $o_handle->save();
 298       }
 299     }
 300   }
 301 }
 302
 303 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 304 ?>