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