Storage driver for fetching login data from a database. More...

Inheritance diagram for ilAuthContainerDatabase:

Collaboration diagram for ilAuthContainerDatabase:

Public Member Functions
	__construct ($dsn)

	getUser ($username)

	fetchData ($username, $password, $isChallengeResponse=false)

	setObserversEnabled ($boolean)
	Enables/disables the observers of this container. More...

	isObserversEnabled ()
	Returns true, if the observers of this container are enabled. More...

	loginObserver ($a_username)
	Called from Auth after successful login. More...

	failedLoginObserver ()
	Called from Auth after failed login. More...

Static Public Member Functions
static	toUsernameWithoutDomain ($username)
	Static function removes Microsoft domain name from username. More...

Private Attributes
	$isObserversEnabled

Detailed Description

Storage driver for fetching login data from a database.

This driver strips leading Microsoft Windows domain names from the user name.

For example: hsw hsw/wrandels and wrandels refer all to the login name wrandels.

This storage driver can use all databases which are supported by the PEAR DB abstraction layer to fetch login data.

Usage note: If you use an ilAuthContainerMDB2 object as the container for an Auth object you MUST call setEnableObservers(true) on the ilAuthContainerMDB2 object. The observers are used to perform actions depending on the success or failure of a login attempt.

Author: Werner Randelshofer, Lucerne University of Applied Sciences and Arts, werne.nosp@m.r.ra.nosp@m.ndels.nosp@m.hofe.nosp@m.r@hsl.nosp@m.u.ch

Version: $Id$

Deprecated:: Will be replace by ilAuthContainerMDB in Services/Database

Definition at line 27 of file class.ilAuthContainerDatabase.php.

Constructor & Destructor Documentation

◆ __construct()

ilAuthContainerDatabase::__construct ( $dsn )

Definition at line 38 of file class.ilAuthContainerDatabase.php.

         {
                 $this->Auth_Container_MDB2($dsn);
         }

Member Function Documentation

◆ failedLoginObserver()

ilAuthContainerDatabase::failedLoginObserver ( )

Called from Auth after failed login.

Parameters

string username

Definition at line 126 of file class.ilAuthContainerDatabase.php.

References $_SERVER, and $ilLog.

Referenced by fetchData().

         {
                 global $ilLog;
                 $ilLog->write(__METHOD__.': login failed'.
                         ', remote:'.$_SERVER['REMOTE_ADDR'].':'.$_SERVER['REMOTE_PORT'].
                         ', server:'.$_SERVER['SERVER_ADDR'].':'.$_SERVER['SERVER_PORT']
                 );
         }

Here is the caller graph for this function:

◆ fetchData()

ilAuthContainerDatabase::fetchData	(	$username,
		$password,
		$isChallengeResponse = `false`
	)

Definition at line 51 of file class.ilAuthContainerDatabase.php.

References failedLoginObserver(), isObserversEnabled(), loginObserver(), and toUsernameWithoutDomain().

         {
                 $username = ilAuthContainerDatabase::toUsernameWithoutDomain($username);
 
                 $isSuccessful = parent::fetchData($username, $password, $isChallengeResponse);
                 if ($this->isObserversEnabled)
                 {
                         if ($isSuccessful)
                         {
                                 $this->loginObserver($username);        
                         }
                         else
                         {
                                 $this->failedLoginObserver();        
                         }
                 }
                 return $isSuccessful;
         }

Here is the call graph for this function:

◆ getUser()

ilAuthContainerDatabase::getUser ( $username )

Definition at line 43 of file class.ilAuthContainerDatabase.php.

References toUsernameWithoutDomain().

         {
                 $username = ilAuthContainerDatabase::toUsernameWithoutDomain($username);
 
                 // Fetch the data
                 return parent::getUser($username);
         }

Here is the call graph for this function:

◆ isObserversEnabled()

ilAuthContainerDatabase::isObserversEnabled ( )

Returns true, if the observers of this container are enabled.

Definition at line 101 of file class.ilAuthContainerDatabase.php.

References $isObserversEnabled.

Referenced by fetchData(), and setObserversEnabled().

         {
                 return $this->isObserversEnabled;
         }

Here is the caller graph for this function:

◆ loginObserver()

ilAuthContainerDatabase::loginObserver ( $a_username )

Called from Auth after successful login.

Parameters

string username

Definition at line 112 of file class.ilAuthContainerDatabase.php.

References $_SERVER, and $ilLog.

Referenced by fetchData().

         {
                 global $ilLog;
                 $ilLog->write(__METHOD__.': logged in as '.$a_username.
                         ', remote:'.$_SERVER['REMOTE_ADDR'].':'.$_SERVER['REMOTE_PORT'].
                         ', server:'.$_SERVER['SERVER_ADDR'].':'.$_SERVER['SERVER_PORT']
                 );
         }

Here is the caller graph for this function:

◆ setObserversEnabled()

ilAuthContainerDatabase::setObserversEnabled ( $boolean )

Enables/disables the observers of this container.

Definition at line 93 of file class.ilAuthContainerDatabase.php.

References isObserversEnabled().

         {
                 $this->isObserversEnabled = $boolean;
         }

Here is the call graph for this function:

◆ toUsernameWithoutDomain()

static ilAuthContainerDatabase::toUsernameWithoutDomain ( $username )

static

Static function removes Microsoft domain name from username.

Definition at line 73 of file class.ilAuthContainerDatabase.php.

Referenced by fetchData(), and getUser().

         {
                 // Remove all characters including the last slash or the last backslash
                 // in the username
                 $pos = strrpos($username, '/');
                 $pos2 = strrpos($username, '\\');
                 if ($pos === false || $pos < $pos2) 
                 {
                         $pos = $pos2;
                 }
                 if ($pos !== false)
                 {
                         $username = substr($username, $pos + 1);
                 }
                 return $username;
         }