forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-47803 Add report that lists user sessions
- Loading branch information
Petr Skoda
committed
Nov 18, 2014
1 parent
c106341
commit 8064168
Showing
9 changed files
with
374 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
<?php | ||
// This file is part of Moodle - http://moodle.org/ | ||
// | ||
// Moodle is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
// | ||
// Moodle is distributed in the hope that it will be useful, | ||
// but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
// GNU General Public License for more details. | ||
// | ||
// You should have received a copy of the GNU General Public License | ||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
/** | ||
* Capabilities for this report. | ||
* | ||
* @package report_usersessions | ||
* @copyright 2014 Totara Learning Solutions Ltd {@link http://www.totaralms.com/} | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
* @author Petr Skoda <petr.skoda@totaralms.com> | ||
*/ | ||
|
||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
$capabilities = array( | ||
|
||
'report/usersessions:manageownsessions' => array( | ||
'captype' => 'write', | ||
'contextlevel' => CONTEXT_USER, | ||
'archetypes' => array( | ||
'user' => CAP_ALLOW, | ||
), | ||
|
||
// NOTE: shared accounts usually do not allow changing | ||
// of own passwords, this is not very accurate but safer. | ||
'clonepermissionsfrom' => 'moodle/user:changeownpassword' | ||
), | ||
); | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
<?php | ||
// This file is part of Moodle - http://moodle.org/ | ||
// | ||
// Moodle is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
// | ||
// Moodle is distributed in the hope that it will be useful, | ||
// but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
// GNU General Public License for more details. | ||
// | ||
// You should have received a copy of the GNU General Public License | ||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
/** | ||
* Listing of all sessions for current user. | ||
* | ||
* @package report_usersessions | ||
* @copyright 2014 Totara Learning Solutions Ltd {@link http://www.totaralms.com/} | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
* @author Petr Skoda <petr.skoda@totaralms.com> | ||
*/ | ||
|
||
require(__DIR__ . '/../../config.php'); | ||
|
||
redirect(new moodle_url('/report/usersessions/user.php')); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
<?php | ||
// This file is part of Moodle - http://moodle.org/ | ||
// | ||
// Moodle is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
// | ||
// Moodle is distributed in the hope that it will be useful, | ||
// but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
// GNU General Public License for more details. | ||
// | ||
// You should have received a copy of the GNU General Public License | ||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
/** | ||
* Lang strings. | ||
* | ||
* @package report_usersessions | ||
* @copyright 2014 Totara Learning Solutions Ltd {@link http://www.totaralms.com/} | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
* @author Petr Skoda <petr.skoda@totaralms.com> | ||
*/ | ||
|
||
$string['navigationlink'] = 'Browser sessions'; | ||
$string['mysessions'] = 'My active sessions'; | ||
$string['pluginname'] = 'User sessions report'; | ||
$string['thissession'] = 'Current session'; | ||
$string['usersessions:manageownsessions'] = 'Manage own browser sessions'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
<?php | ||
// This file is part of Moodle - http://moodle.org/ | ||
// | ||
// Moodle is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
// | ||
// Moodle is distributed in the hope that it will be useful, | ||
// but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
// GNU General Public License for more details. | ||
// | ||
// You should have received a copy of the GNU General Public License | ||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
/** | ||
* Lib API functions. | ||
* | ||
* @package report_usersessions | ||
* @copyright 2014 Totara Learning Solutions Ltd {@link http://www.totaralms.com/} | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
* @author Petr Skoda <petr.skoda@totaralms.com> | ||
*/ | ||
|
||
defined('MOODLE_INTERNAL') || die; | ||
|
||
/** | ||
* This function extends the course navigation with the report items | ||
* | ||
* @param navigation_node $navigation The navigation node to extend | ||
* @param stdClass $user | ||
* @param stdClass $course The course to object for the report | ||
*/ | ||
function report_usersessions_extend_navigation_user($navigation, $user, $course) { | ||
global $USER; | ||
|
||
if (isguestuser() or !isloggedin()) { | ||
return; | ||
} | ||
|
||
if (\core\session\manager::is_loggedinas() or $USER->id != $user->id) { | ||
// No peeking at somebody else's sessions! | ||
return; | ||
} | ||
|
||
$context = context_user::instance($USER->id); | ||
if (has_capability('report/usersessions:manageownsessions', $context)) { | ||
$navigation->add(get_string('navigationlink', 'report_usersessions'), | ||
new moodle_url('/report/usersessions/user.php'), $navigation::TYPE_SETTING); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
<?php | ||
// This file is part of Moodle - http://moodle.org/ | ||
// | ||
// Moodle is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
// | ||
// Moodle is distributed in the hope that it will be useful, | ||
// but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
// GNU General Public License for more details. | ||
// | ||
// You should have received a copy of the GNU General Public License | ||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
/** | ||
* Lib API functions. | ||
* | ||
* @package report_usersessions | ||
* @copyright 2014 Totara Learning Solutions Ltd {@link http://www.totaralms.com/} | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
* @author Petr Skoda <petr.skoda@totaralms.com> | ||
*/ | ||
|
||
defined('MOODLE_INTERNAL') || die; | ||
|
||
require_once(__DIR__ . '/lib.php'); | ||
|
||
/** | ||
* Show user friendly duration since last activity. | ||
* | ||
* @param int $duration in seconds | ||
* @return string | ||
*/ | ||
function report_usersessions_format_duration($duration) { | ||
|
||
// NOTE: The session duration is not accurate thanks to | ||
// $CFG->session_update_timemodified_frequency setting. | ||
// Also there is no point in showing days here because | ||
// the session cleanup should purge all stale sessions | ||
// regularly. | ||
|
||
if ($duration < 60) { | ||
return get_string('now'); | ||
} | ||
|
||
if ($duration < 60 * 60 * 2) { | ||
$minutes = (int)($duration / 60); | ||
$ago = $minutes . ' ' . get_string('minutes'); | ||
return get_string('ago', 'core_message', $ago); | ||
} | ||
|
||
$hours = (int)($duration / (60 * 60)); | ||
$ago = $hours . ' ' . get_string('hours'); | ||
return get_string('ago', 'core_message', $ago); | ||
} | ||
|
||
/** | ||
* Show some user friendly IP address info. | ||
* | ||
* @param string $ip | ||
* @return string | ||
*/ | ||
function report_usersessions_format_ip($ip) { | ||
if (strpos($ip, ':') !== false) { | ||
// For now ipv6 is not supported yet. | ||
return $ip; | ||
} | ||
$url = new moodle_url('/iplookup/index.php', array('ip' => $ip)); | ||
return html_writer::link($url, $ip); | ||
} | ||
|
||
/** | ||
* Kill user session. | ||
* | ||
* @param int $id | ||
* @return void | ||
*/ | ||
function report_usersessions_kill_session($id) { | ||
global $DB, $USER; | ||
|
||
$session = $DB->get_record('sessions', array('id' => $id, 'userid' => $USER->id), 'id, sid'); | ||
|
||
if (!$session or $session->sid === session_id()) { | ||
// Do not delete the current session! | ||
return; | ||
} | ||
|
||
\core\session\manager::kill_session($session->sid); | ||
} |
10 changes: 10 additions & 0 deletions
10
report/usersessions/tests/behat/usersessions_report.feature
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
@report @report_usersessions | ||
Feature: In a report, admin can see current sessions | ||
In order see usersession data | ||
As a admin | ||
I need to view usersessions report and see if the current session is listed | ||
|
||
Scenario: Check usersessions report shows current session | ||
Given I log in as "admin" | ||
When I navigate to "Browser sessions" node in "My profile settings > Activity reports" | ||
Then I should see "Current session" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
<?php | ||
// This file is part of Moodle - http://moodle.org/ | ||
// | ||
// Moodle is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
// | ||
// Moodle is distributed in the hope that it will be useful, | ||
// but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
// GNU General Public License for more details. | ||
// | ||
// You should have received a copy of the GNU General Public License | ||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
/** | ||
* Listing of all sessions for current user. | ||
* | ||
* @package report_usersessions | ||
* @copyright 2014 Totara Learning Solutions Ltd {@link http://www.totaralms.com/} | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
* @author Petr Skoda <petr.skoda@totaralms.com> | ||
*/ | ||
|
||
require(__DIR__ . '/../../config.php'); | ||
require_once(__DIR__ . '/locallib.php'); | ||
|
||
require_login(null, false); | ||
|
||
if (isguestuser()) { | ||
// No guests here! | ||
redirect(new moodle_url('/')); | ||
die; | ||
} | ||
if (\core\session\manager::is_loggedinas()) { | ||
// No login-as users. | ||
redirect(new moodle_url('/user/index.php')); | ||
die; | ||
} | ||
|
||
$context = context_user::instance($USER->id); | ||
require_capability('report/usersessions:manageownsessions', $context); | ||
|
||
$delete = optional_param('delete', 0, PARAM_INT); | ||
|
||
$PAGE->set_url('/report/usersessions/user.php'); | ||
$PAGE->set_context($context); | ||
$PAGE->set_title(get_string('navigationlink', 'report_usersessions')); | ||
$PAGE->set_pagelayout('admin'); | ||
|
||
if ($delete and confirm_sesskey()) { | ||
report_usersessions_kill_session($delete); | ||
redirect($PAGE->url); | ||
} | ||
|
||
echo $OUTPUT->header(); | ||
echo $OUTPUT->heading(get_string('mysessions', 'report_usersessions')); | ||
|
||
$data = array(); | ||
$sql = "SELECT id, timecreated, timemodified, firstip, lastip, sid | ||
FROM {sessions} | ||
WHERE userid = :userid | ||
ORDER BY timemodified DESC"; | ||
$params = array('userid' => $USER->id, 'sid' => session_id()); | ||
|
||
$sessions = $DB->get_records_sql($sql, $params); | ||
foreach ($sessions as $session) { | ||
if ($session->sid === $params['sid']) { | ||
$lastaccess = get_string('thissession', 'report_usersessions'); | ||
$deletelink = ''; | ||
|
||
} else { | ||
$lastaccess = report_usersessions_format_duration(time() - $session->timemodified); | ||
$url = new moodle_url($PAGE->url, array('delete' => $session->id, 'sesskey' => sesskey())); | ||
$deletelink = html_writer::link($url, get_string('logout')); | ||
} | ||
$data[] = array(userdate($session->timecreated), $lastaccess, report_usersessions_format_ip($session->lastip), $deletelink); | ||
} | ||
|
||
$table = new html_table(); | ||
$table->head = array(get_string('login'), get_string('lastaccess'), get_string('lastip'), get_string('action')); | ||
$table->align = array('left', 'left', 'left', 'right'); | ||
$table->data = $data; | ||
echo html_writer::table($table); | ||
|
||
echo $OUTPUT->footer(); | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
<?php | ||
// This file is part of Moodle - http://moodle.org/ | ||
// | ||
// Moodle is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
// | ||
// Moodle is distributed in the hope that it will be useful, | ||
// but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
// GNU General Public License for more details. | ||
// | ||
// You should have received a copy of the GNU General Public License | ||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
/** | ||
* Version info. | ||
* | ||
* @package report_usersessions | ||
* @copyright 2014 Totara Learning Solutions Ltd {@link http://www.totaralms.com/} | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
* @author Petr Skoda <petr.skoda@totaralms.com> | ||
*/ | ||
|
||
defined('MOODLE_INTERNAL') || die; | ||
|
||
$plugin->version = 2014111800; // The current plugin version (Date: YYYYMMDDXX). | ||
$plugin->requires = 2014111300; // Requires this Moodle version. | ||
$plugin->component = 'report_usersessions'; // Full name of the plugin (used for diagnostics). |