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             common_redirect(common_local_url('index'));
  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             // TRANS: Form validation error displayed when trying to log in with incorrect credentials.
 126             $this->showForm(_('Incorrect username or password.'));
 127             return;
 128         }
 129
 130         // success!
 131         if (!common_set_user($user)) {
 132             // TRANS: Server error displayed when during login a server error occurs.
 133             $this->serverError(_('Error setting user. You are probably not authorized.'));
 134             return;
 135         }
 136
 137         common_real_login(true);
 138
 139         if ($this->boolean('rememberme')) {
 140             common_rememberme($user);
 141         }
 142
 143         $url = common_get_returnto();
 144
 145         if ($url) {
 146             // We don't have to return to it again
 147             common_set_returnto(null);
 148             $url = common_inject_session($url);
 149         } else {
 150             $url = common_local_url('all',
 151                                     array('nickname' =>
 152                                           $user->nickname));
 153         }
 154
 155         common_redirect($url, 303);
 156     }
 157
 158     /**
 159      * Store an error and show the page
 160      *
 161      * This used to show the whole page; now, it's just a wrapper
 162      * that stores the error in an attribute.
 163      *
 164      * @param string $error error, if any.
 165      *
 166      * @return void
 167      */
 168     function showForm($error=null)
 169     {
 170         $this->error = $error;
 171         $this->showPage();
 172     }
 173
 174     function showScripts()
 175     {
 176         parent::showScripts();
 177         $this->autofocus('nickname');
 178     }
 179
 180     /**
 181      * Title of the page
 182      *
 183      * @return string title of the page
 184      */
 185     function title()
 186     {
 187         // TRANS: Page title for login page.
 188         return _('Login');
 189     }
 190
 191     /**
 192      * Show page notice
 193      *
 194      * Display a notice for how to use the page, or the
 195      * error if it exists.
 196      *
 197      * @return void
 198      */
 199     function showPageNotice()
 200     {
 201         if ($this->error) {
 202             $this->element('p', 'error', $this->error);
 203         } else {
 204             $instr  = $this->getInstructions();
 205             $output = common_markup_to_html($instr);
 206
 207             $this->raw($output);
 208         }
 209     }
 210
 211     /**
 212      * Core of the display code
 213      *
 214      * Shows the login form.
 215      *
 216      * @return void
 217      */
 218     function showContent()
 219     {
 220         $this->elementStart('form', array('method' => 'post',
 221                                           'id' => 'form_login',
 222                                           'class' => 'form_settings',
 223                                           'action' => common_local_url('login')));
 224         $this->elementStart('fieldset');
 225         // TRANS: Form legend on login page.
 226         $this->element('legend', null, _('Login to site'));
 227         $this->elementStart('ul', 'form_data');
 228         $this->elementStart('li');
 229         // TRANS: Field label on login page.
 230         $this->input('nickname', _('Username or email address'));
 231         $this->elementEnd('li');
 232         $this->elementStart('li');
 233         // TRANS: Field label on login page.
 234         $this->password('password', _('Password'));
 235         $this->elementEnd('li');
 236         $this->elementStart('li');
 237         // TRANS: Checkbox label label on login page.
 238         $this->checkbox('rememberme', _('Remember me'), false,
 239                         // TRANS: Checkbox title on login page.
 240                         _('Automatically login in the future; ' .
 241                           'not for shared computers!'));
 242         $this->elementEnd('li');
 243         $this->elementEnd('ul');
 244         // TRANS: Button text for log in on login page.
 245         $this->submit('submit', _m('BUTTON','Login'));
 246         $this->elementEnd('fieldset');
 247         $this->elementEnd('form');
 248         $this->elementStart('p');
 249         $this->element('a', array('href' => common_local_url('recoverpassword')),
 250                        // TRANS: Link text for link to "reset password" on login page.
 251                        _('Lost or forgotten password?'));
 252         $this->elementEnd('p');
 253     }
 254
 255     /**
 256      * Instructions for using the form
 257      *
 258      * For "remembered" logins, we make the user re-login when they
 259      * try to change settings. Different instructions for this case.
 260      *
 261      * @return void
 262      */
 263     function getInstructions()
 264     {
 265         if (common_logged_in() && !common_is_real_login() &&
 266             common_get_returnto()) {
 267             // rememberme logins have to reauthenticate before
 268             // changing any profile settings (cookie-stealing protection)
 269             // TRANS: Form instructions on login page before being able to change user settings.
 270             return _('For security reasons, please re-enter your ' .
 271                      'user name and password ' .
 272                      'before changing your settings.');
 273         } else {
 274             // TRANS: Form instructions on login page.
 275             $prompt = _('Login with your username and password.');
 276             if (!common_config('site', 'closed') && !common_config('site', 'inviteonly')) {
 277                 $prompt .= ' ';
 278                 // TRANS: Form instructions on login page. This message contains Markdown links in the form [Link text](Link).
 279                 // TRANS: %%action.register%% is a link to the registration page.
 280                 $prompt .= _('Don\'t have a username yet? ' .
 281                              '[Register](%%action.register%%) a new account.');
 282             }
 283             return $prompt;
 284         }
 285     }
 286
 287     /**
 288      * A local menu
 289      *
 290      * Shows different login/register actions.
 291      *
 292      * @return void
 293      */
 294     function showLocalNav()
 295     {
 296         $nav = new LoginGroupNav($this);
 297         $nav->show();
 298     }
 299
 300     function showNoticeForm()
 301     {
 302     }
 303
 304     function showProfileBlock()
 305     {
 306     }
 307 }