7581563e2739801e8e4191535da661094883c23e
[ldapsaisie.git] / trunk / includes / class / class.LSattribute.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('LSattr_ldap');
24 LSsession :: loadLSclass('LSattr_html');
25
26 /**
27  * Attribut Ldap
28  *
29  * Cette classe modélise un attribut Ldap
30  *
31  * @author Benjamin Renard <brenard@easter-eggs.com>
32  */
33 class LSattribute {
34   
35   var $name;
36   var $config;
37   var $ldapObject;
38   var $ldap;
39   var $html;
40   var $data;
41   var $updateData=false;
42   var $is_validate=false;
43   var $_finalUpdateData=false;
44   var $_myRights=NULL;
45   var $_events=array();
46   var $_objectEvents=array();
47   
48   /**
49    * Constructeur
50    *
51    * Cette methode construit l'objet et définis la configuration.
52    * Elle lance la construction des objets LSattr_html et LSattr_ldap correspondant
53    * à ses types définis définis dans sa configuration
54    *
55    * @author Benjamin Renard <brenard@easter-eggs.com>
56    *
57    * @param[in] $name string Nom de l'attribut ldap
58    * @param[in] $config array Configuration de l'objet
59    * @param[in] &$ldapObject LSldapObject L'objet ldap parent
60    *
61    * @retval boolean Retourne true si la création a réussi, false sinon.
62    */ 
63   function LSattribute ($name,$config,&$ldapObject) {
64     $this -> name = $name;
65     $this -> config = $config;
66     $this -> ldapObject = $ldapObject;
67     $html_type = "LSattr_html_".$config['html_type'];
68     $ldap_type = "LSattr_ldap_".$config['ldap_type'];
69     LSsession :: loadLSclass($html_type);
70     LSsession :: loadLSclass($ldap_type);
71     if((class_exists($html_type))&&(class_exists($ldap_type))) {
72       $this -> html = new $html_type($name,$config,$this);
73       $this -> ldap = new $ldap_type($name,$config,$this);
74     }
75     else {
76       LSerror :: addErrorCode('LSattribute_01',array('attr' => $name,'html'=>$config['html_type'],'ldap'=>$config['ldap_type']));
77       return;
78     }
79     return true;
80   }
81   
82   
83   /**
84    * Retourne la valeur du label de l'attribut
85    *
86    * @author Benjamin Renard <brenard@easter-eggs.com>
87    *
88    * @retval string Le label de l'attribut
89    *
90    * @see LSattr_html::getLabel()
91    */ 
92
93   function getLabel() {
94     if (!$this -> html) {
95       LSerror :: addErrorCode('LSattribute_09',array('type' => 'html','name' => $this -> name));
96       return;
97     }
98     return $this -> html -> getLabel();
99   }
100   
101   /**
102    * Défini la valeur de l'attribut
103    *
104    * @author Benjamin Renard <brenard@easter-eggs.com>
105    *
106    * @retval boolean true
107    */
108   function loadData($attr_data) {
109     if ((!is_array($attr_data))&&(!empty($attr_data))) {
110       $attr_data = array($attr_data);
111     }
112     $this -> data = $attr_data;
113     return true;
114   }
115   
116   /**
117    * Redéfini la valeur de l'attribut
118    *
119    * @author Benjamin Renard <brenard@easter-eggs.com>
120    *
121    * @retval boolean true
122    */
123   function reloadData($attr_data) {
124     if ((!is_array($attr_data))&&(!empty($attr_data))) {
125       $attr_data = array($attr_data);
126     }
127     $this -> data = $attr_data;
128     $this -> updateData=false;
129     $this -> is_validate=false;
130     return true;
131   }
132   
133   /**
134    * Retourne la valeur de l'attribut
135    *
136    * Retourne la valeur nouvelle si elle existe, sinon la valeur passé.
137    *
138    * @author Benjamin Renard <brenard@easter-eggs.com>
139    *
140    * @retval mixed La valeur de l'attribut
141    */
142   function getValue() {
143     $updateData=$this -> getUpdateData();
144     if (empty($updateData)) {
145       return $this -> data;
146     }
147     else {
148       return $updateData;
149     }
150   }
151   
152   /**
153    * Retourne la valeur d'affichage de l'attribut
154    *
155    * @author Benjamin Renard <brenard@easter-eggs.com>
156    *
157    * @retval string La valeur d'affichage de l'attribut
158    */
159   function getDisplayValue() {
160     if (!$this -> ldap) {
161       LSerror :: addErrorCode('LSattribute_09',array('type' => 'ldap','name' => $this -> name));
162       return;
163     }
164     $data = $this -> ldap -> getDisplayValue($this -> data);
165     if ($this -> config['onDisplay']) {
166       if (is_array($this -> config['onDisplay'])) {
167         $result=$data;
168         foreach($this -> config['onDisplay'] as $func) {
169           if (function_exists($func)) {
170             $result=$func($result);
171           }
172           else {
173             LSerror :: addErrorCode('LSattribute_02',array('attr' => $this->name,'func' => $func));
174             return;
175           }
176         }
177         return $result;
178       }
179       else {
180         if (function_exists($this -> config['onDisplay'])) {
181           return $this -> config['onDisplay']($data);
182         }
183         else {
184           LSerror :: addErrorCode('LSattribute_02',array('attr' => $this->name,'func' => $this -> config['onDisplay']));
185           return;
186         }
187       }
188     }
189     return $data;
190   }
191   
192   /**
193    * Ajoute l'attribut au formulaire
194    *
195    * Cette méthode ajoute l'attribut au formulaire $form si l'identifiant de celui-ci
196    * ($idForm) est connu dans la configuration de l'objet.
197    *
198    * @author Benjamin Renard <brenard@easter-eggs.com>
199    *
200    * @param[in] object $form Le formulaire dans lequel doit être ajouté l'attribut
201    * @param[in] string $idForm L'identifiant du formulaire
202    * @param[in] objet  &$obj Objet utilisable pour la génération de la valeur de l'attribut
203    * @param[in] array  $value valeur de l'élement
204    *
205    * @retval boolean true si l'ajout a fonctionner ou qu'il n'est pas nécessaire, false sinon
206    */
207   function addToForm(&$form,$idForm,&$obj=NULL,$value=NULL) {
208     if(isset($this -> config['form'][$idForm])) {
209       if (!$this -> html) {
210         LSerror :: addErrorCode('LSattribute_09',array('type' => 'html','name' => $this -> name));
211         return;
212       }
213       if($this -> myRights() == 'n') {
214         return true;
215       }
216       if ($value) {
217         $data = $value;
218       }
219       else if($this -> data !='') {
220         $data=$this -> getFormVal();
221       }
222       else if (isset($this -> config['default_value'])) {
223         $data=$obj -> getFData($this -> config['default_value']);
224       }
225       
226       $element = $this -> html -> addToForm($form,$idForm,$data);
227       if(!$element) {
228         LSerror :: addErrorCode('LSform_06',$this -> name);
229       }
230
231       if($this -> config['required']==1) {
232         $form -> setRequired($this -> name);
233       }
234
235       if (($this -> config['form'][$idForm]==0) || ($this -> myRights() == 'r')) {
236         $element -> freeze();
237       }
238       else {
239         if(isset($this -> config['check_data'])) {
240           if(is_array($this -> config['check_data'])) {
241             foreach ($this -> config['check_data'] as $rule => $rule_infos) {
242               if((!$form -> isRuleRegistered($rule))&&($rule!='')) {
243                 LSerror :: addErrorCode('LSattribute_03',array('attr' => $this->name,'rule' => $rule));
244                 return;
245               }
246               if(!isset($rule_infos['msg']))
247                 $rule_infos['msg']=getFData(_('La valeur du champs %{label} est invalide.'),$this -> config['label']);
248               if(!isset($rule_infos['params']))
249                 $rule_infos['params']=NULL;
250               $form -> addRule($this -> name,$rule,array('msg' => $rule_infos['msg'], 'params' => $rule_infos['params']));
251             }
252           }
253           else {
254             LSerror :: addErrorCode('LSattribute_04',$this->name);
255           }
256         }
257       } 
258     }
259     return true;
260   }
261
262   /**
263    * Récupération des droits de l'utilisateur sur l'attribut
264    * 
265    * @retval string 'r'/'w'/'n' pour 'read'/'write'/'none'
266    **/
267   function myRights() {
268     // cache
269     if ($this -> _myRights != NULL) {
270       return $this -> _myRights;
271     }
272     $return='n';
273     $whoami = $this -> ldapObject -> whoami();
274     foreach($whoami as $who) {
275       switch ($who) {
276         case 'admin':
277           if($this -> config['rights']['admin']=='w') {
278             $return='w';
279             break;
280           }
281           else {
282             $return='r';
283           }
284           break;
285         default:
286           if ($this -> config['rights'][$who] == 'w') {
287             $return='w';
288             break;
289           }
290           else if($this -> config['rights'][$who] == 'r') {
291             $return='r';
292           }
293           break;
294       }
295       if ($return=='w') {
296         break;
297       }
298     }
299     $this -> _myRights = $return;
300     return $return;
301   }
302
303   /**
304    * Ajoute l'attribut au formualaire de vue
305    *
306    * Cette méthode ajoute l'attribut au formulaire $form de vue si il doit l'être
307    *
308    * @author Benjamin Renard <brenard@easter-eggs.com>
309    *
310    * @param[in] object $form Le formulaire dans lequel doit être ajouté l'attribut
311    *
312    * @retval boolean true si l'ajout a fonctionner ou qu'il n'est pas nécessaire, false sinon
313    */
314   function addToView(&$form) {
315     if((isset($this -> config['view'])) && ($this -> myRights() != 'n') ) {
316       if (!$this -> html) {
317         LSerror :: addErrorCode('LSattribute_09',array('type' => 'html','name' => $this -> name));
318         return;
319       }
320       if($this -> data !='') {
321         $data=$this -> getFormVal();
322       }
323       else {
324         $data='';
325       }
326       $element = $this -> html -> addToForm($form,'view',$data);
327       if(!$element instanceof LSformElement) {
328         LSerror :: addErrorCode('LSform_06',$this -> name);
329         return;
330       }
331       $element -> freeze();
332       return true;
333     }
334     return true;
335   }
336   
337   /**
338    * Rafraichis la valeur de l'attribut dans un formualaire
339    *
340    * @author Benjamin Renard <brenard@easter-eggs.com>
341    *
342    * @param[in] object &$form LSform Le formulaire dans lequel doit être ajouté l'attribut
343    * @param[in] string $idForm L'identifiant du formulaire
344    *
345    * @retval boolean true si la valeur a été rafraichie ou que ce n'est pas nécessaire, false sinon
346    */
347   function refreshForm(&$form,$idForm) {
348     if(isset($this -> config['form'][$idForm])&&($this -> myRights()!='n')) {
349       if (!$this -> html) {
350         LSerror :: addErrorCode('LSattribute_09',array('type' => 'html','name' => $this -> name));
351         return;
352       }
353       $form_element = $form -> getElement($this -> name);
354       if ($form_element) {
355         $values = $this -> html -> refreshForm($this -> getFormVal());
356         return $form_element -> setValue($values);
357       }
358       else {
359         LSdebug('LSformElement "'.$this -> name.'" n\'existe pas');
360       }
361     }
362     return true;
363   }
364   
365   /**
366    * Retourne la valeur a afficher dans le formulaire
367    *
368    * @author Benjamin Renard <brenard@easter-eggs.com>
369    *
370    * @retval string La valeur a afficher dans le formulaire.
371    */
372   function getFormVal() {
373     $data=$this -> getDisplayValue();
374     if ($data==NULL) {
375       $data=array();
376     }
377     if(!is_array($data)) {
378       $data=array($data);
379     }
380     return $data;
381   }
382   
383   /**
384    * Définis les données de mises à jour si un changement a eut lieu
385    *
386    * @author Benjamin Renard <brenard@easter-eggs.com>
387    *
388    * @param[in] string $data Les données de mise à jour.
389    *
390    * @retval void
391    */
392   function setUpdateData($data) {
393     if($this -> getFormVal() != $data) {
394       $this -> updateData=$data;
395     }
396   }
397   
398   /**
399    * Vérifie si l'attribut a été validé
400    *
401    * @author Benjamin Renard <brenard@easter-eggs.com>
402    *
403    * @retval boolean true si l'attribut a été validé, false sinon
404    */
405   function isValidate() {
406     return $this -> is_validate;
407   }
408   
409   /**
410    * Valide le champs
411    *
412    * @author Benjamin Renard <brenard@easter-eggs.com>
413    *
414    * @retval void
415    */
416   function validate() {
417     $this -> is_validate=true;
418   }
419   
420   /**
421    * Vérifie si l'attribut a été mise à jour
422    *
423    * @author Benjamin Renard <brenard@easter-eggs.com>
424    *
425    * @retval boolean true si l'attribut a été mis à jour, false sinon
426    */
427   function isUpdate() {
428     return ($this -> updateData===false)?false:true;
429   }
430   
431   /**
432    * Vérifie si l'attribut est obligatoire
433    *
434    * @author Benjamin Renard <brenard@easter-eggs.com>
435    *
436    * @retval boolean true si l'attribut est obligatoire, false sinon
437    */
438   function isRequired() {
439     return $this -> config['required'];
440   }
441   
442   /**
443    * Vérifie si la valeur de l'attribut peut être générée
444    *
445    * @author Benjamin Renard <brenard@easter-eggs.com>
446    *
447    * @retval boolean true si la valeur de l'attribut peut être générée, false sinon
448    */
449   function canBeGenerated() {
450     if (function_exists($this -> config['generate_function'])) {
451       return true;
452     }
453     else if (isset($this -> config['generate_value_format'])) {
454       return true;
455     }
456     else {
457       return ;
458     }
459   }
460
461   /**
462    * Génere la valeur de l'attribut à partir de la fonction de génération
463    *
464    * @author Benjamin Renard <brenard@easter-eggs.com>
465    *
466    * @retval boolean true si la valeur à put être générée, false sinon
467    */
468   function generateValue() {
469     if (function_exists($this -> config['generate_function'])) {
470       $value=call_user_func($this -> config['generate_function'],$this -> ldapObject);
471     }
472     else if (isset($this -> config['generate_value_format'])) {
473       $value = $this -> ldapObject -> getFData($this -> config['generate_value_format']);
474     }
475     if (!empty($value)) {
476       //$this -> setValue($value); // pas nécéssaire ??
477       $this -> updateData=array($value);
478       return true;
479     }
480     return;
481   }
482   
483   /**
484    * Retourne la valeur de l'attribut pour son enregistrement dans l'annuaire
485    * si l'attribut à été modifié.
486    *
487    * @author Benjamin Renard <brenard@easter-eggs.com>
488    *
489    * @retval mixed La valeur de l'attribut pour son enregistrement dans l'annuaire
490    */
491   function getUpdateData() {
492     if (!$this -> isUpdate()) {
493       return;
494     }
495     if ( $this -> _finalUpdateData ) {
496       return  $this -> _finalUpdateData;
497     }
498     $data=$this -> updateData;
499     if ($this -> config['onSave']) {
500       if (is_array($this -> config['onSave'])) {
501         $result=$data;
502         foreach($this -> config['onSave'] as $func) {
503           if (function_exists($func)) {
504             $result=$func($result);
505           }
506           else {
507             LSerror :: addErrorCode('LSattribute_05',array('attr' => $this->name,'func' => $func));
508             return;
509           }
510         }
511       }
512       else {
513         if (function_exists($this -> config['onSave'])) {
514           $result = $this -> config['onSave']($data);
515         }
516         else {
517           LSerror :: addErrorCode('LSattribute_05',array('attr' => $this->name,'func' => $this -> config['onSave']));
518           return;
519         }
520       }
521     }
522     else {
523       if (!$this -> ldap) {
524         LSerror :: addErrorCode('LSattribute_09',array('type' => 'ldap','name' => $this -> name));
525         return;
526       }
527       else {
528         $result = $this -> ldap -> getUpdateData($data);
529       }
530     }
531     $this -> _finalUpdateData = $result;
532     return $result;
533   }
534  
535   /**
536    * Retourne la configuration de validation de l'attribut
537    *
538    * @author Benjamin Renard <brenard@easter-eggs.com>
539    *
540    * @retval mixed La configuration de validation de l'attribut
541    */
542   function getValidateConfig() {
543     return $this -> config['validation'];
544   }
545
546   /**
547    * Retourne les attributs dépendants de celui-ci
548    *
549    * @author Benjamin Renard <brenard@easter-eggs.com>
550    *
551    * @retval array les noms des attributs dépendants
552    */
553   function getDependsAttrs() {
554     return $this -> config['dependAttrs'];
555   }
556
557   /**
558    * Ajouter une action lors d'un événement
559    * 
560    * @param[in] $event string Le nom de l'événement
561    * @param[in] $fct string Le nom de la fonction à exectuer
562    * @param[in] $params mixed Paramètres pour le lancement de la fonction
563    * @param[in] $class Nom de la classe possèdant la méthode $fct à executer
564    * 
565    * @retval void
566    */
567   function addEvent($event,$fct,$params,$class=NULL) {
568     $this -> _events[$event][] = array(
569       'function'  => $fct,
570       'params'    => $params,
571       'class'     => $class
572     );
573   }
574   
575   /**
576    * Ajouter une action sur un objet lors d'un événement
577    * 
578    * @param[in] $event string Le nom de l'événement
579    * @param[in] $obj object L'objet dont la méthode doit être executé
580    * @param[in] $meth string Le nom de la méthode
581    * @param[in] $params mixed Paramètres d'execution de la méthode
582    * 
583    * @retval void
584    */
585   function addObjectEvent($event,&$obj,$meth,$params=NULL) {
586     $this -> _objectEvents[$event][] = array(
587       'obj'  => $obj,
588       'meth'  => $meth,
589       'params'    => $params
590     );
591   }
592   
593   /**
594    * Lance les actions à executer lors d'un événement
595    * 
596    * @param[in] $event string Le nom de l'événement
597    * 
598    * @retval boolean True si tout c'est bien passé, false sinon
599    */
600   function fireEvent($event) {
601     $return = true;
602     if(isset($this -> config[$event])) {
603       if (!is_array($this -> config[$event])) {
604         $funcs = array($this -> config[$event]);
605       }
606       else {
607         $funcs = $this -> config[$event];
608       }
609       foreach($funcs as $func) {
610         if(function_exists($func)) {
611           if(!$func($this -> ldapObject)) {
612             $return = false;
613           }
614         }
615         else {
616           $return = false;
617         }
618       }
619     }
620     
621     if (is_array($this -> _events[$event])) {
622       foreach ($this -> _events[$event] as $e) {
623         if ($e['class']) {
624           if (class_exists($e['class'])) {
625             $obj = new $e['class']();
626             if (method_exists($obj,$e['fct'])) {
627               try {
628                 $obj -> $e['fct']($e['params']);
629               }
630               catch(Exception $er) {
631                 $return = false;
632                 LSdebug("Event ".$event." : Erreur durant l'execution de la méthode ".$e['fct']." de la classe ".$e['class']);
633               }
634             }
635             else {
636               LSdebug("Event ".$event." : La méthode ".$e['fct']." de la classe ".$e['class']." n'existe pas.");
637               $return = false;
638             }
639           }
640           else {
641             $return = false;
642             LSdebug("Event ".$event." : La classe ".$e['class']." n'existe pas");
643           }
644         }
645         else {
646           if (function_exists($e['fct'])) {
647             try {
648               $e['fct']($e['params']);
649             }
650             catch(Exception $er) {
651               LSdebug("Event ".$event." : Erreur durant l'execution de la function ".$e['fct']);
652               $return = false;
653             }
654           }
655           else {
656             LSdebug("Event ".$event." : la function ".$e['fct']." n'existe pas");
657             $return = false;
658           }
659         }
660       }
661     }
662     
663     if (is_array($this -> _objectEvents[$event])) {
664       foreach ($this -> _objectEvents[$event] as $e) {
665         if (method_exists($e['obj'],$e['meth'])) {
666           try {
667             $e['obj'] -> $e['meth']($e['params']);
668           }
669           catch(Exception $er) {
670             $return = false;
671             LSdebug("Event ".$event." : Erreur durant l'execution de la méthode ".$e['meth']." sur l'objet.");
672           }
673         }
674         else {
675           LSdebug("Event ".$event." : La méthode ".$e['meth']." de l'objet n'existe pas.");
676           $return = false;
677         }
678       }
679     }
680     
681     return $return;
682   }
683   
684 }
685
686 /**
687  * Error Codes
688  **/
689 $GLOBALS['LSerror_code']['LSattribute_01'] = array (
690   'msg' => _("LSattribute : Attribute %{attr} : LDAP or HTML types unknow (LDAP = %{ldap} & HTML = %{html}).")
691 );
692 $GLOBALS['LSerror_code']['LSattribute_02'] = array (
693   'msg' => _("LSattribute : The function %{func} to display the attribute %{attr} is unknow.")
694 );
695 $GLOBALS['LSerror_code']['LSattribute_03'] = array (
696   'msg' => _("LSattribute : The rule %{rule} to validate the attribute %{attr} is unknow.")
697 );
698 $GLOBALS['LSerror_code']['LSattribute_04'] = array (
699   'msg' => _("LSattribute : Configuration data to verify the attribute %{attr} are incorrect.")
700 );
701 $GLOBALS['LSerror_code']['LSattribute_05'] = array (
702   'msg' => _("LSattribute : The function %{func} to save the attribute %{attr} is unknow.")
703 );
704 $GLOBALS['LSerror_code']['LSattribute_06'] = array (
705   'msg' => _("LSattribute : The value of the attribute %{attr} can't be generated.")
706 );
707 $GLOBALS['LSerror_code']['LSattribute_07'] = array (
708   'msg' => _("LSattribute : Generation of the attribute %{attr} failed.")
709 );
710 $GLOBALS['LSerror_code']['LSattribute_08'] = array (
711   'msg' => _("LSattribute : Generation of the attribute %{attr} did not return a correct value.")
712 );
713 $GLOBALS['LSerror_code']['LSattribute_09'] = array (
714   'msg' => _("LSattribute : The attr_%{type} of the attribute %{name} is not yet defined.")
715 );
716
717 ?>