Editprofile.php

<?php
/**
 *
 * License, TERMS and CONDITIONS
 *
 * This software is licensed under the GNU LESSER GENERAL PUBLIC LICENSE (LGPL) version 3
 * Please read the license here : http://www.gnu.org/licenses/lgpl-3.0.txt
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * ATTRIBUTION REQUIRED
 * 4. All web pages generated by the use of this software, or at least
 *       the page that lists the recent questions (usually home page) must include
 *    a link to the http://www.lampcms.com and text of the link must indicate that
 *    the website\'s Questions/Answers functionality is powered by lampcms.com
 *    An example of acceptable link would be "Powered by <a href="http://www.lampcms.com">LampCMS</a>"
 *    The location of the link is not important, it can be in the footer of the page
 *    but it must not be hidden by style attributes
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE FREEBSD PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This product includes GeoLite data created by MaxMind,
 *  available from http://www.maxmind.com/
 *
 *
 * @author     Dmitri Snytkine <cms@lampcms.com>
 * @copyright  2005-2012 (or current year) Dmitri Snytkine
 * @license    http://www.gnu.org/licenses/lgpl-3.0.txt GNU LESSER GENERAL PUBLIC LICENSE (LGPL) version 3
 * @link       http://www.lampcms.com   Lampcms.com project
 * @version    Release: @package_version@
 *
 *
 */


namespace Lampcms\Controllers;

use Lampcms\SubmittedProfileWWW;
use Lampcms\WebPage;
use Lampcms\ProfileParser;

class Editprofile extends WebPage
{

    /**
     * Pre-check to deny non-logged in user
     * access to this page
     *
     * @var bool
     */
    protected $membersOnly = true;


    /**
     *
     * Viewer must have edit_profile
     * permission to access this page
     *
     * @var string
     */
    protected $permission = 'edit_profile';


    /**
     * $layoutID 1 means no side-column on page
     *
     * @var int
     */
    protected $layoutID = 1;


    /**
     * Form object
     *
     * @var object of type \Lampcms\Forms\Form
     */
    protected $Form;


    /**
     * User object of user whose profile
     * is being edited
     *
     * @var object of type User
     */
    protected $User;


    protected function main()
    {
        $this->getUser();
        $this->Form                                        = new \Lampcms\Forms\Profile($this->Registry);
        $this->Form->formTitle = $this->aPageVars['title'] = '@@Edit Profile@@';

        if ($this->Form->isSubmitted() && $this->Form->validate()) {
            $this->Registry->Dispatcher->post($this->Form, 'onBeforeProfileUpdate');
            //try{
            $this->saveProfile();
            $this->Registry->Dispatcher->post($this->Form, 'onProfileUpdate');
            $this->aPageVars['body'] = \tplProfileSuccess::parse(array('@@Profile has been updated@@', $this->User->getProfileUrl(), '@@View the new profile@@'), false);
            /*} catch (\Lampcms\Exception $e){
                   $this->Form->setFormError($e->getMessage());
                   $this->setForm();
                   $this->aPageVars['body'] = $this->Form->getForm();
               }*/
        } else {
            $this->setForm();
            $this->aPageVars['body'] = $this->Form->getForm();
        }
    }


    /**
     * Create $this->User User object for user whose
     * profile is being edited
     *
     * @return object $this
     */
    protected function getUser()
    {
        $uid = (!\Lampcms\Request::isPost()) ? $this->Router->getSegment(1, 'i', 0) : $this->Request->get('uid', 'i', null);
        if ($uid && ($uid !== $this->Registry->Viewer->getUid())) {
            /**
             * This is edit profile for another user
             * check Viewer permission here
             */
            $this->checkAccessPermission('edit_any_profile');
            $this->User = \Lampcms\User::userFactory($this->Registry)->by_id($uid);
        } else {
            $this->User = $this->Registry->Viewer;
        }

        return $this;
    }


    /**
     * Populate form elements with
     * values from current user profile
     *
     * @return object $this
     */
    protected function setForm()
    {

        $this->Form->username      = $this->User['username'];
        $this->Form->usernameLabel = '@@Username@@';
        $this->Form->fn            = $this->User['fn'];
        $this->Form->mn            = $this->User['mn'];
        $this->Form->ln            = $this->User['ln'];
        $this->Form->gender        = $this->getGenderOptions();
        $this->Form->dob           = $this->User['dob'];
        $this->Form->cc            = $this->getCountryOptions();
        $this->Form->state         = $this->User['state'];
        $this->Form->city          = $this->User['city'];
        $this->Form->url           = $this->User['url'];
        $this->Form->zip           = $this->User['zip'];
        $this->Form->description   = $this->User['description'];
        $this->Form->avatarSrc     = $this->User->getAvatarSrc();
        $this->Form->width         = $this->Registry->Ini->AVATAR_SQUARE_SIZE;
        $this->Form->uid           = $this->User->getUid();
        $this->Form->maxAvatarSize = $this->Registry->Ini->MAX_AVATAR_UPLOAD_SIZE;
        $this->Form->timezone      = $this->getTimeZonesMenu(); //\Lampcms\TimeZone::getMenu($this->User->getTimezone());

        $this->Form->avatarTos = \sprintf('@@Upload Image. Maximum size of@@ %sMb<br><span class="smaller">@@By uploading a file you certify that you have the right to distribute this picture and that it does not violate the Terms of Service@@</span>', \floor($this->Registry->Ini->MAX_AVATAR_UPLOAD_SIZE / 1000000));

        /**
         * Add '  hide' class to avatar upload
         * if php does not have gd of support for jpeg
         * inside gd
         */
        if (!\extension_loaded('gd') || !\function_exists('imagecreatefromjpeg')) {
            $this->Form->hideAvatar = ' hide';
        }

        return $this;
    }


    protected function getTimeZonesMenu(){

        $translate = $this->Registry->Ini->ENABLE_TIMEZONE_TRANSLATION;
        $menu = \Lampcms\TimeZone::getMenuOptions($this->Registry->Locale->getLocale(), (bool)$translate);
        $current = $this->User->getTimezone();

        return \str_replace('value="'.$current.'"', 'value="'.$current.'" selected="selected"', $menu );
    }


    /**
     * Save changed to user profile
     * using ProfileParser class
     *
     * @return object $this
     */
    protected function saveProfile()
    {

        ProfileParser::factory($this->Registry)->save($this->User, new SubmittedProfileWWW($this->Form));

        /**
         * Should unset 'welcome' from session
         * because it contains user display name in the
         * link and display name may have changed as a
         * result of editing first, middle and last names
         */
        unset($_SESSION['welcome']);

        return $this;
    }


    /**
     * Generates string with <option></option> html elements
     * that will be used as html of the <select> dropdown
     * menu for Country selection
     *
     * @todo use 'cc' key from USER as value
     *       and country name only as label! Don NOT
     *       set 'country' key at all!
     *       For this we need an array that translates
     * 2-letter country code 'cc' to the full country name
     *
     * @return string html string
     */
    protected function getCountryOptions()
    {
        $s          = '';
        $current    = \strtoupper($this->Registry->Viewer['cc']);
        $tpl        = '<option value="%1$s"%2$s>%3$s</option>';
        $aCountries = \array_combine(\Lampcms\Geo\Location::getCodes(), \Lampcms\Geo\Location::getNames());

        foreach ($aCountries as $key => $val) {
            $selected = ($current == $key) ? ' selected' : '';
            $name     = (empty($val)) ? '@@Select country@@' : $val;

            $s .= \vsprintf($tpl, array($key, $selected, $name));
        }

        return $s;
    }


    /**
     * Generates string with 3 <option></option> html elements
     * for the value of "Gender" drop-down menu
     * it also sets the "selected" value of an option
     * that matches the current value in Viewer object
     *
     *
     * @return string html string
     */
    protected function getGenderOptions()
    {
        $current = $this->Registry->Viewer['gender'];
        $s       = '';
        $a       = array('' => '@@Select Gender@@', 'M' => '@@Male@@', 'F' => '@@Female@@');
        $tpl     = '<option value="%1$s"%2$s>%3$s</option>';
        foreach ($a as $key => $val) {
            $selected = ($key === $current) ? ' selected' : '';
            $s .= \vsprintf($tpl, array($key, $selected, $val));
        }

        return $s;
    }

}