SC_index Class Reference

List of all members.

Public Member Functions
	init ()
	Initialize the login box.
	main ()
	Main function - creating the login/logout form.
	printContent ()
	Outputting the accumulated content to screen.
	makeLoginForm ()
	Creates the login form This is drawn when NO login exists.
	makeLogoutForm ()
	Creates the logout form This is drawn if a user login already exists.
	wrapLoginForm ($content)
	Wrapping the login form table in another set of tables etc:.
	checkRedirect ()
	Checking, if we should perform some sort of redirection OR closing of windows.
	makeInterfaceSelectorBox ()
	Making interface selector:.
	makeCopyrightNotice ()
	COPYRIGHT notice.
	makeLoginBoxImage ()
	Returns the login box image, whether the default or an image from the rotation folder.
	makeLoginNews ()
	Make login news - renders the HTML content for a list of news shown under the login form.
Public Attributes
	$redirect_url
	$GPinterface
	$u
	$p
	$L
	$loginRefresh
	$commandLI
	$redirectToURL
	$L_vars
	$content
	$interfaceSelector
	$interfaceSelector_jump
	$interfaceSelector_hidden

---

Member Function Documentation

SC_index::checkRedirect (   )

Checking, if we should perform some sort of redirection OR closing of windows. Returns: void Definition at line 411 of file index.php. References $TBE_TEMPLATE, error(), header(), and typo3PrintError(). { global $BE_USER,$TBE_TEMPLATE; // Do redirect: // If a user is logged in AND a) if either the login is just done (commandLI) or b) a loginRefresh is done or c) the interface-selector is NOT enabled (If it is on the other hand, it should not just load an interface, because people has to choose then...) if ($BE_USER->user['uid'] && ($this->commandLI || $this->loginRefresh || !$this->interfaceSelector)) { // If no cookie has been set previously we tell people that this is a problem. This assumes that a cookie-setting script (like this one) has been hit at least once prior to this instance. if (!$_COOKIE[$BE_USER->name]) { t3lib_BEfunc::typo3PrintError ('Login-error',"Yeah, that's a classic. No cookies, no TYPO3.<br /><br />Please accept cookies from TYPO3 - otherwise you'll not be able to use the system.",0); exit; } // Based on specific setting of interface we set the redirect script: switch ($this->GPinterface) { case 'backend': $this->redirectToURL = 'alt_main.php'; break; case 'frontend': $this->redirectToURL = '../'; break; } // If there is a redirect URL AND if loginRefresh is not set... if (!$this->loginRefresh) { header('Location: '.t3lib_div::locationHeaderUrl($this->redirectToURL)); exit; } else { $TBE_TEMPLATE->JScode.=$TBE_TEMPLATE->wrapScriptTags(' if (parent.opener && parent.opener.busy) { parent.opener.busy.loginRefreshed(); parent.close(); } '); } } elseif(!$BE_USER->user['uid'] && $this->commandLI) { sleep(5); } }

SC_index::init (   )

Initialize the login box. Will also react on a &L=OUT flag and exit. Returns: void Definition at line 119 of file index.php. References header(). { global $BE_USER,$TYPO3_CONF_VARS; // GPvars: $this->redirect_url = t3lib_div::_GP('redirect_url'); $this->GPinterface = t3lib_div::_GP('interface'); $this->u = t3lib_div::_GP('u'); // preset username $this->p = t3lib_div::_GP('p'); // preset password $this->L = t3lib_div::_GP('L'); // If "L" is "OUT", then any logged in used is logged out. If redirect_url is given, we redirect to it $this->loginRefresh = t3lib_div::_GP('loginRefresh'); // Login $this->commandLI = t3lib_div::_GP('commandLI'); // Value of "Login" button. If set, the login button was pressed. // Getting login labels: $this->L_vars = explode('|',$TYPO3_CONF_VARS['BE']['loginLabels']); // Setting the redirect URL to "alt_main.php" if no alternative input is given: $this->redirectToURL = $this->redirect_url ? $this->redirect_url : 'alt_main.php'; // Logout? if ($this->L=='OUT' && is_object($BE_USER)) { $BE_USER->logoff(); if ($this->redirect_url) header('Location: '.t3lib_div::locationHeaderUrl($this->redirect_url)); exit; } }

SC_index::main (   )

Main function - creating the login/logout form. Returns: void Definition at line 150 of file index.php. References $TBE_TEMPLATE. { global $TBE_TEMPLATE, $TYPO3_CONF_VARS, $BE_USER; // Initialize template object: $TBE_TEMPLATE->docType='xhtml_trans'; // Set JavaScript for creating a MD5 hash of the password: $TBE_TEMPLATE->JScode.=' <script type="text/javascript" src="md5.js"></script> '.$TBE_TEMPLATE->wrapScriptTags(' function doChallengeResponse() { // password = document.loginform.p_field.value; if (password) { password = MD5(password); // this makes it superchallenged!! str = document.loginform.username.value+":"+password+":"+document.loginform.challenge.value; document.loginform.userident.value = MD5(str); document.loginform.p_field.value = ""; return true; } } '); // Checking, if we should make a redirect. // Might set JavaScript in the header to close window. $this->checkRedirect(); // Initialize interface selectors: $this->makeInterfaceSelectorBox(); // Replace an optional marker in the "Administration Login" label $this->L_vars[6] = str_replace("###SITENAME###",$TYPO3_CONF_VARS['SYS']['sitename'],$this->L_vars[6]); // Creating form based on whether there is a login or not: if (!$BE_USER->user['uid']) { $TBE_TEMPLATE->form = ' <form action="index.php" method="post" name="loginform" onsubmit="doChallengeResponse();"> <input type="hidden" name="login_status" value="login" /> '; $loginForm = $this->makeLoginForm(); } else { $TBE_TEMPLATE->form = ' <form action="index.php" method="post" name="loginform"> <input type="hidden" name="login_status" value="logout" /> '; $loginForm = $this->makeLogoutForm(); } // Starting page: $this->content.=$TBE_TEMPLATE->startPage('TYPO3 Login: '.$TYPO3_CONF_VARS['SYS']['sitename']); // Add login form: $this->content.=$this->wrapLoginForm($loginForm); // Ending form: $this->content.= ' <input type="hidden" name="userident" value="" /> <input type="hidden" name="challenge" value="'.md5(uniqid('')).'" /> <input type="hidden" name="redirect_url" value="'.htmlspecialchars($this->redirectToURL).'" /> <input type="hidden" name="loginRefresh" value="'.htmlspecialchars($this->loginRefresh).'" /> '.$this->interfaceSelector_hidden.' '; // This moves focus to the right input field: $this->content.=$TBE_TEMPLATE->wrapScriptTags(' // If the login screen is shown in the login_frameset window for re-login, then try to get the username of the current/former login from opening windows main frame: if (parent.opener && parent.opener.TS && parent.opener.TS.username && document.loginform && document.loginform.username) { document.loginform.username.value = parent.opener.TS.username; } // If for some reason there already is a username in the username for field, move focus to the password field: if (document.loginform.username && document.loginform.username.value == "") { document.loginform.username.focus(); } else if (document.loginform.p_field && document.loginform.p_field.type!="hidden") { document.loginform.p_field.focus(); } '); // End page: $this->content.=$TBE_TEMPLATE->endPage(); }

SC_index::makeCopyrightNotice (   )

COPYRIGHT notice. Warning: DO NOT prevent this notice from being shown in ANY WAY. According to the GPL license an interactive application must show such a notice on start-up ('If the program is interactive, make it output a short notice... ' - see GPL.txt) Therefore preventing this notice from being properly shown is a violation of the license, regardless of whether you remove it or use a stylesheet to obstruct the display. Returns: string Text/Image (HTML) for copyright notice. Definition at line 510 of file index.php. { // Get values from TYPO3_CONF_VARS: $loginCopyrightWarrantyProvider = strip_tags(trim($GLOBALS['TYPO3_CONF_VARS']['SYS']['loginCopyrightWarrantyProvider'])); $loginCopyrightWarrantyURL = strip_tags(trim($GLOBALS['TYPO3_CONF_VARS']['SYS']['loginCopyrightWarrantyURL'])); // Make warranty note: if (strlen($loginCopyrightWarrantyProvider)>=2 && strlen($loginCopyrightWarrantyURL)>=10) { $warrantyNote='Warranty is supplied by '.htmlspecialchars($loginCopyrightWarrantyProvider).'; <a href="'.htmlspecialchars($loginCopyrightWarrantyURL).'" target="_blank">click for details.</a>'; } else { $warrantyNote='TYPO3 comes with ABSOLUTELY NO WARRANTY; <a href="http://typo3.com/1316.0.html" target="_blank">click for details.</a>'; } // Compile full copyright notice: $copyrightNotice = '<a href="http://typo3.com/" target="_blank">'. '<img src="gfx/loginlogo_transp.gif" width="75" height="19" alt="TYPO3 logo" align="left" />'. 'TYPO3 CMS'.($GLOBALS['TYPO3_CONF_VARS']['SYS']['loginCopyrightShowVersion']?' ver. '.htmlspecialchars($GLOBALS['TYPO_VERSION']):''). '</a>. '. 'Copyright &copy; 1998-2004 Kasper Sk&#229;rh&#248;j. Extensions are copyright of their respective owners. '. 'Go to <a href="http://typo3.com/" target="_blank">http://typo3.com/</a> for details. '. $warrantyNote.' '. 'This is free software, and you are welcome to redistribute it under certain conditions; <a href="http://typo3.com/1316.0.html" target="_blank">click for details</a>. '. 'Obstructing the appearance of this notice is prohibited by law.'; // Return notice: return $copyrightNotice; }

SC_index::makeInterfaceSelectorBox (   )

Making interface selector:. Returns: void Definition at line 456 of file index.php. References $TYPO3_CONF_VARS. { global $TYPO3_CONF_VARS; // Reset variables: $this->interfaceSelector = ''; $this->interfaceSelector_hidden=''; $this->interfaceSelector_jump = ''; #debug($this->redirect_url); // If interfaces are defined AND no input redirect URL in GET vars: if ($TYPO3_CONF_VARS['BE']['interfaces'] && !$this->redirect_url) { $parts = t3lib_div::trimExplode(',',$TYPO3_CONF_VARS['BE']['interfaces']); if (count($parts)>1) { // Only if more than one interface is defined will we show the selector: // Initialize: $tempLabels=explode(',',$this->L_vars[5]); $labels=array(); $labels['backend']=$tempLabels[0]; $labels['frontend']=$tempLabels[1]; $jumpScript=array(); $jumpScript['backend']='alt_main.php'; $jumpScript['frontend']='../'; // Traverse the interface keys: foreach($parts as $valueStr) { $this->interfaceSelector.=' <option value="'.htmlspecialchars($valueStr).'">'.htmlspecialchars($labels[$valueStr]).'</option>'; $this->interfaceSelector_jump.=' <option value="'.htmlspecialchars($jumpScript[$valueStr]).'">'.htmlspecialchars($labels[$valueStr]).'</option>'; } $this->interfaceSelector=' <select name="interface" class="c-interfaceselector">'.$this->interfaceSelector.' </select>'; $this->interfaceSelector_jump=' <select name="interface" class="c-interfaceselector" onchange="document.location=this.options[this.selectedIndex].value;">'.$this->interfaceSelector_jump.' </select>'; } else { // If there is only ONE interface value set: $this->interfaceSelector_hidden='<input type="hidden" name="interface" value="'.trim($TYPO3_CONF_VARS['BE']['interfaces']).'" />'; } } }

SC_index::makeLoginBoxImage (   )

Returns the login box image, whether the default or an image from the rotation folder. Returns: string HTML image tag. Definition at line 543 of file index.php. { $loginboxImage = ''; if ($GLOBALS['TBE_STYLES']['loginBoxImage_rotationFolder']) { // Look for rotation image folder: $absPath = t3lib_div::resolveBackPath(PATH_typo3.$GLOBALS['TBE_STYLES']['loginBoxImage_rotationFolder']); // Get rotation folder: $dir = t3lib_div::getFileAbsFileName($absPath); if ($dir && @is_dir($dir)) { // Get files for rotation into array: $files = t3lib_div::getFilesInDir($dir,'png,jpg,gif'); // Pick random file: srand((float) microtime() * 10000000); $randImg = array_rand($files, 1); // Get size of random file: $imgSize = @getimagesize($dir.$files[$randImg]); // Create image tag: if (is_array($imgSize)) { $loginboxImage = '<img src="'.htmlspecialchars($GLOBALS['TBE_STYLES']['loginBoxImage_rotationFolder'].$files[$randImg]).'" '.$imgSize[3].' id="loginbox-image" alt="" />'; } } } else { // If no rotation folder configured, print default image: $loginImage = 'loginbox_image_dev.png'; $imagecopy = $loginImage=='loginbox_image_dev.png' ? 'You are running the CVS version of TYPO3 '.$GLOBALS['TYPO_VERSION'] : 'Photo: &copy; 2004 Kasper Sk&#229;rh&#248;j'; // Directly outputted in image attributes... $loginboxImage = '<img'.t3lib_iconWorks::skinImg($GLOBALS['BACK_PATH'],'gfx/'.$loginImage,'width="200" height="133"').' id="loginbox-image" alt="'.$imagecopy.'" title="'.$imagecopy.'" />'; } // Return image tag: return $loginboxImage; }

SC_index::makeLoginForm (   )

Creates the login form This is drawn when NO login exists. Returns: string HTML output Definition at line 263 of file index.php. References $content, and table(). { $content.=' <!-- Login form: --> <table cellspacing="0" cellpadding="0" border="0" id="logintable"> <tr> <td colspan="2"><h2>'.htmlspecialchars($this->L_vars[6]).'</h2></td> </tr>'.($this->commandLI ? ' <tr class="c-wrong"> <td colspan="2"><p class="c-wrong">'.htmlspecialchars($this->L_vars[9]).'</p></td> </tr>' : '').' <tr class="c-username"> <td><p class="c-username">'.htmlspecialchars($this->L_vars[0]).':</p></td> <td><input type="text" name="username" value="'.htmlspecialchars($this->u).'" class="c-username" /></td> </tr> <tr class="c-password"> <td><p class="c-password">'.htmlspecialchars($this->L_vars[1]).':</p></td> <td><input type="password" name="p_field" value="'.htmlspecialchars($this->p).'" class="c-password" /></td> </tr>'.($this->interfaceSelector && !$this->loginRefresh ? ' <tr class="c-interfaceselector"> <td><p class="c-interfaceselector">'.htmlspecialchars($this->L_vars[2]).':</p></td> <td>'.$this->interfaceSelector.'</td> </tr>' : '' ).' <tr class="c-submit"> <td></td> <td><input type="submit" name="commandLI" value="'.htmlspecialchars($this->L_vars[3]).'" class="c-submit" /></td> </tr> <tr class="c-info"> <td></td> <td><p class="c-info">'.htmlspecialchars($this->L_vars[7]).'</p></td> </tr> </table>'; // Return content: return $content; }

SC_index::makeLoginNews (   )

Make login news - renders the HTML content for a list of news shown under the login form. News data is added through $TYPO3_CONF_VARS Returns: string HTML content Idea by Jan-Hendrik Heuing Definition at line 583 of file index.php. References header(), and table(). { // Reset output variable: $newsContent= ''; // Traverse news array IF there are records in it: if (is_array($GLOBALS['TYPO3_CONF_VARS']['BE']['loginNews']) && count($GLOBALS['TYPO3_CONF_VARS']['BE']['loginNews'])) { foreach($GLOBALS['TYPO3_CONF_VARS']['BE']['loginNews'] as $newsItem) { $newsContent.=' <tr> <td class="c-date">'.htmlspecialchars($newsItem['date']).'</td> <td class="c-header">'.htmlspecialchars($newsItem['header']).'</td> </tr> <tr> <td></td> <td class="c-content">'.trim($newsItem['content']).'</td> </tr> <tr class="c-spacer"> <td colspan="2"></td> </tr> '; } // Wrap in a table: $newsContent= ' <!-- Login screen news: --> <div id="loginNews"> <h2>'.htmlspecialchars($this->L_vars[8]).'</h2> <table border="0" cellpadding="0" cellspacing="0"> '.$newsContent.' </table> </div> '; } // Return content: return $newsContent; }

SC_index::makeLogoutForm (   )

Creates the logout form This is drawn if a user login already exists. Returns: string HTML output Definition at line 309 of file index.php. References $content, and table(). { global $BE_USER; $content.=' <!-- Login form: --> <table cellspacing="0" cellpadding="0" border="0" id="logintable"> <tr> <td></td> <td><h2>'.htmlspecialchars($this->L_vars[6]).'</h2></td> </tr> <tr class="c-username"> <td><p class="c-username">'.htmlspecialchars($this->L_vars[0]).':</p></td> <td><p class="c-username-current">'.htmlspecialchars($BE_USER->user['username']).'</p></td> </tr>'.($this->interfaceSelector_jump ? ' <tr class="c-interfaceselector"> <td><p class="c-interfaceselector">'.htmlspecialchars($this->L_vars[2]).':</p></td> <td>'.$this->interfaceSelector_jump.'</td> </tr>' : '' ).' <tr class="c-submit"> <td><input type="hidden" name="p_field" value="" /></td> <td><input type="submit" name="commandLO" value="'.htmlspecialchars($this->L_vars[4]).'" class="c-submit" /></td> </tr> <tr class="c-info"> <td></td> <td><p class="c-info">'.htmlspecialchars($this->L_vars[7]).'</p></td> </tr> </table>'; // Return content: return $content; }

SC_index::printContent (   )

Outputting the accumulated content to screen. Returns: void Definition at line 239 of file index.php. { echo $this->content; }

SC_index::wrapLoginForm (  $  content  )

Wrapping the login form table in another set of tables etc:. Parameters: string  HTML content for the login form Returns: string The HTML for the page. Definition at line 351 of file index.php. References $content, and table(). { // Logo: $logo = $GLOBALS['TBE_STYLES']['logo_login'] ? '<img src="'.htmlspecialchars($GLOBALS['BACK_PATH'].$GLOBALS['TBE_STYLES']['logo_login']).'" alt="" />' : '<img'.t3lib_iconWorks::skinImg($GLOBALS['BACK_PATH'],'gfx/typo3logo.gif','width="333" height="43"').' alt="" />'; // Login box image: $loginboxImage = $this->makeLoginBoxImage(); // Compile the page content: $content=' <!-- Wrapper table for the login form: --> <table cellspacing="0" cellpadding="0" border="0" id="wrapper"> <tr> <td class="c-wrappercell" align="center"> <!-- Login form image: --> <div id="loginimage"> '.$logo.' </div> <!-- Login form wrapper: --> <table cellspacing="0" cellpadding="0" border="0" id="loginwrapper"> <tr> <td>'.$loginboxImage.'</td> <td> '.$content.' </td> </tr> </table> <!-- Copy right notice: --> <div id="copyrightnotice"> '.$this->makeCopyrightNotice().' </div> '.$this->makeLoginNews().' </td> </tr> </table>'; // Return content: return $content; }

---

Member Data Documentation

SC_index::$commandLI

Definition at line 96 of file index.php.

SC_index::$content

Definition at line 103 of file index.php.

SC_index::$GPinterface

Definition at line 91 of file index.php.

SC_index::$interfaceSelector

Definition at line 105 of file index.php.

SC_index::$interfaceSelector_hidden

Definition at line 107 of file index.php.

SC_index::$interfaceSelector_jump

Definition at line 106 of file index.php.

SC_index::$L

Definition at line 94 of file index.php.

SC_index::$L_vars

Definition at line 100 of file index.php.

SC_index::$loginRefresh

Definition at line 95 of file index.php.

SC_index::$p

Definition at line 93 of file index.php.

SC_index::$redirect_url

Definition at line 90 of file index.php.

SC_index::$redirectToURL

Definition at line 99 of file index.php.

SC_index::$u

Definition at line 92 of file index.php.

---

The documentation for this class was generated from the following file:

• typo3/index.php

---