2009-01-02 11:20:10 +01:00
< ? 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 ***** */
/**
* Update user ' s details .
*/
2010-12-05 01:22:32 +01:00
class IDF_Form_Admin_UserUpdate extends Pluf_Form
2009-01-02 11:20:10 +01:00
{
public $user = null ;
public function initFields ( $extra = array ())
{
$this -> user = $extra [ 'user' ];
2010-12-05 01:22:32 +01:00
$user_data = IDF_UserData :: factory ( $this -> user );
2009-01-02 11:20:10 +01:00
$this -> fields [ 'first_name' ] = new Pluf_Form_Field_Varchar (
array ( 'required' => false ,
'label' => __ ( 'First name' ),
'initial' => $this -> user -> first_name ,
'widget_attrs' => array (
'maxlength' => 50 ,
'size' => 15 ,
),
));
$this -> fields [ 'last_name' ] = new Pluf_Form_Field_Varchar (
array ( 'required' => true ,
'label' => __ ( 'Last name' ),
'initial' => $this -> user -> last_name ,
'widget_attrs' => array (
'maxlength' => 50 ,
'size' => 20 ,
),
));
$this -> fields [ 'email' ] = new Pluf_Form_Field_Email (
array ( 'required' => true ,
'label' => __ ( 'Email' ),
'initial' => $this -> user -> email ,
'widget_attrs' => array (
'maxlength' => 50 ,
'size' => 20 ,
),
));
$this -> fields [ 'language' ] = new Pluf_Form_Field_Varchar (
array ( 'required' => true ,
'label' => __ ( 'Language' ),
'initial' => $this -> user -> language ,
'widget' => 'Pluf_Form_Widget_SelectInput' ,
'widget_attrs' => array (
2010-12-05 01:22:32 +01:00
'choices' =>
2009-01-02 11:20:10 +01:00
Pluf_L10n :: getInstalledLanguages ()
),
));
$this -> fields [ 'password' ] = new Pluf_Form_Field_Varchar (
array ( 'required' => false ,
'label' => __ ( 'Password' ),
'initial' => '' ,
'widget' => 'Pluf_Form_Widget_PasswordInput' ,
'help_text' => Pluf_Template :: markSafe ( __ ( 'Leave blank if you do not want to change the password.' ) . '<br />' . __ ( 'The password must be hard for other people to find it, but easy for the user to remember.' )),
'widget_attrs' => array (
'maxlength' => 50 ,
'size' => 15 ,
),
));
$this -> fields [ 'password2' ] = new Pluf_Form_Field_Varchar (
array ( 'required' => false ,
'label' => __ ( 'Confirm password' ),
'initial' => '' ,
'widget' => 'Pluf_Form_Widget_PasswordInput' ,
'widget_attrs' => array (
'maxlength' => 50 ,
'size' => 15 ,
),
));
2010-12-05 01:22:32 +01:00
$this -> fields [ 'description' ] = new Pluf_Form_Field_Varchar (
array ( 'required' => false ,
'label' => __ ( 'Description' ),
'initial' => $user_data -> description ,
'widget_attrs' => array ( 'rows' => 3 ,
'cols' => 40 ),
'widget' => 'Pluf_Form_Widget_TextareaInput' ,
));
$this -> fields [ 'twitter' ] = new Pluf_Form_Field_Varchar (
array ( 'required' => false ,
'label' => __ ( 'Twitter username' ),
'initial' => $user_data -> twitter ,
'widget_attrs' => array (
'maxlength' => 50 ,
'size' => 15 ,
),
));
$this -> fields [ 'public_email' ] = new Pluf_Form_Field_Email (
array ( 'required' => false ,
'label' => __ ( 'Public email address' ),
'initial' => $user_data -> public_email ,
'widget_attrs' => array (
'maxlength' => 50 ,
'size' => 15 ,
),
));
$this -> fields [ 'website' ] = new Pluf_Form_Field_Url (
array ( 'required' => false ,
'label' => __ ( 'Website URL' ),
'initial' => $user_data -> website ,
'widget_attrs' => array (
'maxlength' => 50 ,
'size' => 15 ,
),
));
$this -> fields [ 'custom_avatar' ] = new Pluf_Form_Field_File (
array ( 'required' => false ,
'label' => __ ( 'Upload custom avatar' ),
'initial' => '' ,
'max_size' => Pluf :: f ( 'max_upload_size' , 2097152 ),
'move_function_params' => array ( 'upload_path' => Pluf :: f ( 'upload_path' ) . '/avatars' ,
'upload_path_create' => true ,
'upload_overwrite' => true ,
'file_name' => 'user_' . $this -> user -> id . '_%s' ),
'help_text' => __ ( 'An image file with a width and height not larger than 60 pixels (bigger images are scaled down).' ),
));
$this -> fields [ 'remove_custom_avatar' ] = new Pluf_Form_Field_Boolean (
array ( 'required' => false ,
'label' => __ ( 'Remove custom avatar' ),
'initial' => false ,
'widget' => 'Pluf_Form_Widget_CheckboxInput' ,
'widget_attrs' => array (),
'help_text' => __ ( 'Tick this to delete the custom avatar.' ),
));
2009-01-02 12:07:41 +01:00
if ( $extra [ 'request' ] -> user -> administrator ) {
$this -> fields [ 'staff' ] = new Pluf_Form_Field_Boolean (
array ( 'required' => false ,
'label' => __ ( 'Staff' ),
'initial' => $this -> user -> staff ,
'widget' => 'Pluf_Form_Widget_CheckboxInput' ,
'help_text' => __ ( 'If you give staff rights to a user, you really need to trust him.' ),
));
}
2009-01-02 11:20:10 +01:00
$attrs = ( $extra [ 'request' ] -> user -> id == $this -> user -> id ) ?
array ( 'readonly' => 'readonly' ) : array ();
$this -> fields [ 'active' ] = new Pluf_Form_Field_Boolean (
array ( 'required' => false ,
'label' => __ ( 'Active' ),
'initial' => $this -> user -> active ,
'widget' => 'Pluf_Form_Widget_CheckboxInput' ,
'widget_attrs' => $attrs ,
'help_text' => __ ( 'If the user is not getting the confirmation email or is abusing the system, you can directly enable or disable his account here.' ),
));
}
/**
* 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.' ));
}
unset ( $this -> cleaned_data [ 'password2' ]);
$update_pass = false ;
if ( strlen ( $this -> cleaned_data [ 'password' ]) == 0 ) {
unset ( $this -> cleaned_data [ 'password' ]);
} else {
$update_pass = true ;
}
$this -> user -> setFromFormData ( $this -> cleaned_data );
2010-12-05 01:22:32 +01:00
2009-01-02 11:20:10 +01:00
if ( $commit ) {
$this -> user -> update ();
2010-12-05 01:22:32 +01:00
// FIXME: go the extra mile and check the input lengths for
// all fields here!
// FIXME: this is all doubled in UserAccount!
$user_data = IDF_UserData :: factory ( $this -> user );
// Add or remove avatar - we need to do this here because every
// single setter directly leads to a save in the database
if ( $user_data -> avatar != '' &&
( $this -> cleaned_data [ 'remove_custom_avatar' ] == 1 ||
$this -> cleaned_data [ 'custom_avatar' ] != '' )) {
$avatar_path = Pluf :: f ( 'upload_path' ) . '/avatars/' . basename ( $user_data -> avatar );
if ( basename ( $avatar_path ) != '' && is_file ( $avatar_path )) {
unlink ( $avatar_path );
}
$user_data -> avatar = '' ;
}
if ( $this -> cleaned_data [ 'custom_avatar' ] != '' ) {
$user_data -> avatar = $this -> cleaned_data [ 'custom_avatar' ];
}
$user_data -> description = $this -> cleaned_data [ 'description' ];
$user_data -> twitter = $this -> cleaned_data [ 'twitter' ];
$user_data -> public_email = $this -> cleaned_data [ 'public_email' ];
$user_data -> website = $this -> cleaned_data [ 'website' ];
2009-01-02 11:20:10 +01:00
if ( $update_pass ) {
/**
* [ signal ]
*
* Pluf_User :: passwordUpdated
*
* [ sender ]
*
* IDF_Form_UserAccount
*
* [ description ]
*
* This signal is sent when the user updated his
* password from his account page .
*
* [ parameters ]
*
* array ( 'user' => $user )
*
*/
$params = array ( 'user' => $this -> user );
Pluf_Signal :: send ( 'Pluf_User::passwordUpdated' ,
'IDF_Form_Admin_UserUpdate' , $params );
}
}
return $this -> user ;
}
function clean_last_name ()
{
$last_name = trim ( $this -> cleaned_data [ 'last_name' ]);
if ( $last_name == mb_strtoupper ( $last_name )) {
2010-12-05 01:22:32 +01:00
return mb_convert_case ( mb_strtolower ( $last_name ),
2009-01-02 11:20:10 +01:00
MB_CASE_TITLE , 'UTF-8' );
}
return $last_name ;
}
function clean_first_name ()
{
$first_name = trim ( $this -> cleaned_data [ 'first_name' ]);
2009-05-07 15:28:52 +02:00
if ( $first_name == '---' ) {
throw new Pluf_Form_Invalid ( __ ( '--- is not a valid first name.' ));
}
2009-01-02 11:20:10 +01:00
if ( $first_name == mb_strtoupper ( $first_name )) {
2010-12-05 01:22:32 +01:00
$first_name = mb_convert_case ( mb_strtolower ( $first_name ),
2009-05-07 15:07:02 +02:00
MB_CASE_TITLE , 'UTF-8' );
}
2009-01-02 11:20:10 +01:00
return $first_name ;
}
function clean_email ()
{
$email = mb_strtolower ( trim ( $this -> cleaned_data [ 'email' ]));
$sql = new Pluf_SQL ( 'email=%s AND id!=%s' ,
array ( $email , $this -> user -> id ));
$users = Pluf :: factory ( 'Pluf_User' ) -> getList ( array ( 'filter' => $sql -> gen ()));
if ( $users -> count () > 0 ) {
throw new Pluf_Form_Invalid ( __ ( 'A user with this email already exists, please provide another email address.' ));
}
return $email ;
}
2010-12-05 01:22:32 +01:00
function clean_custom_avatar ()
{
// Just png, jpeg/jpg or gif
if ( ! preg_match ( '/\.(png|jpg|jpeg|gif)$/i' , $this -> cleaned_data [ 'custom_avatar' ]) &&
$this -> cleaned_data [ 'custom_avatar' ] != '' ) {
@ unlink ( Pluf :: f ( 'upload_path' ) . '/avatars/' . $this -> cleaned_data [ 'custom_avatar' ]);
throw new Pluf_Form_Invalid ( __ ( 'For security reason, you cannot upload a file with this extension.' ));
}
return $this -> cleaned_data [ 'custom_avatar' ];
}
2009-01-02 11:20:10 +01:00
/**
2010-12-05 01:22:32 +01:00
* Check to see if the two passwords are the same .
2009-01-02 11:20:10 +01:00
*/
public function clean ()
{
2010-12-05 01:22:32 +01:00
if ( ! isset ( $this -> errors [ 'password' ])
2009-01-02 11:20:10 +01:00
&& ! isset ( $this -> errors [ 'password2' ])) {
$password1 = $this -> cleaned_data [ 'password' ];
$password2 = $this -> cleaned_data [ 'password2' ];
if ( $password1 != $password2 ) {
throw new Pluf_Form_Invalid ( __ ( 'The passwords do not match. Please give them again.' ));
}
}
return $this -> cleaned_data ;
}
}
