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