chamilo-lms2/main/inc/lib/online.inc.php

<?php
/* For licensing terms, see /license.txt */
/**
*	Code library for showing Who is online
*
*	@author Istvan Mandak, principal author
*	@author Denes Nagy, principal author
*	@author Bart Mollet
*	@author Roan Embrechts, cleaning and bugfixing
*	@package chamilo.whoisonline
*/

/**
 * Insert a login reference for the current user into the track_e_online stats table.
 * This table keeps trace of the last login. Nothing else matters (we don't keep traces of anything older)
 * @param int user id
 * @return void
 */

use \ChamiloSession as Session;

class Online
{

    /**
     * Checking user in DB
     * @param int $uid
     */
    public static function loginCheck($uid)
    {
        $_course = api_get_course_info();
        $uid = (int) $uid;
        $online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
        if (!empty($uid)) {
            $login_ip = '';
            if (!empty($_SERVER['REMOTE_ADDR'])) {
                $login_ip = Database::escape_string($_SERVER['REMOTE_ADDR']);
            }

            $login_date = api_get_utc_datetime();
            $access_url_id = 1;
            if (api_get_multiple_access_url() && api_get_current_access_url_id()!=-1) {
                $access_url_id = api_get_current_access_url_id();
            }
            $session_id = api_get_session_id();
            // if the $_course array exists this means we are in a course and we have to store this in the who's online table also
            // to have the x users in this course feature working
            if (is_array($_course) && count($_course)>0 && !empty($_course['id'])) {
                $query = "REPLACE INTO ".$online_table ." (login_id, login_user_id, login_date, login_ip, course, session_id, access_url_id)
                          VALUES ($uid, $uid, '$login_date', '$login_ip', '".$_course['id']."', '$session_id', '$access_url_id' )";
            } else {
                $query = "REPLACE INTO ".$online_table ." (login_id,login_user_id,login_date,login_ip, session_id, access_url_id)
                          VALUES ($uid,$uid,'$login_date','$login_ip', '$session_id', '$access_url_id')";
            }
            Database::query($query);
        }
    }

    /**

     * @return void  Directly redirects the user or leaves him where he is, but doesn't return anything
     * @param int $userId
     * @param bool $logout_redirect
     * @author Fernando P. García <fernando@develcuy.com>
     */
    public static function logout($user_id = null, $logout_redirect = false)
    {
        global $extAuthSource;

        // Database table definition
        $tbl_track_login = Database :: get_main_table(TABLE_STATISTIC_TRACK_E_LOGIN);

        if (empty($user_id)) {
            $user_id = api_get_user_id();
        }
        $user_id = intval($user_id);

        // Changing global chat status to offline
        if (api_is_global_chat_enabled()) {
            $chat = new Chat();
            $chat->set_user_status(0);
        }

        // selecting the last login of the user
        $sql_last_connection = "SELECT login_id, login_date FROM $tbl_track_login
                              WHERE login_user_id='$user_id' ORDER BY login_date DESC LIMIT 0,1";
        $q_last_connection=Database::query($sql_last_connection);
        $i_id_last_connection = null;
        if (Database::num_rows($q_last_connection)>0) {
            $i_id_last_connection = Database::result($q_last_connection, 0, "login_id");
        }

        if (!isset($_SESSION['login_as']) && !empty($i_id_last_connection)) {
            $current_date = api_get_utc_datetime();
            $s_sql_update_logout_date = "UPDATE $tbl_track_login SET logout_date='".$current_date."' WHERE login_id = '$i_id_last_connection'";
            Database::query($s_sql_update_logout_date);
        }

        Online::loginDelete($user_id); //from inc/lib/online.inc.php - removes the "online" status

        //the following code enables the use of an external logout function.
        //example: define a $extAuthSource['ldap']['logout']="file.php" in configuration.php
        // then a function called ldap_logout() inside that file
        // (using *authent_name*_logout as the function name) and the following code
        // will find and execute it
        $uinfo = api_get_user_info($user_id);

        if ((isset($uinfo['auth_source']) && $uinfo['auth_source'] != PLATFORM_AUTH_SOURCE) && is_array($extAuthSource)) {
            if (is_array($extAuthSource[$uinfo['auth_source']])) {
                $subarray = $extAuthSource[$uinfo['auth_source']];
                if (!empty($subarray['logout']) && file_exists($subarray['logout'])) {
                    require_once $subarray['logout'];
                    $logout_function = $uinfo['auth_source'].'_logout';
                    if (function_exists($logout_function)) {
                        $logout_function($uinfo);
                    }
                }
            }
        }

        require_once api_get_path(SYS_PATH) . 'main/chat/chat_functions.lib.php';
        exit_of_chat($user_id);

        if ($logout_redirect) {
            header("Location: index.php");
            exit;
        }
    }

    /**
     * Remove all login records from the track_e_online stats table, for the given user ID.
     * @param int User ID
     * @return bool
     */
    public static function loginDelete($user_id)
    {
        $online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
        $user_id = intval($user_id);
        if (empty($user_id)) {
            return false;
        }
        $query = "DELETE FROM ".$online_table ." WHERE login_user_id = '".$user_id."'";
        Database::query($query);
        return true;
    }

    public static function user_is_online($user_id)
    {
        $track_online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
        $table_user			= Database::get_main_table(TABLE_MAIN_USER);


        $access_url_id		= api_get_current_access_url_id();
        $time_limit			= api_get_setting('time_limit_whosonline');

        $online_time 	= time() - $time_limit*60;
        $limit_date		= api_get_utc_datetime($online_time);

        $query = " SELECT login_user_id,login_date FROM ".$track_online_table ." track INNER JOIN ".$table_user ." u ON (u.user_id=track.login_user_id)
                   WHERE track.access_url_id =  $access_url_id AND
                        login_date >= '".$limit_date."'  AND
                        u.user_id =  $user_id
                   LIMIT 1 ";

        $result = Database::query($query);
        if (Database::num_rows($result)) {
            return true;
        }
        return false;

    }

    /**
     * Gives a list of people online now (and in the last $valid minutes)
     * @return  array       For each line, a list of user IDs and login dates, or FALSE on error or empty results
     */
    public static function who_is_online($from, $number_of_items, $column = null, $direction = null, $time_limit = null, $friends = false)
    {

        // Time limit in seconds?
        if (empty($time_limit)) {
            $time_limit = api_get_setting('time_limit_whosonline');
        } else {
            $time_limit = intval($time_limit);
        }

        $from            = intval($from);
        $number_of_items = intval($number_of_items);

        if (empty($column)) {
            $column = 'picture_uri';
            if ($friends) {
                $column = 'login_date';
            }
        }

        if (empty($direction)) {
            $direction = 'DESC';
        } else {
            if (!in_array(strtolower($direction), array('asc', 'desc'))) {
                $direction = 'DESC';
            }
        }

        $online_time 		= time() - $time_limit*60;
        $current_date		= api_get_utc_datetime($online_time);
        $track_online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
        $friend_user_table  = Database::get_main_table(TABLE_MAIN_USER_REL_USER);
        $table_user			= Database::get_main_table(TABLE_MAIN_USER);
        $query              = '';

        if ($friends) {
            // 	who friends from social network is online
            $query = "SELECT DISTINCT login_user_id, login_date
                      FROM $track_online_table INNER JOIN $friend_user_table ON (friend_user_id = login_user_id)
                      WHERE     login_date >= '".$current_date."' AND
                                friend_user_id <> '".api_get_user_id()."' AND
                                relation_type='".USER_RELATION_TYPE_FRIEND."' AND
                                user_id = '".api_get_user_id()."'
                      ORDER BY $column $direction
                      LIMIT $from, $number_of_items";
        } else {
            $query = "SELECT DISTINCT login_user_id, login_date FROM ".$track_online_table ." e INNER JOIN ".$table_user ." u ON (u.user_id=e.login_user_id)
                      WHERE u.status != ".ANONYMOUS." AND login_date >= '".$current_date."'
                      ORDER BY $column $direction
                      LIMIT $from, $number_of_items";
        }

        if (api_get_multiple_access_url()) {
            $access_url_id = api_get_current_access_url_id();
            if ($access_url_id != -1) {
                if ($friends) {
                    // 	friends from social network is online
                    $query = "SELECT distinct login_user_id,login_date
                                FROM $track_online_table track INNER JOIN $friend_user_table ON (friend_user_id = login_user_id)
                                WHERE   track.access_url_id =  $access_url_id AND
                                        login_date >= '".$current_date."' AND
                                        friend_user_id <> '".api_get_user_id()."' AND
                                        relation_type='".USER_RELATION_TYPE_FRIEND."'
                                ORDER BY $column $direction
                                LIMIT $from, $number_of_items";
                } else {
                    // all users online
                    $query = "SELECT login_user_id, login_date FROM ".$track_online_table ." track INNER JOIN ".$table_user ." u
                              ON (u.user_id=track.login_user_id)
                              WHERE u.status != ".ANONYMOUS." AND track.access_url_id =  $access_url_id AND
                                    login_date >= '".$current_date."'
                              ORDER BY $column $direction
                              LIMIT $from, $number_of_items";
                }
            }
        }

        //This query will show all registered users. Only for dev purposes.
        /*$query = "SELECT DISTINCT u.user_id as login_user_id, login_date FROM ".$track_online_table ."  e , $table_user u
                GROUP by u.user_id
                ORDER BY $column $direction
                LIMIT $from, $number_of_items"; */

        $result = Database::query($query);
        if ($result) {
            /*$valid_date_time = new DateTime();
            $diff = "PT".$time_limit.'M';
            $valid_date_time->sub(new DateInterval($diff));*/
            $users_online = array();
            while(list($login_user_id, $login_date) = Database::fetch_row($result)) {
                $users_online[] = $login_user_id;
            }
            return $users_online;
        } else {
            return false;
        }
    }

    public static function who_is_online_count($time_limit = null, $friends = false)
    {
        if (empty($time_limit)) {
            $time_limit = api_get_setting('time_limit_whosonline');
        } else {
            $time_limit = intval($time_limit);
        }
        $track_online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
        $friend_user_table  = Database::get_main_table(TABLE_MAIN_USER_REL_USER);
        $table_user			= Database::get_main_table(TABLE_MAIN_USER);
        $query = '';


        $online_time 		= time() - $time_limit*60;
        $current_date		= api_get_utc_datetime($online_time);

        if ($friends) {
            // 	who friends from social network is online
            $query = "SELECT DISTINCT count(login_user_id) as count
                      FROM $track_online_table INNER JOIN $friend_user_table ON (friend_user_id = login_user_id)
                      WHERE login_date >= '$current_date' AND friend_user_id <> '".api_get_user_id()."' AND relation_type='".USER_RELATION_TYPE_FRIEND."' AND user_id = '".api_get_user_id()."' ";
        } else {
            // All users online
            $query = "SELECT count(login_id) as count
                      FROM $track_online_table track INNER JOIN $table_user u ON (u.user_id=track.login_user_id)
                      WHERE u.status != ".ANONYMOUS." AND login_date >= '$current_date'  ";
        }

        if (api_get_multiple_access_url()) {
            $access_url_id = api_get_current_access_url_id();
            if ($access_url_id != -1) {
                if ($friends) {
                    // 	friends from social network is online
                    $query = "SELECT DISTINCT count(login_user_id) as count
                                FROM $track_online_table track
                                INNER JOIN $friend_user_table ON (friend_user_id = login_user_id)
                                WHERE track.access_url_id = $access_url_id AND login_date >= '".$current_date."' AND friend_user_id <> '".api_get_user_id()."' AND relation_type='".USER_RELATION_TYPE_FRIEND."'  ";
                } else {
                    // all users online
                    $query = "SELECT count(login_id) as count FROM $track_online_table track
                              INNER JOIN $table_user u ON (u.user_id=track.login_user_id)
                              WHERE u.status != ".ANONYMOUS." AND track.access_url_id =  $access_url_id AND login_date >= '$current_date' ";
                }
            }
        }

        //Dev purposes show all users online

        /*$table_user = Database::get_main_table(TABLE_MAIN_USER);
        $query = "SELECT count(*)  as count FROM ".$table_user ."   ";*/

        $result = Database::query($query);
        if (Database::num_rows($result) > 0) {
            $row = Database::fetch_array($result);
            return $row['count'];
        } else {
            return false;
        }
    }

    /**
    * Returns a list (array) of users who are online and in this course.
    * @param    int User ID
    * @param    int Number of minutes
    * @param    string  Course code (could be empty, but then the function returns false)
    * @return   array   Each line gives a user id and a login time
    */
    public static function who_is_online_in_this_course($from, $number_of_items, $uid, $time_limit, $course_code)
    {
        if (empty($course_code)) return false;

        if (empty($time_limit)) {
            $time_limit = api_get_setting('time_limit_whosonline');
        } else {
            $time_limit = intval($time_limit);
        }

        $online_time 		= time() - $time_limit*60;
        $current_date		= api_get_utc_datetime($online_time);
        $track_online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
        $course_code        = Database::escape_string($course_code);

        $from            = intval($from);
        $number_of_items = intval($number_of_items);

        $query = "SELECT login_user_id, login_date FROM $track_online_table
                  WHERE login_user_id <> 2 AND course='$course_code' AND login_date >= '$current_date'
                  LIMIT $from, $number_of_items ";

        $result = Database::query($query);
        if ($result) {
            /*$valid_date_time = new DateTime();
            $diff = "PT".$time_limit.'M';
            $valid_date_time->sub(new DateInterval($diff));*/
            $users_online = array();

            while (list($login_user_id, $login_date) = Database::fetch_row($result)) {
                /*$user_login_date = new DateTime($login_date);
                if ($user_login_date > $valid_date_time->format('Y-m-d H:i:s')) {*/
                    $users_online[] = $login_user_id;
                }
            return $users_online;
        } else {
            return false;
        }
    }

    public static function who_is_online_in_this_course_count($uid, $time_limit, $coursecode=null)
    {
        if (empty($coursecode)) {
            return false;
        }
        $track_online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
        $coursecode = Database::escape_string($coursecode);
        $time_limit = Database::escape_string($time_limit);

        $online_time 		= time() - $time_limit*60;
        $current_date		= api_get_utc_datetime($online_time);

        $query = "SELECT count(login_user_id) as count FROM ".$track_online_table ."
                  WHERE login_user_id <> 2 AND course='".$coursecode."' AND login_date >= '$current_date' ";
        $result = Database::query($query);
        if (Database::num_rows($result) > 0) {
            $row = Database::fetch_array($result);
            return $row['count'];
        } else {
            return false;
        }
    }
}