]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - actions/login.php
Merge branch 'master' of https://git.gnu.io/gnu/gnu-social into social-master
[quix0rs-gnu-social.git] / actions / login.php
index 4e580d36071482c905f913f1c70dec0f084d823a..f9fe71ed40503744562639af8676d8fbcf10fae9 100644 (file)
@@ -1,9 +1,12 @@
 <?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+/**
+ * StatusNet, 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.
  *
  * 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   GNUsocial
+ * @author    Evan Prodromou <evan@status.net>
+ * @author    Sarven Capadisli <csarven@status.net>
+ * @author    Mikael Nordfeldth <mmn@hethane.se>
+ * @copyright 2008-2009 StatusNet, Inc.
+ * @copyright 2013 Free Software Foundation, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://www.gnu.org/software/social/
  */
 
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('GNUSOCIAL')) { exit(1); }
 
-class LoginAction extends Action
+class LoginAction extends FormAction
 {
-    var $error = null;
-    
-    function isReadOnly()
-    {
-        return true;
-    }
+    protected $needLogin = false;
 
-    function handle($args)
+    /**
+     * Handle input, produce output
+     *
+     * Switches on request method; either shows the form or handles its input.
+     *
+     * @return void
+     */
+    protected function handle()
     {
-        parent::handle($args);
         if (common_is_real_login()) {
-            $this->clientError(_('Already logged in.'));
-        } else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
-            $this->checkLogin();
-        } else {
-            $this->showForm();
+            common_redirect(common_local_url('all', array('nickname' => $this->scoped->nickname)), 307);
         }
+
+        return parent::handle();
     }
 
-    function checkLogin()
+    /**
+     * 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
+     */
+    protected function doPost()
     {
-        # XXX: login throttle
-
-        # CSRF protection - token set in common_notice_form()
-        $token = $this->trimmed('token');
-        if (!$token || $token != common_session_token()) {
-            $this->clientError(_('There was a problem with your session token. Try again, please.'));
-            return;
-        }
+        // XXX: login throttle
 
-        $nickname = common_canonical_nickname($this->trimmed('nickname'));
+        $nickname = $this->trimmed('nickname');
         $password = $this->arg('password');
-        if (common_check_user($nickname, $password)) {
-            # success!
-            if (!common_set_user($nickname)) {
-                $this->serverError(_('Error setting user.'));
-                return;
-            }
-            common_real_login(true);
-            if ($this->boolean('rememberme')) {
-                common_debug('Adding rememberme cookie for ' . $nickname);
-                common_rememberme();
-            }
-            # success!
-            $url = common_get_returnto();
-            if ($url) {
-                # We don't have to return to it again
-                common_set_returnto(null);
-            } else {
-                $url = common_local_url('all',
-                                        array('nickname' =>
-                                              $nickname));
-            }
-            common_redirect($url);
-        } else {
-            $this->showForm(_('Incorrect username or password.'));
-            return;
+
+        $user = common_check_user($nickname, $password);
+
+        if (!$user instanceof User) {
+            // TRANS: Form validation error displayed when trying to log in with incorrect credentials.
+            throw new ServerException(_('Incorrect username or password.'));
         }
 
-        # success!
+        // success!
         if (!common_set_user($user)) {
-            $this->serverError(_('Error setting user.'));
-            return;
+            // TRANS: Server error displayed when during login a server error occurs.
+            throw new ServerException(_('Error setting user. You are probably not authorized.'));
         }
 
         common_real_login(true);
+        $this->updateScopedProfile(); 
 
         if ($this->boolean('rememberme')) {
-            common_debug('Adding rememberme cookie for ' . $nickname);
             common_rememberme($user);
         }
-        # 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);
+            $url = common_inject_session($url);
         } else {
             $url = common_local_url('all',
-                                    array('nickname' =>
-                                          $nickname));
+                                    array('nickname' => $this->scoped->nickname));
         }
-        common_redirect($url);
+
+        common_redirect($url, 303);
     }
 
-    function showForm($error=null)
+    function showScripts()
     {
-        $this->error = $error;
-        $this->showPage();
+        parent::showScripts();
+        $this->autofocus('nickname');
     }
 
+    /**
+     * Title of the page
+     *
+     * @return string title of the page
+     */
     function title()
     {
+        // TRANS: Page title for login page.
         return _('Login');
     }
 
-    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')));
+                                          'id' => 'form_login',
+                                          'class' => 'form_settings',
+                                          'action' => common_local_url('login')));
         $this->elementStart('fieldset');
+        // TRANS: Form legend on login page.
         $this->element('legend', null, _('Login to site'));
-        $this->elementStart('ul', 'form_datas');
+        $this->elementStart('ul', 'form_data');
         $this->elementStart('li');
-        $this->input('nickname', _('Nickname'));
+        // TRANS: Field label on login page.
+        $this->input('nickname', _('Username or email address'));
         $this->elementEnd('li');
         $this->elementStart('li');
+        // TRANS: Field label on login page.
         $this->password('password', _('Password'));
         $this->elementEnd('li');
         $this->elementStart('li');
+        // TRANS: Checkbox label label on login page.
         $this->checkbox('rememberme', _('Remember me'), false,
+                        // TRANS: Checkbox title on login page.
                         _('Automatically login in the future; ' .
-                           'not for shared computers!'));
+                          'not for shared computers!'));
         $this->elementEnd('li');
         $this->elementEnd('ul');
-        $this->submit('submit', _('Login'));
+        // TRANS: Button text for log in on login page.
+        $this->submit('submit', _m('BUTTON','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')),
+                       // TRANS: Link text for link to "reset password" on login page.
                        _('Lost or forgotten password?'));
         $this->elementEnd('p');
     }
 
-    function getInstructions()
+    /**
+     * 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
+     */
+    protected 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)
+            // TRANS: Form instructions on login page before being able to change user settings.
             return _('For security reasons, please re-enter your ' .
                      'user name and password ' .
                      'before changing your settings.');
         } else {
-            return _('Login with your username and password. ' .
-                     'Don\'t have a username yet? ' .
-                     '[Register](%%action.register%%) a new account, or ' .
-                     'try [OpenID](%%action.openidlogin%%). ');
+            // TRANS: Form instructions on login page.
+            $prompt = _('Login with your username and password.');
+            if (!common_config('site', 'closed') && !common_config('site', 'inviteonly')) {
+                $prompt .= ' ';
+                // TRANS: Form instructions on login page. This message contains Markdown links in the form [Link text](Link).
+                // TRANS: %%action.register%% is a link to the registration page.
+                $prompt .= _('Don\'t have a username yet? ' .
+                             '[Register](%%action.register%%) a new account.');
+            }
+            return $prompt;
         }
     }
+
+    /**
+     * A local menu
+     *
+     * Shows different login/register actions.
+     *
+     * @return void
+     */
+    function showLocalNav()
+    {
+        $nav = new LoginGroupNav($this);
+        $nav->show();
+    }
+
+    function showNoticeForm()
+    {
+    }
+
+    function showProfileBlock()
+    {
+    }
 }