- LSldapObject : Correction d'un bug dans l'interprétation d'un rename
[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 $GLOBALS['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 $_relationsCache=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         $GLOBALS['LSerror'] -> addErrorCode(21);
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 = $GLOBALS['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 = $GLOBALS['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 getDisplayAttributes() {
128     return $this -> config['select_display_attrs'];
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 getDisplayValue($spe='',$full=false) {
146     if ($spe=='') {
147       $spe = $this -> getDisplayAttributes();
148     }
149     $val = $this -> getFData($spe,&$this -> attrs,'getDisplayValue');
150     if ($GLOBALS['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     $GLOBALS['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 -> getValue($attr_name))) {
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     $GLOBALS['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         $GLOBALS['LSerror'] -> addErrorCode(22,$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         $GLOBALS['LSerror'] -> addErrorCode(23,$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       debug("les données sont validées");
307       if(isset($this -> config['before_save'])) {
308         if(function_exists($this -> config['before_save'])) {
309           if(!$this -> config['before_save']($this)) {
310             $GLOBALS['LSerror'] -> addErrorCode(28,$this -> config['before_save']);
311             return;
312           }
313         }
314         else {
315           $GLOBALS['LSerror'] -> addErrorCode(27,$this -> config['before_save']);
316           return;
317         }
318       }
319       if ($this -> submitChange($idForm)) {
320         debug('Les modifications sont submitées');
321         $this -> submitError = false;
322         $this -> reloadData();
323         $this -> refreshForm($idForm);
324       }
325       else {
326         return;
327       }
328       if((isset($this -> config['after_save']))&&(!$this -> submitError)) {
329         if(function_exists($this -> config['after_save'])) {
330           if(!$this -> config['after_save']($this)) {
331             $GLOBALS['LSerror'] -> addErrorCode(30,$this -> config['after_save']);
332             return;
333           }
334         }
335         else {
336           $GLOBALS['LSerror'] -> addErrorCode(29,$this -> config['after_save']);
337           return;
338         }
339       }
340       return true;
341     }
342     else {
343       return;
344     }
345   }
346   
347   /**
348    * Valide les données retournées par un formulaire
349    *
350    * @param[in] $idForm Identifiant du formulaire d'origine
351    *
352    * @author Benjamin Renard <brenard@easter-eggs.com>
353    *
354    * @retval boolean true si les données sont valides, false sinon
355    */ 
356   function validateAttrsData($idForm) {
357     $LSform=$this -> forms[$idForm][0];
358     foreach($this -> attrs as $attr) {
359       if (!$attr -> isValidate()) {
360         if($attr -> isUpdate()) {
361           if (!$this -> validateAttrData($LSform, $attr)) {
362             return;
363           }
364         }
365         else if( ($attr -> getValue() == '') && ($attr -> isRequired()) ) { 
366           if ( $attr -> canBeGenerated()) {
367             if ($attr -> generateValue()) {
368               if (!$this -> validateAttrData($LSform, $attr)) {
369                 $GLOBALS['LSerror'] -> addErrorCode(48,$attr -> getLabel());
370                 return;
371               }
372             }
373             else {
374               $GLOBALS['LSerror'] -> addErrorCode(47,$attr -> getLabel());
375               return;
376             }
377           }
378           else {
379             $GLOBALS['LSerror'] -> addErrorCode(46,$attr -> getLabel());
380             return;
381           }
382
383         }
384       }
385     }
386     return true;
387   }
388
389    /**
390    * Valide les données d'un attribut
391    *
392    * @param[in] $LSForm Formulaire d'origine
393    * @param[in] &$attr Attribut à valider
394    *
395    * @author Benjamin Renard <brenard@easter-eggs.com>
396    *
397    * @retval boolean true si les données sont valides, false sinon
398    */
399   function validateAttrData(&$LSform,&$attr) {
400     $vconfig=$attr -> getValidateConfig();
401
402     $data=$attr -> getUpdateData();
403     if(!is_array($data)) {
404       $data=array($data);
405     }
406
407     // Validation des valeurs de l'attribut
408     if(is_array($vconfig)) {
409       foreach($vconfig as $test) {
410         // Définition du basedn par défaut
411         if (!isset($test['basedn'])) {
412           $test['basedn']=$GLOBALS['LSsession']->topDn;
413         }
414
415         // Définition du message d'erreur
416         if (!empty($test['msg'])) {
417           $msg_error=getFData($test['msg'],$this,'getValue');
418         }
419         else {
420           $msg_error=getFData(_("L'attribut %{attr} n'est pas valide."),$attr -> getLabel());
421         }
422         foreach($data as $val) {
423           // validation par check LDAP
424           if((isset($test['filter'])||isset($test['basedn']))&&(isset($test['result']))) {
425             $sparams=(isset($test['scope']))?array('scope' => $test['scope']):array();
426             $this -> other_values['val']=$val;
427             $sfilter_user=(isset($test['basedn']))?getFData($test['filter'],$this,'getValue'):NULL;
428             if(isset($test['object_type'])) {
429               $test_obj = new $test['object_type']();
430               $sfilter=$test_obj->getObjectFilter();
431               $sfilter='(&'.$sfilter;
432               if($sfilter_user[0]=='(') {
433                 $sfilter=$sfilter.$sfilter_user.')';
434               }
435               else {
436                 $sfilter=$sfilter.'('.$sfilter_user.'))';
437               }
438             }
439             else {
440               $sfilter=$sfilter_user;
441             }
442             $sbasedn=(isset($test['basedn']))?getFData($test['basedn'],$this,'getValue'):NULL;
443             $ret=$GLOBALS['LSldap'] -> getNumberResult ($sfilter,$sbasedn,$sparams);
444             if($test['result']==0) {
445               if($ret!=0) {
446                 $LSform -> setElementError($attr,$msg_error);
447                 return;
448               }
449             }
450             else {
451               if($ret<0) {
452                 $LSform -> setElementError($attr,$msg_error);
453                 return;
454               }
455             }
456           }
457           // Validation par fonction externe
458           else if(isset($test['function'])) {
459             if (function_exists($test['function'])) {
460               if(!$test['function']($this)) {
461                 $LSform -> setElementError($attr,$msg_error);
462               return;
463               }
464             }
465             else {
466               $GLOBALS['LSerror'] -> addErrorCode(24,array('attr' => $attr->name,'obj' => $this->getType(),'func' => $test['function']));
467               return;
468             }
469           }
470           else {
471             $GLOBALS['LSerror'] -> addErrorCode(25,array('attr' => $attr->name,'obj' => $this->getType()));
472             return;
473           }
474         }
475       }
476     }
477     // Génération des valeurs des attributs dépendants
478     $dependsAttrs=$attr->getDependsAttrs();
479     if (!empty($dependsAttrs)) {
480       foreach($dependsAttrs as $dependAttr) {
481         if(!isset($this -> attrs[$dependAttr])){
482           $GLOBALS['LSerror'] -> addErrorCode(34,array('attr_depend' => $dependAttr, 'attr' => $attr -> getLabel()));
483           continue;
484         }
485         if($this -> attrs[$dependAttr] -> canBeGenerated()) {
486           if (!$this -> attrs[$dependAttr] -> generateValue()) {
487             $GLOBALS['LSerror'] -> addErrorCode(47,$this -> attrs[$dependAttr] -> getLabel());
488             return;
489           }
490         }
491         else {
492           $GLOBALS['LSerror'] -> addErrorCode(46,$this -> attrs[$dependAttr] -> getLabel());
493           return;
494         }
495       }
496     }
497
498     $attr -> validate();
499     unset($this -> other_values['val']);
500     return true;
501   }
502
503   /**
504    * Met à jour les données modifiés dans l'annuaire
505    *
506    * @param[in] $idForm Identifiant du formulaire d'origine
507    *
508    * @author Benjamin Renard <brenard@easter-eggs.com>
509    *
510    * @retval boolean true si la mise à jour a réussi, false sinon
511    */ 
512   function submitChange($idForm) {
513     $submitData=array();
514     foreach($this -> attrs as $attr) {
515       if(($attr -> isUpdate())&&($attr -> isValidate())) {
516         if(($attr -> name == $this -> config['rdn'])&&(!$this -> isNew())) {
517           debug('Rename');
518           if (!$this -> beforeRename()) {
519             $GLOBALS['LSerror'] -> addErrorCode(36);
520             return;
521           }
522           $oldDn = $this -> getDn();
523           $this -> dn = false;
524           $newDn = $this -> getDn();
525           if ($newDn) {
526             if (!$GLOBALS['LSldap'] -> move($oldDn,$newDn)) {
527               return;
528             }
529             if (!$this -> afterRename($oldDn,$newDn)) {
530               $GLOBALS['LSerror'] -> addErrorCode(37);
531               return;
532             }
533           }
534           else {
535             return;
536           }
537         }
538         else {
539           $submitData[$attr -> name] = $attr -> getUpdateData();
540         }
541       }
542     }
543     if(!empty($submitData)) {
544       $dn=$this -> getDn();
545       if($dn) {
546         $this -> dn=$dn;
547         debug($submitData);
548         return $GLOBALS['LSldap'] -> update($this -> getType(),$dn, $submitData);
549       }
550       else {
551         $GLOBALS['LSerror'] -> addErrorCode(33);
552         return;
553       }
554     }
555     else {
556       return true;
557     }
558   }
559   
560   /**
561    * Retourne les informations issus d'un DN
562    *
563    * @param[in] $dn Un DN.
564    *
565    * @author Benjamin Renard <brenard@easter-eggs.com>
566    *
567    * @retval array Tableau : 
568    *                  - [0] : le premier paramètre
569    *                  - [1] : les paramètres suivants
570    */ 
571   function getDnInfos($dn) {
572     $infos=ldap_explode_dn($dn,0);
573     if(!$infos)
574       return;
575     $first=true;
576     for($i=1;$i<$infos['count'];$i++)
577       if($first) {
578         $basedn.=$infos[$i];
579         $first=false;
580       }
581       else
582         $basedn.=','.$infos[$i];
583     return array($infos[0],$basedn);
584   }
585   
586   /**
587    * Retourne le filtre correpondants aux objetcClass de l'objet
588    *
589    * @author Benjamin Renard <brenard@easter-eggs.com>
590    *
591    * @retval string le filtre ldap correspondant au type de l'objet
592    */ 
593   function getObjectFilter() {
594     if(!isset($this -> config['objectclass'])) return;
595     foreach ($this -> config['objectclass'] as $class)
596       $filter.='(objectClass='.$class.')';
597     return $filter;
598   }
599   
600   /**
601    * Retourne une liste d'objet du même type.
602    *
603    * Effectue une recherche en fonction des paramètres passé et retourne un
604    * tableau d'objet correspond au resultat de la recherche.
605    *
606    * @author Benjamin Renard <brenard@easter-eggs.com>
607    *
608    * @param[in] $filter array (ou string) Filtre de recherche Ldap / Tableau de filtres de recherche
609    * @param[in] $basedn string DN de base pour la recherche
610    * @param[in] $params array Paramètres de recherche au format Net_LDAP2::search()
611    *
612    * @retval array Tableau d'objets correspondant au resultat de la recherche
613    */ 
614   function listObjects($filter='',$basedn=NULL,$params=array()) {
615     $retInfos=array();
616     $attrs=false;
617     $check_final_dn=false;
618
619     if(!is_array($filter))
620       $filter=array(array('filter' => $filter));
621     
622     $nbFilter=count($filter);
623
624     for($i=0;$i<$nbFilter;$i++) {
625       $new_attrs=array();
626       // Défintion des paramètres de base pour la recherche
627       $sbasedn=$basedn;
628       $sparams=$params;
629       $ret=array();
630       if (isset($filter[$i]['scope']))
631         $sparams["scope"]=$filter[$i]['scope'];
632       
633       // Definition des critères de recherche correspondant au type d'objet à lister
634       if(($nbFilter==1)||(!isset($filter[$i]['attr']))) {
635         // Filtre sur l'objet souhaité
636         $sfilter='(&';
637         $sfilter.=$this -> getObjectFilter();
638         $sfilter_end=')';
639         $check_final_dn=true;
640       }
641       // Initialisation des critères d'une recherche intermédiaire
642       else {
643         if(isset($filter[$i]['object_type'])) {
644           $obj_tmp=new $filter[$i]['object_type']();
645           $obj_filter=$obj_tmp->getObjectFilter();
646           $sfilter='(&'.$obj_filter;
647           $sfilter_end=')';
648         }
649         else {
650           $sfilter='';
651           $sfilter_end='';
652         }
653         if(isset($filter[$i]['scope'])) {
654           $sparams['scope']=$filter[$i]['scope'];
655         }
656         if(isset($filter[$i]['basedn'])) {
657           $sbasedn=$filter[$i]['basedn'];
658         }
659       }
660       // Dans le cas d'une recherche intermédiaire ou finale
661       if($attrs!=false) {
662         // Initialisation des variables
663         $ret_gen=array();
664         $new_attrs=array();
665         
666         // Pour tout les attributs retournés
667         for($ii=0;$ii<count($attrs);$ii++) {
668           $sfilter_for='';
669           // Définition du filtre de recherche à partir des paramètres utilisateurs et
670           // des paramètres de recherche de l'objet à listé (dans le cas d'une recherche finale
671           if((isset($filter[$i]['filter']))&&(!empty($filter[$i]['filter']))) {
672             $sfilter_user=getFData($filter[$i]['filter'],$attrs[$ii]);
673             if($sfilter_user[0]=='(')
674               $sfilter_for=$sfilter.$sfilter_user;
675             else
676               $sfilter_for=$sfilter.'('.$sfilter_user.')';
677           }
678           else {
679             $sfilter_for=$sfilter;
680           }
681           
682           if(isset($filter[$i]['basedn'])) {
683             $sbasedn=getFData($filter[$i]['basedn'],$attrs[$ii]);
684             if ((!$this -> isCompatibleDNs($sbasedn,$basedn))&&($check_final_dn)) continue;
685           }
686         
687           // Vérification de la compatibilité du basedn de la recherche et du basedn générale
688           // Finalisation du filtre
689           $sfilter_for.=$sfilter_end;
690         
691         
692           // Execution de la recherche
693           $ret=$GLOBALS['LSldap'] -> search ($sfilter_for,$sbasedn,$sparams);
694           
695           // Si il y un retour
696           if(isset($ret[0])) {
697             // si il ya une suite (recherche intermédiaire)
698             if($filter[$i]['attr']){
699               for($iii=0;$iii<count($ret);$iii++) {
700                 if(isset($ret[$iii]['attrs'][$filter[$i]['attr']])) {
701                   // cas de valeur multiple
702                   if(is_array($ret[$iii]['attrs'][$filter[$i]['attr']])) {
703                     foreach($ret[$iii]['attrs'][$filter[$i]['attr']] as $val_attr) {
704                       $new_attrs[]=$val_attr;
705                     }
706                   }
707                   // cas de valeur unique
708                   else {
709                     $new_attrs[]=$ret[$iii]['attrs'][$filter[$i]['attr']];
710                   }
711                 }
712               }
713             }
714             else {
715               // vérification de la compatibilité de la compatibilité du DN resultant
716               // et du basedn de recherche 
717               if (!$this -> isCompatibleDNs($ret[0]['dn'],$basedn))
718                 continue;
719               // ajout du DN au resultat finale
720               $ret_gen[]=$ret[0]['dn'];
721             }
722           }
723         }
724         // cas du dernier filtre
725         if(!empty($ret_gen)) {
726           // on quitte la boucle des filtres de la conf
727           $ret=$ret_gen;
728           break;
729         }
730         // dans le cas d'une suite prévu mais d'un retour nul de la précédente recherche
731         else if(empty($new_attrs)) {
732             // retour vide et arrêt de la recherche
733             $ret=array();
734             break;
735         }
736         else {
737           $attrs=$new_attrs;
738         }
739       }
740       // Dans le cas de la recherche initiale
741       else {
742         // Déclaration du filtre de recherche
743         if((isset($filter[$i]['filter']))&&(!empty($filter[$i]['filter']))) {
744           if($filter[$i]['filter'][0]=='(') {
745             $sfilter.=$filter[$i]['filter'];
746           }
747           else {
748             $sfilter.='('.$filter[$i]['filter'].')';
749           }
750         }
751         // fermeture du filtre
752         $sfilter.=$sfilter_end;
753         
754         // Lancement de la recherche
755         $ret=$GLOBALS['LSldap'] -> search ($sfilter,$sbasedn,$sparams);
756         
757         //Si filtre multiple => on recupère une liste d'attributs
758         if(isset($filter[$i]['attr'])) {
759           for($ii=0;$ii<count($ret);$ii++) {
760             if(isset($ret[$ii]['attrs'][$filter[$i]['attr']])) {
761               // cas de valeur multiple
762               if(is_array($ret[$ii]['attrs'][$filter[$i]['attr']])) {
763                 foreach($ret[$ii]['attrs'][$filter[$i]['attr']] as $val_attr) {
764                   $attrs[]=$val_attr;
765                 }
766               }
767               // cas de valeur unique
768               else {
769                 $attrs[]=$ret[$ii]['attrs'][$filter[$i]['attr']];
770               }
771             }
772           }
773           
774           // Si aucunne valeur n'est retournées
775           if(empty($attrs)){
776             // arrêt et retour à zéro
777             $ret=array();
778             break;
779           }
780         }
781         // Si recherche unique
782         else {
783           // préparation du retour finale
784           if (is_array($ret)) {
785             $ret_final=array();
786             foreach($ret as $obj)
787               $ret_final[]=$obj['dn'];
788             $ret=$ret_final;
789           }
790           else {
791             $ret=array();
792           }
793           break;
794         }
795       }
796     }
797     
798     // Création d'un tableau d'objet correspondant au valeur retourné
799     for($i=0;$i<count($ret);$i++) {
800       $retInfos[$i] = new $this -> type_name($this -> config);
801       $retInfos[$i] -> loadData($ret[$i]);
802     }
803     
804     return $retInfos;
805   }
806  
807  
808   /**
809    * Recherche un objet à partir de la valeur exact de son RDN
810    * 
811    * @author Benjamin Renard <brenard@easter-eggs.com>
812    * 
813    * @param[in] $name string Valeur de son RDN
814    * @param[in] $basedn string Le DN de base de la recherche
815    * 
816    * @retval array Tableau d'objets correspondant au resultat de la recherche
817    */
818   function searchObject($name,$basedn=NULL) {
819     $filter = $this -> config['rdn'].'='.$name; 
820     return $this -> listObjects($filter,$basedn); 
821   }
822
823   /**
824    * Retourne une valeur de l'objet
825    *
826    * Retourne une valeur en fonction du paramètre. Si la valeur est inconnue, la valeur retourné est ' '.
827    * tableau d'objet correspond au resultat de la recherche.
828    *
829    * Valeurs possibles :
830    * - 'dn' ou '%{dn} : DN de l'objet
831    * - [nom d'un attribut] : valeur de l'attribut
832    * - [clef de $this -> other_values] : valeur de $this -> other_values
833    *
834    * @author Benjamin Renard <brenard@easter-eggs.com>
835    *
836    * @param[in] $val string Le nom de la valeur demandée
837    *
838    * @retval mixed la valeur demandé ou ' ' si celle-ci est inconnue.
839    */ 
840   function getValue($val) {
841     if(($val=='dn')||($val=='%{dn}')) {
842       return $this -> dn;
843     }
844     else if(($val=='rdn')||($val=='%{rdn}')) {
845       return $this -> attrs[ $this -> config['rdn'] ] -> getValue();
846     }
847     else if(($val=='subDn')||($val=='%{subDn}')) {
848       return $this -> getSubDnValue();
849     }
850     else if(($val=='subDnName')||($val=='%{subDnName}')) {
851       return $this -> getSubDnName();
852     }
853     else if(isset($this ->  attrs[$val])){
854       if (method_exists($this ->  attrs[$val],'getValue'))
855         return $this -> attrs[$val] -> getValue();
856       else
857         return ' ';
858     }
859     else if(isset($this -> other_values[$val])){
860       return $this -> other_values[$val];
861     }
862     else {
863       return ' ';
864     }
865   }
866
867   /**
868    * Retourn un tableau pour un select d'un objet du même type
869    * 
870    * @author Benjamin Renard <brenard@easter-eggs.com>
871    *
872    * @retval array('dn' => 'display')
873    */
874   function getSelectArray($topDn=NULL) {
875     $list = $this -> listObjects(NULL,$topDn);
876     $return=array();
877     foreach($list as $object) {
878       $return[$object -> getDn()] = $object -> getDisplayValue(); 
879     }
880     return $return;
881   }
882
883   /**
884    * Retourne le DN de l'objet
885    *
886    * Cette methode retourne le DN de l'objet. Si celui-ci n'existe pas, il le construit à partir de la 
887    * configuration de l'objet et la valeur de son attribut rdn.
888    *
889    * @author Benjamin Renard <brenard@easter-eggs.com>
890    *
891    * @retval string Le DN de l'objet
892    */   
893   function getDn() {
894     if($this -> dn) {
895       return $this -> dn;
896     }
897     else {
898       $rdn_attr=$this -> config['rdn'];
899       if( (isset($this -> config['rdn'])) && (isset($this -> attrs[$rdn_attr])) && (isset($this -> config['container_dn'])) && (isset($GLOBALS['LSsession']->topDn)) ) {
900         $rdn_val=$this -> attrs[$rdn_attr] -> getUpdateData();
901         if (!empty($rdn_val)) {
902           return $rdn_attr.'='.$rdn_val[0].','.$this -> config['container_dn'].','.$GLOBALS['LSsession']->topDn;
903         }
904         else {
905           $GLOBALS['LSerror'] -> addErrorCode(32,$this -> config['rdn']);
906           return;
907         }
908       }
909       else {
910         $GLOBALS['LSerror'] -> addErrorCode(31,$this -> getType());
911         return;
912       }
913     }
914   }
915
916   /**
917    * Retourne le type de l'objet
918    *
919    * @author Benjamin Renard <brenard@easter-eggs.com>
920    * 
921    * @retval string Le type de l'objet ($this -> type_name)
922    */
923   function getType() {
924     return $this -> type_name;
925   }
926   
927   /**
928    * Retourne qui est l'utilisateur par rapport à cet object
929    *
930    * @author Benjamin Renard <brenard@easter-eggs.com>
931    * 
932    * @retval string 'admin'/'self'/'user' pour Admin , l'utilisateur lui même ou un simple utilisateur
933    */
934   function whoami() {
935     if (!$this -> _whoami)
936       $this -> _whoami = $GLOBALS['LSsession'] -> whoami($this -> dn);
937     return $this -> _whoami;
938   }
939   
940   /**
941    * Retourne le label de l'objet
942    *
943    * @author Benjamin Renard <brenard@easter-eggs.com>
944    * 
945    * @retval string Le label de l'objet ($this -> config['label'])
946    */
947   function getLabel() {
948     return $this -> config['label'];
949   }
950   
951   
952   /**
953    * Supprime l'objet dans l'annuaire
954    *
955    * @author Benjamin Renard <brenard@easter-eggs.com>
956    * 
957    * @retval boolean True si l'objet à été supprimé, false sinon
958    */
959   function remove() {
960     return $GLOBALS['LSldap'] -> remove($this -> getDn());
961   }
962   
963   /**
964    * L'objet est-il nouveau
965    * 
966    * @author Benjamin Renard <brenard@easter-eggs.com>
967    * 
968    * @retval boolean True si l'objet est nouveau, false sinon
969    */
970   function isNew() {
971     return (!$this -> dn);
972   }
973
974   /**
975    * Retourne la valeur (DN) du subDn de l'objet  
976    * 
977    * @return string La valeur du subDn de l'object
978    */
979   function getSubDnValue() {
980     if ($this -> _subDn_value) {
981       return $this -> _subDn_value;
982     }
983     $dn = $this -> getValue('dn');
984     $subDn_value='';
985     $subDnLdapServer = $GLOBALS['LSsession'] -> getSortSubDnLdapServer();
986     foreach ($subDnLdapServer as $subDn => $subDn_name) {
987       if (isCompatibleDNs($subDn,$dn)&&($subDn!=$dn)) {
988         $subDn_value=$subDn;
989         break;
990       }
991     }
992     $this -> _subDn_value = $subDn_value;
993     return $subDn_value;
994   }
995
996   /**
997    * Retourne la nom du subDn de l'objet  
998    * 
999    * @return string Le nom du subDn de l'object
1000    */
1001   function getSubDnName() {
1002     $subDnLdapServer = $GLOBALS['LSsession'] -> getSortSubDnLdapServer();
1003     return $subDnLdapServer[$this -> getSubDnValue()];
1004   }
1005   
1006   /**
1007    * Methode executant les actions nécéssaires avant le changement du DN de
1008    * l'objet.
1009    * 
1010    * Cette méthode n'est qu'un exemple et elle doit être certainement réécrite
1011    * pour les objets plus complexe.
1012    * 
1013    * @retval True en cas de cas ce succès, False sinon.
1014    */
1015   function beforeRename() {
1016     if (is_array($this->config['relations'])) {
1017       foreach($this->config['relations'] as $relation_name => $relation_conf) {
1018         if ( isset($relation_conf['list_function']) && isset($relation_conf['rename_function']) ) {
1019           if ($GLOBALS['LSsession'] -> loadLSobject($relation_conf['LSobject'])) {
1020             $obj = new $relation_conf['LSobject']();
1021             if (method_exists($obj,$relation_conf['list_function'])) {
1022               $list = $obj -> $relation_conf['list_function']($this);
1023               if (is_array($list)) {
1024                 $this -> _relationsCache[$relation_name] = $list; 
1025               }
1026               else {
1027                 return;
1028               }
1029             }
1030             else {
1031               return;
1032             }
1033           }
1034           else {
1035             return;
1036           }
1037         }
1038       }
1039     }
1040     return true;
1041   }
1042   
1043   /**
1044    * Methode executant les actions nécéssaires après le changement du DN de
1045    * l'objet.
1046    * 
1047    * Cette méthode n'est qu'un exemple et elle doit être certainement réécrite
1048    * pour les objets plus complexe.
1049    * 
1050    * @param[in] $oldDn string L'ancien DN de l'objet
1051    * @param[in] $newDn string Le nouveau DN de l'objet
1052    * 
1053    * @retval True en cas de cas ce succès, False sinon.
1054    */
1055   function afterRename($oldDn,$newDn) {
1056     $error = 0;
1057     if($GLOBALS['LSsession'] -> dn == $oldDn) {
1058       $GLOBALS['LSsession'] -> changeAuthUser($this);
1059     }
1060     
1061     foreach($this -> _relationsCache as $relation_name => $objList) {
1062       foreach($objList as $obj) {
1063         $meth = $this->config['relations'][$relation_name]['rename_function'];
1064         if (method_exists($obj,$meth)) {
1065           if (!($obj -> $meth($this,$oldDn))) {
1066             $error=1;
1067           }
1068         }
1069         else {
1070           $error=1;
1071         }
1072       }
1073     }
1074     return !$error;
1075   }
1076 }
1077
1078 ?>