class.ilBackgroundTaskHub.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once "Services/BackgroundTask/classes/class.ilBackgroundTask.php";

class ilBackgroundTaskHub
{
        protected $task; // [ilBackgroundTask]
        protected $handler; // [ilBackgroundTaskHandler]
        
        public function __construct()
        {
                global $lng;
                
                $lng->loadLanguageModule("bgtask");
                
                if((int)$_REQUEST["tid"])
                {
                        $this->task = new ilBackgroundTask((int)$_REQUEST["tid"]);              
                        $this->handler = $this->task->getHandlerInstance();
                }
        }


        //
        // ajax
        // 
        
        public function executeCommand()
        {
                global $ilCtrl;
                
                $next_class = $ilCtrl->getNextClass($this);
                $cmd = $ilCtrl->getCmd("validate");                             
                        
                switch ($next_class)
                {                       
                        default:
                                if($cmd == "deliver" || 
                                        $ilCtrl->isAsynch())
                                {
                                        $this->$cmd();
                                        break;
                                }
                }               
                
                // deliver file and ajax require exit
                exit();
        }       
        
        protected function sendJson(stdClass $a_json)
        {               
                echo json_encode($a_json);
        }
        
        protected function validate()
        {                               
                $class = trim($_GET["hid"]);
                $file = "Services/BackgroundTask/classes/class.".$class.".php";
                if(file_exists($file))
                {                       
                        include_once $file;
                        $handler = new $class();                
                        $json = $handler->init($_GET["par"]);
                
                        $this->sendJson($json);
                }
        }
        
        protected function unblock()
        {
                global $ilUser;
                
                foreach(ilBackgroundTask::getActiveByUserId($ilUser->getId()) as $task_id)
                {
                        // leave current task alone
                        if($task_id != $this->task->getId())
                        {
                                // emit cancelling status, running processes will cancel
                                $task = new ilBackgroundTask($task_id);
                                $task->setStatus(ilBackgroundTask::STATUS_CANCELLING);
                                $task->save();
                        }                               
                }
                
                // init/start current task
                $json = $this->handler->init();
                $this->sendJson($json);
        }
        
        protected function process()
        {                                                                               
                $this->task->setStatus(ilBackgroundTask::STATUS_PROCESSING);
                $this->task->save();
                
                if(!$this->isSOAPEnabled())
                {
                        $this->handler->process();      
                }
                else
                {
                        require_once 'Services/WebServices/SOAP/classes/class.ilSoapClient.php';
                        $soap_client = new ilSoapClient();
                        $soap_client->setResponseTimeout(1);
                        $soap_client->enableWSDL(true);
                        $soap_client->init();
                        $soap_client->call('processBackgroundTask', array(
                                session_id() . '::' . $_COOKIE['ilClientId'],
                                $this->task->getId()
                        ));
                }
        }
        
        public function isSOAPEnabled()
        {               
                global $ilSetting;

                // see ilMail
                return (extension_loaded('curl') &&
                        $ilSetting->get('soap_user_administration') &&
                        ilContext::getType() != ilContext::CONTEXT_CRON);
        }
        
        protected function progress() 
        {               
                include_once "Services/BackgroundTask/classes/class.ilBackgroundTaskJson.php";
                
                // if task has been finished, get result action
                if($this->task->getStatus() == ilBackgroundTask::STATUS_FINISHED)
                {
                        $result = $this->handler->finish();
                        $json = ilBackgroundTaskJson::getProgressJson($this->task, $result[0], $result[1]);
                }
                else
                {
                        $json = ilBackgroundTaskJson::getProgressJson($this->task);
                }
                
                $this->sendJson($json);
        }
        
        protected function cancel()
        {
                // just emit cancelling status, (background) process will stop ASAP
                $this->task->setStatus(ilBackgroundTask::STATUS_CANCELLING);
                $this->task->save();                            
        }
        
        protected function deliver()
        {
                // :TODO: delete task?
                
                $this->handler->deliver();
        }       
}