LSformElement_password : Added possibility to have multiple contact mail attributes
[ldapsaisie.git] / public_html / includes / class / class.LSformElement_password.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('LSformElement');
24
25 /**
26  * Element password d'un formulaire pour LdapSaisie
27  *
28  * Cette classe définis les éléments password des formulaires.
29  * Elle étant la classe basic LSformElement.
30  *
31  * @author Benjamin Renard <brenard@easter-eggs.com>
32  */
33
34 class LSformElement_password extends LSformElement {
35   
36   var $fieldTemplate = 'LSformElement_password_field.tpl';
37   var $template = 'LSformElement_password.tpl';
38   
39   var $sendMail = false;
40
41   /**
42    * Recupère la valeur de l'élement passée en POST
43    *
44    * Cette méthode vérifie la présence en POST de la valeur de l'élément et la récupère
45    * pour la mettre dans le tableau passer en paramètre avec en clef le nom de l'élément
46    *
47    * @param[] array Pointeur sur le tableau qui recupèrera la valeur.
48    *
49    * @retval boolean true si la valeur est présente en POST, false sinon
50    */
51   function getPostData(&$return) {
52     // Récupère la valeur dans _POST, et les vérifie avec la fonction générale
53     $retval = parent :: getPostData($return);
54     // Si une valeur est recupérée
55     if ($retval) {
56       $val = $this -> form -> ldapObject -> attrs[$this -> name] -> getValue(); 
57       if( (empty($return[$this -> name][0]) ) && ( ! empty( $val ) ) ) {
58         unset($return[$this -> name]);
59         $this -> form -> _notUpdate[$this -> name] == true;
60         return true;
61       }
62       
63       if ($this -> verifyPassword($return[$this -> name][0]) || (empty($return[$this -> name][0]) && empty($val))) {
64         LSdebug("Password : no change");
65         unset($return[$this -> name]);
66         $this -> form -> _notUpdate[$this -> name] == true;
67         return true;
68       }
69       
70       //Mail
71
72       // Do not send mail if password is not set :
73       if (empty($return[$this -> name])) {
74         return true;
75       }
76
77       if (isset($_POST['LSformElement_password_'.$this -> name.'_send'])) {
78         if ($_POST['LSformElement_password_'.$this -> name.'_send']==1) {
79           $this -> sendMail = true;
80           LSdebug ('send by form');
81         }
82       }
83       else if (isset($this -> params['html_options']['mail']['isset']) && $this -> params['html_options']['mail']['send']==1) {
84         $this -> sendMail = true;
85         LSdebug ('send by config');
86       }
87       if ($this -> sendMail && LSsession :: loadLSaddon('mail')) {
88         $msg = $this -> params['html_options']['mail']['msg'];
89         $subject = $this -> params['html_options']['mail']['subject'];
90         if (isset($_POST['LSformElement_password_'.$this -> name.'_msg'])) {
91           $msgInfos = json_decode($_POST['LSformElement_password_'.$this -> name.'_msg']);
92           if ($msgInfos -> subject) {
93             $subject = $msgInfos -> subject;
94           }
95           if ($msgInfos -> msg) {
96             $msg = $msgInfos -> msg;
97           }
98           if ($msgInfos -> mail) {
99             $mail = $msgInfos -> mail;
100           }
101         }
102         $this -> sendMail = array (
103           'subject' => $subject,
104           'msg' => $msg,
105           'mail' => $mail,
106           'pwd' => $return[$this -> name][0]
107         );
108         $this -> attr_html -> attribute -> addObjectEvent('after_modify',$this,'send');
109       }
110     }
111     return $retval;
112   }
113
114  /**
115   * Retourne les infos d'affichage de l'élément
116   * 
117   * Cette méthode retourne les informations d'affichage de l'élement
118   *
119   * @retval array
120   */
121   function getDisplay(){
122     LSsession :: addCssFile('LSformElement_password.css');
123     $return = $this -> getLabelInfos();
124     $pwd = "";
125     if (!$this -> isFreeze()) {
126       
127       // Help Infos
128       LSsession :: addHelpInfos(
129         'LSformElement_password',
130         array(
131           'generate' => _('Generate a password.'),
132           'verify' => _('Compare with stored password.'),
133           'view' => _('Display password.'),
134           'viewHash' => _('Display hashed password.'),
135           'hide' => _('Hide password.'),
136           'mail' => _("The password will be sent by mail if changed. Click to disable automatic notification."),
137           'nomail' => _("The password will not be sent if changed. Click to enable automatic notification."),
138           'editmail' => _("Modify the mail sent to notice the user")
139         )
140       );
141       
142       if (($this -> params['html_options']['generationTool'])&&($this -> params['html_options']['autoGenerate'])&&(empty($this -> values))) {
143         $pwd=$this->generatePassword($this -> params);
144       }
145       
146       $params = array(
147         'generate' => ($this -> params['html_options']['generationTool']==True),
148         'viewHash' => ($this -> params['html_options']['viewHash']==True),
149         'verify' => ( (!$this -> attr_html -> attribute -> ldapObject-> isNew()) && ( (isset($this -> params['html_options']['verify']) && $this -> params['html_options']['verify']) || (!isset($this -> params['html_options']['verify'])) ) )
150       );
151       if (isset($this -> params['html_options']['mail'])) {
152         $params['mail'] = $this -> params['html_options']['mail'];
153       }
154       LSsession :: addJSconfigParam($this -> name,$params);
155       
156       LSsession :: addJSscript('LSformElement_password_field.js');
157       LSsession :: addJSscript('LSformElement_password.js');
158     }
159     $return['html'] = $this -> fetchTemplate(NULL,array('pwd' => $pwd));
160     return $return;
161   }
162   
163   function generatePassword($params=NULL) {
164     return generatePassword($params['html_options']['chars'],$params['html_options']['lenght']);
165   }
166   
167   function verifyPassword($pwd) {
168     if ($this -> attr_html -> attribute -> ldapObject -> isNew()) {
169       return false;
170     }
171     if ($this -> isLoginPassword()) {
172       return LSsession :: checkUserPwd($this -> attr_html -> attribute -> ldapObject,$pwd);
173     }
174     else {
175       $hash = $this -> attr_html -> attribute -> ldap -> encodePassword($pwd);
176       $find=false;
177       if (is_array($this -> attr_html -> attribute -> data)) {
178         $data = $this -> attr_html -> attribute -> data;
179       }
180       elseif (!is_array($this -> attr_html -> attribute -> data) && !empty($this -> attr_html -> attribute -> data)) {
181         $data = array($this -> attr_html -> attribute -> data);
182       }
183       else {
184         return $find;
185       }
186       foreach($data as $val) {
187         if ($hash == $val)
188           $find=true;
189       }
190       return $find;
191     }
192   }
193   
194   function send($params) {
195     if (is_array($this -> sendMail)) {
196       $mail = (String)$this -> sendMail['mail'];
197       Lsdebug($mail);
198       if ($mail=="") {
199         $mail_attrs = $this -> params['html_options']['mail']['mail_attr'];
200         if (!is_array($mail_attrs)) {
201           $mail_attrs=array();
202         }
203         foreach($mail_attrs as $attr) {
204           $mail_attr = $this -> attr_html -> attribute -> ldapObject -> attrs[$attr];
205           if ($mail_attr instanceOf LSattribute) {
206             $mail = $mail_attr -> getValue();
207             if (!empty($mail) && checkEmail($mail[0],NULL,true)) {
208               $mail=$mail[0];
209               break;
210             }
211             else {
212               $mail="";
213             }
214           }
215           else {
216             LSdebug("L'attribut $mail_attr pour l'envoie du nouveau mot de passe n'existe pas.");
217           }
218         }
219         if ($mail=="") {
220           LSerror :: addErrorCode('LSformElement_password_01');
221           return;
222         }
223       }
224               
225       if (checkEmail($mail,NULL,true)) {
226         $this -> attr_html -> attribute -> ldapObject -> registerOtherValue('password',$this -> sendMail['pwd']);
227         $msg = $this -> attr_html -> attribute -> ldapObject -> getFData($this -> sendMail['msg']);
228         if (isset($this -> params['html_options']['mail']['headers'])) {
229           $headers = $this -> params['html_options']['mail']['headers'];
230         }
231         else {
232           $headers = array();
233         }
234         if ($this -> params['html_options']['mail']['bcc']) {
235                 $headers['Bcc']=$this -> params['html_options']['mail']['bcc'];
236         }
237         if (sendMail(
238           $mail,
239           $this -> sendMail['subject'],
240           $msg,
241           $headers
242         )) {
243           LSsession :: addInfo(_('Notice mail sent.'));
244         }
245       }
246       else {
247         LSerror :: addErrorCode('LSformElement_password_02',$mail);
248         return;
249       }
250     }
251     return true;
252   }
253   
254   public static function ajax_verifyPassword(&$data) {
255     if ((isset($_REQUEST['attribute'])) && (isset($_REQUEST['objecttype'])) && (isset($_REQUEST['fieldValue'])) && (isset($_REQUEST['idform'])) && (isset($_REQUEST['objectdn'])) ) {
256       if (LSsession ::loadLSobject($_REQUEST['objecttype'])) {
257         $object = new $_REQUEST['objecttype']();
258         $object -> loadData($_REQUEST['objectdn']);
259         $form = $object -> getForm($_REQUEST['idform']);
260         if ($form) {
261           $field=$form -> getElement($_REQUEST['attribute']);
262           if ($field) {
263             $val = $field -> verifyPassword($_REQUEST['fieldValue']);
264             $data = array(
265               'verifyPassword' => $val
266             );
267           }
268           else {
269             LSdebug('Impossible de récupérer le LSformElement');
270           }
271         }
272         else {
273           LSdebug('Impossible de recuperer le LSform.');
274         }
275       }
276     }
277   }
278   
279   public static function ajax_generatePassword(&$data) {
280     if ((isset($_REQUEST['attribute'])) && (isset($_REQUEST['objecttype'])) && (isset($_REQUEST['objectdn'])) && (isset($_REQUEST['idform'])) ) {
281       if (LSsession ::loadLSobject($_REQUEST['objecttype'])) {
282         $params = LSconfig :: get("LSobjects.".$_REQUEST['objecttype'].".attrs.".$_REQUEST['attribute']);
283         $val = self :: generatePassword($params);
284         if ( $val ) {
285           $data = array(
286             'generatePassword' => $val
287           );
288         }
289       }
290     }
291   }
292
293   public static function ajax_viewHash(&$data) {
294     if ((isset($_REQUEST['attribute'])) && (isset($_REQUEST['objecttype'])) && (isset($_REQUEST['objectdn'])) ) {
295       if (LSsession ::loadLSobject($_REQUEST['objecttype'])) {
296         $object = new $_REQUEST['objecttype']();
297         $object -> loadData($_REQUEST['objectdn']);
298         if (LSsession::canAccess($_REQUEST['objecttype'],$_REQUEST['objectdn'],null,$_REQUEST['attribute'])) {
299           $values = $object -> getValue($_REQUEST['attribute']);
300           if (is_string($values[0])) {
301             $data = array (
302               'hash' => $values[0]
303             );
304           }
305         }
306       }
307     }
308   }
309
310   public function isLoginPassword() {
311     if (!isset($this -> params['html_options']['isLoginPassword']) || $this -> params['html_options']['isLoginPassword']) {
312       return true;
313     }
314     return false;
315   }
316
317 }
318
319 /*
320  * Error Codes
321  */
322 LSerror :: defineError('LSformElement_password_01',
323 _("LSformElement_password : No contact mail available to send password.")
324 );
325 LSerror :: defineError('LSformElement_password_02',
326 _("LSformElement_password : Contact mail invalid (%{mail}). Can't send password.")
327 );
328
329 ?>