Handles calendar authentication tokens for external calendar subscriptions. More...

Collaboration diagram for ilCalendarAuthenticationToken:

Public Member Functions
	__construct ($a_user_id, $a_token='')
	Constructor. More...

	getSelectionType ()
	get selection type for key More...

	getUserId ()
	Get current user. More...

	setSelectionType ($a_type)
	set selection type More...

	setCalendar ($a_cal)
	set calendar id More...

	getCalendar ()

	setIcal ($ical)

	getIcal ()
	get stored ical More...

	getToken ()
	get token More...

	storeIcal ()
	store ical More...

	isIcalExpired ()
	Check if cache is disabled or expired. More...

	add ()
	Add token. More...

Static Public Member Functions
static	lookupAuthToken ($a_user_id, $a_selection, $a_calendar=0)

static	lookupUser ($a_token)
	Lookup user by hash. More...

Data Fields
const	SELECTION_NONE = 0

const	SELECTION_PD = 1

const	SELECTION_CATEGORY = 2

const	SELECTION_CALENDAR = 3

Protected Member Functions
	createToken ()
	Create a new token. More...

	read ()
	Read key. More...

Private Attributes
	$user = null

	$token = ''

	$selection_type = 0

	$calendar = 0

	$ical = null

	$ical_ctime = null

Detailed Description

Handles calendar authentication tokens for external calendar subscriptions.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 12 of file class.ilCalendarAuthenticationToken.php.

Constructor & Destructor Documentation

◆ __construct()

ilCalendarAuthenticationToken::__construct	(	$a_user_id,
		$a_token = `''`
	)

Constructor.

Parameters

int	$a_user_id
string	$a_hash

Returns: ilCalendarAuthenticationKey

Definition at line 34 of file class.ilCalendarAuthenticationToken.php.

References read(), and user().

     {
         $this->user = $a_user_id;
         $this->token = $a_token;
         
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ add()

ilCalendarAuthenticationToken::add ( )

Add token.

Returns

Definition at line 187 of file class.ilCalendarAuthenticationToken.php.

References $ilDB, $query, createToken(), getCalendar(), getSelectionType(), getToken(), and getUserId().

     {
         global $ilDB;
         
         $this->createToken();
         
         $query = "INSERT INTO cal_auth_token (user_id,hash,selection,calendar) " .
             "VALUES ( " .
             $ilDB->quote($this->getUserId(), 'integer') . ', ' .
             $ilDB->quote($this->getToken(), 'text') . ', ' .
             $ilDB->quote($this->getSelectionType(), 'integer') . ', ' .
             $ilDB->quote($this->getCalendar(), 'integer') . ' ' .
             ')';
         $ilDB->manipulate($query);
         
         return $this->getToken();
     }

Here is the call graph for this function:

◆ createToken()

ilCalendarAuthenticationToken::createToken ( )

protected

Create a new token.

Returns

Definition at line 209 of file class.ilCalendarAuthenticationToken.php.

References getSelectionType(), and getUserId().

Referenced by add().

     {
         $random = new \ilRandom();
         $this->token = md5($this->getUserId() . $this->getSelectionType() . $random->int());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCalendar()

ilCalendarAuthenticationToken::getCalendar ( )

Definition at line 114 of file class.ilCalendarAuthenticationToken.php.

References $calendar.

Referenced by add().

     {
         return $this->calendar;
     }

Here is the caller graph for this function:

◆ getIcal()

ilCalendarAuthenticationToken::getIcal ( )

get stored ical

Returns

Definition at line 128 of file class.ilCalendarAuthenticationToken.php.

References $ical.

Referenced by storeIcal().

     {
         return $this->ical;
     }

Here is the caller graph for this function:

◆ getSelectionType()

ilCalendarAuthenticationToken::getSelectionType ( )

get selection type for key

Returns: int selection type

Definition at line 79 of file class.ilCalendarAuthenticationToken.php.

References $selection_type.

Referenced by add(), and createToken().

     {
         return $this->selection_type;
     }

Here is the caller graph for this function:

◆ getToken()

ilCalendarAuthenticationToken::getToken ( )

get token

Returns

Definition at line 138 of file class.ilCalendarAuthenticationToken.php.

References $token.

Referenced by add(), read(), and storeIcal().

     {
         return $this->token;
     }

Here is the caller graph for this function:

◆ getUserId()

ilCalendarAuthenticationToken::getUserId ( )

Get current user.

Returns: int user

Definition at line 89 of file class.ilCalendarAuthenticationToken.php.

References $user.

Referenced by add(), createToken(), read(), and storeIcal().

     {
         return $this->user;
     }

Here is the caller graph for this function:

◆ isIcalExpired()

ilCalendarAuthenticationToken::isIcalExpired ( )

Check if cache is disabled or expired.

Returns

Definition at line 168 of file class.ilCalendarAuthenticationToken.php.

References ilCalendarSettings\_getInstance(), and time.

     {
         return true;
 
         include_once './Services/Calendar/classes/class.ilCalendarSettings.php';
         
         if (!ilCalendarSettings::_getInstance()->isSynchronisationCacheEnabled()) {
             return true;
         }
         if (!ilCalendarSettings::_getInstance()->getSynchronisationCacheMinutes()) {
             return true;
         }
         return time() > ($this->ical_ctime + 60 * ilCalendarSettings::_getInstance()->getSynchronisationCacheMinutes());
     }

Here is the call graph for this function:

◆ lookupAuthToken()

static ilCalendarAuthenticationToken::lookupAuthToken	(	$a_user_id,
		$a_selection,
		$a_calendar = `0`
	)

static

Definition at line 42 of file class.ilCalendarAuthenticationToken.php.

References $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilCalendarSubscriptionGUI\createToken(), and ilCalendarBlockGUI\showCalendarSubscription().

     {
         global $ilDB;
         
         $query = "SELECT * FROM cal_auth_token " .
             "WHERE user_id = " . $ilDB->quote($a_user_id, 'integer') . ' ' .
             "AND selection = " . $ilDB->quote($a_selection, 'integer') . ' ' .
             "AND calendar = " . $ilDB->quote($a_calendar, 'integer');
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return $row->hash;
         }
         return false;
     }

Here is the caller graph for this function:

◆ lookupUser()

static ilCalendarAuthenticationToken::lookupUser ( $a_token )

static

Lookup user by hash.

Parameters

object $a_token

Returns

Definition at line 62 of file class.ilCalendarAuthenticationToken.php.

References $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilAuthContainerCalendarToken\fetchData(), and ilCalendarRemoteAccessHandler\initTokenHandler().

     {
         global $ilDB;
         
         $query = "SELECT * FROM cal_auth_token " .
             "WHERE hash = " . $ilDB->quote($a_token, 'text');
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return $row->user_id;
         }
         return 0;
     }

Here is the caller graph for this function:

◆ read()

ilCalendarAuthenticationToken::read ( )

protected

Read key.

Returns

Definition at line 219 of file class.ilCalendarAuthenticationToken.php.

References $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, getToken(), and getUserId().

Referenced by __construct().

     {
         global $ilDB;
 
         if (!$this->getToken()) {
             $query = "SELECT * FROM cal_auth_token " .
                 "WHERE user_id = " . $ilDB->quote($this->getUserId(), 'integer');
         } else {
             $query = 'SELECT * FROM cal_auth_token ' .
                 'WHERE user_id = ' . $ilDB->quote($this->getUserId(), 'integer') . ' ' .
                 'AND hash = ' . $ilDB->quote($this->getToken(), 'text');
         }
             
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->token = $row->hash;
             $this->selection_type = $row->selection;
             $this->calendar = $row->calendar;
             $this->ical = $row->ical;
             $this->ical_ctime = $row->c_time;
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCalendar()

ilCalendarAuthenticationToken::setCalendar ( $a_cal )

set calendar id

Parameters

object $a_cal

Returns

Definition at line 109 of file class.ilCalendarAuthenticationToken.php.

     {
         $this->calendar = $a_cal;
     }

◆ setIcal()

ilCalendarAuthenticationToken::setIcal ( $ical )

Definition at line 119 of file class.ilCalendarAuthenticationToken.php.

References $ical.

     {
         $this->ical = $ical;
     }

◆ setSelectionType()

ilCalendarAuthenticationToken::setSelectionType ( $a_type )

set selection type

Parameters

int $a_type

Returns

Definition at line 99 of file class.ilCalendarAuthenticationToken.php.

References $a_type.

Referenced by ilCalendarBlockGUI\showCalendarSubscription().

     {
         $this->selection_type = $a_type;
     }

Here is the caller graph for this function:

◆ storeIcal()

ilCalendarAuthenticationToken::storeIcal ( )

store ical

Returns

Definition at line 147 of file class.ilCalendarAuthenticationToken.php.

References $ilDB, array, getIcal(), getToken(), getUserId(), and time.

     {
         global $ilDB;
         
         $ilDB->update(
             'cal_auth_token',
             array(
                 'ical'          => array('clob',$this->getIcal()),
                 'c_time'        => array('integer',time())
             ),
             array(
                 'user_id'       => array('integer',$this->getUserId()),
                 'hash'          => array('text',$this->getToken())
             )
         );
     }