- LSerror : Déclaration des messages d'erreurs avec la méthode statique
[ldapsaisie.git] / trunk / includes / class / class.LSldapObject.php
1 <?php
2 /*******************************************************************************
3  * Copyright (C) 2007 Easter-eggs
4  * http://ldapsaisie.labs.libre-entreprise.org
5  *
6  * Author: See AUTHORS file in top-level directory.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License version 2
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
20
21 ******************************************************************************/
22
23 LSsession :: loadLSclass('LSattribute');
24
25 /**
26  * Base d'un objet ldap
27  *
28  * Cette classe définis la base de tout objet ldap géré par LdapSaisie
29  *
30  * @author Benjamin Renard <brenard@easter-eggs.com>
31  */
32 class LSldapObject { 
33   
34   var $config = array();
35   var $type_name;
36   var $attrs = array();
37   var $forms;
38   var $view;
39   var $dn=false;
40   var $other_values=array();
41   var $submitError=true;
42   var $_whoami=NULL;
43   var $_subDn_value=NULL;
44   var $_LSrelationsCache=array();
45   
46   /**
47    * Constructeur
48    *
49    * Cette methode construit l'objet et définis la configuration.
50    * Elle lance la construction du tableau d'attributs représentés par un objet LSattribute.
51    *
52    * @author Benjamin Renard <brenard@easter-eggs.com>
53    *
54    * @param[in] $type_name [<b>required</b>] string Le nom du type de l'objet
55    * @param[in] $config array La configuration de l'objet
56    *
57    * @retval boolean true si l'objet a Ã©té construit, false sinon.
58    */ 
59   function LSldapObject($type_name,$config='auto') {
60     $this -> type_name = $type_name;
61     $this -> config = $config;
62     if($config=='auto') {
63       if(isset($GLOBALS['LSobjects'][$type_name])) {
64         $this -> config = $GLOBALS['LSobjects'][$type_name];
65       }
66       else {
67         LSerror :: addErrorCode('LSldapObject_01');
68         return;
69       }
70     }
71     foreach($this -> config['attrs'] as $attr_name => $attr_config) {
72       if(!$this -> attrs[$attr_name]=new LSattribute($attr_name,$attr_config,$this)) {
73         return;
74       }
75     }
76     return true;
77   }
78   
79   /**
80    * Charge les données de l'objet
81    *
82    * Cette methode définis le DN de l'objet et charge les valeurs de attributs de l'objet
83    * Ã  partir de l'annuaire.
84    *
85    * @author Benjamin Renard <brenard@easter-eggs.com>
86    *
87    * @param[in] $dn string Le DN de l'objet.
88    *
89    * @retval boolean true si la chargement a réussi, false sinon.
90    */ 
91   function loadData($dn) {
92     $this -> dn = $dn;
93     $data = LSldap :: getAttrs($dn);
94     if(!empty($data)) {
95       foreach($this -> attrs as $attr_name => $attr) {
96         if(!$this -> attrs[$attr_name] -> loadData($data[$attr_name]))
97           return;
98       }
99       return true;
100     }
101     return;
102   }
103   
104   /**
105    * Recharge les données de l'objet
106    *
107    * @author Benjamin Renard <brenard@easter-eggs.com>
108    *
109    * @retval boolean true si la rechargement a réussi, false sinon.
110    */ 
111   function reloadData() {
112     $data = LSldap :: getAttrs($this -> dn);
113     foreach($this -> attrs as $attr_name => $attr) {
114       if(!$this -> attrs[$attr_name] -> reloadData($data[$attr_name]))
115         return;
116     }
117     return true;
118   }
119   
120   /**
121    * Retourne le format d'affichage de l'objet
122    *
123    * @author Benjamin Renard <brenard@easter-eggs.com>
124    *
125    * @retval string Format d'affichage de l'objet.
126    */ 
127   function getDisplayNameFormat() {
128     return $this -> config['display_name_format'];
129   }
130   
131   /**
132    * Retourne la valeur descriptive d'affichage de l'objet
133    * 
134    * Cette fonction retourne la valeur descriptive d'affichage de l'objet en fonction
135    * du format défini dans la configuration de l'objet ou spécifié en paramètre.
136    *
137    * @author Benjamin Renard <brenard@easter-eggs.com>
138    *
139    * @param[in] $spe [<i>optionnel</i>] string Format d'affichage de l'objet
140    * @param[in] $full [<i>optionnel</i>] boolean True pour afficher en plus le
141    *                                             subDnName
142    *
143    * @retval string Valeur descriptive d'affichage de l'objet
144    */ 
145   function getDisplayName($spe='',$full=false) {
146     if ($spe=='') {
147       $spe = $this -> getDisplayNameFormat();
148     }
149     $val = $this -> getFData($spe,&$this -> attrs,'getDisplayValue');
150     if (LSsession :: haveSubDn() && $full) {
151       $val.=' ('.$this -> getSubDnName().')';
152     }
153     return $val;
154   }
155   
156   /**
157    * Chaine formatée
158    * 
159    * Cette fonction retourne la valeur d'une chaine formatée en prennant les valeurs
160    * de l'objet.
161    *
162    * @author Benjamin Renard <brenard@easter-eggs.com>
163    *
164    * @param[in] $format string Format de la chaine
165    *
166    * @retval string Valeur d'une chaine formatée
167    */ 
168   function getFData($format) {
169     $format=getFData($format,$this,'getValue');
170     return $format;
171   }
172   
173   /**
174    * Construit un formulaire de l'objet
175    * 
176    * Cette méthode construit un formulaire LSform Ã  partir de la configuration de l'objet
177    * et de chaque attribut.
178    *
179    * @param[in] $idForm [<b>required</b>] Identifiant du formulaire a créer
180    * @param[in] $load DN d'un objet similaire dont la valeur des attribut doit Ãªtre chargé dans le formulaire.
181    *
182    * @author Benjamin Renard <brenard@easter-eggs.com>
183    *
184    * @retval LSform Le formulaire crée
185    */ 
186   function getForm($idForm,$load=NULL) {
187     LSsession :: loadLSclass('LSform');
188     $LSform = new LSform($this,$idForm);
189     $this -> forms[$idForm] = array($LSform,$load);
190     
191     if ($load) {
192       $type = $this -> getType();
193       $loadObject = new $type();
194       if (!$loadObject -> loadData($load)) {
195         $load=false;
196       }
197     }
198     
199     if ($load) {
200       foreach($this -> attrs as $attr_name => $attr) {
201         if(!$this -> attrs[$attr_name] -> addToForm($LSform,$idForm,$this,$loadObject -> attrs[$attr_name] -> getFormVal())) {
202           $LSform -> can_validate = false;
203         }
204       }
205     }
206     else {
207       foreach($this -> attrs as $attr_name => $attr) {
208         if(!$this -> attrs[$attr_name] -> addToForm($LSform,$idForm,$this)) {
209           $LSform -> can_validate = false;
210         }
211       }      
212     }
213     return $LSform;
214   }
215   
216   /**
217    * Construit un formulaire de l'objet
218    * 
219    * Cette méthode construit un formulaire LSform Ã  partir de la configuration de l'objet
220    * et de chaque attribut.
221    *
222    * @param[in] $idForm [<b>required</b>] Identifiant du formulaire a créer
223    * @param[in] $config Configuration spécifique pour le formulaire
224    *
225    * @author Benjamin Renard <brenard@easter-eggs.com>
226    *
227    * @retval LSform Le formulaire crée
228    */ 
229   function getView() {
230     LSsession :: loadLSclass('LSform');
231     $this -> view = new LSform($this,'view');
232     foreach($this -> attrs as $attr_name => $attr) {
233       $this -> attrs[$attr_name] -> addToView($this -> view);
234     }
235     $this -> view -> can_validate = false;
236     return $this -> view;
237   }  
238   
239   /**
240    * Rafraichis le formulaire de l'objet
241    * 
242    * Cette méthode recharge les données d'un formulaire LSform.
243    *
244    * @param[in] $idForm [<b>required</b>] Identifiant du formulaire a créer
245    *
246    * @author Benjamin Renard <brenard@easter-eggs.com>
247    *
248    * @retval boolean true sile formulaire a Ã©té rafraichis, false sinon
249    */ 
250   function refreshForm($idForm) {
251     $LSform = $this -> forms[$idForm][0];
252     foreach($this -> attrs as $attr_name => $attr) {
253       if(!$this -> attrs[$attr_name] -> refreshForm($LSform,$idForm)) {
254         return;
255       }
256     }
257     return true;
258   }
259   
260   /**
261    * Met Ã  jour les données de l'objet et de l'entré de l'annuaire
262    * 
263    * Met Ã  jour les données de l'objet Ã  partir d'un retour d'un formulaire.
264    *
265    * @param[in] $idForm Identifiant du formulaire d'origine
266    *
267    * @author Benjamin Renard <brenard@easter-eggs.com>
268    *
269    * @retval boolean true si la mise Ã  jour a réussi, false sinon
270    *
271    * @see validateAttrsData()
272    * @see submitChange()
273    */ 
274   function updateData($idForm=NULL) {
275     if($idForm!=NULL) {
276       if(isset($this -> forms[$idForm]))
277         $LSform = $this -> forms[$idForm][0];
278       else {
279         LSerror :: addErrorCode('LSldapObject_02',$this -> getType());
280         return;
281       }
282     }
283     else {
284       if(count($this -> forms) > 0) {
285         reset($this -> forms);
286         $idForm = key($this -> forms);
287         $LSform = current($this -> forms);
288         $config = $LSform[1];
289         $LSform = $LSform[0];
290       }
291       else {
292         LSerror :: addErrorCode('LSldapObject_03',$this -> getType());
293         return;
294       }
295     }
296     $new_data = $LSform -> exportValues();
297     if(!is_array($new_data)) {
298       return;
299     }
300     foreach($new_data as $attr_name => $attr_val) {
301       if(isset($this -> attrs[$attr_name])) {
302         $this -> attrs[$attr_name] -> setUpdateData($attr_val);
303       }
304     }
305     if($this -> validateAttrsData($idForm)) {
306       LSdebug("les données sont validées");
307       if(isset($this -> config['before_modify'])) {
308         if(function_exists($this -> config['before_modify'])) {
309           if(!$this -> config['before_modify']($this)) {
310             LSerror :: addErrorCode('LSldapObject_08',$this -> config['before_modify']);
311             return;
312           }
313         }
314         else {
315           LSerror :: addErrorCode('LSldapObject_07',$this -> config['before_modify']);
316           return;
317         }
318       }
319       // $this -> attrs[*] => before_modify
320       foreach($new_data as $attr_name => $attr_val) {
321         if (!$this -> attrs[$attr_name] -> fireEvent('before_modify')) {
322           return;
323         }
324       }
325       
326       if ($this -> submitChange($idForm)) {
327         LSdebug('Les modifications sont submitées');
328         $this -> submitError = false;
329         $this -> reloadData();
330         $this -> refreshForm($idForm);
331       }
332       else {
333         return;
334       }
335       if((isset($this -> config['after_modify']))&&(!$this -> submitError)) {
336         if(function_exists($this -> config['after_modify'])) {
337           if(!$this -> config['after_modify']($this)) {
338             LSerror :: addErrorCode('LSldapObject_10',$this -> config['after_modify']);
339           }
340         }
341         else {
342           LSerror :: addErrorCode('LSldapObject_09',$this -> config['after_modify']);
343         }
344       }
345       
346       // $this -> attrs[*] => After Modify
347       foreach($new_data as $attr_name => $attr_val) {
348         $this -> attrs[$attr_name] -> fireEvent('after_modify');
349       }
350       return true;
351     }
352     else {
353       return;
354     }
355   }
356   
357   /**
358    * Valide les données retournées par un formulaire
359    *
360    * @param[in] $idForm Identifiant du formulaire d'origine
361    *
362    * @author Benjamin Renard <brenard@easter-eggs.com>
363    *
364    * @retval boolean true si les données sont valides, false sinon
365    */ 
366   function validateAttrsData($idForm) {
367     $retval = true;
368     $LSform=$this -> forms[$idForm][0];
369     foreach($this -> attrs as $attr) {
370       $attr_values = $attr -> getValue();
371       if (!$attr -> isValidate()) {
372         if($attr -> isUpdate()) {
373           if (!$this -> validateAttrData($LSform, $attr)) {
374             $retval = false;
375           }
376         }
377         else if( (empty($attr_values)) && ($attr -> isRequired()) ) { 
378           if ( $attr -> canBeGenerated()) {
379             if ($attr -> generateValue()) {
380               if (!$this -> validateAttrData($LSform, $attr)) {
381                 LSerror :: addErrorCode('LSattribute_08',$attr -> getLabel());
382                 $retval = false;
383               }
384             }
385             else {
386               LSerror :: addErrorCode('LSattribute_07',$attr -> getLabel());
387               $retval = false;
388             }
389           }
390           else {
391             LSerror :: addErrorCode('LSattribute_06',$attr -> getLabel());
392             $retval = false;
393           }
394         }
395       }
396     }
397     return $retval;
398   }
399
400    /**
401    * Valide les données d'un attribut
402    *
403    * @param[in] $LSForm Formulaire d'origine
404    * @param[in] &$attr Attribut Ã  valider
405    *
406    * @author Benjamin Renard <brenard@easter-eggs.com>
407    *
408    * @retval boolean true si les données sont valides, false sinon
409    */
410   function validateAttrData(&$LSform,&$attr) {
411     $retval = true;
412     
413     $vconfig=$attr -> getValidateConfig();
414
415     $data=$attr -> getUpdateData();
416     if(!is_array($data)) {
417       $data=array($data);
418     }
419
420     // Validation des valeurs de l'attribut
421     if(is_array($vconfig)) {
422       foreach($vconfig as $test) {
423         // Définition du basedn par défaut
424         if (!isset($test['basedn'])) {
425           $test['basedn']=LSsession :: getTopDn();
426         }
427
428         // Définition du message d'erreur
429         if (!empty($test['msg'])) {
430           $msg_error=getFData($test['msg'],$this,'getValue');
431         }
432         else {
433           $msg_error=getFData(_("L'attribut %{attr} n'est pas valide."),$attr -> getLabel());
434         }
435         foreach($data as $val) {
436           // validation par check LDAP
437           if((isset($test['filter'])||isset($test['basedn']))&&(isset($test['result']))) {
438             $sparams=(isset($test['scope']))?array('scope' => $test['scope']):array();
439             $this -> other_values['val']=$val;
440             $sfilter_user=(isset($test['basedn']))?getFData($test['filter'],$this,'getValue'):NULL;
441             if(isset($test['object_type'])) {
442               $test_obj = new $test['object_type']();
443               $sfilter=$test_obj->getObjectFilter();
444               $sfilter='(&'.$sfilter;
445               if($sfilter_user[0]=='(') {
446                 $sfilter=$sfilter.$sfilter_user.')';
447               }
448               else {
449                 $sfilter=$sfilter.'('.$sfilter_user.'))';
450               }
451             }
452             else {
453               $sfilter=$sfilter_user;
454             }
455             $sbasedn=(isset($test['basedn']))?getFData($test['basedn'],$this,'getValue'):NULL;
456             $ret=LSldap :: getNumberResult ($sfilter,$sbasedn,$sparams);
457             if($test['result']==0) {
458               if($ret!=0) {
459                 $LSform -> setElementError($attr,$msg_error);
460                 $retval = false;
461               }
462             }
463             else {
464               if($ret<0) {
465                 $LSform -> setElementError($attr,$msg_error);
466                 $retval = false;
467               }
468             }
469           }
470           // Validation par fonction externe
471           else if(isset($test['function'])) {
472             if (function_exists($test['function'])) {
473               if(!$test['function']($this)) {
474                 $LSform -> setElementError($attr,$msg_error);
475                 $retval = false;
476               }
477             }
478             else {
479               LSerror :: addErrorCode('LSldapObject_04',array('attr' => $attr->name,'obj' => $this->getType(),'func' => $test['function']));
480               $retval = false;
481             }
482           }
483           else {
484             LSerror :: addErrorCode('LSldapObject_05',array('attr' => $attr->name,'obj' => $this->getType()));
485             $retval = false;
486           }
487         }
488       }
489     }
490     // Génération des valeurs des attributs dépendants
491     $dependsAttrs=$attr->getDependsAttrs();
492     if (!empty($dependsAttrs)) {
493       foreach($dependsAttrs as $dependAttr) {
494         if(!isset($this -> attrs[$dependAttr])){
495           LSerror :: addErrorCode('LSldapObject_14',array('attr_depend' => $dependAttr, 'attr' => $attr -> getLabel()));
496           continue;
497         }
498         if($this -> attrs[$dependAttr] -> canBeGenerated()) {
499           if (!$this -> attrs[$dependAttr] -> generateValue()) {
500             LSerror :: addErrorCode('LSattribute_07',$this -> attrs[$dependAttr] -> getLabel());
501             $retval = false;
502           }
503         }
504         else {
505           LSerror :: addErrorCode('LSattribute_06',$this -> attrs[$dependAttr] -> getLabel());
506           $retval = false;
507         }
508       }
509     }
510
511     $attr -> validate();
512     unset($this -> other_values['val']);
513     return $retval;
514   }
515
516   /**
517    * Met Ã  jour les données modifiés dans l'annuaire
518    *
519    * @param[in] $idForm Identifiant du formulaire d'origine
520    *
521    * @author Benjamin Renard <brenard@easter-eggs.com>
522    *
523    * @retval boolean true si la mise Ã  jour a réussi, false sinon
524    */ 
525   function submitChange($idForm) {
526     $submitData=array();
527     $new = $this -> isNew();
528     foreach($this -> attrs as $attr) {
529       if(($attr -> isUpdate())&&($attr -> isValidate())) {
530         if(($attr -> name == $this -> config['rdn'])&&(!$new)) {
531           $new = true;
532           LSdebug('Rename');
533           if (!$this -> beforeRename()) {
534             LSerror :: addErrorCode('LSldapObject_16');
535             return;
536           }
537           $oldDn = $this -> getDn();
538           $this -> dn = false;
539           $newDn = $this -> getDn();
540           if ($newDn) {
541             if (!LSldap :: move($oldDn,$newDn)) {
542               return;
543             }
544             $this -> dn = $newDn;
545             if (!$this -> afterRename($oldDn,$newDn)) {
546               LSerror :: addErrorCode('LSldapObject_17');
547               return;
548             }
549           }
550           else {
551             return;
552           }
553         }
554         else {
555           $submitData[$attr -> name] = $attr -> getUpdateData();
556         }
557       }
558     }
559     if(!empty($submitData)) {
560       $dn=$this -> getDn();
561       if($dn) {
562         $this -> dn=$dn;
563         LSdebug($submitData);
564         if (!LSldap :: update($this -> getType(),$dn, $submitData)) {
565           return;
566         }
567         if ($new) {
568           if (!$this -> afterCreate()) {
569             LSerror :: addErrorCode('LSldapObject_21');
570             return;
571           }
572         }
573         return true;
574       }
575       else {
576         LSerror :: addErrorCode('LSldapObject_13');
577         return;
578       }
579     }
580     else {
581       return true;
582     }
583   }
584   
585   /**
586    * Retourne les informations issus d'un DN
587    *
588    * @param[in] $dn Un DN.
589    *
590    * @author Benjamin Renard <brenard@easter-eggs.com>
591    *
592    * @retval array Tableau : 
593    *                  - [0] : le premier paramètre
594    *                  - [1] : les paramètres suivants
595    */ 
596   function getDnInfos($dn) {
597     $infos=ldap_explode_dn($dn,0);
598     if(!$infos)
599       return;
600     $first=true;
601     for($i=1;$i<$infos['count'];$i++)
602       if($first) {
603         $basedn.=$infos[$i];
604         $first=false;
605       }
606       else
607         $basedn.=','.$infos[$i];
608     return array($infos[0],$basedn);
609   }
610   
611   /**
612    * Retourne le filtre correpondants aux objetcClass de l'objet
613    *
614    * @author Benjamin Renard <brenard@easter-eggs.com>
615    *
616    * @retval string le filtre ldap correspondant au type de l'objet
617    */ 
618   function getObjectFilter() {
619     if(!isset($this -> config['objectclass'])) return;
620     $filter="(&";
621     foreach ($this -> config['objectclass'] as $class) {
622       $filter.='(objectClass='.$class.')';
623     }
624     $filter.=')';
625     if ($this -> config['filter']) {
626       $filter="(&(".$this -> config['filter'].")$filter)";
627     }
628     return $filter;
629   }
630   
631   /**
632    * Retourne une liste d'objet du même type.
633    *
634    * Effectue une recherche en fonction des paramètres passé et retourne un
635    * tableau d'objet correspond au resultat de la recherche.
636    *
637    * @author Benjamin Renard <brenard@easter-eggs.com>
638    *
639    * @param[in] $filter array (ou string) Filtre de recherche Ldap / Tableau de filtres de recherche
640    * @param[in] $basedn string DN de base pour la recherche
641    * @param[in] $params array Paramètres de recherche au format Net_LDAP2::search()
642    *
643    * @retval array Tableau d'objets correspondant au resultat de la recherche
644    */ 
645   function listObjects($filter=NULL,$basedn=NULL,$params=array()) {
646     $retInfos=array();
647     
648     $ret = $this -> search($filter,$basedn,$params);
649     
650     // Création d'un tableau d'objet correspondant au valeur retourné
651     for($i=0;$i<count($ret);$i++) {
652       $retInfos[$i] = new $this -> type_name($this -> config);
653       $retInfos[$i] -> loadData($ret[$i]['dn']);
654     }
655     
656     return $retInfos;
657   }
658   
659   /**
660    * Recherche les objets du même type dans l'annuaire
661    *
662    * Effectue une recherche en fonction des paramètres passé et retourne un
663    * tableau array(dn => '', attrs => array()) d'objet correspondant au resultat*
664    * de la recherche.
665    *
666    * @author Benjamin Renard <brenard@easter-eggs.com>
667    *
668    * @param[in] $filter array (ou string) Filtre de recherche Ldap / Tableau de filtres de recherche
669    * @param[in] $basedn string DN de base pour la recherche
670    * @param[in] $params array Paramètres de recherche au format Net_LDAP2::search()
671    *
672    * @retval array Tableau d'objets correspondant au resultat de la recherche
673    */ 
674   function search($filter='',$basedn=NULL,$params=array()) {
675     $retInfos=array();
676     $attrs=false;
677     $check_final_dn=false;
678
679     if(!is_array($filter))
680       $filter=array(array('filter' => $filter));
681     
682     $nbFilter=count($filter);
683
684     for($i=0;$i<$nbFilter;$i++) {
685       $new_attrs=array();
686       // Défintion des paramètres de base pour la recherche
687       $sbasedn=$basedn;
688       $sparams=$params;
689       $ret=array();
690       if (isset($filter[$i]['scope']))
691         $sparams["scope"]=$filter[$i]['scope'];
692       
693       // Definition des critères de recherche correspondant au type d'objet Ã  lister
694       if(($nbFilter==1)||(!isset($filter[$i]['attr']))) {
695         // Filtre sur l'objet souhaité
696         $sfilter='(&';
697         $sfilter.=$this -> getObjectFilter();
698         $sfilter_end=')';
699         $check_final_dn=true;
700       }
701       // Initialisation des critères d'une recherche intermédiaire
702       else {
703         if(isset($filter[$i]['object_type'])) {
704           $obj_tmp=new $filter[$i]['object_type']();
705           $obj_filter=$obj_tmp->getObjectFilter();
706           $sfilter='(&'.$obj_filter;
707           $sfilter_end=')';
708         }
709         else {
710           $sfilter='';
711           $sfilter_end='';
712         }
713         if(isset($filter[$i]['scope'])) {
714           $sparams['scope']=$filter[$i]['scope'];
715         }
716         if(isset($filter[$i]['basedn'])) {
717           $sbasedn=$filter[$i]['basedn'];
718         }
719       }
720       // Dans le cas d'une recherche intermédiaire ou finale
721       if($attrs!=false) {
722         // Initialisation des variables
723         $ret_gen=array();
724         $new_attrs=array();
725         
726         // Pour tout les attributs retournés
727         for($ii=0;$ii<count($attrs);$ii++) {
728           $sfilter_for='';
729           // Définition du filtre de recherche Ã  partir des paramètres utilisateurs et
730           // des paramètres de recherche de l'objet Ã  listé (dans le cas d'une recherche finale
731           if((isset($filter[$i]['filter']))&&(!empty($filter[$i]['filter']))) {
732             $sfilter_user=getFData($filter[$i]['filter'],$attrs[$ii]);
733             if($sfilter_user[0]=='(')
734               $sfilter_for=$sfilter.$sfilter_user;
735             else
736               $sfilter_for=$sfilter.'('.$sfilter_user.')';
737           }
738           else {
739             $sfilter_for=$sfilter;
740           }
741           
742           if(isset($filter[$i]['basedn'])) {
743             $sbasedn=getFData($filter[$i]['basedn'],$attrs[$ii]);
744             if ((!$this -> isCompatibleDNs($sbasedn,$basedn))&&($check_final_dn)) continue;
745           }
746         
747           // Vérification de la compatibilité du basedn de la recherche et du basedn générale
748           // Finalisation du filtre
749           $sfilter_for.=$sfilter_end;
750         
751         
752           // Attributes
753           if ($filter[$i]['attr']) {
754             $sparams['attributes'] = array($filter[$i]['attr']);
755           }
756           else if (!isset($sparams['attributes'])) {
757             $sparams['attributes'] = array($this -> config['rdn']);
758           }
759         
760           // Execution de la recherche
761           $ret=LSldap :: search ($sfilter_for,$sbasedn,$sparams);
762           
763           // Si il y un retour
764           if(isset($ret[0])) {
765             // si il ya une suite (recherche intermédiaire)
766             if($filter[$i]['attr']){
767               for($iii=0;$iii<count($ret);$iii++) {
768                 if(isset($ret[$iii]['attrs'][$filter[$i]['attr']])) {
769                   // cas de valeur multiple
770                   if(is_array($ret[$iii]['attrs'][$filter[$i]['attr']])) {
771                     foreach($ret[$iii]['attrs'][$filter[$i]['attr']] as $val_attr) {
772                       $new_attrs[]=$val_attr;
773                     }
774                   }
775                   // cas de valeur unique
776                   else {
777                     $new_attrs[]=$ret[$iii]['attrs'][$filter[$i]['attr']];
778                   }
779                 }
780               }
781             }
782           }
783         }
784         // cas du dernier filtre
785         if(!empty($ret_gen)) {
786           break;
787         }
788         // dans le cas d'une suite prévu mais d'un retour nul de la précédente recherche
789         else if(empty($new_attrs)) {
790             // retour vide et arrêt de la recherche
791             $ret=array();
792             break;
793         }
794         else {
795           $attrs=$new_attrs;
796         }
797       }
798       // Dans le cas de la recherche initiale
799       else {
800         // Déclaration du filtre de recherche
801         if((isset($filter[$i]['filter']))&&(!empty($filter[$i]['filter']))) {
802           if($filter[$i]['filter'][0]=='(') {
803             $sfilter.=$filter[$i]['filter'];
804           }
805           else {
806             $sfilter.='('.$filter[$i]['filter'].')';
807           }
808         }
809         // fermeture du filtre
810         $sfilter.=$sfilter_end;
811         
812         // Attributes
813         if (!isset($sparams['attributes'])) {
814           $sparams['attributes'] = array($this -> config['rdn']);
815         }
816         
817         // Lancement de la recherche
818         $ret=LSldap :: search ($sfilter,$sbasedn,$sparams);
819         
820         //Si filtre multiple => on recupère une liste d'attributs
821         if(isset($filter[$i]['attr'])) {
822           for($ii=0;$ii<count($ret);$ii++) {
823             if(isset($ret[$ii]['attrs'][$filter[$i]['attr']])) {
824               // cas de valeur multiple
825               if(is_array($ret[$ii]['attrs'][$filter[$i]['attr']])) {
826                 foreach($ret[$ii]['attrs'][$filter[$i]['attr']] as $val_attr) {
827                   $attrs[]=$val_attr;
828                 }
829               }
830               // cas de valeur unique
831               else {
832                 $attrs[]=$ret[$ii]['attrs'][$filter[$i]['attr']];
833               }
834             }
835           }
836           
837           // Si aucunne valeur n'est retournées
838           if(empty($attrs)){
839             // arrêt et retour Ã  zéro
840             $ret=array();
841             break;
842           }
843         }
844         // Si recherche unique
845         else {
846           // préparation du retour finale
847           if (!is_array($ret)) {
848             $ret=array();
849           }
850           break;
851         }
852       }
853     }
854     return $ret;
855   }
856   
857   /**
858    * Retourne une liste d'objet du même type et retourne leur noms
859    *
860    * Effectue une recherche en fonction des paramètres passé et retourne un
861    * tableau (dn => nom) correspondant au resultat de la recherche.
862    *
863    * @author Benjamin Renard <brenard@easter-eggs.com>
864    *
865    * @param[in] $filter string Filtre de recherche Ldap
866    * @param[in] $basedn string DN de base pour la recherche
867    * @param[in] $params array Paramètres de recherche au format Net_LDAP2::search()
868    * @param[in] $displayFormat string Format d'affichage du nom des objets
869    *
870    * @retval array Tableau dn => name correspondant au resultat de la recherche
871    */ 
872   function listObjectsName($filter=NULL,$sbasedn=NULL,$sparams=array(),$displayFormat=false) {
873     $retInfos=array();
874     
875     if (!$displayFormat) {
876       $displayFormat = $this -> getDisplayNameFormat();
877     }
878     // Attributes
879     $attrs = getFieldInFormat($displayFormat);
880     if(!empty($attrs)) {
881       $sparams['attributes'] = $attrs;
882     }
883     
884     // Lancement de la recherche
885     $ret=$this -> search ($filter,$sbasedn,$sparams);
886
887     if (is_array($ret)) {
888       foreach($ret as $obj) {
889         $retInfos[$obj['dn']] = getFData($displayFormat,$obj['attrs']);
890       }
891     }
892     
893     return $retInfos;
894   }
895  
896  
897   /**
898    * Recherche un objet à partir de la valeur exact de son RDN
899    * 
900    * @author Benjamin Renard <brenard@easter-eggs.com>
901    * 
902    * @param[in] $name string Valeur de son RDN
903    * @param[in] $basedn string Le DN de base de la recherche
904    * 
905    * @retval array Tableau d'objets correspondant au resultat de la recherche
906    */
907   function searchObject($name,$basedn=NULL) {
908     $filter = $this -> config['rdn'].'='.$name; 
909     return $this -> listObjects($filter,$basedn); 
910   }
911
912   /**
913    * Retourne une valeur de l'objet
914    *
915    * Retourne une valeur en fonction du paramètre. Si la valeur est inconnue, la valeur retourné est ' '.
916    * tableau d'objet correspond au resultat de la recherche.
917    *
918    * Valeurs possibles :
919    * - 'dn' ou '%{dn} : DN de l'objet
920    * - [nom d'un attribut] : valeur de l'attribut
921    * - [clef de $this -> other_values] : valeur de $this -> other_values
922    *
923    * @author Benjamin Renard <brenard@easter-eggs.com>
924    *
925    * @param[in] $val string Le nom de la valeur demandée
926    *
927    * @retval mixed la valeur demandé ou ' ' si celle-ci est inconnue.
928    */ 
929   function getValue($val) {
930     if(($val=='dn')||($val=='%{dn}')) {
931       return $this -> dn;
932     }
933     else if(($val=='rdn')||($val=='%{rdn}')) {
934       return $this -> attrs[ $this -> config['rdn'] ] -> getValue();
935     }
936     else if(($val=='subDn')||($val=='%{subDn}')) {
937       return $this -> getSubDnValue();
938     }
939     else if(($val=='subDnName')||($val=='%{subDnName}')) {
940       return $this -> getSubDnName();
941     }
942     else if(isset($this ->  attrs[$val])){
943       if (method_exists($this ->  attrs[$val],'getValue'))
944         return $this -> attrs[$val] -> getValue();
945       else
946         return ' ';
947     }
948     else if(isset($this -> other_values[$val])){
949       return $this -> other_values[$val];
950     }
951     else {
952       return ' ';
953     }
954   }
955
956   /**
957    * Retourn un tableau pour un select d'un objet du même type
958    * 
959    * @author Benjamin Renard <brenard@easter-eggs.com>
960    *
961    * @retval array('dn' => 'display')
962    */
963   function getSelectArray($pattern=NULL,$topDn=NULL,$displayFormat=NULL,$approx=false) {
964     if ($pattern!=NULL) {
965       $filter='(|';
966       if ($approx) {
967         foreach ($this -> attrs as $attr_name => $attr_val) {
968           $filter.='('.$attr_name.'~='.$pattern.')';
969         }
970       }
971       else {
972         foreach ($this -> attrs as $attr_name => $attr_val) {
973           $filter.='('.$attr_name.'=*'.$pattern.'*)';
974         }
975       }
976       $filter.=')';
977     }
978     else {
979       $filter=NULL;
980     }
981     return $this -> listObjectsName($filter,$topDn,array(),$displayFormat);
982   }
983
984   /**
985    * Retourne le DN de l'objet
986    *
987    * Cette methode retourne le DN de l'objet. Si celui-ci n'existe pas, il le construit Ã  partir de la 
988    * configuration de l'objet et la valeur de son attribut rdn.
989    *
990    * @author Benjamin Renard <brenard@easter-eggs.com>
991    *
992    * @retval string Le DN de l'objet
993    */   
994   function getDn() {
995     if($this -> dn) {
996       return $this -> dn;
997     }
998     else {
999       $rdn_attr=$this -> config['rdn'];
1000       $topDn = LSsession :: getTopDn();
1001       if( (isset($this -> config['rdn'])) && (isset($this -> attrs[$rdn_attr])) && (isset($this -> config['container_dn'])) && ($topDn) ) {
1002         $rdn_val=$this -> attrs[$rdn_attr] -> getUpdateData();
1003         if (!empty($rdn_val)) {
1004           return $rdn_attr.'='.$rdn_val[0].','.$this -> config['container_dn'].','.$topDn;
1005         }
1006         else {
1007           LSerror :: addErrorCode('LSldapObject_12',$this -> config['rdn']);
1008           return;
1009         }
1010       }
1011       else {
1012         LSerror :: addErrorCode('LSldapObject_11',$this -> getType());
1013         return;
1014       }
1015     }
1016   }
1017
1018   /**
1019    * Retourne le type de l'objet
1020    *
1021    * @author Benjamin Renard <brenard@easter-eggs.com>
1022    * 
1023    * @retval string Le type de l'objet ($this -> type_name)
1024    */
1025   function getType() {
1026     return $this -> type_name;
1027   }
1028   
1029   /**
1030    * Retourne qui est l'utilisateur par rapport Ã  cet object
1031    *
1032    * @author Benjamin Renard <brenard@easter-eggs.com>
1033    * 
1034    * @retval string 'admin'/'self'/'user' pour Admin , l'utilisateur lui même ou un simple utilisateur
1035    */
1036   function whoami() {
1037     if (!$this -> _whoami)
1038       $this -> _whoami = LSsession :: whoami($this -> dn);
1039     return $this -> _whoami;
1040   }
1041   
1042   /**
1043    * Retourne le label de l'objet
1044    *
1045    * @author Benjamin Renard <brenard@easter-eggs.com>
1046    * 
1047    * @retval string Le label de l'objet ($this -> config['label'])
1048    */
1049   function getLabel() {
1050     return $this -> config['label'];
1051   }
1052   
1053   
1054   /**
1055    * Supprime l'objet dans l'annuaire
1056    *
1057    * @author Benjamin Renard <brenard@easter-eggs.com>
1058    * 
1059    * @retval boolean True si l'objet Ã  Ã©té supprimé, false sinon
1060    */
1061   function remove() {
1062     if ($this -> beforeDelete()) {
1063       if (LSldap :: remove($this -> getDn())) {
1064         if ($this -> afterDelete()) {
1065           return true;
1066         }
1067         LSerror :: addErrorCode('LSldapObject_19');
1068       }
1069     }
1070     else {
1071       LSerror :: addErrorCode('LSldapObject_18');
1072     }
1073     return;
1074   }
1075   
1076   /**
1077    * L'objet est-il nouveau
1078    * 
1079    * @author Benjamin Renard <brenard@easter-eggs.com>
1080    * 
1081    * @retval boolean True si l'objet est nouveau, false sinon
1082    */
1083   function isNew() {
1084     return (!$this -> dn);
1085   }
1086
1087   /**
1088    * Retourne la valeur (DN) du subDn de l'objet  
1089    * 
1090    * @parram[in] $dn string Un DN
1091    * 
1092    * @return string La valeur du subDn de l'object
1093    */
1094   function getSubDnValue($dn=NULL) {
1095     if (!$dn) {
1096       $dn = $this -> getValue('dn');
1097     }
1098     if ($this -> _subDn_value[$dn]) {
1099       return $this -> _subDn_value[$dn];
1100     }
1101     $subDn_value='';
1102     $subDnLdapServer = LSsession :: getSortSubDnLdapServer();
1103     foreach ($subDnLdapServer as $subDn => $subDn_name) {
1104       if (isCompatibleDNs($subDn,$dn)&&($subDn!=$dn)) {
1105         $subDn_value=$subDn;
1106         break;
1107       }
1108     }
1109     $this -> _subDn_value[$dn] = $subDn_value;
1110     return $subDn_value;
1111   }
1112
1113   /**
1114    * Retourne la nom du subDn de l'objet  
1115    * 
1116    * @parram[in] $dn string Un DN
1117    * 
1118    * @return string Le nom du subDn de l'object
1119    */
1120   function getSubDnName($dn=NULL) {
1121     $subDnLdapServer = LSsession :: getSortSubDnLdapServer();
1122     return $subDnLdapServer[$this -> getSubDnValue($dn)];
1123   }
1124   
1125   /**
1126    * Methode créant la liste des objets en relations avec l'objet courant et qui
1127    * la met en cache ($this -> _LSrelationsCache)
1128    * 
1129    * @retval True en cas de cas ce succès, False sinon.
1130    */
1131   function updateLSrelationsCache() {
1132     $this -> _LSrelationsCache=array();
1133     if (is_array($this->config['LSrelation'])) {
1134       $type = $this -> getType();
1135       $me = new $type();
1136       $me -> loadData($this -> getDn());
1137       foreach($this->config['LSrelation'] as $relation_name => $relation_conf) {
1138         if ( isset($relation_conf['list_function']) ) {
1139           if (LSsession :: loadLSobject($relation_conf['LSobject'])) {
1140             $obj = new $relation_conf['LSobject']();
1141             if ((method_exists($obj,$relation_conf['list_function']))&&(method_exists($obj,$relation_conf['getkeyvalue_function']))) {
1142               $list = $obj -> $relation_conf['list_function']($me);
1143               if (is_array($list)) {
1144                 // Key Value
1145                 $key = $obj -> $relation_conf['getkeyvalue_function']($me);
1146                 
1147                 $this -> _LSrelationsCache[$relation_name] = array(
1148                   'list' => $list,
1149                   'keyvalue' => $key
1150                 );
1151               }
1152               else {
1153                 LSdebug('Problème durant la mise en cache de la relation '.$relation_name);
1154                 return;
1155               }
1156             }
1157             else {
1158               LSdebug('Les méthodes de mise en cache de la relation '.$relation_name. ' ne sont pas toutes disponibles.');
1159               return;
1160             }
1161           }
1162           else {
1163             return;
1164           }
1165         }
1166       }
1167     }
1168     return true;
1169   }
1170   
1171   /**
1172    * Methode executant les actions nécéssaires avant le changement du DN de
1173    * l'objet.
1174    * 
1175    * Cette méthode n'est qu'un exemple et elle doit être certainement réécrite
1176    * pour les objets plus complexe.
1177    * 
1178    * @retval True en cas de cas ce succès, False sinon.
1179    */
1180   function beforeRename() {
1181     return $this -> updateLSrelationsCache();
1182   }
1183   
1184   /**
1185    * Methode executant les actions nécéssaires après le changement du DN de
1186    * l'objet.
1187    * 
1188    * Cette méthode n'est qu'un exemple et elle doit être certainement réécrite
1189    * pour les objets plus complexe.
1190    * 
1191    * @param[in] $oldDn string L'ancien DN de l'objet
1192    * @param[in] $newDn string Le nouveau DN de l'objet
1193    * 
1194    * @retval True en cas de cas ce succès, False sinon.
1195    */
1196   function afterRename($oldDn,$newDn) {
1197     $error = 0;
1198     if(LSsession :: getLSuserObjectDn() == $oldDn) {
1199       LSsession :: changeAuthUser($this);
1200     }
1201     
1202     foreach($this -> _LSrelationsCache as $relation_name => $objInfos) {
1203       if ((isset($this->config['LSrelation'][$relation_name]['rename_function']))&&(is_array($objInfos['list']))) {
1204         foreach($objInfos['list'] as $obj) {
1205           $meth = $this->config['LSrelation'][$relation_name]['rename_function'];
1206           if (method_exists($obj,$meth)) {
1207             if (!($obj -> $meth($this,$objInfos['keyvalue']))) {
1208               $error=1;
1209             }
1210           }
1211           else {
1212             $error=1;
1213           }
1214         }
1215       }
1216     }
1217     return !$error;
1218   }
1219   
1220   /**
1221    * Methode executant les actions nécéssaires avant la suppression de
1222    * l'objet.
1223    * 
1224    * Cette méthode n'est qu'un exemple et elle doit être certainement réécrite
1225    * pour les objets plus complexe.
1226    * 
1227    * @retval True en cas de cas ce succès, False sinon.
1228    */
1229   function beforeDelete() {
1230     $return = $this -> updateLSrelationsCache();
1231     
1232     foreach(array_keys($this -> attrs) as $attr_name) {
1233       if (!$this -> attrs[$attr_name] -> fireEvent('before_delete')) {
1234         $return = false;
1235       }
1236     }
1237     
1238     return $return;
1239   }
1240   
1241   /**
1242    * Methode executant les actions nécéssaires après la suppression de
1243    * l'objet.
1244    * 
1245    * Cette méthode n'est qu'un exemple et elle doit être certainement réécrite
1246    * pour les objets plus complexe.
1247    * 
1248    * @retval True en cas de cas ce succès, False sinon.
1249    */
1250   function afterDelete() {
1251     $error = 0;
1252     foreach($this -> _LSrelationsCache as $relation_name => $objInfos) {
1253       if ((isset($this->config['LSrelation'][$relation_name]['remove_function']))&&(is_array($objInfos['list']))) {
1254         foreach($objInfos['list'] as $obj) {
1255           $meth = $this->config['LSrelation'][$relation_name]['remove_function'];
1256           if (method_exists($obj,$meth)) {
1257             if (!($obj -> $meth($this))) {
1258               $error=1;
1259             }
1260           }
1261           else {
1262             $error=1;
1263           }
1264         }
1265       }
1266     }
1267     
1268     if (isset($this -> config['after_delete'])) {
1269       if (is_array($this -> config['after_delete'])) {
1270         $config = $this -> config['after_delete'];
1271       }
1272       else {
1273         $config = array($this -> config['after_delete']);
1274       }
1275       foreach($config as $action) {
1276         if(function_exists($action)) {
1277           if(!$action($this)) {
1278             LSerror :: addErrorCode('LSldapObject_25',$action);
1279             $error=true;
1280           }
1281         }
1282         else {
1283           LSerror :: addErrorCode('LSldapObject_24',$action);
1284           $error=true;
1285         }
1286       }
1287     }
1288     
1289     foreach(array_keys($this -> attrs) as $attr_name) {
1290       if (!$this -> attrs[$attr_name] -> fireEvent('after_delete')) {
1291         $error = true;
1292       }
1293     }
1294     
1295     return !$error;
1296   }
1297   
1298   /**
1299    * Methode executant les actions nécéssaires après la création de
1300    * l'objet.
1301    * 
1302    * Cette méthode n'est qu'un exemple et elle doit être certainement réécrite
1303    * pour les objets plus complexe.
1304    * 
1305    * @retval True en cas de cas ce succès, False sinon.
1306    */
1307   function afterCreate() {
1308     LSdebug('after');
1309     $error = 0;
1310     if (LSsession :: isSubDnLSobject($this -> getType())) {
1311       if (is_array(LSsession :: $ldapServer['subDn']['LSobject'][$this -> getType()]['LSobjects'])) {
1312         foreach(LSsession :: $ldapServer['subDn']['LSobject'][$this -> getType()]['LSobjects'] as $type) {
1313           if (LSsession :: loadLSobject($type)) {
1314             if (isset($GLOBALS['LSobjects'][$type]['container_auto_create'])&&isset($GLOBALS['LSobjects'][$type]['container_dn'])) {
1315               $dn = $GLOBALS['LSobjects'][$type]['container_dn'].','.$this -> getDn();
1316               if(!LSldap :: getNewEntry($dn,$GLOBALS['LSobjects'][$type]['container_auto_create']['objectclass'],$GLOBALS['LSobjects'][$type]['container_auto_create']['attrs'],true)) {
1317                 LSdebug("Impossible de créer l'entrée fille : ".print_r(
1318                   array(
1319                     'dn' => $dn,
1320                     'objectClass' => $GLOBALS['LSobjects'][$type]['container_auto_create']['objectclass'],
1321                     'attrs' => $GLOBALS['LSobjects'][$type]['container_auto_create']['attrs']
1322                   )
1323                 ,true));
1324                 $error=1;
1325               }
1326             }
1327           }
1328           else {
1329             $error=1;
1330           }
1331         }
1332       }
1333     }
1334     
1335     if (isset($this -> config['after_create'])) {
1336       if (is_array($this -> config['after_create'])) {
1337         $config = $this -> config['after_create'];
1338       }
1339       else {
1340         $config = array($this -> config['after_create']);
1341       }
1342       foreach($config as $action) {
1343         if(function_exists($action)) {
1344           if(!$action($this)) {
1345             LSerror :: addErrorCode('LSldapObject_23',$action);
1346             $error=true;
1347           }
1348         }
1349         else {
1350           LSerror :: addErrorCode('LSldapObject_22',$action);
1351           $error=true;
1352         }
1353       }
1354     }
1355     
1356     return !$error;
1357   }
1358   
1359   /**
1360    * Retourne la valeur clef d'un objet en relation
1361    * 
1362    * @param[in] $object Un object de type $objectType
1363    * @param[in] $attr L'attribut dans lequel l'objet doit apparaitre
1364    * @param[in] $objectType Le type d'objet en relation
1365    * @param[in] $value La valeur que doit avoir l'attribut :
1366    *                      - soit le dn (par defaut)
1367    *                      - soit la valeur [0] d'un attribut
1368    * 
1369    * @retval Mixed La valeur clef d'un objet en relation
1370    **/
1371   function getObjectKeyValueInRelation($object,$attr,$objectType,$attrValue='dn') {
1372     if ((!$attr)||(!$objectType)) {
1373       LSerror :: addErrorCode('LSrelations_05','getObjectKeyValueInRelation');
1374       return;
1375     }
1376     if ($attrValue=='dn') {
1377       $val = $object -> getDn();
1378     }
1379     else {
1380       $val = $object -> getValue($attrValue);
1381       $val = $val[0];
1382     }
1383     return $val;
1384   }
1385   
1386   /**
1387    * Retourne la liste des relations pour l'objet en fonction de sa présence 
1388    * dans un des attributs
1389    * 
1390    * Retourne un tableau de d'objet (type : $objectType) correspondant à la 
1391    * relation entre l'objet $object et les objets de type $objectType. Cette relation
1392    * est établis par la présence de la valeur de référence à l'objet dans 
1393    * l'attribut des objets de type $objectType.
1394    * 
1395    * @param[in] $object Un object de type $objectType
1396    * @param[in] $attr L'attribut dans lequel l'objet doit apparaitre
1397    * @param[in] $objectType Le type d'objet en relation
1398    * @param[in] $value La valeur que doit avoir l'attribut :
1399    *                      - soit le dn (par defaut)
1400    *                      - soit la valeur [0] d'un attribut
1401    * 
1402    * @retval Array of $objectType Les objets en relations
1403    **/
1404   function listObjectsInRelation($object,$attr,$objectType,$attrValue='dn') {
1405     if ((!$attr)||(!$objectType)) {
1406       LSerror :: addErrorCode('LSrelations_05','listObjectsInRelation');
1407       return;
1408     }
1409     if ($attrValue=='dn') {
1410       $val = $object -> getDn();
1411     }
1412     else {
1413       $val = $object -> getValue($attrValue);
1414       $val = $val[0];
1415     }
1416     if ($val) {
1417       $filter = $this -> getObjectFilter();
1418       $filter = '(&'.$filter.'('.$attr.'='.$val.'))';
1419       return $this -> listObjects($filter,LSsession :: $ldapServer['ldap_config']['basedn'],array('scope' => 'sub'));
1420     }
1421     return;
1422   }
1423
1424   /**
1425    * Ajoute un objet en relation dans l'attribut $attr de $this
1426    * 
1427    * @param[in] $object Un objet de type $objectType à ajouter
1428    * @param[in] $attr L'attribut dans lequel l'objet doit être ajouté
1429    * @param[in] $objectType Le type d'objet en relation
1430    * @param[in] $attrValue La valeur que doit avoir l'attribut :
1431    *                      - soit le dn (par defaut)
1432    *                      - soit la valeur [0] d'un attribut
1433    * 
1434    * @retval boolean true si l'objet à été ajouté, False sinon
1435    **/  
1436   function addOneObjectInRelation($object,$attr,$objectType,$attrValue='dn') {
1437     if ((!$attr)||(!$objectType)) {
1438       LSerror :: addErrorCode('LSrelations_05','addOneObjectInRelation');
1439       return;
1440     }
1441     if ($object instanceof $objectType) {
1442       if ($this -> attrs[$attr] instanceof LSattribute) {
1443         if ($attrValue=='dn') {
1444           $val = $object -> getDn();
1445         }
1446         else {
1447           $val = $object -> getValue($attrValue);
1448           $val = $val[0];
1449         }
1450         $values = $this -> attrs[$attr] -> getValue();
1451         if ($this -> attrs[$attr] -> config['multiple']) {
1452           if (!is_array($values)) {
1453             $updateData = array($val);
1454           }
1455           else if (!in_array($val,$values)) {
1456             $values[]=$val;
1457             $updateData = $values;
1458           }
1459         }
1460         else {
1461           if (($values[0]!=$val)&&($values!=$val)) {
1462             $updateData = array($val);
1463           }
1464         }
1465         if (isset($updateData)) {
1466           return LSldap :: update($this -> getType(),$this -> getDn(), array($attr => $updateData));
1467         }
1468         return true;
1469       }
1470     }
1471     return;
1472   }
1473   
1474   /**
1475    * Supprime un objet en relation dans l'attribut $attr de $this
1476    * 
1477    * @param[in] $object Un objet de type $objectType à supprimer
1478    * @param[in] $attr L'attribut dans lequel l'objet doit être supprimé
1479    * @param[in] $objectType Le type d'objet en relation
1480    * @param[in] $attrValue La valeur que doit avoir l'attribut :
1481    *                      - soit le dn (par defaut)
1482    *                      - soit la valeur [0] d'un attribut
1483    * 
1484    * @retval boolean true si l'objet à été supprimé, False sinon
1485    **/  
1486   function deleteOneObjectInRelation($object,$attr,$objectType,$attrValue='dn') {
1487     if ((!$attr)||(!$objectType)) {
1488       LSerror :: addErrorCode('LSrelations_05','deleteOneObjectInRelation');
1489       return;
1490     }
1491     if ($object instanceof $objectType) {
1492       if ($this -> attrs[$attr] instanceof LSattribute) {
1493         if ($attrValue=='dn') {
1494           $val = $object -> getDn();
1495         }
1496         else {
1497           $val = $object -> getValue($attrValue);
1498           $val = $val[0];
1499         }
1500         $values = $this -> attrs[$attr] -> getValue();
1501         if ((!is_array($values)) && (!empty($values))) {
1502           $values = array($values);
1503         }
1504         if (is_array($values)) {
1505           $updateData=array();
1506           foreach($values as $value) {
1507             if ($value!=$val) {
1508               $updateData[]=$value;
1509             }
1510           }
1511           return LSldap :: update($this -> getType(),$this -> getDn(), array($attr => $updateData));
1512         }
1513       }
1514     }
1515     return;
1516   }
1517   
1518  /**
1519   * Renome un objet en relation dans l'attribut $attr de $this
1520   * 
1521   * @param[in] $object Un objet de type $objectType à renomer
1522   * @param[in] $oldValue string L'ancienne valeur faisant référence à l'objet
1523   * @param[in] $attr L'attribut dans lequel l'objet doit être supprimé
1524   * @param[in] $objectType Le type d'objet en relation
1525   * @param[in] $attrValue La valeur que doit avoir l'attribut :
1526   *                      - soit le dn (par defaut)
1527   *                      - soit la valeur [0] d'un attribut
1528   *  
1529   * @retval boolean True en cas de succès, False sinon
1530   */
1531   function renameOneObjectInRelation($object,$oldValue,$attr,$objectType,$attrValue='dn') {
1532     if ((!$attr)||(!$objectType)) {
1533       LSerror :: addErrorCode('LSrelations_05','renameOneObjectInRelation');
1534       return;
1535     }
1536     if ($object instanceof $objectType) {
1537       if ($this -> attrs[$attr] instanceof LSattribute) {
1538         $values = $this -> attrs[$attr] -> getValue();
1539         if ((!is_array($values)) && (!empty($values))) {
1540           $values = array($values);
1541         }
1542         if (is_array($values)) {
1543           $updateData=array();
1544           foreach($values as $value) {
1545             if ($value!=$oldValue) {
1546               $updateData[] = $value;
1547             }
1548             else {
1549               if ($attrValue=='dn') {
1550                 $val = $object -> getDn();
1551               }
1552               else {
1553                 $val = $object -> getValue($attrValue);
1554                 $val = $val[0];
1555               }
1556               $updateData[] = $val;
1557             }
1558           }
1559           return LSldap :: update($this -> getType(),$this -> getDn(), array($attr => $updateData));
1560         }
1561       }
1562     }
1563     return;
1564   }
1565   
1566   /**
1567    * Met à jour les objets du meme type que $this en relation avec l'objet $object
1568    * de type $objectType en modifiant la valeur de leur attribut $attr des objets
1569    * en relation
1570    * 
1571    * @param[in] $object Mixed Un object (type : $this -> userObjectType) : l'utilisateur
1572    * @param[in] $listDns Array(string) Un tableau des DNs des objets en relation
1573    * @param[in] $attr L'attribut dans lequel l'utilisateur doit apparaitre
1574    * @param[in] $objectType Le type d'objet en relation
1575    * @param[in] $attrValue La valeur que doit avoir l'attribut :
1576    *                      - soit le dn (par defaut)
1577    *                      - soit la valeur [0] d'un attribut
1578    * 
1579    * @retval boolean true si tout c'est bien passé, False sinon
1580    **/  
1581   function updateObjectsInRelation($object,$listDns,$attr,$objectType,$attrValue='dn') {
1582     if ((!$attr)||(!$objectType)) {
1583       LSerror :: addErrorCode('LSrelations_05','updateObjectsInRelation');
1584       return;
1585     }
1586     $currentObjects = $this -> listObjectsInRelation($object,$attr,$objectType,$attrValue);
1587     $type=$this -> getType();
1588     if(is_array($currentObjects)) {
1589       if (is_array($listDns)) {
1590         $values=array();
1591         if ($attrValue!='dn') {
1592           $obj=new $objectType();
1593           foreach ($listDns as $dn) {
1594             $obj -> loadData($dn);
1595             $val = $obj -> getValue($attrValue);
1596             $values[$dn] = $val[0];
1597           }
1598         }
1599         else {
1600           foreach($listDns as $dn) {
1601             $values[$dn] = $dn;
1602           }
1603         }
1604         $dontDelete=array();
1605         $dontAdd=array();
1606         for ($i=0;$i<count($currentObjects);$i++) {
1607           if ($attrValue=='dn') {
1608             $val = $currentObjects[$i] -> getDn();
1609           }
1610           else {
1611             $val = $currentObjects[$i] -> getValue($attrValue);
1612             $val = $val[0];
1613           }
1614           if (in_array($val, $listDns)) {
1615             $dontDelete[$i]=true;
1616             $dontAdd[]=$val;
1617           }
1618         }
1619         
1620         for($i=0;$i<count($currentObjects);$i++) {
1621           if ($dontDelete[$i]) {
1622             continue;
1623           }
1624           else {
1625             if (!$currentObjects[$i] -> deleteOneObjectInRelation($object,$attr,$objectType,$attrValue)) {
1626               return;
1627             }
1628           }
1629         }
1630         
1631         foreach($values as $dn => $val) {
1632           if (in_array($val,$dontAdd)) {
1633             continue;
1634           }
1635           else {
1636             $obj = new $type();
1637             if ($obj -> loadData($dn)) {
1638               if (!$obj -> addOneObjectInRelation($object,$attr,$objectType,$attrValue)) {
1639                 return;
1640               }
1641             }
1642             else {
1643               return;
1644             }
1645           }
1646         }
1647         return true;
1648       }
1649     }
1650     else {
1651       if(!is_array($listDns)) {
1652         return true;
1653       }
1654       foreach($listDns as $dn) {
1655         $obj = new $type();
1656         if ($obj -> loadData($dn)) {
1657           if (!$obj -> addOneObjectInRelation($object,$attr,$objectType,$attrValue)) {
1658             return;
1659           }
1660         }
1661         else {
1662           return;
1663         }
1664       }
1665     }
1666   }
1667   
1668 }
1669
1670 /**
1671  * Error Codes
1672  **/
1673 LSerror :: defineError('LSldapObject_01',
1674 _("LSldapObject : Object type unknow.")
1675 );
1676 LSerror :: defineError('LSldapObject_02',
1677 _("LSldapObject : Update form is not defined for the object %{obj}.")
1678 );
1679 LSerror :: defineError('LSldapObject_03',
1680 _("LSldapObject : No form exist for the object %{obj}.")
1681 );
1682 LSerror :: defineError('LSldapObject_04',
1683 _("LSldapObject : The function %{func} to validate the attribute %{attr} the object %{obj} is unknow.")
1684 );
1685 LSerror :: defineError('LSldapObject_05',
1686 _("LSldapObject : Configuration data are missing to validate the attribute %{attr} of the object %{obj}.")
1687 );
1688 /* No longer used
1689 LSerror :: defineError(26,
1690 _("LSldapObject : Configuration error : The object %{obj} doesn't had attribute %{attr}.")
1691 );
1692 */
1693 LSerror :: defineError('LSldapObject_07',
1694 _("LSldapObject : The function %{func} to be executed before changing the object doesn't exist.")
1695 );
1696 LSerror :: defineError('LSldapObject_08',
1697 _("LSldapObject : The execution of the function %{func} to be executed before changing the object failed.")
1698 );
1699 LSerror :: defineError('LSldapObject_09',
1700 _("LSldapObject : The function %{func} to be executed after changing the object doesn't exist.")
1701 );
1702 LSerror :: defineError('LSldapObject_10',
1703 _("LSldapObject : The execution of the function %{func} to be executed after changing the object failed.")
1704 );
1705 LSerror :: defineError('LSldapObject_11',
1706 _("LSldapObject : Some configuration data of the object type %{obj} are missing to generate the DN of the new object.")
1707 );
1708 LSerror :: defineError('LSldapObject_12',
1709 _("LSldapObject : The attibute %{attr} of the object is not yet defined. Impossible to generate DN.")
1710 );
1711 LSerror :: defineError('LSldapObject_13',
1712 _("LSldapObject : Without DN, the object could not be changed.")
1713 );
1714 LSerror :: defineError('LSldapObject_14',
1715 _("LSldapObject : The attribute %{attr_depend} depending on the attribute %{attr} doesn't exist.")
1716 );
1717 LSerror :: defineError('LSldapObject_15',
1718 _("LSldapObject : Error during deleting the object %{objectname}.")
1719 );
1720 LSerror :: defineError('LSldapObject_16',
1721 _("LSldapObject : Error during actions to be executed before renaming the objet.")
1722 );
1723 LSerror :: defineError('LSldapObject_17',
1724 _("LSldapObject : Error during actions to be executed after renaming the objet.")
1725 );
1726 LSerror :: defineError('LSldapObject_18',
1727 _("LSldapObject : Error during actions to be executed before deleting the objet.")
1728 );
1729 LSerror :: defineError('LSldapObject_19',
1730 _("LSldapObject : Error during actions to be executed after deleting the objet.")
1731 );
1732 // 20 : not used
1733 LSerror :: defineError('LSldapObject_21',
1734 _("LSldapObject : Error during the actions to be executed after creating the object. It was created anyway.")
1735 );
1736 LSerror :: defineError('LSldapObject_22',
1737 _("LSldapObject : The function %{func} to be generated before creating the object doesn't exist.")
1738 );
1739 LSerror :: defineError('LSldapObject_23',
1740 _("LSldapObject : Error during the execution of the function %{func} to be generated after deleting the object.")
1741 );
1742 LSerror :: defineError('LSldapObject_24',
1743 _("LSldapObject : The function %{func} to be generated after deleting the object doesn't exist.")
1744 );
1745 LSerror :: defineError('LSldapObject_25',
1746 _("LSldapObject : Error during the execution of the function %{func} to be generated after creating the object.")
1747 );
1748 /* Not yet used
1749 LSerror :: defineError(306,
1750 _("LSldapObject : The function %{func} to be executed after changing the attribute %{attr} is unknow.")
1751 );
1752 LSerror :: defineError(307,
1753 _("LSldapObject : The execution of the function %{func} to be executed after changing the attribute %{attr} failed.")
1754 );
1755 LSerror :: defineError(308,
1756 _("LSldapObject : The function %{func} to be executed before changing the attribute %{attr} is unknow.")
1757 );
1758 LSerror :: defineError(309,
1759 _("LSldapObject : The execution of the function %{func} to be executed before changing the attribute %{attr} failed.")
1760 );
1761 */
1762 ?>