Handles requests from external calendar applications More...

Collaboration diagram for ilCalendarRemoteAccessHandler:

Public Member Functions
	__construct ()

	getTokenHandler ()

	parseRequest ()
	Fetch client id, the chosen calendar... More...

	handleRequest ()

Protected Member Functions
	initTokenHandler ()

	initLimitEnabled ()

	initIlias ()

	initUser ()

Protected Attributes
const	LIMITED_QUERY_PARAM = 'limited'

Refinery	$refinery = null

HTTPServices	$http = null

ilLogger	$logger = null

ilLanguage	$lng = null

bool	$limit_enabled

Private Attributes
ilCalendarAuthenticationToken	$token_handler = null

Detailed Description

Handles requests from external calendar applications

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

Definition at line 29 of file class.ilCalendarRemoteAccessHandler.php.

Constructor & Destructor Documentation

◆ __construct()

ilCalendarRemoteAccessHandler::__construct ( )

Definition at line 40 of file class.ilCalendarRemoteAccessHandler.php.

41 {

42 }

Member Function Documentation

◆ getTokenHandler()

ilCalendarRemoteAccessHandler::getTokenHandler ( )

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

References $token_handler.

Referenced by handleRequest(), and initUser().

                                      : ?ilCalendarAuthenticationToken
     {
         return $this->token_handler;
     }

Here is the caller graph for this function:

◆ handleRequest()

ilCalendarRemoteAccessHandler::handleRequest ( )

Definition at line 64 of file class.ilCalendarRemoteAccessHandler.php.

References $GLOBALS, $limit_enabled, ilCalendarCategories\_getInstance(), ilUtil\deliverData(), exit, ilCalendarExport\export(), getTokenHandler(), initIlias(), initLimitEnabled(), initTokenHandler(), initUser(), ilCalendarCategories\MODE_REMOTE_ACCESS, ilCalendarCategories\MODE_REMOTE_SELECTED, ilCalendarAuthenticationToken\SELECTION_CALENDAR, and ilLogger\warning().

                                    : bool
     {
         session_name('ILCALSESSID');
         $this->initIlias();
         $logger = $GLOBALS['DIC']->logger()->cal();
         $this->initTokenHandler();
         $this->initLimitEnabled();
 
         if (!$this->initUser()) {
             $logger->warning('Calendar token is invalid. Authentication failed.');
             return false;
         }
 
         if ($this->getTokenHandler()->getIcal() and !$this->getTokenHandler()->isIcalExpired()) {
             $GLOBALS['DIC']['ilAuthSession']->logout();
             ilUtil::deliverData($this->getTokenHandler()->getIcal(), 'calendar.ics', 'text/calendar');
             exit;
         }
 
         if ($this->getTokenHandler()->getSelectionType() == ilCalendarAuthenticationToken::SELECTION_CALENDAR) {
             #$export = new ilCalendarExport(array($this->getTokenHandler()->getCalendar()));
             $cats = ilCalendarCategories::_getInstance();
             $cats->initialize(ilCalendarCategories::MODE_REMOTE_SELECTED, $this->getTokenHandler()->getCalendar());
             $export = new ilCalendarExport($cats->getCategories(true), $this->limit_enabled);
         } else {
             $cats = ilCalendarCategories::_getInstance();
             $cats->initialize(ilCalendarCategories::MODE_REMOTE_ACCESS);
             $export = new ilCalendarExport($cats->getCategories(true), $this->limit_enabled);
         }
 
         $export->export();
 
         $this->getTokenHandler()->setIcal($export->getExportString());
         $this->getTokenHandler()->storeIcal();
 
         $GLOBALS['DIC']['ilAuthSession']->logout();
         ilUtil::deliverData($export->getExportString(), 'calendar.ics', 'text/calendar');
         exit;
     }

Here is the call graph for this function:

◆ initIlias()

ilCalendarRemoteAccessHandler::initIlias ( )

protected

Definition at line 130 of file class.ilCalendarRemoteAccessHandler.php.

References $DIC, ilAuthFactory\CONTEXT_CALENDAR_TOKEN, ilContext\CONTEXT_ICAL, ilContext\init(), ilInitialisation\initILIAS(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), and ilAuthFactory\setContext().

Referenced by handleRequest().

                                   : void
     {
         include_once './Services/Context/classes/class.ilContext.php';
         ilContext::init(ilContext::CONTEXT_ICAL);
 
         include_once './Services/Authentication/classes/class.ilAuthFactory.php';
         ilAuthFactory::setContext(ilAuthFactory::CONTEXT_CALENDAR_TOKEN);
 
         include_once './Services/Init/classes/class.ilInitialisation.php';
         ilInitialisation::initILIAS();
 
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->lng->loadLanguageModule('dateplaner');
         $this->logger = $DIC->logger()->cal();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initLimitEnabled()

ilCalendarRemoteAccessHandler::initLimitEnabled ( )

protected

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

References $_GET.

Referenced by handleRequest().

                                          : void
     {
         $this->limit_enabled = (bool) ($_GET[self::LIMITED_QUERY_PARAM] ?? false);
     }

Here is the caller graph for this function:

◆ initTokenHandler()

ilCalendarRemoteAccessHandler::initTokenHandler ( )

protected

Definition at line 104 of file class.ilCalendarRemoteAccessHandler.php.

References $DIC, $token, ILIAS\FileDelivery\http(), ILIAS\Repository\logger(), ilCalendarAuthenticationToken\lookupUser(), and ILIAS\Repository\refinery().

Referenced by handleRequest().

                                          : void
     {
         global $DIC;
 
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
 
         $token = '';
         if ($this->http->wrapper()->query()->has('token')) {
             $token = $this->http->wrapper()->query()->retrieve(
                 'token',
                 $this->refinery->kindlyTo()->string()
             );
         }
         $this->logger->info('Authentication token: ' . $token);
         $this->token_handler = new ilCalendarAuthenticationToken(
             ilCalendarAuthenticationToken::lookupUser($token),
             $token
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initUser()

ilCalendarRemoteAccessHandler::initUser ( )

protected

Definition at line 148 of file class.ilCalendarRemoteAccessHandler.php.

References $DIC, $GLOBALS, ilObject\_exists(), getTokenHandler(), ilInitialisation\initUserAccount(), and ILIAS\Repository\logger().

Referenced by handleRequest().

                                  : bool
     {
         global $DIC;
 
         if (!$this->getTokenHandler() instanceof ilCalendarAuthenticationToken) {
             $this->logger->info('Initialisation of authentication token failed');
             return false;
         }
         if (!$this->getTokenHandler()->getUserId()) {
             $this->logger->info('No user id found for calendar synchronisation');
             return false;
         }
         if (!ilObjUser::_exists($this->getTokenHandler()->getUserId())) {
             $this->logger->notice('No valid user id found for calendar synchronisation');
             return false;
         }
 
         $GLOBALS['DIC']['ilAuthSession']->setAuthenticated(true, $this->getTokenHandler()->getUserId());
         ilInitialisation::initUserAccount();
 
         if (!$DIC->user() instanceof ilObjUser) {
             $this->logger->debug('No user object defined');
         } else {
             $this->logger->debug('Current user is: ' . $DIC->user()->getId());
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseRequest()

ilCalendarRemoteAccessHandler::parseRequest ( )

Fetch client id, the chosen calendar...

Definition at line 52 of file class.ilCalendarRemoteAccessHandler.php.

References $_COOKIE, $_GET, $_SERVER, and $path_info_components.

                                   : void
     {
         // before initialization: $_GET and $_COOKIE is required is unavoidable
         // in the moment.
         if ($_GET['client_id']) {
             $_COOKIE['ilClientId'] = $_GET['client_id'];
         } else {
             $path_info_components = explode('/', $_SERVER['PATH_INFO']);
             $_COOKIE['ilClientId'] = $path_info_components[1];
         }
     }