Clarify and simplify how session is destroyed and separate from session restore mechanism
[squirrelmail.git] / src / login.php
index f124cceffd643560d7527d6b57527291683c1745..2eaea9e239ea6b4846a309aa2d5675c074dbf7d5 100644 (file)
@@ -3,29 +3,26 @@
 /**
  * login.php -- simple login screen
  *
- * Copyright (c) 1999-2004 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
  * This a simple login screen. Some housekeeping is done to clean
  * cookies and find language.
  *
- * $Id$
+ * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
-define('SM_PATH','../');
+/** This is the login page */
+define('PAGE_NAME', 'login');
+
+/**
+ * Include the SquirrelMail initialization file.
+ */
+require('../include/init.php');
 
 /* SquirrelMail required files. */
-require_once(SM_PATH . 'functions/strings.php');
-require_once(SM_PATH . 'config/config.php');
-require_once(SM_PATH . 'functions/i18n.php');
-require_once(SM_PATH . 'functions/plugin.php');
-require_once(SM_PATH . 'functions/constants.php');
-require_once(SM_PATH . 'functions/page_header.php');
-require_once(SM_PATH . 'functions/html.php');
-require_once(SM_PATH . 'functions/global.php');
 require_once(SM_PATH . 'functions/imap_general.php');
+require_once(SM_PATH . 'functions/forms.php');
 
 /**
  * $squirrelmail_language is set by a cookie when the user selects
@@ -34,47 +31,69 @@ require_once(SM_PATH . 'functions/imap_general.php');
 set_up_language($squirrelmail_language, TRUE, TRUE);
 
 /**
- * Find out the base URI to set cookies.
- */
-if (!function_exists('sqm_baseuri')){
-    require_once(SM_PATH . 'functions/display_messages.php');
-}
-$base_uri = sqm_baseuri();
-
-/*
  * In case the last session was not terminated properly, make sure
- * we get a new one.
+ * we get a new one, but make sure we preserve session_expired_*
  */
+$sep = '';
+$sel = '';
+sqGetGlobalVar('session_expired_post', $sep, SQ_SESSION);
+sqGetGlobalVar('session_expired_location', $sel, SQ_SESSION);
 
+/* blow away session */
 sqsession_destroy();
-header('Pragma: no-cache');
 
 /**
- * This detects if the IMAP server has logins disabled, and if so, 
+ * in some rare instances, the session seems to stick
+ * around even after destroying it (!!), so if it does,
+ * we'll manually flatten the $_SESSION data
+ */
+if (!empty($_SESSION)) {
+    $_SESSION = array();
+}
+
+/* start session and put session_expired_* variables back in session */
+@sqsession_is_active();
+if (!empty($sep) && !empty($sel)) {
+    sqsession_register($sep, 'session_expired_post');
+    sqsession_register($sel, 'session_expired_location');
+}
+
+/**
+ * This detects if the IMAP server has logins disabled, and if so,
  * squelches the display of the login form and puts up a message
  * explaining the situation.
  */
 if($imap_auth_mech == 'login') {
-    $imap = sqimap_create_stream($imapServerAddress, $imapPort, $use_imap_tls);
-    $logindisabled = sqimap_capability($imap,'LOGINDISABLED');
-    sqimap_logout($imap);
-    if ($logindisabled) {
-        $string = "The IMAP server is reporting that logins are disabled.<br>";
-        if (!$use_imap_tls) {
-            $string .= "The use of TLS may allow SquirrelMail to login.<br>";
+    /**
+     * detect disabled login, only when imapServerAddress contains
+     * server address and not mapping. See sqimap_get_user_server()
+     */
+    if (substr($imapServerAddress, 0, 4) != "map:") {
+        $imap = sqimap_create_stream($imapServerAddress, $imapPort, $use_imap_tls);
+        $logindisabled = sqimap_capability($imap,'LOGINDISABLED');
+        sqimap_logout($imap);
+        if ($logindisabled) {
+            $string = _("The IMAP server is reporting that plain text logins are disabled.").'<br />'.
+                _("Using CRAM-MD5 or DIGEST-MD5 authentication instead may work.").'<br />';
+            if (!$use_imap_tls) {
+                $string .= _("Also, the use of TLS may allow SquirrelMail to login.").'<br />';
+            }
+            $string .= _("Please contact your system administrator and report this error.");
+            error_box($string);
+            // display footer (closes html tags) and stop script execution
+            $oTemplate->display('footer.tpl');
+            exit;
         }
-        $string .= "Please contact your system administrator.";
-        error_box($string,$color);
-        exit;
     }
 }
 
-do_hook('login_cookie');
+do_hook('login_cookie', $null);
 
-/* Output the javascript onload function. */
+$loginname_value = (sqGetGlobalVar('loginname', $loginname) ? htmlspecialchars($loginname) : '');
 
-$header = "<script language=\"JavaScript\" type=\"text/javascript\">\n" .
+//FIXME: should be part of the template, not the core!
+/* Output the javascript onload function. */
+$header = "<script type=\"text/javascript\">\n" .
           "<!--\n".
           "  function squirrelmail_loginpage_onload() {\n".
           "    var textElements = 0;\n".
@@ -94,92 +113,84 @@ $header = "<script language=\"JavaScript\" type=\"text/javascript\">\n" .
 if (@file_exists($theme[$theme_default]['PATH']))
    @include ($theme[$theme_default]['PATH']);
 
-displayHtmlHeader( "$org_name - " . _("Login"), $header, FALSE );
+if (! isset($color) || ! is_array($color)) {
+    // Add default color theme, if theme loading fails
+    $color = array();
+    $color[0]  = '#dcdcdc';  /* light gray    TitleBar               */
+    $color[1]  = '#800000';  /* red                                  */
+    $color[2]  = '#cc0000';  /* light red     Warning/Error Messages */
+    $color[4]  = '#ffffff';  /* white         Normal Background      */
+    $color[7]  = '#0000cc';  /* blue          Links                  */
+    $color[8]  = '#000000';  /* black         Normal text            */
+}
 
-echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\" onLoad=\"squirrelmail_loginpage_onload()\">" .
-     "\n" . '<form action="redirect.php" method="post" onSubmit="document.forms[0].js_autodetect_results.value=\'' . SMPREF_JS_ON .'\';">' . "\n";
+displayHtmlHeader( "$org_name - " . _("Login"), $header, FALSE );
 
-$username_form_name = 'login_username';
-$password_form_name = 'secretkey';
-do_hook('login_top');
 
-$loginname_value = (sqGetGlobalVar('loginname', $loginname) ? htmlspecialchars($loginname) : '');
 
 /* If they don't have a logo, don't bother.. */
+$logo_str = '';
 if (isset($org_logo) && $org_logo) {
-    /* Display width and height like good little people */
-    $width_and_height = '';
+
     if (isset($org_logo_width) && is_numeric($org_logo_width) &&
      $org_logo_width>0) {
-        $width_and_height = " width=\"$org_logo_width\"";
+        $width = $org_logo_width;
+    } else {
+        $width = '';
     }
     if (isset($org_logo_height) && is_numeric($org_logo_height) &&
      $org_logo_height>0) {
-        $width_and_height .= " height=\"$org_logo_height\"";
+        $height = $org_logo_height;
+    } else {
+        $height = '';
     }
+
+    $logo_str = create_image($org_logo, sprintf(_("%s Logo"), $org_name),
+                             $width, $height, '', 'sqm_loginImage');
+
+}
+
+$sm_attribute_str = '';
+if (isset($hide_sm_attributions) && !$hide_sm_attributions) {
+    $sm_attribute_str = _("SquirrelMail Webmail")."\n" .
+                        _("By the SquirrelMail Project Team");
 }
 
-if(sqgetGlobalVar('mailto', $mailto)) {
-    $rcptaddress = '<input type="hidden" name="mailto" value="' . urlencode($mailto) . '" />' . "\n";
+if(sqgetGlobalVar('mailtodata', $mailtodata)) {
+    $mailtofield = addHidden('mailtodata', $mailtodata);
 } else {
-    $rcptaddress = '';
+    $mailtofield = '';
 }
-echo html_tag( 'table',
-    html_tag( 'tr',
-        html_tag( 'td',
-            '<center>'.
-            ( isset($org_logo) && $org_logo
-              ? '<img src="' . $org_logo . '" alt="' .
-                sprintf(_("%s Logo"), $org_name) .'"' . $width_and_height .
-                ' /><br />' . "\n"
-              : '' ).
-            ( (isset($hide_sm_attributions) && $hide_sm_attributions) ? '' :
-            '<small>' . sprintf (_("SquirrelMail version %s"), $version) . '<br />' ."\n".
-            '  ' . _("By the SquirrelMail Development Team") . '<br /></small>' . "\n" ) .
-            html_tag( 'table',
-                html_tag( 'tr',
-                    html_tag( 'td',
-                        '<b>' . sprintf (_("%s Login"), $org_name) . "</b>\n",
-                    'center', $color[0] )
-                ) .
-                html_tag( 'tr',
-                    html_tag( 'td',  "\n" .
-                        html_tag( 'table',
-                            html_tag( 'tr',
-                                html_tag( 'td',
-                                    _("Name:") ,
-                                'right', '', 'width="30%"' ) .
-                                html_tag( 'td',
-                                    '<input type="text" name="' . $username_form_name .'" value="' . $loginname_value .'" />' ,
-                                'left', '', 'width="*"' )
-                                ) . "\n" .
-                            html_tag( 'tr',
-                                html_tag( 'td',
-                                    _("Password:") ,
-                                'right', '', 'width="30%"' ) .
-                                html_tag( 'td',
-                                    '<input type="password" name="' . $password_form_name . '" />' . "\n" .
-                                    '<input type="hidden" name="js_autodetect_results" value="'.SMPREF_JS_OFF.'" />' . "\n" .
-                                    $rcptaddress .
-                                    '<input type="hidden" name="just_logged_in" value="1" />' . "\n",
-                                'left', '', 'width="*"' )
-                            ) ,
-                        'center', $color[4], 'border="0" width="100%"' ) ,
-                    'left', $color[4] )
-                ) . 
-                html_tag( 'tr',
-                    html_tag( 'td',
-                        '<center><input type="submit" value="' . _("Login") . '" /></center>',
-                    'left' )
-                ),
-            '', $color[4], 'border="0" width="350"' ) . '</center>',
-        'center' )
-    ) ,
-'', $color[4], 'border="0" cellspacing="0" cellpadding="0" width="100%"' );
-do_hook('login_form');
-echo '</form>' . "\n";
-
-do_hook('login_bottom');
-echo "</body>\n".
-     "</html>\n";
-?>
+
+$password_field = addPwField('secretkey');
+$login_extra = addHidden('js_autodetect_results', SMPREF_JS_OFF).
+               $mailtofield .
+               addHidden('just_logged_in', '1');
+
+session_write_close();
+
+$oTemplate->assign('logo_str', $logo_str, FALSE);
+$oTemplate->assign('logo_path', $org_logo);
+$oTemplate->assign('sm_attribute_str', $sm_attribute_str);
+// i18n: The %s represents the service provider's name
+$oTemplate->assign('org_name_str', sprintf (_("%s Login"), $org_name));
+// i18n: The %s represents the service provider's name
+$oTemplate->assign('org_logo_str', sprintf (_("The %s logo"), $org_name));
+$oTemplate->assign('login_field_value', $loginname_value);
+$oTemplate->assign('login_extra', $login_extra, FALSE);
+
+//FIXME: need to remove *ALL* HTML from this file!
+echo '<body onload="squirrelmail_loginpage_onload()">'."\n";
+echo '<form action="redirect.php" method="post" onsubmit="document.forms[0].js_autodetect_results.value='. SMPREF_JS_ON .'">'."\n";
+do_hook('login_top', $null);
+
+$oTemplate->display('login.tpl');
+
+//FIXME: need to remove *ALL* HTML from this file!
+echo "</form>\n";
+do_hook('login_bottom', $null);
+
+// Turn off delayed error handling to make sure all errors are dumped.
+$oErrorHandler->setDelayedErrors(false);
+
+$oTemplate->display('footer.tpl');