Source for file user.php

Documentation is available at user.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Site
  4.  * @subpackage  com_users
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  8.  */
  9.  
  10. defined('_JEXEC') or die;
  11.  
  12. require_once JPATH_COMPONENT . '/controller.php';
  13.  
  14. /**
  15.  * Registration controller class for Users.
  16.  *
  17.  * @package     Joomla.Site
  18.  * @subpackage  com_users
  19.  * @since       1.6
  20.  */
  21. class UsersControllerUser extends UsersController
  22. {
  23.     /**
  24.      * Method to log in a user.
  25.      *
  26.      * @since   1.6
  27.      */
  28.     public function login()
  29.     {
  30.         JSession::checkToken('post') or jexit(JText::_('JInvalid_Token'));
  31.  
  32.         $app = JFactory::getApplication();
  33.  
  34.         // Populate the data array:
  35.         $data = array();
  36.         $data['return'] = base64_decode($app->input->post->get('return', '', 'BASE64'));
  37.         $data['username'] = JRequest::getVar('username', '', 'method', 'username');
  38.         $data['password'] = JRequest::getString('password', '', 'post', JREQUEST_ALLOWRAW);
  39.         $data['secretkey'] = JRequest::getString('secretkey', '');
  40.  
  41.         // Set the return URL if empty.
  42.         if (empty($data['return']))
  43.         {
  44.             $data['return'] = 'index.php?option=com_users&view=profile';
  45.         }
  46.  
  47.         // Set the return URL in the user state to allow modification by plugins
  48.         $app->setUserState('users.login.form.return', $data['return']);
  49.  
  50.         // Get the log in options.
  51.         $options = array();
  52.         $options['remember'] = $this->input->getBool('remember', false);
  53.         $options['return'] = $data['return'];
  54.  
  55.         // Get the log in credentials.
  56.         $credentials = array();
  57.         $credentials['username']  = $data['username'];
  58.         $credentials['password']  = $data['password'];
  59.         $credentials['secretkey'] = $data['secretkey'];
  60.  
  61.         // Perform the log in.
  62.         if (true === $app->login($credentials, $options))
  63.         {
  64.             // Success
  65.             if ($options['remember'] = true)
  66.             {
  67.                 $app->setUserState('rememberLogin', true);
  68.             }
  69.  
  70.             $app->setUserState('users.login.form.data', array());
  71.             $app->redirect(JRoute::_($app->getUserState('users.login.form.return'), false));
  72.         }
  73.         else
  74.         {
  75.             // Login failed !
  76.             $data['remember'] = (int) $options['remember'];
  77.             $app->setUserState('users.login.form.data', $data);
  78.             $app->redirect(JRoute::_('index.php?option=com_users&view=login', false));
  79.         }
  80.     }
  81.  
  82.     /**
  83.      * Method to log out a user.
  84.      *
  85.      * @since   1.6
  86.      */
  87.     public function logout()
  88.     {
  89.         JSession::checkToken('request') or jexit(JText::_('JInvalid_Token'));
  90.  
  91.         $app = JFactory::getApplication();
  92.  
  93.         // Perform the log in.
  94.         $error = $app->logout();
  95.  
  96.         // Check if the log out succeeded.
  97.         if (!($error instanceof Exception))
  98.         {
  99.             // Get the return url from the request and validate that it is internal.
  100.             $return = JRequest::getVar('return', '', 'method', 'base64');
  101.             $return = base64_decode($return);
  102.             if (!JUri::isInternal($return))
  103.             {
  104.                 $return = '';
  105.             }
  106.  
  107.             // Redirect the user.
  108.             $app->redirect(JRoute::_($return, false));
  109.         }
  110.         else
  111.         {
  112.             $app->redirect(JRoute::_('index.php?option=com_users&view=login', false));
  113.         }
  114.     }
  115.  
  116.     /**
  117.      * Method to register a user.
  118.      *
  119.      * @since   1.6
  120.      */
  121.     public function register()
  122.     {
  123.         JSession::checkToken('post') or jexit(JText::_('JINVALID_TOKEN'));
  124.  
  125.         // Get the form data.
  126.         $data  = $this->input->post->get('user', array(), 'array');
  127.  
  128.         // Get the model and validate the data.
  129.         $model  = $this->getModel('Registration', 'UsersModel');
  130.         $return    = $model->validate($data);
  131.  
  132.         // Check for errors.
  133.         if ($return === false)
  134.         {
  135.             // Get the validation messages.
  136.             $app    = &JFactory::getApplication();
  137.             $errors    = $model->getErrors();
  138.  
  139.             // Push up to three validation messages out to the user.
  140.             for ($i = 0, $n = count($errors); $i < $n && $i < 3; $i++)
  141.             {
  142.                 if ($errors[$i] instanceof Exception)
  143.                 {
  144.                     $app->enqueueMessage($errors[$i]->getMessage(), 'notice');
  145.                 } else {
  146.                     $app->enqueueMessage($errors[$i], 'notice');
  147.                 }
  148.             }
  149.  
  150.             // Save the data in the session.
  151.             $app->setUserState('users.registration.form.data', $data);
  152.  
  153.             // Redirect back to the registration form.
  154.             $this->setRedirect('index.php?option=com_users&view=registration');
  155.             return false;
  156.         }
  157.  
  158.         // Finish the registration.
  159.         $return    = $model->register($data);
  160.  
  161.         // Check for errors.
  162.         if ($return === false)
  163.         {
  164.             // Save the data in the session.
  165.             $app->setUserState('users.registration.form.data', $data);
  166.  
  167.             // Redirect back to the registration form.
  168.             $message = JText::sprintf('COM_USERS_REGISTRATION_SAVE_FAILED', $model->getError());
  169.             $this->setRedirect('index.php?option=com_users&view=registration', $message, 'error');
  170.             return false;
  171.         }
  172.  
  173.         // Flush the data from the session.
  174.         $app->setUserState('users.registration.form.data', null);
  175.  
  176.         exit;
  177.     }
  178.  
  179.     /**
  180.      * Method to login a user.
  181.      *
  182.      * @since   1.6
  183.      */
  184.     public function remind()
  185.     {
  186.         // Check the request token.
  187.         JSession::checkToken('post') or jexit(JText::_('JINVALID_TOKEN'));
  188.  
  189.         $app   = JFactory::getApplication();
  190.         $model = $this->getModel('User', 'UsersModel');
  191.         $data  = $this->input->post->get('jform', array(), 'array');
  192.  
  193.         // Submit the username remind request.
  194.         $return    = $model->processRemindRequest($data);
  195.  
  196.         // Check for a hard error.
  197.         if ($return instanceof Exception)
  198.         {
  199.             // Get the error message to display.
  200.             if ($app->getCfg('error_reporting'))
  201.             {
  202.                 $message = $return->getMessage();
  203.             } else {
  204.                 $message = JText::_('COM_USERS_REMIND_REQUEST_ERROR');
  205.             }
  206.  
  207.             // Get the route to the next page.
  208.             $itemid = UsersHelperRoute::getRemindRoute();
  209.             $itemid = $itemid !== null ? '&Itemid='.$itemid : '';
  210.             $route    = 'index.php?option=com_users&view=remind'.$itemid;
  211.  
  212.             // Go back to the complete form.
  213.             $this->setRedirect(JRoute::_($route, false), $message, 'error');
  214.             return false;
  215.         } elseif ($return === false)
  216.         {
  217.             // Complete failed.
  218.             // Get the route to the next page.
  219.             $itemid = UsersHelperRoute::getRemindRoute();
  220.             $itemid = $itemid !== null ? '&Itemid='.$itemid : '';
  221.             $route    = 'index.php?option=com_users&view=remind'.$itemid;
  222.  
  223.             // Go back to the complete form.
  224.             $message = JText::sprintf('COM_USERS_REMIND_REQUEST_FAILED', $model->getError());
  225.             $this->setRedirect(JRoute::_($route, false), $message, 'notice');
  226.             return false;
  227.         }
  228.         else
  229.         {
  230.             // Complete succeeded.
  231.             // Get the route to the next page.
  232.             $itemid = UsersHelperRoute::getLoginRoute();
  233.             $itemid = $itemid !== null ? '&Itemid='.$itemid : '';
  234.             $route    = 'index.php?option=com_users&view=login'.$itemid;
  235.  
  236.             // Proceed to the login form.
  237.             $message = JText::_('COM_USERS_REMIND_REQUEST_SUCCESS');
  238.             $this->setRedirect(JRoute::_($route, false), $message);
  239.             return true;
  240.         }
  241.     }
  242.  
  243.     /**
  244.      * Method to login a user.
  245.      *
  246.      * @since   1.6
  247.      */
  248.     public function resend()
  249.     {
  250.         // Check for request forgeries
  251.         JSession::checkToken('post') or jexit(JText::_('JINVALID_TOKEN'));
  252.     }
  253. }

Documentation generated on Tue, 19 Nov 2013 15:16:18 +0100 by phpDocumentor 1.4.3