online.inc.php 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532
  1. <?php
  2. /* For licensing terms, see /license.txt */
  3. use ChamiloSession as Session;
  4. /**
  5. * Code library for showing Who is online
  6. *
  7. * @author Istvan Mandak, principal author
  8. * @author Denes Nagy, principal author
  9. * @author Bart Mollet
  10. * @author Roan Embrechts, cleaning and bugfixing
  11. * @package chamilo.whoisonline
  12. */
  13. /**
  14. * Insert a login reference for the current user into the track_e_online stats table.
  15. * This table keeps trace of the last login. Nothing else matters (we don't keep traces of anything older)
  16. * @param int user id
  17. * @return void
  18. */
  19. function LoginCheck($uid)
  20. {
  21. $uid = (int) $uid;
  22. if (!empty($uid)) {
  23. $online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
  24. $_course = api_get_course_info();
  25. $user_ip = '';
  26. if (!empty($_SERVER['REMOTE_ADDR'])) {
  27. $user_ip = Database::escape_string(api_get_real_ip());
  28. }
  29. $login_date = api_get_utc_datetime();
  30. $access_url_id = 1;
  31. if (api_get_multiple_access_url() && api_get_current_access_url_id() != -1) {
  32. $access_url_id = api_get_current_access_url_id();
  33. }
  34. $session_id = api_get_session_id();
  35. // 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
  36. // to have the x users in this course feature working
  37. if (is_array($_course) && count($_course) > 0 && !empty($_course['id'])) {
  38. $query = "REPLACE INTO ".$online_table." (login_id,login_user_id,login_date,user_ip, c_id, session_id, access_url_id)
  39. VALUES ($uid,$uid,'$login_date','$user_ip', '".$_course['real_id']."' , '$session_id' , '$access_url_id' )";
  40. } else {
  41. $query = "REPLACE INTO ".$online_table." (login_id,login_user_id,login_date,user_ip, c_id, session_id, access_url_id)
  42. VALUES ($uid,$uid,'$login_date','$user_ip', 0, '$session_id', '$access_url_id')";
  43. }
  44. Database::query($query);
  45. }
  46. }
  47. /**
  48. * @param int $userId
  49. */
  50. function preventMultipleLogin($userId)
  51. {
  52. $table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
  53. $userId = intval($userId);
  54. if (api_get_setting('prevent_multiple_simultaneous_login') === 'true') {
  55. if (!empty($userId) && !api_is_anonymous()) {
  56. $isFirstLogin = Session::read('first_user_login');
  57. if (empty($isFirstLogin)) {
  58. $sql = "SELECT login_id FROM $table
  59. WHERE login_user_id = $userId
  60. LIMIT 1";
  61. $result = Database::query($sql);
  62. $loginData = array();
  63. if (Database::num_rows($result)) {
  64. $loginData = Database::fetch_array($result);
  65. }
  66. $userIsReallyOnline = user_is_online($userId);
  67. // Trying double login.
  68. if (!empty($loginData) && $userIsReallyOnline == true) {
  69. session_regenerate_id();
  70. Session::destroy();
  71. header('Location: '.api_get_path(WEB_PATH).'index.php?loginFailed=1&error=multiple_connection_not_allowed');
  72. exit;
  73. } else {
  74. // First time
  75. Session::write('first_user_login', 1);
  76. }
  77. }
  78. }
  79. }
  80. }
  81. /**
  82. * This function handles the logout and is called whenever there is a $_GET['logout']
  83. * @param int $user_id
  84. * @param bool $logout_redirect
  85. * @return void Directly redirects the user or leaves him where he is, but doesn't return anything
  86. * @author Fernando P. García <fernando@develcuy.com>
  87. */
  88. function online_logout($user_id = null, $logout_redirect = false)
  89. {
  90. global $extAuthSource;
  91. // Database table definition
  92. $tbl_track_login = Database::get_main_table(TABLE_STATISTIC_TRACK_E_LOGIN);
  93. if (empty($user_id)) {
  94. $user_id = isset($_GET['uid']) ? intval($_GET['uid']) : 0;
  95. }
  96. //Changing global chat status to offline
  97. if (api_is_global_chat_enabled()) {
  98. $chat = new Chat();
  99. $chat->setUserStatus(0);
  100. }
  101. // selecting the last login of the user
  102. $sql = "SELECT login_id, login_date
  103. FROM $tbl_track_login
  104. WHERE login_user_id = $user_id
  105. ORDER BY login_date DESC
  106. LIMIT 0,1";
  107. $q_last_connection = Database::query($sql);
  108. if (Database::num_rows($q_last_connection) > 0) {
  109. $i_id_last_connection = Database::result($q_last_connection, 0, "login_id");
  110. }
  111. if (!isset($_SESSION['login_as'])) {
  112. $current_date = api_get_utc_datetime();
  113. $sql = "UPDATE $tbl_track_login SET logout_date='".$current_date."'
  114. WHERE login_id='$i_id_last_connection'";
  115. Database::query($sql);
  116. }
  117. UserManager::loginDelete($user_id);
  118. //the following code enables the use of an external logout function.
  119. //example: define a $extAuthSource['ldap']['logout']="file.php" in configuration.php
  120. // then a function called ldap_logout() inside that file
  121. // (using *authent_name*_logout as the function name) and the following code
  122. // will find and execute it
  123. $uinfo = api_get_user_info($user_id);
  124. if (($uinfo['auth_source'] != PLATFORM_AUTH_SOURCE) && is_array($extAuthSource)) {
  125. if (is_array($extAuthSource[$uinfo['auth_source']])) {
  126. $subarray = $extAuthSource[$uinfo['auth_source']];
  127. if (!empty($subarray['logout']) && file_exists($subarray['logout'])) {
  128. require_once($subarray['logout']);
  129. $logout_function = $uinfo['auth_source'].'_logout';
  130. if (function_exists($logout_function)) {
  131. $logout_function($uinfo);
  132. }
  133. }
  134. }
  135. }
  136. // After logout redirect to
  137. $url = api_get_path(WEB_PATH).'index.php';
  138. if ($logout_redirect && api_get_plugin_setting('azure_active_directory', 'enable') == 'true') {
  139. $activeDirectoryPlugin = AzureActiveDirectory::create();
  140. $azureLogout = $activeDirectoryPlugin->getUrl(AzureActiveDirectory::URL_TYPE_SIGNOUT);
  141. if (!empty($azureLogout)) {
  142. $url = $azureLogout;
  143. }
  144. }
  145. CourseChatUtils::exitChat($user_id);
  146. session_regenerate_id();
  147. Session::destroy();
  148. if ($logout_redirect) {
  149. header("Location: ".$url);
  150. exit;
  151. }
  152. }
  153. /**
  154. * @param int $user_id
  155. * @return bool
  156. */
  157. function user_is_online($user_id)
  158. {
  159. $track_online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
  160. $table_user = Database::get_main_table(TABLE_MAIN_USER);
  161. $access_url_id = api_get_current_access_url_id();
  162. $time_limit = api_get_setting('time_limit_whosonline');
  163. $online_time = time() - $time_limit * 60;
  164. $limit_date = api_get_utc_datetime($online_time);
  165. $user_id = intval($user_id);
  166. $query = " SELECT login_user_id, login_date
  167. FROM $track_online_table track
  168. INNER JOIN $table_user u
  169. ON (u.id=track.login_user_id)
  170. WHERE
  171. track.access_url_id = $access_url_id AND
  172. login_date >= '".$limit_date."' AND
  173. u.id = $user_id
  174. LIMIT 1 ";
  175. $result = Database::query($query);
  176. if (Database::num_rows($result)) {
  177. return true;
  178. }
  179. return false;
  180. }
  181. /**
  182. * Gives a list of people online now (and in the last $valid minutes)
  183. *
  184. * @param $from
  185. * @param $number_of_items
  186. * @param null $column
  187. * @param null $direction
  188. * @param null $time_limit
  189. * @param bool $friends
  190. * @return array|bool For each line, a list of user IDs and login dates, or FALSE on error or empty results
  191. */
  192. function who_is_online(
  193. $from,
  194. $number_of_items,
  195. $column = null,
  196. $direction = null,
  197. $time_limit = null,
  198. $friends = false
  199. ) {
  200. // Time limit in seconds?
  201. if (empty($time_limit)) {
  202. $time_limit = api_get_setting('time_limit_whosonline');
  203. } else {
  204. $time_limit = intval($time_limit);
  205. }
  206. $from = intval($from);
  207. $number_of_items = intval($number_of_items);
  208. if (empty($column)) {
  209. $column = 'picture_uri';
  210. if ($friends) {
  211. $column = 'login_date';
  212. }
  213. }
  214. if (empty($direction)) {
  215. $direction = 'DESC';
  216. } else {
  217. if (!in_array(strtolower($direction), array('asc', 'desc'))) {
  218. $direction = 'DESC';
  219. }
  220. }
  221. $online_time = time() - $time_limit * 60;
  222. $current_date = api_get_utc_datetime($online_time);
  223. $track_online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
  224. $friend_user_table = Database::get_main_table(TABLE_MAIN_USER_REL_USER);
  225. $table_user = Database::get_main_table(TABLE_MAIN_USER);
  226. if ($friends) {
  227. // who friends from social network is online
  228. $query = "SELECT DISTINCT login_user_id, login_date
  229. FROM $track_online_table INNER JOIN $friend_user_table
  230. ON (friend_user_id = login_user_id)
  231. WHERE
  232. login_date >= '".$current_date."' AND
  233. friend_user_id <> '".api_get_user_id()."' AND
  234. relation_type='".USER_RELATION_TYPE_FRIEND."' AND
  235. user_id = '".api_get_user_id()."'
  236. ORDER BY $column $direction
  237. LIMIT $from, $number_of_items";
  238. } else {
  239. $query = "SELECT DISTINCT login_user_id, login_date
  240. FROM ".$track_online_table." e
  241. INNER JOIN ".$table_user." u ON (u.id = e.login_user_id)
  242. WHERE u.status != ".ANONYMOUS." AND login_date >= '".$current_date."'
  243. ORDER BY $column $direction
  244. LIMIT $from, $number_of_items";
  245. }
  246. if (api_get_multiple_access_url()) {
  247. $access_url_id = api_get_current_access_url_id();
  248. if ($access_url_id != -1) {
  249. if ($friends) {
  250. // friends from social network is online
  251. $query = "SELECT distinct login_user_id, login_date
  252. FROM $track_online_table track INNER JOIN $friend_user_table
  253. ON (friend_user_id = login_user_id)
  254. WHERE track.access_url_id = $access_url_id AND
  255. login_date >= '".$current_date."' AND
  256. friend_user_id <> '".api_get_user_id()."' AND
  257. relation_type='".USER_RELATION_TYPE_FRIEND."'
  258. ORDER BY $column $direction
  259. LIMIT $from, $number_of_items";
  260. } else {
  261. // all users online
  262. $query = "SELECT login_user_id, login_date
  263. FROM ".$track_online_table." track
  264. INNER JOIN ".$table_user." u
  265. ON (u.id=track.login_user_id)
  266. WHERE u.status != ".ANONYMOUS." AND track.access_url_id = $access_url_id AND
  267. login_date >= '".$current_date."'
  268. ORDER BY $column $direction
  269. LIMIT $from, $number_of_items";
  270. }
  271. }
  272. }
  273. //This query will show all registered users. Only for dev purposes.
  274. /*$query = "SELECT DISTINCT u.id as login_user_id, login_date
  275. FROM $track_online_table e, $table_user u
  276. GROUP by u.id
  277. ORDER BY $column $direction
  278. LIMIT $from, $number_of_items";*/
  279. $result = Database::query($query);
  280. if ($result) {
  281. $users_online = array();
  282. while (list($login_user_id, $login_date) = Database::fetch_row($result)) {
  283. $users_online[] = $login_user_id;
  284. }
  285. return $users_online;
  286. } else {
  287. return false;
  288. }
  289. }
  290. /**
  291. * @param string $time_limit
  292. */
  293. function who_is_online_count($time_limit = null, $friends = false)
  294. {
  295. if (empty($time_limit)) {
  296. $time_limit = api_get_setting('time_limit_whosonline');
  297. } else {
  298. $time_limit = intval($time_limit);
  299. }
  300. $track_online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
  301. $friend_user_table = Database::get_main_table(TABLE_MAIN_USER_REL_USER);
  302. $table_user = Database::get_main_table(TABLE_MAIN_USER);
  303. $online_time = time() - $time_limit * 60;
  304. $current_date = api_get_utc_datetime($online_time);
  305. if ($friends) {
  306. // who friends from social network is online
  307. $query = "SELECT DISTINCT count(login_user_id) as count
  308. FROM $track_online_table INNER JOIN $friend_user_table
  309. ON (friend_user_id = login_user_id)
  310. WHERE
  311. login_date >= '$current_date' AND
  312. friend_user_id <> '".api_get_user_id()."' AND
  313. relation_type='".USER_RELATION_TYPE_FRIEND."' AND
  314. user_id = '".api_get_user_id()."' ";
  315. } else {
  316. // All users online
  317. $query = "SELECT count(login_id) as count
  318. FROM $track_online_table track INNER JOIN $table_user u
  319. ON (u.id=track.login_user_id)
  320. WHERE u.status != ".ANONYMOUS." AND login_date >= '$current_date' ";
  321. }
  322. if (api_get_multiple_access_url()) {
  323. $access_url_id = api_get_current_access_url_id();
  324. if ($access_url_id != -1) {
  325. if ($friends) {
  326. // friends from social network is online
  327. $query = "SELECT DISTINCT count(login_user_id) as count
  328. FROM $track_online_table track
  329. INNER JOIN $friend_user_table ON (friend_user_id = login_user_id)
  330. WHERE
  331. track.access_url_id = $access_url_id AND
  332. login_date >= '".$current_date."' AND
  333. friend_user_id <> '".api_get_user_id()."' AND
  334. relation_type='".USER_RELATION_TYPE_FRIEND."' ";
  335. } else {
  336. // all users online
  337. $query = "SELECT count(login_id) as count FROM $track_online_table track
  338. INNER JOIN $table_user u ON (u.id=track.login_user_id)
  339. WHERE
  340. u.status != ".ANONYMOUS." AND
  341. track.access_url_id = $access_url_id AND
  342. login_date >= '$current_date' ";
  343. }
  344. }
  345. }
  346. // Dev purposes show all users online
  347. /*$table_user = Database::get_main_table(TABLE_MAIN_USER);
  348. $query = "SELECT count(*) as count FROM ".$table_user;*/
  349. $result = Database::query($query);
  350. if (Database::num_rows($result) > 0) {
  351. $row = Database::fetch_array($result);
  352. return $row['count'];
  353. } else {
  354. return false;
  355. }
  356. }
  357. /**
  358. * Returns a list (array) of users who are online and in this course.
  359. * @param int User ID
  360. * @param int Number of minutes
  361. * @param string Course code (could be empty, but then the function returns false)
  362. * @return array Each line gives a user id and a login time
  363. */
  364. function who_is_online_in_this_course($from, $number_of_items, $uid, $time_limit, $course_code)
  365. {
  366. if (empty($course_code)) {
  367. return false;
  368. }
  369. if (empty($time_limit)) {
  370. $time_limit = api_get_setting('time_limit_whosonline');
  371. } else {
  372. $time_limit = intval($time_limit);
  373. }
  374. $online_time = time() - $time_limit * 60;
  375. $current_date = api_get_utc_datetime($online_time);
  376. $track_online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
  377. $tableUser = Database::get_main_table(TABLE_MAIN_USER);
  378. $course_code = Database::escape_string($course_code);
  379. $courseInfo = api_get_course_info($course_code);
  380. $courseId = $courseInfo['real_id'];
  381. $from = intval($from);
  382. $number_of_items = intval($number_of_items);
  383. $query = "SELECT o.login_user_id, o.login_date
  384. FROM $track_online_table o INNER JOIN $tableUser u
  385. ON (o.login_user_id = u.id)
  386. WHERE
  387. u.status <> '".ANONYMOUS."' AND
  388. o.c_id = $courseId AND
  389. o.login_date >= '$current_date'
  390. LIMIT $from, $number_of_items ";
  391. $result = Database::query($query);
  392. if ($result) {
  393. $users_online = array();
  394. while (list($login_user_id, $login_date) = Database::fetch_row($result)) {
  395. $users_online[] = $login_user_id;
  396. }
  397. return $users_online;
  398. } else {
  399. return false;
  400. }
  401. }
  402. /**
  403. * @param integer $uid
  404. * @param string $time_limit
  405. */
  406. function who_is_online_in_this_course_count(
  407. $uid,
  408. $time_limit,
  409. $coursecode = null
  410. ) {
  411. if (empty($coursecode)) {
  412. return false;
  413. }
  414. $track_online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
  415. $tableUser = Database::get_main_table(TABLE_MAIN_USER);
  416. $time_limit = Database::escape_string($time_limit);
  417. $online_time = time() - $time_limit * 60;
  418. $current_date = api_get_utc_datetime($online_time);
  419. $courseId = api_get_course_int_id($coursecode);
  420. if (empty($courseId)) {
  421. return false;
  422. }
  423. $query = "SELECT count(login_user_id) as count
  424. FROM $track_online_table o INNER JOIN $tableUser u
  425. ON (login_user_id = u.id)
  426. WHERE
  427. u.status <> '".ANONYMOUS."' AND
  428. c_id = $courseId AND
  429. login_date >= '$current_date' ";
  430. $result = Database::query($query);
  431. if (Database::num_rows($result) > 0) {
  432. $row = Database::fetch_array($result);
  433. return $row['count'];
  434. } else {
  435. return false;
  436. }
  437. }
  438. /**
  439. * @param string $timeLimit
  440. * @param int $sessionId
  441. * @return bool
  442. */
  443. function whoIsOnlineInThisSessionCount($timeLimit, $sessionId)
  444. {
  445. if (!$sessionId) {
  446. return 0;
  447. }
  448. $tblTrackOnline = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
  449. $tableUser = Database::get_main_table(TABLE_MAIN_USER);
  450. $timeLimit = Database::escape_string($timeLimit);
  451. $online_time = time() - $timeLimit * 60;
  452. $current_date = api_get_utc_datetime($online_time);
  453. $query = "SELECT count(login_user_id) as count
  454. FROM $tblTrackOnline o INNER JOIN $tableUser u
  455. ON (login_user_id = u.id)
  456. WHERE
  457. u.status <> '".ANONYMOUS."' AND
  458. session_id = $sessionId AND
  459. login_date >= '$current_date' ";
  460. $result = Database::query($query);
  461. if (Database::num_rows($result) > 0) {
  462. $row = Database::fetch_assoc($result);
  463. return $row['count'];
  464. }
  465. return 0;
  466. }