class.ilBackgroundTask.php

Go to the documentation of this file.

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

class ilBackgroundTask
{
        protected $id; // [int]
        protected $user_id; // [int]
        protected $start_date; // [DateTime]
        protected $status; // [string]  
        protected $steps; // [int]
        protected $current_step; // [int]       
        protected $handler; // [string]
        protected $params; // [array]
        protected $exists; // [bool]

        protected $log;
        
        // :TODO:
        const STATUS_INITIALIZED = "initialized";       
        const STATUS_PROCESSING = "processing"; 
        const STATUS_PROCESSED = "processed";   
        const STATUS_CANCELLING = "cancelling";
        const STATUS_CANCELLED = "cancelled";
        const STATUS_FINISHED = "finished";
        const STATUS_FAILED = "failed";
        
        const DB_NAME = "background_task";
        
        public function __construct($a_id = 0)
        {
                $this->log = ilLoggerFactory::getLogger('btsk');
                if ($a_id != 0)
                {
                        $this->doRead($a_id);
                }
        }       
        
        public function getHandlerInstance()
        {
                $handler_id = $this->getHandlerId();
                $this->log->debug("Handler ID: ".$handler_id);
                if($handler_id)
                {
                        include_once "Services/BackgroundTask/classes/class.".$handler_id.".php";
                        return $handler_id::getInstanceFromTask($this);
                }
        }
        
        public static function getActiveByUserId($a_user_id)
        {
                global $ilDB;
                
                $res = array();
                
                $set = $ilDB->query("SELECT id FROM ".self::DB_NAME.
                        " WHERE user_id = ".$ilDB->quote($a_user_id, "integer").
                        " AND status = ".$ilDB->quote(self::STATUS_PROCESSING, "text"));
                while($row = $ilDB->fetchAssoc($set))
                {
                        $res[] = $row["id"];
                }
                
                return $res;
        }
        
        public function isToBeCancelled()
        {
                $this->doRead($this->getId());
                return ($this->getStatus() == self::STATUS_CANCELLING);
        }
        

        //
        // setter/getter
        // 
        
        public function getHandlerId()
        {
                return $this->handler;
        }
        
        public function setHandlerId($a_val)
        {
                $this->handler = $a_val;
        }
        
        public function getId()
        {
                return $this->id;
        }
        
        protected function setId($a_val)
        {
                $this->id = (int)$a_val;
        }

        public function getUserId()
        {
                return $this->user_id;
        }
        
        public function setUserId($a_val)
        {
                $this->user_id = (int)$a_val;
        }
        
        public function getStartDate()
        {
                return $this->start_date;
        }
        
        protected function setStartDate(ilDateTime $a_val)
        {
                $this->start_date = $a_val;
        }
        
        public function getStatus()
        {
                return $this->status;
        }
        
        protected function getValidStatus()
        {
                return array(
                        self::STATUS_INITIALIZED,
                        self::STATUS_PROCESSING,
                        self::STATUS_CANCELLING,
                        self::STATUS_CANCELLED,                 
                        self::STATUS_PROCESSED,
                        self::STATUS_FINISHED,
                        self::STATUS_FAILED,
                );
        }
        
        public function setStatus($a_val)
        {
                if(in_array($a_val, $this->getValidStatus()))
                {
                        $this->status = $a_val;
                }
        }

        public function getSteps()
        {
                return $this->steps;
        }
        
        public function setSteps($a_val)
        {
                $this->steps = abs($a_val);
        }
        
        public function getCurrentStep()
        {
                return $this->current_step;
        }
        
        public function setCurrentStep($a_val)
        {               
                $this->current_step = min(abs($a_val), $this->getSteps());
        }
        
        public function getParams()
        {
                return $this->params;
        }
        
        public function setParams(array $a_params = null)
        {
                $this->params = $a_params;
        }
                
        public function exists()
        {
                return $this->exists;
        }       
        
        
        //
        // CRUD
        //
        
        public function save()
        {
                $this->log->debug($this->getHandlerId());
                // does not exist yet?
                if (!$this->exists)
                {
                        $this->doCreate();
                }
                else
                {
                        $this->doUpdate();
                }
        }
        
        public function delete()
        {
                $this->log->debug($this->getHandlerId());
                if(!$this->exists)
                {
                        return;
                }
                
                return $this->doDelete();                       
        }
        
        
        protected function doRead($a_id)
        {
                global $ilDB;

                $this->log->debug($this->getHandlerId()."/".$a_id);
                
                $set = $ilDB->queryF(
                        "SELECT * FROM " . self::DB_NAME . " WHERE id=%s", 
                        array("integer"), 
                        array($a_id));
                
                while ($rec = $ilDB->fetchAssoc($set))
                {
                        $this->setId($a_id);            
                        $this->exists = true;
                        
                        $this->setUserId($rec["user_id"]);                      
                        $this->setStartDate(new ilDateTime($rec["start_date"], IL_CAL_DATETIME));               
                        $this->setStatus($rec["status"]);               
                        $this->setSteps($rec["steps"]);
                        $this->setCurrentStep($rec["cstep"]);
                        $this->setHandlerId($rec["handler"]);
                        $this->setParams($rec["params"] 
                                ? unserialize($rec["params"])
                                : null);
                }
        }
        
        protected function preparePropertiesForDB()
        {
                return array(
                        "user_id" => array("integer", $this->getUserId()),                      
                        "start_date" => array("timestamp", $this->getStartDate()->get(IL_CAL_DATETIME)),                                
                        "status" => array("text", $this->getStatus()),
                        "steps" => array("integer", $this->getSteps()),
                        "cstep" => array("integer", $this->getCurrentStep()),
                        "handler" => array("string", $this->getHandlerId()),
                        "params" => array("string", is_array($this->getParams())
                                ? serialize($this->getParams())
                                : null)
                );
        }
        
        protected function doCreate()
        {
                global $ilDB;
                                                
                $this->setId($ilDB->nextId(self::DB_NAME));             
                $this->setStartDate(new ilDateTime(time(), IL_CAL_UNIX));
                
                $fields = $this->preparePropertiesForDB();
                $fields["id"] = array("integer", $this->getId());
                
                $ilDB->insert(self::DB_NAME, $fields);
                
                $this->exists = true;
        }
        
        protected function doUpdate()
        {
                global $ilDB;
                
                $ilDB->update(
                        self::DB_NAME, 
                        $this->preparePropertiesForDB(),
                        array("id" => array("integer", $this->getId()))
                );
        }
        
        protected function doDelete()
        {
                global $ilDB;
                
                return $ilDB->manipulateF(
                    "DELETE FROM " . self::DB_NAME . " WHERE id=%s",
                        array("integer"), 
                        array($this->getId()));
        }
}