summaryrefslogtreecommitdiff
path: root/actions/login.php
diff options
context:
space:
mode:
Diffstat (limited to 'actions/login.php')
-rw-r--r--actions/login.php237
1 files changed, 183 insertions, 54 deletions
diff --git a/actions/login.php b/actions/login.php
index 8600d44fd..11cf1f02a 100644
--- a/actions/login.php
+++ b/actions/login.php
@@ -1,9 +1,12 @@
<?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+/**
+ * Laconica, the distributed open-source microblogging tool
*
- * This program is free software: you can redistribute it and/or modify
+ * Login form
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
@@ -15,47 +18,98 @@
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category Login
+ * @package Laconica
+ * @author Evan Prodromou <evan@controlyourself.ca>
+ * @copyright 2008-2009 Control Yourself, Inc.
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link http://laconi.ca/
*/
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('LACONICA')) {
+ exit(1);
+}
+
+/**
+ * Login form
+ *
+ * @category Personal
+ * @package Laconica
+ * @author Evan Prodromou <evan@controlyourself.ca>
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link http://laconi.ca/
+ */
class LoginAction extends Action
{
+ /**
+ * Has there been an error?
+ */
+
+ var $error = null;
+
+ /**
+ * Is this a read-only action?
+ *
+ * @return boolean false
+ */
- function is_readonly()
+ function isReadOnly()
{
- return true;
+ return false;
}
+ /**
+ * Handle input, produce output
+ *
+ * Switches on request method; either shows the form or handles its input.
+ *
+ * @param array $args $_REQUEST data
+ *
+ * @return void
+ */
+
function handle($args)
{
parent::handle($args);
if (common_is_real_login()) {
- common_user_error(_('Already logged in.'));
+ $this->clientError(_('Already logged in.'));
} else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
- $this->check_login();
+ $this->checkLogin();
} else {
- $this->show_form();
+ $this->showForm();
}
}
- function check_login()
+ /**
+ * Check the login data
+ *
+ * Determines if the login data is valid. If so, logs the user
+ * in, and redirects to the 'with friends' page, or to the stored
+ * return-to URL.
+ *
+ * @return void
+ */
+
+ function checkLogin()
{
- # XXX: login throttle
+ // XXX: login throttle
- # CSRF protection - token set in common_notice_form()
+ // CSRF protection - token set in common_notice_form()
$token = $this->trimmed('token');
if (!$token || $token != common_session_token()) {
- $this->client_error(_('There was a problem with your session token. Try again, please.'));
+ $this->clientError(_('There was a problem with your session token. '.
+ 'Try again, please.'));
return;
}
$nickname = common_canonical_nickname($this->trimmed('nickname'));
$password = $this->arg('password');
if (common_check_user($nickname, $password)) {
- # success!
+ // success!
if (!common_set_user($nickname)) {
- common_server_error(_('Error setting user.'));
+ $this->serverError(_('Error setting user.'));
return;
}
common_real_login(true);
@@ -63,10 +117,10 @@ class LoginAction extends Action
common_debug('Adding rememberme cookie for ' . $nickname);
common_rememberme();
}
- # success!
+ // success!
$url = common_get_returnto();
if ($url) {
- # We don't have to return to it again
+ // We don't have to return to it again
common_set_returnto(null);
} else {
$url = common_local_url('all',
@@ -75,13 +129,13 @@ class LoginAction extends Action
}
common_redirect($url);
} else {
- $this->show_form(_('Incorrect username or password.'));
+ $this->showForm(_('Incorrect username or password.'));
return;
}
- # success!
+ // success!
if (!common_set_user($user)) {
- common_server_error(_('Error setting user.'));
+ $this->serverError(_('Error setting user.'));
return;
}
@@ -91,10 +145,10 @@ class LoginAction extends Action
common_debug('Adding rememberme cookie for ' . $nickname);
common_rememberme($user);
}
- # success!
+ // success!
$url = common_get_returnto();
if ($url) {
- # We don't have to return to it again
+ // We don't have to return to it again
common_set_returnto(null);
} else {
$url = common_local_url('all',
@@ -104,35 +158,109 @@ class LoginAction extends Action
common_redirect($url);
}
- function show_form($error=null)
+ /**
+ * Store an error and show the page
+ *
+ * This used to show the whole page; now, it's just a wrapper
+ * that stores the error in an attribute.
+ *
+ * @param string $error error, if any.
+ *
+ * @return void
+ */
+
+ function showForm($error=null)
+ {
+ $this->error = $error;
+ $this->showPage();
+ }
+
+ /**
+ * Title of the page
+ *
+ * @return string title of the page
+ */
+
+ function title()
{
- common_show_header(_('Login'), null, $error, array($this, 'show_top'));
- common_element_start('form', array('method' => 'post',
- 'id' => 'login',
+ return _('Login');
+ }
+
+ /**
+ * Show page notice
+ *
+ * Display a notice for how to use the page, or the
+ * error if it exists.
+ *
+ * @return void
+ */
+
+ function showPageNotice()
+ {
+ if ($this->error) {
+ $this->element('p', 'error', $this->error);
+ } else {
+ $instr = $this->getInstructions();
+ $output = common_markup_to_html($instr);
+
+ $this->raw($output);
+ }
+ }
+
+ /**
+ * Core of the display code
+ *
+ * Shows the login form.
+ *
+ * @return void
+ */
+
+ function showContent()
+ {
+ $this->elementStart('form', array('method' => 'post',
+ 'id' => 'form_login',
+ 'class' => 'form_settings',
'action' => common_local_url('login')));
- common_input('nickname', _('Nickname'));
- common_password('password', _('Password'));
- common_checkbox('rememberme', _('Remember me'), false,
+ $this->elementStart('fieldset');
+ $this->element('legend', null, _('Login to site'));
+ $this->elementStart('ul', 'form_data');
+ $this->elementStart('li');
+ $this->input('nickname', _('Nickname'));
+ $this->elementEnd('li');
+ $this->elementStart('li');
+ $this->password('password', _('Password'));
+ $this->elementEnd('li');
+ $this->elementStart('li');
+ $this->checkbox('rememberme', _('Remember me'), false,
_('Automatically login in the future; ' .
'not for shared computers!'));
- common_submit('submit', _('Login'));
- common_hidden('token', common_session_token());
- common_element_end('form');
- common_element_start('p');
- common_element('a', array('href' => common_local_url('recoverpassword')),
+ $this->elementEnd('li');
+ $this->elementEnd('ul');
+ $this->submit('submit', _('Login'));
+ $this->hidden('token', common_session_token());
+ $this->elementEnd('fieldset');
+ $this->elementEnd('form');
+ $this->elementStart('p');
+ $this->element('a', array('href' => common_local_url('recoverpassword')),
_('Lost or forgotten password?'));
- common_element_end('p');
- common_show_footer();
+ $this->elementEnd('p');
}
- function get_instructions()
+ /**
+ * Instructions for using the form
+ *
+ * For "remembered" logins, we make the user re-login when they
+ * try to change settings. Different instructions for this case.
+ *
+ * @return void
+ */
+
+ function getInstructions()
{
- if (common_logged_in() &&
- !common_is_real_login() &&
- common_get_returnto())
- {
- # rememberme logins have to reauthenticate before
- # changing any profile settings (cookie-stealing protection)
+ if (common_logged_in() && !common_is_real_login() &&
+ common_get_returnto()) {
+ // rememberme logins have to reauthenticate before
+ // changing any profile settings (cookie-stealing protection)
return _('For security reasons, please re-enter your ' .
'user name and password ' .
'before changing your settings.');
@@ -144,16 +272,17 @@ class LoginAction extends Action
}
}
- function show_top($error=null)
+ /**
+ * A local menu
+ *
+ * Shows different login/register actions.
+ *
+ * @return void
+ */
+
+ function showLocalNav()
{
- if ($error) {
- common_element('p', 'error', $error);
- } else {
- $instr = $this->get_instructions();
- $output = common_markup_to_html($instr);
- common_element_start('div', 'instructions');
- common_raw($output);
- common_element_end('div');
- }
+ $nav = new LoginGroupNav($this);
+ $nav->show();
}
}
generated by cgit v1.2.3-54-g00ecf (git 2.45.2) at 2024-10-31 00:08:32 +0000