Added the ability for a user to change his email address.

The change is not performed immediately. First a confirmation email is
sent to the user and if validated, the email address is changed.

src/IDF/Form/UserAccount.php

@@ -21,6 +21,8 @@
 #
 # ***** END LICENSE BLOCK ***** */
 
+Pluf::loadFunction('Pluf_HTTP_URL_urlForView');
+
 /**
  * Allow a user to update its details.
  */
@@ -50,6 +52,13 @@ class IDF_Form_UserAccount  extends Pluf_Form
                                                                     ),
                                             ));
 
+        $this->fields['email'] = new Pluf_Form_Field_Email(
+                                      array('required' => true,
+                                            'label' => __('Your mail'),
+                                            'initial' => $this->user->email,
+                                            'help_text' => __('If you change your email address, an email will be sent to the new address to confirm it.'),
+                                            ));
+
         $this->fields['language'] = new Pluf_Form_Field_Varchar(
                                       array('required' => true,
                                             'label' => __('Language'),
@@ -116,6 +125,31 @@ class IDF_Form_UserAccount  extends Pluf_Form
         } else {
             $update_pass = true;
         }
+        $old_email = $this->user->email;
+        $new_email = $this->cleaned_data['email'];
+        unset($this->cleaned_data['email']);
+        if ($old_email != $new_email) {
+            $cr = new Pluf_Crypt(md5(Pluf::f('secret_key')));
+            $encrypted = trim($cr->encrypt($new_email.':'.$this->user->id.':'.time()), '~');
+            $key = substr(md5(Pluf::f('secret_key').$encrypted), 0, 2).$encrypted;
+            $url = Pluf::f('url_base').Pluf_HTTP_URL_urlForView('IDF_Views_User::changeEmailDo', array($key), array(), false);
+            $urlik = Pluf::f('url_base').Pluf_HTTP_URL_urlForView('IDF_Views_User::changeEmailInputKey', array(), array(), false);
+            $context = new Pluf_Template_Context(
+                 array('key' => Pluf_Template::markSafe($key),
+                       'url' => Pluf_Template::markSafe($url),
+                       'urlik' => Pluf_Template::markSafe($urlik),
+                       'email' => $new_email,
+                       'user'=> $this->user,
+                       )
+                                                 );
+            $tmpl = new Pluf_Template('idf/user/changeemail-email.txt');
+            $text_email = $tmpl->render($context);
+            $email = new Pluf_Mail(Pluf::f('from_email'), $new_email,
+                                   __('Confirm your new email address.'));
+            $email->addTextMessage($text_email);
+            $email->sendMail();
+            $this->user->setMessage(sprintf(__('A validation email has been sent to "%s" to validate the email address change.'), Pluf_esc($new_email)));
+        }
         $this->user->setFromFormData($this->cleaned_data);
         // Get keys
         $keys = $this->user->get_idf_key_list();
@@ -181,6 +215,18 @@ class IDF_Form_UserAccount  extends Pluf_Form
         return $first_name;
     }
 
+    function clean_email()
+    {
+        $this->cleaned_data['email'] = mb_strtolower(trim($this->cleaned_data['email']));
+        $guser = new Pluf_User();
+        $sql = new Pluf_SQL('email=%s AND id!=%s', 
+                            array($this->cleaned_data['email'], $this->user->id));
+        if ($guser->getCount(array('filter' => $sql->gen())) > 0) {
+            throw new Pluf_Form_Invalid(sprintf(__('The email "%s" is already used.'), $this->cleaned_data['email']));
+        }
+        return $this->cleaned_data['email'];
+    }
+
     /**
      * Check to see if the 2 passwords are the same.
      */

src/IDF/Form/UserChangeEmail.php

@@ -0,0 +1,84 @@
+<?php
+/* -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+# ***** BEGIN LICENSE BLOCK *****
+# This file is part of InDefero, an open source project management application.
+# Copyright (C) 2008 Céondo Ltd and contributors.
+#
+# InDefero is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# InDefero is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+# ***** END LICENSE BLOCK ***** */
+
+/**
+ * Change the email address of a user.
+ *
+ */
+class IDF_Form_UserChangeEmail extends Pluf_Form
+{
+    protected $user;
+
+    public function initFields($extra=array())
+    {
+        $this->fields['key'] = new Pluf_Form_Field_Varchar(
+                                      array('required' => true,
+                                            'label' => __('Your verification key'),
+                                            'initial' => '',
+                                            'widget_attrs' => array(
+                                                       'size' => 50,
+                                                                    ),
+                                            ));
+    }
+
+    function clean_key()
+    {
+        self::validateKey($this->cleaned_data['key']);
+        return $this->cleaned_data['key'];
+    }
+
+    /**
+     * Validate the key.
+     *
+     * Throw a Pluf_Form_Invalid exception if the key is not valid.
+     *
+     * @param string Key
+     * @return array array($new_email, $user_id, time())
+     */
+    public static function validateKey($key)
+    {
+        $hash = substr($key, 0, 2);
+        $encrypted = substr($key, 2);
+        if ($hash != substr(md5(Pluf::f('secret_key').$encrypted), 0, 2)) {
+            throw new Pluf_Form_Invalid(__('The validation key is not valid. Please copy/paste it from your confirmation email.'));
+        }
+        $cr = new Pluf_Crypt(md5(Pluf::f('secret_key')));
+        return split(':', $cr->decrypt($encrypted), 3);
+        
+    }
+
+    /**
+     * Save the model in the database.
+     *
+     * @param bool Commit in the database or not. If not, the object
+     *             is returned but not saved in the database.
+     * @return Object Model with data set from the form.
+     */
+    function save($commit=true)
+    {
+        if (!$this->isValid()) {
+            throw new Exception(__('Cannot save the model from an invalid form.'));
+        }
+        return Pluf::f('url_base').Pluf_HTTP_URL_urlForView('IDF_Views_User::changeEmailDo', array($this->cleaned_data['key']));
+    }
+}

src/IDF/Views/User.php

@@ -96,8 +96,6 @@ class IDF_Views_User
                                                      'issues' => $pag,
                                                      ),
                                                $request);
-        
-
     }
 
     /**
@@ -139,6 +137,55 @@ class IDF_Views_User
                                                $request);
     }
 
+    /**
+     * Enter the key to change an email address.
+     *
+     * This is redirecting to changeEmailDo
+     */
+    public $changeEmailInputKey_precond = array('Pluf_Precondition::loginRequired');
+    public function changeEmailInputKey($request, $match)
+    {
+        if ($request->method == 'POST') {
+            $form = new IDF_Form_UserChangeEmail($request->POST);
+            if ($form->isValid()) {
+                $url = $form->save();
+                return new Pluf_HTTP_Response_Redirect($url);
+            }
+        } else {
+            $form = new IDF_Form_UserChangeEmail();
+        }
+        return Pluf_Shortcuts_RenderToResponse('idf/user/changeemail.html', 
+                                               array('page_title' => __('Confirm The Email Change'),
+                                                     'form' => $form),
+                                               $request);
+        
+    }
+
+    /**
+     * Really change the email address.
+     */
+    public $changeEmailDo_precond = array('Pluf_Precondition::loginRequired');
+    public function changeEmailDo($request, $match)
+    {
+        $key = $match[1];
+        $url = Pluf_HTTP_URL_urlForView('IDF_Views_User::changeEmailInputKey');
+        try {
+            list($email, $id, $time) = IDF_Form_UserChangeEmail::validateKey($key);
+        } catch (Pluf_Form_Invalid $e) {
+            return new Pluf_HTTP_Response_Redirect($url);
+        }
+        if ($id != $request->user->id) {
+            return new Pluf_HTTP_Response_Redirect($url);
+        }
+        // Now we have a change link coming from the right user.
+        $request->user->email = $email;
+        $request->user->update();
+        $request->user->setMessage(sprintf(__('Your new email address "%s" has been validated. Thank you!'), Pluf_esc($email)));
+        $url = Pluf_HTTP_URL_urlForView('IDF_Views_User::myAccount');
+        return new Pluf_HTTP_Response_Redirect($url);
+    }
+
+
     /**
      * Public profile of a user.
      */

src/IDF/conf/urls.php

@@ -473,6 +473,19 @@ $ctl[] = array('regex' => '#^/password/k/(.*)/$#',
                'model' => 'IDF_Views',
                'method' => 'passwordRecovery');
 
+$ctl[] = array('regex' => '#^/preferences/email/ik/$#',
+               'base' => $base,
+               'priority' => 4,
+               'model' => 'IDF_Views_User',
+               'method' => 'changeEmailInputKey');
+
+$ctl[] = array('regex' => '#^/preferences/email/ak/(.*)/$#',
+               'base' => $base,
+               'priority' => 4,
+               'model' => 'IDF_Views_User',
+               'method' => 'changeEmailDo');
+
+
 
 
 return $ctl;

src/IDF/templates/idf/user/changeemail-email.txt

@@ -0,0 +1,22 @@
+{blocktrans}Hello {$user},
+
+To confirm that you want {$email}
+to be your new email address, just follow this link:
+
+{$url}
+
+Alternatively, go to this page:
+
+{$urlik}
+
+and provide the following verification key:
+
+{$key}
+
+If you do not want to change your email address, 
+just ignore this message.
+
+Yours faithfully,
+The development team.
+{/blocktrans}
+

src/IDF/templates/idf/user/changeemail.html

@@ -0,0 +1,39 @@
+{extends "idf/base-simple.html"}
+{block body}
+{if $form.errors}
+<div class="px-message-error">
+<p>{trans 'Oups, we found an error in the form.'}</p>
+{if $form.get_top_errors}
+{$form.render_top_errors|unsafe}
+{/if}
+</div>
+{/if}
+
+<form method="post" action=".">
+<table class="form" summary="">
+<tr>
+<td>&nbsp;</td>
+<td><strong>{$form.f.key.labelTag}:</strong><br />
+{if $form.f.key.errors}{$form.f.key.fieldErrors}{/if}
+{$form.f.key|unsafe}
+</td>
+</tr>
+<tr>
+<td>&nbsp;</td>
+<td><input type="submit" value="{trans 'Confirm Your New Email Address'}" name="submit" /> | <a href="{url 'IDF_Views_User::myAccount'}">{trans 'Cancel'}</a>
+</td>
+</tr>
+</table>
+</form>
+{/block}
+{block context}
+<div class="issue-submit-info">
+<h2>{trans 'Instructions'}</h2>
+<p>{trans 'Use your email software to read your emails and open your verification email. Either click directly on the verification link or copy/paste the verification key in the box and submit the form.'}</p>
+</div>
+{/block}
+{block javascript}<script type="text/javascript">
+document.getElementById('id_key').focus()
+</script>
+{/block}
+

src/IDF/templates/idf/user/myaccount.html

@@ -28,6 +28,13 @@
 </td>
 </tr>
 <tr>
+<th><strong>{$form.f.email.labelTag}:</strong></th>
+<td>{if $form.f.email.errors}{$form.f.email.fieldErrors}{/if}
+{$form.f.email|unsafe}<br />
+<span class="helptext">{$form.f.email.help_text}</span>
+</td>
+</tr>
+<tr>
 <th>{$form.f.language.labelTag}:</th>
 <td>{if $form.f.language.errors}{$form.f.language.fieldErrors}{/if}
 {$form.f.language|unsafe}