actions/login.php

   1 <?php
   2 /**
   3  * Laconica, 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   Laconica
  24  * @author    Evan Prodromou <evan@controlyourself.ca>
  25  * @copyright 2008-2009 Control Yourself, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://laconi.ca/
  28  */
  29
  30 if (!defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Login form
  36  *
  37  * @category Personal
  38  * @package  Laconica
  39  * @author   Evan Prodromou <evan@controlyourself.ca>
  40  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  41  * @link     http://laconi.ca/
  42  */
  43
  44 class LoginAction extends Action
  45 {
  46     /**
  47      * Has there been an error?
  48      */
  49
  50     var $error = null;
  51
  52     /**
  53      * Is this a read-only action?
  54      *
  55      * @return boolean false
  56      */
  57
  58     function isReadOnly()
  59     {
  60         return false;
  61     }
  62
  63     /**
  64      * Handle input, produce output
  65      *
  66      * Switches on request method; either shows the form or handles its input.
  67      *
  68      * @param array $args $_REQUEST data
  69      *
  70      * @return void
  71      */
  72
  73     function handle($args)
  74     {
  75         parent::handle($args);
  76         if (common_is_real_login()) {
  77             $this->clientError(_('Already logged in.'));
  78         } else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
  79             $this->checkLogin();
  80         } else {
  81             common_ensure_session();
  82             $this->showForm();
  83         }
  84     }
  85
  86     /**
  87      * Check the login data
  88      *
  89      * Determines if the login data is valid. If so, logs the user
  90      * in, and redirects to the 'with friends' page, or to the stored
  91      * return-to URL.
  92      *
  93      * @return void
  94      */
  95
  96     function checkLogin()
  97     {
  98         // XXX: login throttle
  99
 100         // CSRF protection - token set in NoticeForm
 101         $token = $this->trimmed('token');
 102         if (!$token || $token != common_session_token()) {
 103             $this->clientError(_('There was a problem with your session token. '.
 104                                  'Try again, please.'));
 105             return;
 106         }
 107
 108         $nickname = common_canonical_nickname($this->trimmed('nickname'));
 109         $password = $this->arg('password');
 110
 111         $user = common_check_user($nickname, $password);
 112
 113         if (!$user) {
 114             $this->showForm(_('Incorrect username or password.'));
 115             return;
 116         }
 117
 118         // success!
 119         if (!common_set_user($user)) {
 120             $this->serverError(_('Error setting user.'));
 121             return;
 122         }
 123
 124         common_real_login(true);
 125
 126         if ($this->boolean('rememberme')) {
 127             common_rememberme($user);
 128         }
 129
 130         $url = common_get_returnto();
 131
 132         if ($url) {
 133             // We don't have to return to it again
 134             common_set_returnto(null);
 135         } else {
 136             $url = common_local_url('all',
 137                                     array('nickname' =>
 138                                           $nickname));
 139         }
 140
 141         common_redirect($url, 303);
 142     }
 143
 144     /**
 145      * Store an error and show the page
 146      *
 147      * This used to show the whole page; now, it's just a wrapper
 148      * that stores the error in an attribute.
 149      *
 150      * @param string $error error, if any.
 151      *
 152      * @return void
 153      */
 154
 155     function showForm($error=null)
 156     {
 157         $this->error = $error;
 158         $this->showPage();
 159     }
 160
 161     /**
 162      * Title of the page
 163      *
 164      * @return string title of the page
 165      */
 166
 167     function title()
 168     {
 169         return _('Login');
 170     }
 171
 172     /**
 173      * Show page notice
 174      *
 175      * Display a notice for how to use the page, or the
 176      * error if it exists.
 177      *
 178      * @return void
 179      */
 180
 181     function showPageNotice()
 182     {
 183         if ($this->error) {
 184             $this->element('p', 'error', $this->error);
 185         } else {
 186             $instr  = $this->getInstructions();
 187             $output = common_markup_to_html($instr);
 188
 189             $this->raw($output);
 190         }
 191     }
 192
 193     /**
 194      * Core of the display code
 195      *
 196      * Shows the login form.
 197      *
 198      * @return void
 199      */
 200
 201     function showContent()
 202     {
 203         $this->elementStart('form', array('method' => 'post',
 204                                            'id' => 'form_login',
 205                                            'class' => 'form_settings',
 206                                            'action' => common_local_url('login')));
 207         $this->elementStart('fieldset');
 208         $this->element('legend', null, _('Login to site'));
 209         $this->elementStart('ul', 'form_data');
 210         $this->elementStart('li');
 211         $this->input('nickname', _('Nickname'));
 212         $this->elementEnd('li');
 213         $this->elementStart('li');
 214         $this->password('password', _('Password'));
 215         $this->elementEnd('li');
 216         $this->elementStart('li');
 217         $this->checkbox('rememberme', _('Remember me'), false,
 218                         _('Automatically login in the future; ' .
 219                            'not for shared computers!'));
 220         $this->elementEnd('li');
 221         $this->elementEnd('ul');
 222         $this->submit('submit', _('Login'));
 223         $this->hidden('token', common_session_token());
 224         $this->elementEnd('fieldset');
 225         $this->elementEnd('form');
 226         $this->elementStart('p');
 227         $this->element('a', array('href' => common_local_url('recoverpassword')),
 228                        _('Lost or forgotten password?'));
 229         $this->elementEnd('p');
 230     }
 231
 232     /**
 233      * Instructions for using the form
 234      *
 235      * For "remembered" logins, we make the user re-login when they
 236      * try to change settings. Different instructions for this case.
 237      *
 238      * @return void
 239      */
 240
 241     function getInstructions()
 242     {
 243         if (common_logged_in() && !common_is_real_login() &&
 244             common_get_returnto()) {
 245             // rememberme logins have to reauthenticate before
 246             // changing any profile settings (cookie-stealing protection)
 247             return _('For security reasons, please re-enter your ' .
 248                      'user name and password ' .
 249                      'before changing your settings.');
 250         } else {
 251             return _('Login with your username and password. ' .
 252                      'Don\'t have a username yet? ' .
 253                      '[Register](%%action.register%%) a new account, or ' .
 254                      'try [OpenID](%%action.openidlogin%%). ');
 255         }
 256     }
 257
 258     /**
 259      * A local menu
 260      *
 261      * Shows different login/register actions.
 262      *
 263      * @return void
 264      */
 265
 266     function showLocalNav()
 267     {
 268         $nav = new LoginGroupNav($this);
 269         $nav->show();
 270     }
 271 }