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    Combine two ldap result arrays.
 126    * @param     array   $base   Base array
 127    * @param     array   $add    Array to add
 128    * @returns   array   Combination of $base and $add
 129    */
 130   private function array_combine($base,$add)
 131   {
 132     foreach($add as $key => $attr) {
 133       if(!is_numeric($key)){
 134         if(!isset($base[$key])){
 135           $base[$key] = $add[$key];
 136         }elseif(is_array($add[$key])){
 137           for($i=0;$i<$add[$key]['count'];$i++){
 138             if(!in_array($add[$key][$i],$base[$key])){
 139               $base[$key][] = $add[$key][$i];
 140               $base[$key]['count']++;
 141             }
 142           }
 143         }
 144       }
 145     }
 146     return($base);
 147   }
 148
 149
 150   /*! \brief    Intersect two ldap result arrays/Inner join of two ldap result arrays
 151    * @param     array   $base   Base array
 152    * @param     array   $minus  Array number two
 153    * @returns   array   Result intersection
 154    */
 155   private function array_intersect($base,$minus)
 156   {
 157     foreach($base as $key => $entry){
 158       if(is_numeric($key) || !isset($minus[$key])){
 159         unset($base[$key]);
 160       }elseif(gettype($base[$key]) != gettype($minus[$key])){
 161         unset($base[$key]);
 162       }elseif(is_string($base[$key]) && $base[$key]!=$minus[$key]){
 163         unset($base[$key]);
 164       }elseif(is_array($base[$key])){
 165         $tmp = array();
 166         for($i = 0 ; $i < $base[$key]['count'] ; $i ++){
 167           if(isset($base[$key][$i]) && in_array($base[$key][$i],$minus[$key])){
 168             $tmp[] = $base[$key][$i];
 169           }
 170         }
 171         if(count($tmp)){
 172           $tmp['count'] = count($tmp);
 173           $base[$key] = $tmp;
 174         }else{
 175           unset($base[$key]);
 176         }
 177       }
 178     }
 179     return($base);
 180   }
 181
 182
 183   /*! \brief    Detect values that are used in all edited objects.
 184    * @returns   array   All multiple used attributes
 185    */
 186   private function detect_multiple_used_attributes()
 187   {
 188     $attrs = array();
 189     $first = $this->o_tab->current;
 190     $all   = array();
 191     foreach($this->a_handles as $handle){
 192       if(count($attrs) == 0){
 193         $attrs = $handle->by_object[$first]->attrs;
 194       }else{
 195         $attrs = $this->array_intersect($attrs,$handle->by_object[$first]->attrs);
 196       }
 197       $all = $this->array_combine($all,$handle->by_object[$first]->attrs);
 198     }
 199     foreach($this->o_tab->by_object as $name => $obj){
 200       $this->o_tab->by_object[$name]->init_multiple_support($attrs,$all);
 201     }
 202   }
 203
 204
 205   /*! \brief    Returns the edit ui for multiple edit.
 206      @return    string  HTML User interface for given tab object.
 207    */
 208   public function execute()
 209   {
 210     return($this->o_tab->execute());
 211   }
 212
 213
 214   /*! \brief    Checks if one of the objects we want to edit is locked.
 215      @return    boolean   Returns TRUE if at least one entry is locked, else false.
 216    */
 217   public function entries_locked()
 218   {
 219     $ui = get_userinfo();
 220     foreach($this->dn as $dn){
 221       if(get_lock($dn) != ""){
 222         return(TRUE);
 223       }
 224     }
 225     return(FALSE);
 226   }
 227
 228
 229   /*! \brief    Generates a lock message that can be displayed if an entry is locked.
 230      @return    string  Returns a list of locked entries
 231    */
 232   public function display_lock_message()
 233   {
 234     $ui = get_userinfo();
 235     $lock_msg = "";
 236     $lock_msg.=  gen_locked_message ($ui->dn, $this->dn);
 237     return($lock_msg);
 238   }
 239
 240
 241   /*! \brief    Locks all currently managed objects (array $this->dn)
 242      @return    boolean   Returns TRUE
 243    */
 244   public function lock_entries($uid)
 245   {
 246     foreach($this->dn as $dn)
 247     add_lock($dn,$uid);
 248     return(TRUE);
 249   }
 250
 251
 252   /*! \brief    Checks if the given tab object supports multiple edit.
 253      @return    boolean   Returns TRUE if the given tab objects supports multiple edit else FALSE.
 254    */
 255   public function multiple_available()
 256   {
 257     if(isset($this->o_tab) && is_object($this->o_tab)){
 258       return($this->o_tab->multiple_support_available());
 259     }else{
 260       return(FALSE);
 261     }
 262   }
 263
 264
 265   /*! \brief    Sets the currently active tab. The tab that will be displayed by $this->execute().
 266    */
 267   public function set_active_tab($str)
 268   {
 269     $this->current = $str;
 270   }
 271
 272
 273   /*! \brief    Returns the object info string, that can be displayed in the tab header.
 274       @return   string  Returns an information string, containing the list of currently edited dns.
 275    */
 276   public function get_object_info()
 277   {
 278     return(_("You are currently editing mutliple entries."));
 279   }
 280
 281
 282   /*! \brief    Handles all HTML posts from the dummy tab object.
 283    */
 284   public function save_object()
 285   {
 286     $this->o_tab->save_object();
 287   }
 288
 289
 290   /*! \brief    Checks if the values fetched by $this->save_object() are valid.
 291       @param    array Returns an array containig all error messages.
 292    */
 293   public function check()
 294   {
 295     $messages = $this->o_tab->check();
 296     return($messages);
 297   }
 298
 299
 300   /*! \brief    Currently not implemented, later be used to trigger password changes.
 301       @param    boolean Returns TRUE if a password change is needed.
 302    */
 303   public function password_change_needed()
 304   {
 305     foreach($this->a_handles as $i_id => $o_handle){
 306       if($o_handle->password_change_needed() && isset($o_handle->by_object['user'])){
 307         new msg_dialog(_("Password reset"),_("The user password was resetted, please set a new password value!"),WARNING_DIALOG);
 308         change_password ($o_handle->dn, "",0, $o_handle->by_object['user']->pw_storage);
 309       }
 310     }
 311     return(FALSE);
 312   }
 313
 314
 315   /*! \brief    Populate all collected values to the target tab objects ($this->o_handles)
 316    */
 317   public function populate_values()
 318   {
 319     if($this->multiple_available() && is_array($this->a_handles)){
 320       foreach($this->o_tab->by_object as $name => $obj){
 321
 322         $values = $this->o_tab->by_object[$name]->get_multi_edit_values();
 323         foreach($this->a_handles as $i_id => $o_handle){
 324           $this->a_handles[$i_id]->by_object[$name]->set_multi_edit_values($values);
 325         }
 326       }
 327     }
 328   }
 329
 330
 331   /*! \brief    Save all edited tab objects ($this->o_handles).
 332    */
 333   public function save()
 334   {
 335     if($this->multiple_available() && is_array($this->a_handles)){
 336       $this->populate_values();
 337       foreach($this->a_handles as $i_id => $o_handle){
 338         $o_handle->save();
 339       }
 340     }
 341   }
 342 }
 343
 344 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 345 ?>