f757272e1ff6c4adb7b828a63c969a7677f78c64
[moodle.git] / report / log / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Public API of the log report.
19  *
20  * @package    report
21  * @subpackage log
22  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die;
28 /**
29  * This function extends the navigation with the report items
30  *
31  * @param navigation_node $navigation The navigation node to extend
32  * @param stdClass $course The course to object for the report
33  * @param stdClass $context The context of the course
34  */
35 function report_log_extend_navigation_course($navigation, $course, $context) {
36     if (has_capability('report/log:view', $context)) {
37         $url = new moodle_url('/report/log/index.php', array('id'=>$course->id));
38         $navigation->add(get_string('pluginname', 'report_log'), $url, navigation_node::TYPE_SETTING, null, null, new pix_icon('i/report', ''));
39     }
40 }
42 /**
43  * This function extends the course navigation with the report items
44  *
45  * @param navigation_node $navigation The navigation node to extend
46  * @param stdClass $user
47  * @param stdClass $course The course to object for the report
48  */
49 function report_log_extend_navigation_user($navigation, $user, $course) {
50     list($all, $today) = report_log_can_access_user_report($user, $course);
52     if ($today) {
53         $url = new moodle_url('/report/log/user.php', array('id'=>$user->id, 'course'=>$course->id, 'mode'=>'today'));
54         $navigation->add(get_string('todaylogs'), $url);
55     }
56     if ($all) {
57         $url = new moodle_url('/report/log/user.php', array('id'=>$user->id, 'course'=>$course->id, 'mode'=>'all'));
58         $navigation->add(get_string('alllogs'), $url);
59     }
60 }
62 /**
63  * Is current user allowed to access this report
64  *
65  * @private defined in lib.php for performance reasons
66  *
67  * @param stdClass $user
68  * @param stdClass $course
69  * @return array with two elements $all, $today
70  */
71 function report_log_can_access_user_report($user, $course) {
72     global $USER;
74     $coursecontext = context_course::instance($course->id);
75     $personalcontext = context_user::instance($user->id);
77     $today = false;
78     $all = false;
80     if (has_capability('report/log:view', $coursecontext)) {
81         $today = true;
82     }
83     if (has_capability('report/log:viewtoday', $coursecontext)) {
84         $all = true;;
85     }
87     if ($today and $all) {
88         return array(true, true);
89     }
91     if (has_capability('moodle/user:viewuseractivitiesreport', $personalcontext)) {
92         if ($course->showreports and (is_viewing($coursecontext, $user) or is_enrolled($coursecontext, $user))) {
93             return array(true, true);
94         }
96     } else if ($user->id == $USER->id) {
97         if ($course->showreports and (is_viewing($coursecontext, $USER) or is_enrolled($coursecontext, $USER))) {
98             return array(true, true);
99         }
100     }
102     return array($all, $today);
105 /**
106  * This function extends the module navigation with the report items
107  *
108  * @param navigation_node $navigation The navigation node to extend
109  * @param stdClass $cm
110  */
111 function report_log_extend_navigation_module($navigation, $cm) {
112     if (has_capability('report/log:view', context_course::instance($cm->course))) {
113         $url = new moodle_url('/report/log/index.php', array('chooselog'=>'1','id'=>$cm->course,'modid'=>$cm->id));
114         $navigation->add(get_string('logs'), $url, navigation_node::TYPE_SETTING, null, 'logreport');
115     }
118 /**
119  * Return a list of page types
120  * @param string $pagetype current page type
121  * @param stdClass $parentcontext Block's parent context
122  * @param stdClass $currentcontext Current context of block
123  * @return array
124  */
125 function report_log_page_type_list($pagetype, $parentcontext, $currentcontext) {
126     $array = array(
127         '*'                => get_string('page-x', 'pagetype'),
128         'report-*'         => get_string('page-report-x', 'pagetype'),
129         'report-log-*'     => get_string('page-report-log-x',  'report_log'),
130         'report-log-index' => get_string('page-report-log-index',  'report_log'),
131         'report-log-user'  => get_string('page-report-log-user',  'report_log')
132     );
133     return $array;