class.ilLPCronObjectStatistics.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once "Services/Cron/classes/class.ilCronJob.php";

class ilLPCronObjectStatistics extends ilCronJob
{
    protected $date; // [string]
    
    public function getId()
    {
        return "lp_object_statistics";
    }
    
    public function getTitle()
    {
        global $DIC;

        $lng = $DIC['lng'];
        
        $lng->loadLanguageModule("trac");
        return $lng->txt("trac_object_statistics");
    }
    
    public function getDescription()
    {
        global $DIC;

        $lng = $DIC['lng'];
        
        $lng->loadLanguageModule("trac");
        return $lng->txt("trac_object_statistics_info");
    }
    
    public function getDefaultScheduleType()
    {
        return self::SCHEDULE_TYPE_DAILY;
    }
    
    public function getDefaultScheduleValue()
    {
        return;
    }
    
    public function hasAutoActivation()
    {
        return true;
    }
    
    public function hasFlexibleSchedule()
    {
        return false;
    }
    
    public function run()
    {
        // all date related operations are based on this timestamp
        // should be midnight of yesterday (see gatherUserData()) to always have full day
        $this->date = strtotime("yesterday");
        
        $status = ilCronJobResult::STATUS_NO_ACTION;
        $message = array();
        
        $count = 0;
        $count += $this->gatherCourseLPData();
        $count += $this->gatherTypesData();
        $count += $this->gatherUserData();
        
        if ($count) {
            $status = ilCronJobResult::STATUS_OK;
        }
        
        $result = new ilCronJobResult();
        $result->setStatus($status);
        
        return $result;
    }
    
    protected function gatherCourseLPData()
    {
        global $DIC;

        $tree = $DIC['tree'];
        $ilDB = $DIC['ilDB'];
        
        $logger = $GLOBALS['DIC']->logger()->trac();
        
        $count = 0;
                
        // process all courses
        $all_courses = array_keys(ilObject::_getObjectsByType("crs"));
        if ($all_courses) {
            // gather objects in trash
            $trashed_objects = $tree->getSavedNodeObjIds($all_courses);
            
            include_once 'Services/Object/classes/class.ilObjectLP.php';
            include_once "Modules/Course/classes/class.ilCourseParticipants.php";
            include_once "Services/Tracking/classes/class.ilLPStatusWrapper.php";
            foreach ($all_courses as $crs_id) {
                // trashed objects will not change
                if (!in_array($crs_id, $trashed_objects)) {
                    $refs = ilObject::_getAllReferences($crs_id);
                    if (!count($refs)) {
                        $logger->warning('Found course without reference: obj_id = ' . $crs_id);
                        continue;
                    }
                    
                    // only if LP is active
                    $olp = ilObjectLP::getInstance($crs_id);
                    if (!$olp->isActive()) {
                        continue;
                    }
                                    
                    // only save once per day
                    $ilDB->manipulate("DELETE FROM obj_lp_stat WHERE" .
                        " obj_id = " . $ilDB->quote($crs_id, "integer") .
                        " AND fulldate = " . $ilDB->quote(date("Ymd", $this->date), "integer"));
                    
                    $members = new ilCourseParticipants($crs_id);
                    $members = $members->getMembers();
                    
                    $in_progress = count(ilLPStatusWrapper::_lookupInProgressForObject($crs_id, $members));
                    $completed = count(ilLPStatusWrapper::_lookupCompletedForObject($crs_id, $members));
                    $failed = count(ilLPStatusWrapper::_lookupFailedForObject($crs_id, $members));
                    
                    // calculate with other values - there is not direct method
                    $not_attempted = count($members) - $in_progress - $completed - $failed;
                    
                    $set = array(
                        "type" => array("text", "crs"),
                        "obj_id" => array("integer", $crs_id),
                        "yyyy" => array("integer", date("Y", $this->date)),
                        "mm" => array("integer", date("m", $this->date)),
                        "dd" => array("integer", date("d", $this->date)),
                        "fulldate" => array("integer", date("Ymd", $this->date)),
                        "mem_cnt" => array("integer", count($members)),
                        "in_progress" => array("integer", $in_progress),
                        "completed" => array("integer", $completed),
                        "failed" => array("integer", $failed),
                        "not_attempted" => array("integer", $not_attempted)
                        );
                    
                    $ilDB->insert("obj_lp_stat", $set);
                    
                    $count++;
                    
                    // #17928
                    ilCronManager::ping($this->getId());
                }
            }
        }
        
        return $count;
    }
    
    protected function gatherTypesData()
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $count = 0;
        
        include_once "Services/Tracking/classes/class.ilTrQuery.php";
        $data = ilTrQuery::getObjectTypeStatistics();
        foreach ($data as $type => $item) {
            // only save once per day
            $ilDB->manipulate("DELETE FROM obj_type_stat WHERE" .
                " type = " . $ilDB->quote($type, "text") .
                " AND fulldate = " . $ilDB->quote(date("Ymd", $this->date), "integer"));
            
            $set = array(
                "type" => array("text", $type),
                "yyyy" => array("integer", date("Y", $this->date)),
                "mm" => array("integer", date("m", $this->date)),
                "dd" => array("integer", date("d", $this->date)),
                "fulldate" => array("integer", date("Ymd", $this->date)),
                "cnt_references" => array("integer", (int) $item["references"]),
                "cnt_objects" => array("integer", (int) $item["objects"]),
                "cnt_deleted" => array("integer", (int) $item["deleted"])
                );

            $ilDB->insert("obj_type_stat", $set);
            
            $count++;
            
            // #17928
            ilCronManager::ping($this->getId());
        }
        
        return $count;
    }
    
    protected function gatherUserData()
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $count = 0;
        
        $to = mktime(23, 59, 59, date("m", $this->date), date("d", $this->date), date("Y", $this->date));
                    
        $sql = "SELECT COUNT(DISTINCT(usr_id)) counter,obj_id FROM read_event" .
            " WHERE last_access >= " . $ilDB->quote($this->date, "integer") .
            " AND last_access <= " . $ilDB->quote($to, "integer") .
            " GROUP BY obj_id";
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            // only save once per day
            $ilDB->manipulate("DELETE FROM obj_user_stat" .
                " WHERE fulldate = " . $ilDB->quote(date("Ymd", $this->date), "integer") .
                " AND obj_id = " . $ilDB->quote($row["obj_id"], "integer"));

            $iset = array(
                "obj_id" => array("integer", $row["obj_id"]),
                "yyyy" => array("integer", date("Y", $this->date)),
                "mm" => array("integer", date("m", $this->date)),
                "dd" => array("integer", date("d", $this->date)),
                "fulldate" => array("integer", date("Ymd", $this->date)),
                "counter" => array("integer", $row["counter"])
                );

            $ilDB->insert("obj_user_stat", $iset);
            
            $count++;
            
            // #17928
            ilCronManager::ping($this->getId());
        }
        
        return $count;
    }
}