4d21d814049d7ab238eb6bd1c353b51ca6b8c58d
[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 ($this -> config['rights'][$who] == 'w') {
301             $return='w';
302             break;
303           }
304           else if($this -> config['rights'][$who] == 'r') {
305             $return='r';
306           }
307           break;
308       }
309       if ($return=='w') {
310         break;
311       }
312     }
313     $this -> _myRights = $return;
314     return $return;
315   }
316
317   /**
318    * Ajoute l'attribut au formualaire de vue
319    *
320    * Cette méthode ajoute l'attribut au formulaire $form de vue si il doit l'être
321    *
322    * @author Benjamin Renard <brenard@easter-eggs.com>
323    *
324    * @param[in] object $form Le formulaire dans lequel doit être ajouté l'attribut
325    *
326    * @retval boolean true si l'ajout a fonctionner ou qu'il n'est pas nécessaire, false sinon
327    */
328   function addToView(&$form) {
329     if((isset($this -> config['view'])) && ($this -> config['view']) && ($this -> myRights() != 'n') ) {
330       if (!$this -> html) {
331         LSerror :: addErrorCode('LSattribute_09',array('type' => 'html','name' => $this -> name));
332         return;
333       }
334       if($this -> data !='') {
335         $data=$this -> getFormVal();
336       }
337       else {
338         $data='';
339       }
340       $element = $this -> html -> addToForm($form,'view',$data);
341       if(!$element instanceof LSformElement) {
342         LSerror :: addErrorCode('LSform_06',$this -> name);
343         return;
344       }
345       $element -> freeze();
346       return true;
347     }
348     return true;
349   }
350   
351   /**
352    * Rafraichis la valeur de l'attribut dans un formualaire
353    *
354    * @author Benjamin Renard <brenard@easter-eggs.com>
355    *
356    * @param[in] object &$form LSform Le formulaire dans lequel doit être ajouté l'attribut
357    * @param[in] string $idForm L'identifiant du formulaire
358    *
359    * @retval boolean true si la valeur a été rafraichie ou que ce n'est pas nécessaire, false sinon
360    */
361   function refreshForm(&$form,$idForm) {
362     if(isset($this -> config['form'][$idForm])&&($this -> myRights()!='n')) {
363       if (!$this -> html) {
364         LSerror :: addErrorCode('LSattribute_09',array('type' => 'html','name' => $this -> name));
365         return;
366       }
367       $form_element = $form -> getElement($this -> name);
368       if ($form_element) {
369         $values = $this -> html -> refreshForm($this -> getFormVal());
370         return $form_element -> setValue($values);
371       }
372       else {
373         LSdebug('LSformElement "'.$this -> name.'" n\'existe pas');
374       }
375     }
376     return true;
377   }
378   
379   /**
380    * Retourne la valeur a afficher dans le formulaire
381    *
382    * @author Benjamin Renard <brenard@easter-eggs.com>
383    *
384    * @retval string La valeur a afficher dans le formulaire.
385    */
386   function getFormVal() {
387     $data=$this -> getDisplayValue();
388     if ($data==NULL) {
389       $data=array();
390     }
391     if(!is_array($data)) {
392       $data=array($data);
393     }
394     return $data;
395   }
396   
397   /**
398    * Définis les données de mises à jour si un changement a eut lieu
399    *
400    * @author Benjamin Renard <brenard@easter-eggs.com>
401    *
402    * @param[in] string $data Les données de mise à jour.
403    *
404    * @retval void
405    */
406   function setUpdateData($data) {
407     if($this -> ldap -> isUpdated($data)) {
408       $this -> updateData=$data;
409     }
410   }
411   
412   /**
413    * Vérifie si l'attribut a été validé
414    *
415    * @author Benjamin Renard <brenard@easter-eggs.com>
416    *
417    * @retval boolean true si l'attribut a été validé, false sinon
418    */
419   function isValidate() {
420     return $this -> is_validate;
421   }
422   
423   /**
424    * Valide le champs
425    *
426    * @author Benjamin Renard <brenard@easter-eggs.com>
427    *
428    * @retval void
429    */
430   function validate() {
431     $this -> is_validate=true;
432   }
433   
434   /**
435    * Vérifie si l'attribut a été mise à jour
436    *
437    * @author Benjamin Renard <brenard@easter-eggs.com>
438    *
439    * @retval boolean true si l'attribut a été mis à jour, false sinon
440    */
441   function isUpdate() {
442     return ($this -> updateData===false)?false:true;
443   }
444   
445   /**
446    * Vérifie si l'attribut est obligatoire
447    *
448    * @author Benjamin Renard <brenard@easter-eggs.com>
449    *
450    * @retval boolean true si l'attribut est obligatoire, false sinon
451    */
452   function isRequired() {
453     return $this -> config['required'];
454   }
455   
456   /**
457    * Vérifie si la valeur de l'attribut peut être générée
458    *
459    * @author Benjamin Renard <brenard@easter-eggs.com>
460    *
461    * @retval boolean true si la valeur de l'attribut peut être générée, false sinon
462    */
463   function canBeGenerated() {
464     return (
465               (function_exists($this -> config['generate_function']))
466               ||
467               (isset($this -> config['generate_value_format']))
468               ||
469               (
470                 (is_string($this -> config['default_value']))
471                 &&
472                 (strlen($this -> config['default_value'])>0)
473               )
474            );
475   }
476
477   /**
478    * Génere la valeur de l'attribut à partir de la fonction de génération
479    *
480    * @author Benjamin Renard <brenard@easter-eggs.com>
481    *
482    * @retval boolean true si la valeur à put être générée, false sinon
483    */
484   function generateValue() {
485     $value=false;
486     if (function_exists($this -> config['generate_function'])) {
487       $value=call_user_func($this -> config['generate_function'],$this -> ldapObject);
488     }
489     else if (isset($this -> config['generate_value_format'])) {
490       $value = $this -> ldapObject -> getFData($this -> config['generate_value_format']);
491     }
492     else if (is_string($this -> config['default_value']) && strlen($this -> config['default_value'])>0) {
493       $value = $this -> ldapObject -> getFData($this -> config['default_value']);
494     }
495     if ($value!==false) {
496       if (!empty($value)) {
497         if (!is_array($value)) {
498           $value=array($value);
499         }
500         $this -> updateData=$value;
501       }
502       else {
503         $this -> updateData=array();
504       }
505       return true;
506     }
507     return;
508   }
509   
510   /**
511    * Retourne la valeur de l'attribut pour son enregistrement dans l'annuaire
512    * si l'attribut à été modifié.
513    *
514    * @author Benjamin Renard <brenard@easter-eggs.com>
515    *
516    * @retval mixed La valeur de l'attribut pour son enregistrement dans l'annuaire
517    */
518   function getUpdateData() {
519     if (!$this -> isUpdate()) {
520       return;
521     }
522     if ( $this -> _finalUpdateData ) {
523       return  $this -> _finalUpdateData;
524     }
525     $data=$this -> updateData;
526     if ($this -> config['onSave']) {
527       if (is_array($this -> config['onSave'])) {
528         $result=$data;
529         foreach($this -> config['onSave'] as $func) {
530           if (function_exists($func)) {
531             $result=$func($result);
532           }
533           else {
534             LSerror :: addErrorCode('LSattribute_05',array('attr' => $this->name,'func' => $func));
535             return;
536           }
537         }
538       }
539       else {
540         if (function_exists($this -> config['onSave'])) {
541           $result = $this -> config['onSave']($data);
542         }
543         else {
544           LSerror :: addErrorCode('LSattribute_05',array('attr' => $this->name,'func' => $this -> config['onSave']));
545           return;
546         }
547       }
548     }
549     else {
550       if (!$this -> ldap) {
551         LSerror :: addErrorCode('LSattribute_09',array('type' => 'ldap','name' => $this -> name));
552         return;
553       }
554       else {
555         $result = $this -> ldap -> getUpdateData($data);
556       }
557     }
558     $this -> _finalUpdateData = $result;
559     return $result;
560   }
561  
562   /**
563    * Retourne la configuration de validation de l'attribut
564    *
565    * @author Benjamin Renard <brenard@easter-eggs.com>
566    *
567    * @retval mixed La configuration de validation de l'attribut
568    */
569   function getValidateConfig() {
570     return $this -> config['validation'];
571   }
572
573   /**
574    * Retourne les attributs dépendants de celui-ci
575    *
576    * @author Benjamin Renard <brenard@easter-eggs.com>
577    *
578    * @retval array les noms des attributs dépendants
579    */
580   function getDependsAttrs() {
581     return $this -> config['dependAttrs'];
582   }
583
584   /**
585    * Ajouter une action lors d'un événement
586    * 
587    * @param[in] $event string Le nom de l'événement
588    * @param[in] $fct string Le nom de la fonction à exectuer
589    * @param[in] $params mixed Paramètres pour le lancement de la fonction
590    * @param[in] $class Nom de la classe possèdant la méthode $fct à executer
591    * 
592    * @retval void
593    */
594   function addEvent($event,$fct,$params,$class=NULL) {
595     $this -> _events[$event][] = array(
596       'function'  => $fct,
597       'params'    => $params,
598       'class'     => $class
599     );
600   }
601   
602   /**
603    * Ajouter une action sur un objet lors d'un événement
604    * 
605    * @param[in] $event string Le nom de l'événement
606    * @param[in] $obj object L'objet dont la méthode doit être executé
607    * @param[in] $meth string Le nom de la méthode
608    * @param[in] $params mixed Paramètres d'execution de la méthode
609    * 
610    * @retval void
611    */
612   function addObjectEvent($event,&$obj,$meth,$params=NULL) {
613     $this -> _objectEvents[$event][] = array(
614       'obj'  => $obj,
615       'meth'  => $meth,
616       'params'    => $params
617     );
618   }
619   
620   /**
621    * Lance les actions à executer lors d'un événement
622    * 
623    * @param[in] $event string Le nom de l'événement
624    * 
625    * @retval boolean True si tout c'est bien passé, false sinon
626    */
627   function fireEvent($event) {
628     $return = true;
629     if(isset($this -> config[$event])) {
630       if (!is_array($this -> config[$event])) {
631         $funcs = array($this -> config[$event]);
632       }
633       else {
634         $funcs = $this -> config[$event];
635       }
636       foreach($funcs as $func) {
637         if(function_exists($func)) {
638           if(!$func($this -> ldapObject)) {
639             $return = false;
640           }
641         }
642         else {
643           $return = false;
644         }
645       }
646     }
647     
648     if (is_array($this -> _events[$event])) {
649       foreach ($this -> _events[$event] as $e) {
650         if ($e['class']) {
651           if (class_exists($e['class'])) {
652             $obj = new $e['class']();
653             if (method_exists($obj,$e['fct'])) {
654               try {
655                 $obj -> $e['fct']($e['params']);
656               }
657               catch(Exception $er) {
658                 $return = false;
659                 LSdebug("Event ".$event." : Erreur durant l'execution de la méthode ".$e['fct']." de la classe ".$e['class']);
660               }
661             }
662             else {
663               LSdebug("Event ".$event." : La méthode ".$e['fct']." de la classe ".$e['class']." n'existe pas.");
664               $return = false;
665             }
666           }
667           else {
668             $return = false;
669             LSdebug("Event ".$event." : La classe ".$e['class']." n'existe pas");
670           }
671         }
672         else {
673           if (function_exists($e['fct'])) {
674             try {
675               $e['fct']($e['params']);
676             }
677             catch(Exception $er) {
678               LSdebug("Event ".$event." : Erreur durant l'execution de la function ".$e['fct']);
679               $return = false;
680             }
681           }
682           else {
683             LSdebug("Event ".$event." : la function ".$e['fct']." n'existe pas");
684             $return = false;
685           }
686         }
687       }
688     }
689     
690     if (is_array($this -> _objectEvents[$event])) {
691       foreach ($this -> _objectEvents[$event] as $e) {
692         if (method_exists($e['obj'],$e['meth'])) {
693           try {
694             $e['obj'] -> $e['meth']($e['params']);
695           }
696           catch(Exception $er) {
697             $return = false;
698             LSdebug("Event ".$event." : Erreur durant l'execution de la méthode ".$e['meth']." sur l'objet.");
699           }
700         }
701         else {
702           LSdebug("Event ".$event." : La méthode ".$e['meth']." de l'objet n'existe pas.");
703           $return = false;
704         }
705       }
706     }
707     
708     return $return;
709   }
710   
711 }
712
713 /**
714  * Error Codes
715  **/
716 LSerror :: defineError('LSattribute_01',
717   _("LSattribute : Attribute %{attr} : LDAP or HTML types unknow (LDAP = %{ldap} & HTML = %{html}).")
718 );
719 LSerror :: defineError('LSattribute_02',
720   _("LSattribute : The function %{func} to display the attribute %{attr} is unknow.")
721 );
722 LSerror :: defineError('LSattribute_03',
723   _("LSattribute : The rule %{rule} to validate the attribute %{attr} is unknow.")
724 );
725 LSerror :: defineError('LSattribute_04',
726   _("LSattribute : Configuration data to verify the attribute %{attr} are incorrect.")
727 );
728 LSerror :: defineError('LSattribute_05',
729   _("LSattribute : The function %{func} to save the attribute %{attr} is unknow.")
730 );
731 LSerror :: defineError('LSattribute_06',
732   _("LSattribute : The value of the attribute %{attr} can't be generated.")
733 );
734 LSerror :: defineError('LSattribute_07',
735   _("LSattribute : Generation of the attribute %{attr} failed.")
736 );
737 LSerror :: defineError('LSattribute_08',
738   _("LSattribute : Generation of the attribute %{attr} did not return a correct value.")
739 );
740 LSerror :: defineError('LSattribute_09',
741   _("LSattribute : The attr_%{type} of the attribute %{name} is not yet defined.")
742 );
743
744 ?>