class.ilObjUserTracking.php

Go to the documentation of this file.

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

define('UT_INACTIVE_BOTH',0);
define('UT_ACTIVE_BOTH',1);
define('UT_ACTIVE_UT',2);
define('UT_ACTIVE_LP',3);

include_once "classes/class.ilObject.php";

class ilObjUserTracking extends ilObject
{
        var $valid_time_span = null;
        var $extended_data = null;

        // BEGIN ChangeEvent
        private $is_change_event_tracking_enabled = null;
        // BEGIN ChangeEvent

        const EXTENDED_DATA_LAST_ACCESS = 1;
        const EXTENDED_DATA_READ_COUNT = 2;
        const EXTENDED_DATA_SPENT_SECONDS = 4;


        function ilObjUserTracking($a_id = 0,$a_call_by_reference = true)
        {
                $this->type = "trac";
                $this->ilObject($a_id,$a_call_by_reference);

                define("DEFAULT_TIME_SPAN",60*5);
                $this->__readSettings();
        }


        
        function setActivationStatus($a_status)
        {
                $this->status = $a_status;
        }
        
        function getActivationStatus()
        {
                return $this->status;
        }

        function enableTracking($a_enable)
        {
                echo 'deprecated';

                $this->tracking_enabled = (bool) $a_enable;

                return true;
        }
        
        function enabledTracking()
        {
                return ($this->status == UT_ACTIVE_UT) || ($this->status == UT_ACTIVE_BOTH);
        }

        function _enabledTracking()
        {
                global $ilias;

                $status = $ilias->getSetting("enable_tracking");

                return ($status == UT_ACTIVE_UT) || ($status == UT_ACTIVE_BOTH);
        }

        function enabledLearningProgress()
        {
                return ($this->status == UT_ACTIVE_LP) || ($this->status == UT_ACTIVE_BOTH);
        }

        function _enabledLearningProgress()
        {
                global $ilias;

                $status = $ilias->getSetting("enable_tracking");

                return ($status == UT_ACTIVE_LP) || ($status == UT_ACTIVE_BOTH);
        }

        function enableUserRelatedData($a_enable)
        {
                $this->tracking_user_related = (bool) $a_enable;
        }

        function enabledUserRelatedData()
        {
                return $this->tracking_user_related ? true : false;
        }


        function _enabledUserRelatedData()
        {
                global $ilSetting;
                return (boolean) $ilSetting->get('save_user_related_data');
        }

        function setValidTimeSpan($a_time_span)
        {
                $this->valid_time = (int) $a_time_span;

                return true;
        }

        function getValidTimeSpan()
        {
                return (int) $this->valid_time;
        } 
        
        function _getValidTimeSpan()
        {
                global $ilias;
                
                return (int) $ilias->getSetting("tracking_time_span",DEFAULT_TIME_SPAN);
        }

        // BEGIN ChangeEvent
        public function setChangeEventTrackingEnabled($newValue)
        {
                $this->is_change_event_tracking_enabled = $newValue;
        }
        public function isChangeEventTrackingEnabled()
        {
                return $this->is_change_event_tracking_enabled;
        }
        // END ChangeEvent

        function updateSettings()
        {
                global $ilias;

                $ilias->setSetting("enable_tracking",$this->getActivationStatus());
                $ilias->setSetting("save_user_related_data",$this->enabledUserRelatedData() ? 1 : 0);
                $ilias->setSetting("tracking_time_span",$this->getValidTimeSpan());
                $ilias->setSetting("lp_extended_data", $this->extended_data);

                // BEGIN ChangeEvent
                require_once 'Services/Tracking/classes/class.ilChangeEvent.php';
                if ($this->is_change_event_tracking_enabled != ilChangeEvent::_isActive())
                {
                        if ($this->is_change_event_tracking_enabled)
                        {
                                ilChangeEvent::_activate();
                        }
                        else
                        {
                                ilChangeEvent::_deactivate();
                        }
                }
                // END ChangeEvent


                return true;
        }

        function validateSettings()
        {
                if(!is_numeric($time = $this->getValidTimeSpan()) or
                   $time < 1 or
                   $time > 9999)
                {
                        return false;
                }
                return true;
        }

        function getRecordsTotal()
        {
                global $ilDB;

                $q = "SELECT count(*) AS cnt FROM ut_access";
                $cnt_set = $ilDB->query($q);

                $cnt_rec = $cnt_set->fetchRow(DB_FETCHMODE_ASSOC);

                return $cnt_rec["cnt"];
        }

        function getMonthTotalOverview()
        {
                global $ilDB;

                $q = "SELECT count(*) as cnt, count(distinct user_id) as user_cnt, ut_month FROM ut_access".
                        " GROUP BY ut_month ORDER BY ut_month DESC";
                $min_set = $ilDB->query($q);
                $months = array();
                while ($min_rec = $min_set->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        $months[] = array("month" => $min_rec["ut_month"],
                                "cnt" => $min_rec["cnt"], "user_cnt" => $min_rec["user_cnt"]);
                }
                return $months;
        }

        function getTotalOlderThanMonth($a_month)
        {
                global $ilDB;

                $q = "SELECT count(*) as cnt, count(ut_month) as d FROM ut_access WHERE acc_time <= ".
                        $ilDB->quote($this->increaseMonth($a_month)."-01", "timestamp");

                $cnt_set = $ilDB->query($q);
                $cnt_rec = $cnt_set->fetchRow(DB_FETCHMODE_ASSOC);
//echo "cnt:".$cnt_rec["cnt"].":date:".$cnt_rec["d"].":";

                return $cnt_rec["cnt"];
        }

        function getAccessTotalPerUser($a_condition, $a_searchTermsCondition="",$a_objectCondition="")
        {
                global $ilDB;

                $q = "SELECT count(*) as cnt, user_id FROM ut_access "
                        .($a_searchTermsCondition != "" ? $a_searchTermsCondition : " WHERE ")
                        .$a_condition
                        .$a_objectCondition
                        ." GROUP BY user_id";

                $cnt_set = $ilDB->query($q);

                $acc = array();
                while ($cnt_rec = $cnt_set->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        $name = ilObjUser::_lookupName($cnt_rec["user_id"]);

                        if ($cnt_rec["user_id"] != 0)
                        {
                                $acc[] = array("user_id" => $cnt_rec["user_id"],
                                        "name" => $name["lastname"].", ".$name["firstname"],
                                        "cnt" => $cnt_rec["cnt"]);
                        }
                }
                return $acc;
        }
        
        function getAccessTotalPerObj($a_condition, $a_searchTermsCondition="")
        {
                global $ilDB;
                $q = "SELECT count(acc_obj_id) AS cnt, acc_obj_id FROM ut_access "
                        .($a_searchTermsCondition != "" ? $a_searchTermsCondition : " WHERE ")
                        .$a_condition
                        ." GROUP BY acc_obj_id";
                $cnt_set = $ilDB->query($q);
                //echo "q:".$q;

                $acc = array();
                while ($cnt_rec = $cnt_set->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        if ($cnt_rec["cnt"] != "")
                        {
                                
                                $acc[] = array("id" => $cnt_rec["acc_obj_id"],
                                        "title" => ilObject::_lookupTitle($cnt_rec["acc_obj_id"]),
                                        "author" => $this->getOwnerName($cnt_rec["acc_obj_id"]),
                                        "duration" => $this->getDuration($cnt_rec["acc_obj_id"]),
                                        "cnt" => $cnt_rec["cnt"]);
                        }
                }
                return $acc;
        }

        function getDuration($a_obj_id)
        {
                global $ilDB;

                $query = sprintf('SELECT AVG(spent_seconds) FROM read_event '.
                        'WHERE obj_id = %s '.
                        'GROUP BY obj_id ',
                        $ilDB->quote($a_obj_id,'integer'));
                $res = $ilDB->query($query);
                $data = $ilDB->fetchAssoc($res);
                return $data["spent_seconds"];
        }

        function getAccessPerUserDetail($a_condition, $a_searchTermsCondition="",$a_objectCondition="")
        {
                global $ilDB;

                $q = "SELECT id, user_id,client_ip,acc_obj_id,language ,acc_time FROM ut_access "
                        .($a_searchTermsCondition != "" ? $a_searchTermsCondition : " WHERE ")
                        .$a_condition
                        .$a_objectCondition
                        ." GROUP BY id";

                $cnt_set = $ilDB->query($q);
                $acc = array();
                while($cnt_rec = $cnt_set->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        $name = ilObjUser::_lookupName($cnt_rec["user_id"]);

                        if ($cnt_rec["user_id"] != 0)
                        {
                                $acc[] = array("user_id" => $cnt_rec["user_id"],
                                        "name" => $name["lastname"].", ".$name["firstname"],
                                        "client_ip" => $cnt_rec["client_ip"],
                                        "acc_obj_id" => ilObject::_lookupTitle($cnt_rec["acc_obj_id"]),
                                        "language" => $cnt_rec["language"],
                                        "acc_time" => $cnt_rec["acc_time"]
                                        );
                        }
                }

                return $acc;
        }
        function deleteTrackingDataBeforeMonth($a_month)
        {
                global $ilDB;

                $q = "DELETE FROM ut_access WHERE acc_time < ".
                        $ilDB->quote($this->increaseMonth($a_month)."-01", "timestamp");

                $ilDB->manipulate($q);
        }

        function increaseMonth($a_month)
        {
                $year = (int) substr($a_month, 0, 4);
                $month = (int) substr($a_month, 5);
                $month += 1;
                if ($month == 13)
                {
                        $year += 1;
                        $month = 1;
                }
                return $year."-".str_pad($month, 2, "0", STR_PAD_LEFT);
        }

        function allAuthor($a_type,$type)
        {
                global $ilDB;

                $q = "SELECT DISTINCT A.obj_id,A.type,A.title FROM object_data  A,object_data B WHERE A.type = ".
                        $ilDB->quote($a_type ,'text')." AND A.obj_id = B.owner AND B.type=".$ilDB->quote($type ,'text')." ".
                        "GROUP BY A.obj_id";
                //echo $q;
                $author = $ilDB->query($q);
                $all = array();
                while ($aauthor = $author->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        $all[] = array("title" => $aauthor["title"],
                                        "obj_id" =>$aauthor["obj_id"]);
                }
                return $all;
        }

        function authorLms($id,$type)
        {
                global $ilDB;

                $q = "SELECT title,obj_id FROM object_data WHERE owner = ".$ilDB->quote($id ,'integer')." and type=".$ilDB->quote($type ,'text');
                //echo $q."<br>";
                $lms = $ilDB->query($q);
                $all = array();
                while ($alms = $lms->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        $all[] = array("title" => $alms["title"],
                                        "obj_id" =>$alms["obj_id"]);
                }
                return $all;
                
        }

        function getObjId($title,$type)
        {
                global $ilDB;
                $q ="SELECT obj_id FROM object_data WHERE type = ".$ilDB->quote($type ,'text')." and title=".$ilDB->quote($title ,'text');
                $id = $ilDB->query($q);
                $obj_id = $id->fetchRow(DB_FETCHMODE_ASSOC);
                return $obj_id["obj_id"];
        }
        
        function getTestId($id)
        {
                $q = "select obj_id from object_data "
                ." where type = 'tst' and "
                ." owner = ".$ilDB->quote($id ,'integer');
                $res = $this->ilias->db->query($q);
                for ($i=0;$i<$res->numRows();$i++)
                {
                        $result[$i]=$res->fetchRow();
                }
                return $result;
        }
        
        function countResults($condition)
        {
                $q = "SELECT count(*) from ut_access "
                ." WHERE "
                .$condition;
                $res = $this->ilias->db->query($q);
                $result = $res->fetchRow();
                return $result[0];
        }
        
        function getOwnerName($id)
        {
                global $ilDB;
        
                $q =" select A.login from usr_data A, object_data B where A.usr_id=B.owner and B.obj_id = ".$ilDB->quote($id ,'integer');
                $res = $this->ilias->db->query($q);
                $result = $res->fetchRow();
                return $result[0];
        }

        // PRIVATE
        function __readSettings()
        {
                global $ilias;

                #$this->enableTracking($ilias->getSetting("enable_tracking",0));
                $this->status = $ilias->getSetting('enable_tracking',UT_INACTIVE_BOTH);
                $this->enableUserRelatedData($ilias->getSetting("save_user_related_data",0));
                $this->setValidTimeSpan($ilias->getSetting("tracking_time_span",DEFAULT_TIME_SPAN));#

                // BEGIN ChangeEvent
                require_once 'Services/Tracking/classes/class.ilChangeEvent.php';
                $this->is_change_event_tracking_enabled = ilChangeEvent::_isActive();
                // END ChangeEvent

                $this->setExtendedData($ilias->getSetting("lp_extended_data"),0);

                return true;
        }

        function _deleteUser($a_usr_id)
        {
                global $ilDB;

                $query = "DELETE FROM ut_access WHERE user_id = ".$ilDB->quote($a_usr_id, "integer")."";
                $ilDB->manipulate($query);

                $query = sprintf('DELETE FROM read_event WHERE usr_id = %s ',
                        $ilDB->quote($a_usr_id,'integer'));
                $aff = $ilDB->manipulate($query);                       

                $query = sprintf('DELETE FROM write_event WHERE usr_id = %s ',
                        $ilDB->quote($a_usr_id,'integer'));
                $aff = $ilDB->manipulate($query);

                $query = "DELETE FROM ut_lp_marks WHERE usr_id = ".$ilDB->quote($a_usr_id ,'integer')." ";
                $res = $ilDB->manipulate($query);

                $ilDB->manipulate("DELETE FROM ut_online WHERE usr_id = ".
                        $ilDB->quote($a_usr_id, "integer"));

                return true;
        }

        function setExtendedData($a_value)
        {
                $this->extended_data = $a_value;
        }

        function hasExtendedData($a_code)
        {
                return $this->extended_data & $a_code;
        }
                
} // END class.ilObjUserTracking
?>