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

Collaboration diagram for ilCalendarAuthenticationToken:

Public Member Functions
	__construct (int $a_user_id, string $a_token='')

	getSelectionType ()

	getUserId ()

	setSelectionType (int $a_type)

	setCalendar (int $a_cal)

	getCalendar ()

	setIcal (string $ical)

	getIcal ()

	getToken ()

	storeIcal ()

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

	add ()

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

static	lookupUser (string $a_token)

Data Fields
const	SELECTION_NONE = 0

const	SELECTION_PD = 1

const	SELECTION_CATEGORY = 2

const	SELECTION_CALENDAR = 3

Protected Member Functions
	createToken ()

	read ()

Protected Attributes
ilDBInterface	$db

Private Attributes
int	$user

string	$token = ''

int	$selection_type = self::SELECTION_NONE

int	$calendar = 0

string	$ical = ''

int	$ical_ctime = 0

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

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

Constructor & Destructor Documentation

◆ __construct()

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

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

    {
        global $DIC;
 
        $this->db = $DIC->database();
 
        $this->user = $a_user_id;
        $this->token = $a_token;
        $this->read();
    }

References $DIC, read(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ add()

ilCalendarAuthenticationToken::add ( )

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

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

References createToken(), getCalendar(), getSelectionType(), getToken(), and getUserId().

Here is the call graph for this function:

◆ createToken()

ilCalendarAuthenticationToken::createToken ( )

protected

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

                                    : void
    {
        $random = new \Random\Randomizer();
        $this->token = md5($this->getUserId() . $this->getSelectionType() . $random->nextInt());
    }

References getSelectionType(), and getUserId().

Referenced by add().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCalendar()

ilCalendarAuthenticationToken::getCalendar ( )

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

                                 : int
    {
        return $this->calendar;
    }

References $calendar.

Referenced by add().

Here is the caller graph for this function:

◆ getIcal()

ilCalendarAuthenticationToken::getIcal ( )

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

                             : string
    {
        return $this->ical;
    }

References $ical.

Referenced by storeIcal().

Here is the caller graph for this function:

◆ getSelectionType()

ilCalendarAuthenticationToken::getSelectionType ( )

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

                                      : int
    {
        return $this->selection_type;
    }

References $selection_type.

Referenced by add(), and createToken().

Here is the caller graph for this function:

◆ getToken()

ilCalendarAuthenticationToken::getToken ( )

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

                              : string
    {
        return $this->token;
    }

References $token.

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

Here is the caller graph for this function:

◆ getUserId()

ilCalendarAuthenticationToken::getUserId ( )

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

                               : int
    {
        return $this->user;
    }

References $user.

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

Here is the caller graph for this function:

◆ isIcalExpired()

ilCalendarAuthenticationToken::isIcalExpired ( )

Check if cache is disabled or expired.

Todo:: enable the cache

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

                                   : bool
    {
        if (!ilCalendarSettings::_getInstance()->isSynchronisationCacheEnabled()) {
            return true;
        }
        if (!ilCalendarSettings::_getInstance()->getSynchronisationCacheMinutes()) {
            return true;
        }
        return time() > ($this->ical_ctime + 60 * ilCalendarSettings::_getInstance()->getSynchronisationCacheMinutes());
    }

References ilCalendarSettings\_getInstance().

Here is the call graph for this function:

◆ lookupAuthToken()

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

static

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

                                                                                                 : string
    {
        global $DIC;
 
        $ilDB = $DIC['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 '';
    }

References $DIC, $ilDB, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilCalendarSubscriptionGUI\createToken().

Here is the caller graph for this function:

◆ lookupUser()

static ilCalendarAuthenticationToken::lookupUser ( string $a_token )

static

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

                                                      : int
    {
        global $DIC;
 
        $ilDB = $DIC['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 (int) $row->user_id;
        }
        return 0;
    }

References $DIC, $ilDB, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilCalendarRemoteAccessHandler\initTokenHandler().

Here is the caller graph for this function:

◆ read()

ilCalendarAuthenticationToken::read ( )

protected

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

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

References $res, ILIAS\UI\examples\Symbol\Glyph\Calendar\calendar(), ilDBConstants\FETCHMODE_OBJECT, getToken(), getUserId(), and ILIAS\Repository\int().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCalendar()

ilCalendarAuthenticationToken::setCalendar ( int $a_cal )

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

                                           : void
    {
        $this->calendar = $a_cal;
    }

References ILIAS\UI\examples\Symbol\Glyph\Calendar\calendar().

Here is the call graph for this function:

◆ setIcal()

ilCalendarAuthenticationToken::setIcal ( string $ical )

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

                                         : void
    {
        $this->ical = $ical;
    }

References $ical.

◆ setSelectionType()

ilCalendarAuthenticationToken::setSelectionType ( int $a_type )

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

                                                 : void
    {
        $this->selection_type = $a_type;
    }

◆ storeIcal()

ilCalendarAuthenticationToken::storeIcal ( )

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

                               : void
    {
        $this->db->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())
            )
        );
    }