class.ilLPStatus.php

Go to the documentation of this file.

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

class ilLPStatus
{
    public $obj_id = null;

    public $db = null;
    
    public static $list_gui_cache;
    
    const LP_STATUS_NOT_ATTEMPTED = 'trac_no_attempted';
    const LP_STATUS_IN_PROGRESS = 'trac_in_progress';
    const LP_STATUS_COMPLETED = 'trac_completed';
    const LP_STATUS_FAILED = 'trac_failed';
    
    const LP_STATUS_NOT_ATTEMPTED_NUM = 0;
    const LP_STATUS_IN_PROGRESS_NUM = 1;
    const LP_STATUS_COMPLETED_NUM = 2;
    const LP_STATUS_FAILED_NUM = 3;

    const LP_STATUS_REGISTERED = 'trac_registered';
    const LP_STATUS_NOT_REGISTERED = 'trac_not_registered';
    const LP_STATUS_PARTICIPATED = 'trac_participated';
    const LP_STATUS_NOT_PARTICIPATED = 'trac_not_participated';
    
    public function __construct($a_obj_id)
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $this->obj_id = $a_obj_id;
        $this->db = $ilDB;
    }

    public static function _getCountNotAttempted($a_obj_id)
    {
        return 0;
    }

    public static function _getNotAttempted($a_obj_id)
    {
        return array();
    }
    
    public static function _getCountInProgress($a_obj_id)
    {
        return 0;
    }
    
    public static function _getInProgress($a_obj_id)
    {
        return array();
    }

    public static function _getCountCompleted($a_obj_id)
    {
        return 0;
    }
    
    public static function _getCompleted($a_obj_id)
    {
        return array();
    }
    
    public static function _getFailed($a_obj_id)
    {
        return array();
    }
    
    public static function _getCountFailed()
    {
        return 0;
    }
    
    public static function _getStatusInfo($a_obj_id)
    {
        return array();
    }
    
    public static function _getTypicalLearningTime($a_obj_id)
    {
        include_once 'Services/MetaData/classes/class.ilMDEducational.php';
        return ilMDEducational::_getTypicalLearningTimeSeconds($a_obj_id);
    }


    public function _updateStatus($a_obj_id, $a_usr_id, $a_obj = null, $a_percentage = false, $a_force_raise = false)
    {
        $log = ilLoggerFactory::getLogger('trac');
        $log->debug(sprintf(
            "obj_id: %s, user id: %s, object: %s",
            $a_obj_id,
            $a_usr_id,
            (is_object($a_obj) ? get_class($a_obj) : 'null')
        ));

        $status = $this->determineStatus($a_obj_id, $a_usr_id, $a_obj);
        $percentage = $this->determinePercentage($a_obj_id, $a_usr_id, $a_obj);
        $changed = self::writeStatus($a_obj_id, $a_usr_id, $status, $percentage);

        // ak: I don't think that this is a good way to fix 15529, we should not
        // raise the event, if the status does not change imo.
        // for now the changes in the next line just prevent the event being raised twice
        if (!$changed && (bool) $a_force_raise) { // #15529
            self::raiseEvent($a_obj_id, $a_usr_id, $status, $percentage);
        }
    }
    
    public function determinePercentage($a_obj_id, $a_usr_id, $a_obj = null)
    {
        return false;
    }

    public function determineStatus($a_obj_id, $a_usr_id, $a_obj = null)
    {
        return false;
    }
    
        
    public static function checkStatusForObject($a_obj_id, $a_users = false)
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        //@todo: there maybe the need to add extra handling for sessions here, since the
        // "in progress" status is time dependent here. On the other hand, if they registered
        // to the session, they already accessed the course and should have a "in progress"
        // anyway. But the status on the session itself may not be correct.

        $sql = "SELECT usr_id FROM ut_lp_marks WHERE " .
            " obj_id = " . $ilDB->quote($a_obj_id, "integer") . " AND " .
            " status_dirty = " . $ilDB->quote(1, "integer");
        if (is_array($a_users) && count($a_users) > 0) {
            $sql .= " AND " . $ilDB->in("usr_id", $a_users, false, "integer");
        }
        $set = $ilDB->query($sql);
        $dirty = false;
        if ($rec = $ilDB->fetchAssoc($set)) {
            $dirty = true;
        }

        // check if any records are missing
        $missing = false;
        if (!$dirty && is_array($a_users) && count($a_users) > 0) {
            $set = $ilDB->query("SELECT count(usr_id) cnt FROM ut_lp_marks WHERE " .
                " obj_id = " . $ilDB->quote($a_obj_id, "integer") . " AND " .
                $ilDB->in("usr_id", $a_users, false, "integer"));
            $r = $ilDB->fetchAssoc($set);
            if ($r["cnt"] < count($a_users)) {
                $missing = true;
            }
        }

        // refresh status, if records are dirty or missing
        if ($dirty || $missing) {
            require_once "Services/Tracking/classes/class.ilLPStatusFactory.php"; // #13330
            $trac_obj = ilLPStatusFactory::_getInstance($a_obj_id);
            $trac_obj->refreshStatus($a_obj_id, $a_users);
        }
    }
    
    protected static function raiseEvent($a_obj_id, $a_usr_id, $a_status, $a_percentage)
    {
        global $DIC;

        $ilAppEventHandler = $DIC['ilAppEventHandler'];

        $log = ilLoggerFactory::getLogger('trac');
        $log->debug("obj_id: " . $a_obj_id . ", user id: " . $a_usr_id . ", status: " .
            $a_status . ", percentage: " . $a_percentage);

        $ilAppEventHandler->raise("Services/Tracking", "updateStatus", array(
            "obj_id" => $a_obj_id,
            "usr_id" => $a_usr_id,
            "status" => $a_status,
            "percentage" => $a_percentage
            ));
    }
    
    public function refreshStatus($a_obj_id, $a_users = null)
    {
        include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
        $not_attempted = ilLPStatusWrapper::_getNotAttempted($a_obj_id);
        foreach ($not_attempted as $user_id) {
            $percentage = $this->determinePercentage($a_obj_id, $user_id);
            if (self::writeStatus($a_obj_id, $user_id, self::LP_STATUS_NOT_ATTEMPTED_NUM, $percentage, true)) {
                //self::raiseEvent($a_obj_id, $user_id, self::LP_STATUS_NOT_ATTEMPTED_NUM, $percentage);
            }
        }
        $in_progress = ilLPStatusWrapper::_getInProgress($a_obj_id);
        foreach ($in_progress as $user_id) {
            $percentage = $this->determinePercentage($a_obj_id, $user_id);
            if (self::writeStatus($a_obj_id, $user_id, self::LP_STATUS_IN_PROGRESS_NUM, $percentage, true)) {
                //self::raiseEvent($a_obj_id, $user_id, self::LP_STATUS_IN_PROGRESS_NUM, $percentage);
            }
        }
        $completed = ilLPStatusWrapper::_getCompleted($a_obj_id);
        foreach ($completed as $user_id) {
            $percentage = $this->determinePercentage($a_obj_id, $user_id);
            if (self::writeStatus($a_obj_id, $user_id, self::LP_STATUS_COMPLETED_NUM, $percentage, true)) {
                //self::raiseEvent($a_obj_id, $user_id, self::LP_STATUS_COMPLETED_NUM, $percentage);
            }
        }
        $failed = ilLPStatusWrapper::_getFailed($a_obj_id);
        foreach ($failed as $user_id) {
            $percentage = $this->determinePercentage($a_obj_id, $user_id);
            if (self::writeStatus($a_obj_id, $user_id, self::LP_STATUS_FAILED_NUM, $percentage, true)) {
                //self::raiseEvent($a_obj_id, $user_id, self::LP_STATUS_FAILED_NUM, $percentage);
            }
        }
        if ($a_users) {
            $missing_users = array_diff($a_users, $not_attempted + $in_progress + $completed + $failed);
            if ($missing_users) {
                foreach ($missing_users as $user_id) {
                    ilLPStatusWrapper::_updateStatus($a_obj_id, $user_id);
                }
            }
        }
    }

    public static function writeStatus($a_obj_id, $a_user_id, $a_status, $a_percentage = false, $a_force_per = false)
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $log = ilLoggerFactory::getLogger('trac');
        $log->debug("obj_id: " . $a_obj_id . ", user id: " . $a_user_id . ", status: " .
            $a_status . ", percentage: " . $a_percentage . ", force: " . $a_force_per);

        $update_collections = false;

        // get status in DB
        $set = $ilDB->query(
            "SELECT usr_id,status,status_dirty FROM ut_lp_marks WHERE " .
            " obj_id = " . $ilDB->quote($a_obj_id, "integer") . " AND " .
            " usr_id = " . $ilDB->quote($a_user_id, "integer")
        );
        $rec = $ilDB->fetchAssoc($set);
        
        // update
        if ($rec) {
            // status has changed: update
            if ($rec["status"] != $a_status) {
                $ret = $ilDB->manipulate(
                    "UPDATE ut_lp_marks SET " .
                    " status = " . $ilDB->quote($a_status, "integer") . "," .
                    " status_changed = " . $ilDB->now() . "," .
                    " status_dirty = " . $ilDB->quote(0, "integer") .
                    " WHERE usr_id = " . $ilDB->quote($a_user_id, "integer") .
                    " AND obj_id = " . $ilDB->quote($a_obj_id, "integer")
                );
                if ($ret != 0) {
                    $update_collections = true;
                }
            }
            // status has not changed: reset dirty flag
            elseif ($rec["status_dirty"]) {
                $ilDB->manipulate(
                    "UPDATE ut_lp_marks SET " .
                    " status_dirty = " . $ilDB->quote(0, "integer") .
                    " WHERE usr_id = " . $ilDB->quote($a_user_id, "integer") .
                    " AND obj_id = " . $ilDB->quote($a_obj_id, "integer")
                );
            }
        }
        // insert
        else {
            /*
            $ilDB->manipulate("INSERT INTO ut_lp_marks ".
                "(status, status_changed, usr_id, obj_id, status_dirty) VALUES (".
                $ilDB->quote($a_status, "integer").",".
                $ilDB->now().",".
                $ilDB->quote($a_user_id, "integer").",".
                $ilDB->quote($a_obj_id, "integer").",".
                $ilDB->quote(0, "integer").
                ")");
            */
            
            // #13783
            $ilDB->replace(
                "ut_lp_marks",
                array(
                    "obj_id" => array("integer", $a_obj_id),
                    "usr_id" => array("integer", $a_user_id)
                ),
                array(
                    "status" => array("integer", $a_status),
                    "status_changed" => array("timestamp", date("Y-m-d H:i:s")), // was $ilDB->now()
                    "status_dirty" => array("integer", 0)
                )
            );
            
            $update_collections = true;
        }

        // update percentage
        if ($a_percentage !== false || $a_force_per) {
            $a_percentage = max(0, (int) $a_percentage);
            $a_percentage = min(100, $a_percentage);
            $ret = $ilDB->manipulate(
                "UPDATE ut_lp_marks SET " .
                " percentage = " . $ilDB->quote($a_percentage, "integer") .
                " WHERE usr_id = " . $ilDB->quote($a_user_id, "integer") .
                " AND obj_id = " . $ilDB->quote($a_obj_id, "integer")
            );
        }

        // update collections
        if ($update_collections) {
            // a change occured - remove existing cache entry
            include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
            ilLPStatusWrapper::_removeStatusCache($a_obj_id, $a_user_id);
            
            $set = $ilDB->query("SELECT ut_lp_collections.obj_id obj_id FROM " .
                "object_reference JOIN ut_lp_collections ON " .
                "(object_reference.obj_id = " . $ilDB->quote($a_obj_id, "integer") .
                " AND object_reference.ref_id = ut_lp_collections.item_id)");
            while ($rec = $ilDB->fetchAssoc($set)) {
                if (in_array(ilObject::_lookupType($rec["obj_id"]), array("crs", "grp", "fold"))) {
                    // just to make sure - remove existing cache entry
                    ilLPStatusWrapper::_removeStatusCache($rec["obj_id"], $a_user_id);
                    
                    ilLPStatusWrapper::_updateStatus($rec["obj_id"], $a_user_id);
                }
            }

            self::raiseEvent($a_obj_id, $a_user_id, $a_status, $a_percentage);
        }
        
        return $update_collections;
    }
    
    public static function setInProgressIfNotAttempted($a_obj_id, $a_user_id)
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        // #11513

        $needs_update = false;

        $set = $ilDB->query(
            "SELECT usr_id, status FROM ut_lp_marks WHERE " .
            " obj_id = " . $ilDB->quote($a_obj_id, "integer") . " AND " .
            " usr_id = " . $ilDB->quote($a_user_id, "integer")
        );
        if ($rec = $ilDB->fetchAssoc($set)) {
            // current status is not attempted, so we need to update
            if ($rec["status"] == self::LP_STATUS_NOT_ATTEMPTED_NUM) {
                $needs_update = true;
            }
        } else {
            // no ut_lp_marks yet, we should update
            $needs_update = true;
        }
            
        if ($needs_update) {
            require_once "Services/Tracking/classes/class.ilLPStatusWrapper.php";
            ilLPStatusWrapper::_updateStatus($a_obj_id, $a_user_id);
        }
    }
    
    public static function setAllDirty()
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
    
        $ilDB->manipulate(
            "UPDATE ut_lp_marks SET " .
            " status_dirty = " . $ilDB->quote(1, "integer")
        );
    }

    public static function setDirty($a_obj_id)
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
    
        $ilDB->manipulate(
            "UPDATE ut_lp_marks SET " .
            " status_dirty = " . $ilDB->quote(1, "integer") .
            " WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer")
        );
    }
    
    public static function _lookupStatus($a_obj_id, $a_user_id, $a_create = true)
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $set = $ilDB->query(
            "SELECT status FROM ut_lp_marks WHERE " .
            " status_dirty = " . $ilDB->quote(0, "integer") .
            " AND usr_id = " . $ilDB->quote($a_user_id, "integer") .
            " AND obj_id = " . $ilDB->quote($a_obj_id, "integer")
        );
        if ($rec = $ilDB->fetchAssoc($set)) {
            return $rec["status"];
        } elseif ((bool) $a_create) {
            include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
            ilLPStatusWrapper::_updateStatus($a_obj_id, $a_user_id);
            $set = $ilDB->query(
                "SELECT status FROM ut_lp_marks WHERE " .
                " status_dirty = " . $ilDB->quote(0, "integer") .
                " AND usr_id = " . $ilDB->quote($a_user_id, "integer") .
                " AND obj_id = " . $ilDB->quote($a_obj_id, "integer")
            );
            if ($rec = $ilDB->fetchAssoc($set)) {
                return $rec["status"];
            }
        }
    }
    
    public static function _lookupPercentage($a_obj_id, $a_user_id)
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $set = $ilDB->query(
            "SELECT percentage FROM ut_lp_marks WHERE " .
            " status_dirty = " . $ilDB->quote(0, "integer") .
            " AND usr_id = " . $ilDB->quote($a_user_id, "integer") .
            " AND obj_id = " . $ilDB->quote($a_obj_id, "integer")
        );
        if ($rec = $ilDB->fetchAssoc($set)) {
            return $rec["percentage"];
        }
    }
    
    public static function _hasUserCompleted($a_obj_id, $a_user_id)
    {
        return (self::_lookupStatus($a_obj_id, $a_user_id) == self::LP_STATUS_COMPLETED_NUM);
    }
        
    public static function _lookupStatusChanged($a_obj_id, $a_user_id)
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $set = $ilDB->query(
            "SELECT status_changed FROM ut_lp_marks WHERE " .
            " status_dirty = " . $ilDB->quote(0, "integer") .
            " AND usr_id = " . $ilDB->quote($a_user_id, "integer") .
            " AND obj_id = " . $ilDB->quote($a_obj_id, "integer")
        );
        if ($rec = $ilDB->fetchAssoc($set)) {
            return $rec["status_changed"];
        } else {
            include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
            ilLPStatusWrapper::_updateStatus($a_obj_id, $a_user_id);
            $set = $ilDB->query(
                "SELECT status_changed FROM ut_lp_marks WHERE " .
                " status_dirty = " . $ilDB->quote(0, "integer") .
                " AND usr_id = " . $ilDB->quote($a_user_id, "integer") .
                " AND obj_id = " . $ilDB->quote($a_obj_id, "integer")
            );
            if ($rec = $ilDB->fetchAssoc($set)) {
                return $rec["status_changed"];
            }
        }
    }
    
    protected static function _lookupStatusForObject($a_obj_id, $a_status, $a_user_ids = null)
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $sql = "SELECT usr_id, status, status_dirty FROM ut_lp_marks" .
            " WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer") .
            " AND status = " . $ilDB->quote($a_status, "integer");
        if ($a_user_ids) {
            $sql .= " AND " . $ilDB->in("usr_id", $a_user_ids, "", "integer");
        }
        
        $set = $ilDB->query($sql);
        $res = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            if ($res["status_dirty"]) {
                // update status and check again
                if (self::_lookupStatus($a_obj_id, $rec["usr_id"]) != $a_status) {
                    continue;
                }
            }
            $res[] = $rec["usr_id"];
        }
        
        return $res;
    }
    
    public static function _lookupCompletedForObject($a_obj_id, $a_user_ids = null)
    {
        return self::_lookupStatusForObject($a_obj_id, self::LP_STATUS_COMPLETED_NUM, $a_user_ids);
    }
    
    public static function _lookupFailedForObject($a_obj_id, $a_user_ids = null)
    {
        return self::_lookupStatusForObject($a_obj_id, self::LP_STATUS_FAILED_NUM, $a_user_ids);
    }
    
    public static function _lookupInProgressForObject($a_obj_id, $a_user_ids = null)
    {
        return self::_lookupStatusForObject($a_obj_id, self::LP_STATUS_IN_PROGRESS_NUM, $a_user_ids);
    }
    
    
    //
    // LIST GUI
    //
    
    protected static function validateLPForObjects($a_user_id, $a_obj_ids, $a_parent_ref_id)
    {
        $lp_invalid = array();
        
        include_once "Services/Object/classes/class.ilObjectLP.php";
        $memberships = ilObjectLP::getLPMemberships($a_user_id, $a_obj_ids, $a_parent_ref_id);
        foreach ($memberships as $obj_id => $status) {
            if (!$status) {
                $lp_invalid[] = $obj_id;
            }
        }
        
        return array_diff($a_obj_ids, $lp_invalid);
    }
    
    protected static function checkLPModesForObjects($a_obj_ids, array &$a_coll_obj_ids)
    {
        $valid = array();
        
        // all lp modes with collections (gathered separately)
        include_once "Services/Tracking/classes/collection/class.ilLPCollection.php";
        $coll_modes = ilLPCollection::getCollectionModes();
        
        include_once "Services/Tracking/classes/class.ilLPObjSettings.php";
        
        // check if objects have LP activated at all (DB entries)
        $existing = ilLPObjSettings::_lookupDBModeForObjects($a_obj_ids);
        foreach ($existing as $obj_id => $obj_mode) {
            if ($obj_mode != ilLPObjSettings::LP_MODE_DEACTIVATED) {
                $valid[$obj_id] = $obj_id;
                
                if (in_array($obj_mode, $coll_modes)) {
                    $a_coll_obj_ids[] = $obj_id;
                }
            }
        }
                                
        // missing objects in DB (default mode)
        include_once "Services/Object/classes/class.ilObjectLP.php";
        if (sizeof($existing) != sizeof($a_obj_ids)) {
            foreach (array_diff($a_obj_ids, $existing) as $obj_id) {
                $olp = ilObjectLP::getInstance($obj_id);
                $mode = $olp->getCurrentMode();
                if ($mode == ilLPObjSettings::LP_MODE_DEACTIVATED) {
                    // #11141
                    unset($valid[$obj_id]);
                } elseif ($mode != ilLPObjSettings::LP_MODE_UNDEFINED) {
                    $valid[$obj_id] = $obj_id;

                    if (in_array($mode, $coll_modes)) {
                        $a_coll_obj_ids[] = $obj_id;
                    }
                }
            }
            unset($existing);
        }
        
        return array_values($valid);
    }
    
    protected static function getLPStatusForObjects($a_user_id, $a_obj_ids)
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $res = array();
        
        // get user lp data
        $sql = "SELECT status, status_dirty, obj_id FROM ut_lp_marks" .
            " WHERE " . $ilDB->in("obj_id", $a_obj_ids, "", "integer") .
            " AND usr_id = " . $ilDB->quote($a_user_id, "integer");
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            if (!$row["status_dirty"]) {
                $res[$row["obj_id"]] = $row["status"];
            } else {
                $res[$row["obj_id"]] = self::_lookupStatus($row["obj_id"], $a_user_id);
            }
        }

        // process missing user entries (same as dirty entries, see above)
        foreach ($a_obj_ids as $obj_id) {
            if (!isset($res[$obj_id])) {
                $res[$obj_id] = self::_lookupStatus($obj_id, $a_user_id);
                if ($res[$obj_id] === null) {
                    $res[$obj_id] = self::LP_STATUS_NOT_ATTEMPTED_NUM;
                }
            }
        }
            
        return $res;
    }
    
    public static function preloadListGUIData($a_obj_ids)
    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $lng = $DIC['lng'];
        
        $user_id = $ilUser->getId();
        
        $res = array();
        
        include_once("Services/Tracking/classes/class.ilObjUserTracking.php");
        if ($ilUser->getId() != ANONYMOUS_USER_ID &&
            ilObjUserTracking::_enabledLearningProgress() &&
            ilObjUserTracking::_hasLearningProgressLearner() && // #12042
            ilObjUserTracking::_hasLearningProgressListGUI()) {
            // -- validate
            
            // :TODO: we need the parent ref id, but this is awful
            $a_obj_ids = self::validateLPForObjects($user_id, $a_obj_ids, (int) $_GET["ref_id"]);
            
            // we are not handling the collections differently yet
            $coll_obj_ids = array();
            $a_obj_ids = self::checkLPModesForObjects($a_obj_ids, $coll_obj_ids);
            
            
            // -- gather
            
            $res = self::getLPStatusForObjects($user_id, $a_obj_ids);
            
            
            // -- render

            // value to icon
            $lng->loadLanguageModule("trac");
            include_once("./Services/Tracking/classes/class.ilLearningProgressBaseGUI.php");
            foreach ($res as $obj_id => $status) {
                $path = ilLearningProgressBaseGUI::_getImagePathForStatus($status);
                $text = ilLearningProgressBaseGUI::_getStatusText((int) $status);
                $res[$obj_id] = [
                    "image" => ilUtil::img($path, $text),
                    "status" => $status
                    ];
            }
        }
        
        self::$list_gui_cache = $res;
    }
    
    public static function getListGUIStatus($a_obj_id, $a_image_only = true)
    {
        if ($a_image_only) {
            $image = '';
            if (isset(self::$list_gui_cache[$a_obj_id]["image"])) {
                $image = self::$list_gui_cache[$a_obj_id]["image"];
            }

            return $image;
        }
        return self::$list_gui_cache[$a_obj_id];
    }
}