class.t3lib_beuserauth.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2004 Kasper Skaarhoj (kasperYYYY@typo3.com)
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*  A copy is found in the textfile GPL.txt and important notices to the license
*  from the author is found in LICENSE.txt distributed with these scripts.
*
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
class t3lib_beUserAuth extends t3lib_userAuthGroup {
   var $session_table = 'be_sessions';       // Table to use for session data.
   var $name = 'be_typo_user';                 // Session/Cookie name

   var $user_table = 'be_users';                // Table in database with userdata
   var $username_column = 'username';        // Column for login-name
   var $userident_column = 'password';       // Column for password
   var $userid_column = 'uid';               // Column for user-id
   var $lastLogin_column = 'lastlogin';
   var $notifyHeader = 'From: TYPO3 Login notify <no_reply@no_reply.no_reply>';

   var $enablecolumns = Array (
      'rootLevel' => 1,
      'deleted' => 'deleted',
      'disabled' => 'disable',
      'starttime' => 'starttime',
      'endtime' => 'endtime'
   );

   var $formfield_uname = 'username';        // formfield with login-name
   var $formfield_uident = 'userident';      // formfield with password
   var $formfield_chalvalue = 'challenge';      // formfield with a unique value which is used to encrypt the password and username
   var $formfield_status = 'login_status';   // formfield with status: *'login', 'logout'
   var $security_level = 'challenged';          // sets the level of security. *'normal' = clear-text. 'challenged' = hashed password/username from form in $formfield_uident. 'superchallenged' = hashed password hashed again with username.

   var $writeStdLog = 1;               // Decides if the writelog() function is called at login and logout
   var $writeAttemptLog = 1;           // If the writelog() functions is called if a login-attempt has be tried without success

   var $auth_include = '';                // this is the name of the include-file containing the login form. If not set, login CAN be anonymous. If set login IS needed.

   var $auth_timeout_field = 6000;           // if > 0 : session-timeout in seconds. if false/<0 : no timeout. if string: The string is fieldname from the usertable where the timeout can be found.
   var $lifetime = 0;                        // 0 = Session-cookies. If session-cookies, the browser will stop session when the browser is closed. Else it keeps the session for $lifetime seconds.



      // User Config:
   var $uc;

      // User Config Default values:
      // The array may contain other fields for configuration. For this, see "setup" extension and "TSConfig" document (User TSconfig, "setup.[xxx]....")
      /*
         Reserved keys for other storage of session data:
         moduleData
         moduleSessionID
      */
   var $uc_default = Array (
//    'lang' => 'dk',      // this value will be transferred from $BE_USER->user[lang] if not set...
      'interfaceSetup' => '', // serialized content that is used to store interface pane and menu positions. Set by the logout.php-script
      'moduleData' => Array(),   // user-data for the modules
      'thumbnailsByDefault' => 0,
      'emailMeAtLogin' => 0,
      'condensedMode' => 0,
      'noMenuMode' => 0,
      'startInTaskCenter' => 0,
      'hideSubmoduleIcons' => 0,
      'helpText' => 1,
      'titleLen' => 30,
      'edit_wideDocument' => '0',
      'edit_showFieldHelp' => 'icon',
      'edit_RTE' => '1',
      'edit_docModuleUpload' => '1',
      'disableCMlayers' => 0,
      'navFrameWidth' => '',  // Default is 245 pixels
      'navFrameResizable' => 0,
   );


   function trackBeUser($flag)   {
      if ($flag && t3lib_extMgm::isLoaded('beuser_tracking'))  {
         $insertFields = array(
            'userid' => intval($this->user['uid']),
            'tstamp' => time(),
            'script' => t3lib_div::getIndpEnv('REQUEST_URI')
         );

         $GLOBALS['TYPO3_DB']->exec_INSERTquery('sys_trackbeuser', $insertFields);
      }
   }

   function checkLockToIP()   {
      global $TYPO3_CONF_VARS;
      $out = 1;
      if ($TYPO3_CONF_VARS['BE']['enabledBeUserIPLock']) {
         $IPList = $this->getTSConfigVal('options.lockToIP');
         if (trim($IPList))   {
            $baseIP = t3lib_div::getIndpEnv('REMOTE_ADDR');
            $out = t3lib_div::cmpIP($baseIP, $IPList);
         }
      }
      return $out;
   }

   function backendCheckLogin()  {
      if (!$this->user['uid'])   {
         if (!defined('TYPO3_PROCEED_IF_NO_USER') || !TYPO3_PROCEED_IF_NO_USER)  {
            t3lib_BEfunc::typo3PrintError ('Login-error','No user logged in! Sorry, I can\'t proceed then!<br /><br />(You must have cookies enabled!)',0);
            exit;
         }
      } else { // ...and if that's the case, call these functions
         $this->fetchGroupData();   // The groups are fetched and ready for permission checking in this initialization. Tables.php must be read before this because stuff like the modules has impact in this
         if ($this->checkLockToIP())   {
            if (!$GLOBALS['TYPO3_CONF_VARS']['BE']['adminOnly'] || $this->isAdmin())   {
               $this->backendSetUC();     // Setting the UC array. It's needed with fetchGroupData first, due to default/overriding of values.
               $this->emailAtLogin();     // email at login - if option set.
            } else {
               t3lib_BEfunc::typo3PrintError ('Login-error','TYPO3 is in maintenance mode at the moment. Only administrators are allowed access.',0);
               exit;
            }
         } else {
            t3lib_BEfunc::typo3PrintError ('Login-error','IP locking prevented you from being authorized. Can\'t proceed, sorry.',0);
            exit;
         }
      }
   }

   function checkCLIuser() {
         // First, check if cliMode is enabled:
      if (defined('TYPO3_cliMode') && TYPO3_cliMode)  {
         if (!$this->user['uid'])   {
            if (substr($GLOBALS['MCONF']['name'],0,5)=='_CLI_')   {
               $userName = strtolower($GLOBALS['MCONF']['name']);
               $this->setBeUserByName($userName);
               if ($this->user['uid']) {
                  if (!$this->isAdmin())  {
                     return TRUE;
                  } else die('ERROR: CLI backend user "'.$userName.'" was ADMIN which is not allowed!'.chr(10).chr(10));
               } else die('ERROR: No backend user named "'.$userName.'" was found!'.chr(10).chr(10));
            } else die('ERROR: Module name, "'.$GLOBALS['MCONF']['name'].'", was not prefixed with "_CLI_"'.chr(10).chr(10));
         } else die('ERROR: Another user was already loaded which is impossible in CLI mode!'.chr(10).chr(10));
      }
   }

   function backendSetUC() {

         // UC - user configuration is a serialized array inside the userobject
      $temp_theSavedUC=unserialize($this->user['uc']);      // if there is a saved uc we implement that instead of the default one.
      if (is_array($temp_theSavedUC))  {
         $this->unpack_uc($temp_theSavedUC);
      }
         // Setting defaults if uc is empty
      if (!is_array($this->uc))  {
         $this->uc = array_merge($this->uc_default, (array)$TYPO3_CONF_VARS['BE']['defaultUC'], (array)$this->getTSConfigProp('setup.default'));   // Candidate for t3lib_div::array_merge() if integer-keys will some day make trouble...
         $this->overrideUC();
         $U=1;
      }
         // If TSconfig is updated, update the defaultUC.
      if ($this->userTSUpdated)  {
         $this->overrideUC();
         $U=1;
      }
         // Setting default lang from be_user record.
      if (!isset($this->uc['lang']))   {
         $this->uc['lang']=$this->user['lang'];
         $U=1;
      }
         // Saving if updated.
      if ($U)  {
         $this->writeUC(); // Method from the t3lib_userauth class.
      }
   }

   function overrideUC()   {
      $this->uc = array_merge((array)$this->uc, (array)$this->getTSConfigProp('setup.override'));  // Candidate for t3lib_div::array_merge() if integer-keys will some day make trouble...
   }

   function resetUC()   {
      $this->user['uc']='';
      $this->uc='';
      $this->backendSetUC();
   }

   function emailAtLogin() {
      if ($this->loginSessionStarted)  {
            // Send notify-mail
         $subject = 'At "'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'].'"'.
                  ' from '.t3lib_div::getIndpEnv('REMOTE_ADDR').
                  (t3lib_div::getIndpEnv('REMOTE_HOST') ? ' ('.t3lib_div::getIndpEnv('REMOTE_HOST').')' : '');
         $msg = sprintf ('User "%s" logged in from %s (%s) at "%s" (%s)',
            $this->user['username'],
            t3lib_div::getIndpEnv('REMOTE_ADDR'),
            t3lib_div::getIndpEnv('REMOTE_HOST'),
            $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'],
            t3lib_div::getIndpEnv('HTTP_HOST')
         );

            // Warning email address
         if ($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_email_addr'])   {
            $warn=0;
            $prefix='';
            if (intval($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_mode']) & 1)   {  // first bit: All logins
               $warn=1;
               $prefix= $this->isAdmin() ? '[AdminLoginWarning]' : '[LoginWarning]';
            }
            if ($this->isAdmin() && (intval($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_mode']) & 2))  {  // second bit: Only admin-logins
               $warn=1;
               $prefix='[AdminLoginWarning]';
            }
            if ($warn)  {
               mail($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_email_addr'],
                  $prefix.' '.$subject,
                  $msg,
                  $this->notifyHeader
               );
            }
         }

            // If An email should be sent to the current user, do that:
         if ($this->uc['emailMeAtLogin'] && strstr($this->user['email'],'@')) {
            mail($this->user['email'],
               $subject,
               $msg,
               $this->notifyHeader
            );
         }
      }
   }

   function veriCode()  {
      return substr(md5($this->id.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']),0,10);
   }
}




if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_beuserauth.php']) {
   include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_beuserauth.php']);
}
?>

---