actions/login.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Login form
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Login
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Sarven Capadisli <csarven@status.net>
  26  * @copyright 2008-2009 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 /**
  36  * Login form
  37  *
  38  * @category Personal
  39  * @package  StatusNet
  40  * @author   Evan Prodromou <evan@status.net>
  41  * @author   Sarven Capadisli <csarven@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://status.net/
  44  */
  45 class LoginAction extends Action
  46 {
  47     /**
  48      * Has there been an error?
  49      */
  50     var $error = null;
  51
  52     /**
  53      * Is this a read-only action?
  54      *
  55      * @return boolean false
  56      */
  57     function isReadOnly($args)
  58     {
  59         return false;
  60     }
  61
  62     /**
  63      * Prepare page to run
  64      *
  65      *
  66      * @param $args
  67      * @return string title
  68      */
  69     function prepare($args)
  70     {
  71         parent::prepare($args);
  72
  73         // @todo this check should really be in index.php for all sensitive actions
  74         $ssl = common_config('site', 'ssl');
  75         if (empty($_SERVER['HTTPS']) && ($ssl == 'always' || $ssl == 'sometimes')) {
  76             common_redirect(common_local_url('login'));
  77             // exit
  78         }
  79
  80         return true;
  81     }
  82
  83     /**
  84      * Handle input, produce output
  85      *
  86      * Switches on request method; either shows the form or handles its input.
  87      *
  88      * @param array $args $_REQUEST data
  89      *
  90      * @return void
  91      */
  92     function handle($args)
  93     {
  94         parent::handle($args);
  95
  96         if (common_is_real_login()) {
  97             $this->clientError(_('Already logged in.'));
  98         } else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
  99             $this->checkLogin();
 100         } else {
 101             common_ensure_session();
 102             $this->showForm();
 103         }
 104     }
 105
 106     /**
 107      * Check the login data
 108      *
 109      * Determines if the login data is valid. If so, logs the user
 110      * in, and redirects to the 'with friends' page, or to the stored
 111      * return-to URL.
 112      *
 113      * @return void
 114      */
 115     function checkLogin($user_id=null, $token=null)
 116     {
 117         // XXX: login throttle
 118
 119         $nickname = $this->trimmed('nickname');
 120         $password = $this->arg('password');
 121
 122         $user = common_check_user($nickname, $password);
 123
 124         if (!$user) {
 125             $this->showForm(_('Incorrect username or password.'));
 126             return;
 127         }
 128
 129         // success!
 130         if (!common_set_user($user)) {
 131             $this->serverError(_('Error setting user. You are probably not authorized.'));
 132             return;
 133         }
 134
 135         common_real_login(true);
 136
 137         if ($this->boolean('rememberme')) {
 138             common_rememberme($user);
 139         }
 140
 141         $url = common_get_returnto();
 142
 143         if ($url) {
 144             // We don't have to return to it again
 145             common_set_returnto(null);
 146             $url = common_inject_session($url);
 147         } else {
 148             $url = common_local_url('all',
 149                                     array('nickname' =>
 150                                           $user->nickname));
 151         }
 152
 153         common_redirect($url, 303);
 154     }
 155
 156     /**
 157      * Store an error and show the page
 158      *
 159      * This used to show the whole page; now, it's just a wrapper
 160      * that stores the error in an attribute.
 161      *
 162      * @param string $error error, if any.
 163      *
 164      * @return void
 165      */
 166     function showForm($error=null)
 167     {
 168         $this->error = $error;
 169         $this->showPage();
 170     }
 171
 172     function showScripts()
 173     {
 174         parent::showScripts();
 175         $this->autofocus('nickname');
 176     }
 177
 178     /**
 179      * Title of the page
 180      *
 181      * @return string title of the page
 182      */
 183     function title()
 184     {
 185         return _('Login');
 186     }
 187
 188     /**
 189      * Show page notice
 190      *
 191      * Display a notice for how to use the page, or the
 192      * error if it exists.
 193      *
 194      * @return void
 195      */
 196     function showPageNotice()
 197     {
 198         if ($this->error) {
 199             $this->element('p', 'error', $this->error);
 200         } else {
 201             $instr  = $this->getInstructions();
 202             $output = common_markup_to_html($instr);
 203
 204             $this->raw($output);
 205         }
 206     }
 207
 208     /**
 209      * Core of the display code
 210      *
 211      * Shows the login form.
 212      *
 213      * @return void
 214      */
 215     function showContent()
 216     {
 217         $this->elementStart('form', array('method' => 'post',
 218                                           'id' => 'form_login',
 219                                           'class' => 'form_settings',
 220                                           'action' => common_local_url('login')));
 221         $this->elementStart('fieldset');
 222         $this->element('legend', null, _('Login to site'));
 223         $this->elementStart('ul', 'form_data');
 224         $this->elementStart('li');
 225         $this->input('nickname', _('Nickname'));
 226         $this->elementEnd('li');
 227         $this->elementStart('li');
 228         $this->password('password', _('Password'));
 229         $this->elementEnd('li');
 230         $this->elementStart('li');
 231         $this->checkbox('rememberme', _('Remember me'), false,
 232                         _('Automatically login in the future; ' .
 233                           'not for shared computers!'));
 234         $this->elementEnd('li');
 235         $this->elementEnd('ul');
 236         $this->submit('submit', _('Login'));
 237         $this->elementEnd('fieldset');
 238         $this->elementEnd('form');
 239         $this->elementStart('p');
 240         $this->element('a', array('href' => common_local_url('recoverpassword')),
 241                        _('Lost or forgotten password?'));
 242         $this->elementEnd('p');
 243     }
 244
 245     /**
 246      * Instructions for using the form
 247      *
 248      * For "remembered" logins, we make the user re-login when they
 249      * try to change settings. Different instructions for this case.
 250      *
 251      * @return void
 252      */
 253     function getInstructions()
 254     {
 255         if (common_logged_in() && !common_is_real_login() &&
 256             common_get_returnto()) {
 257             // rememberme logins have to reauthenticate before
 258             // changing any profile settings (cookie-stealing protection)
 259             return _('For security reasons, please re-enter your ' .
 260                      'user name and password ' .
 261                      'before changing your settings.');
 262         } else {
 263             $prompt = _('Login with your username and password.');
 264             if (!common_config('site', 'closed') && !common_config('site', 'inviteonly')) {
 265                 $prompt .= ' ';
 266                 $prompt .= _('Don\'t have a username yet? ' .
 267                              '[Register](%%action.register%%) a new account.');
 268             }
 269             return $prompt;
 270         }
 271     }
 272
 273     /**
 274      * A local menu
 275      *
 276      * Shows different login/register actions.
 277      *
 278      * @return void
 279      */
 280     function showLocalNav()
 281     {
 282         $nav = new LoginGroupNav($this);
 283         $nav->show();
 284     }
 285 }