Merge branch 'wip-MDL-52008-master' of git://github.com/abgreeve/moodle
[moodle.git] / report / log / classes / table_log.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  * Table log for displaying logs.
19  *
20  * @package    report_log
21  * @copyright  2014 Rajesh Taneja <rajesh.taneja@gmail.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die;
27 /**
28  * Table log class for displaying logs.
29  *
30  * @package    report_log
31  * @copyright  2014 Rajesh Taneja <rajesh.taneja@gmail.com>
32  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33  */
34 class report_log_table_log extends table_sql {
36     /** @var array list of user fullnames shown in report */
37     private $userfullnames = array();
39     /**
40      * @deprecated since Moodle 2.9 MDL-48595 - please do not use this argument any more.
41      * @todo MDL-49291 This will be deleted in 3.1
42      * @var array list of course short names shown in report.
43      */
44     private $courseshortnames = array();
46     /** @var array list of context name shown in report */
47     private $contextname = array();
49     /** @var stdClass filters parameters */
50     private $filterparams;
52     /**
53      * Sets up the table_log parameters.
54      *
55      * @param string $uniqueid unique id of form.
56      * @param stdClass $filterparams (optional) filter params.
57      *     - int courseid: id of course
58      *     - int userid: user id
59      *     - int|string modid: Module id or "site_errors" to view site errors
60      *     - int groupid: Group id
61      *     - \core\log\sql_reader logreader: reader from which data will be fetched.
62      *     - int edulevel: educational level.
63      *     - string action: view action
64      *     - int date: Date from which logs to be viewed.
65      */
66     public function __construct($uniqueid, $filterparams = null) {
67         parent::__construct($uniqueid);
69         $this->set_attribute('class', 'reportlog generaltable generalbox');
70         $this->filterparams = $filterparams;
71         // Add course column if logs are displayed for site.
72         $cols = array();
73         $headers = array();
74         if (empty($filterparams->courseid)) {
75             $cols = array('course');
76             $headers = array(get_string('course'));
77         }
79         $this->define_columns(array_merge($cols, array('time', 'fullnameuser', 'relatedfullnameuser', 'context', 'component',
80                 'eventname', 'description', 'origin', 'ip')));
81         $this->define_headers(array_merge($headers, array(
82                 get_string('time'),
83                 get_string('fullnameuser'),
84                 get_string('eventrelatedfullnameuser', 'report_log'),
85                 get_string('eventcontext', 'report_log'),
86                 get_string('eventcomponent', 'report_log'),
87                 get_string('eventname'),
88                 get_string('description'),
89                 get_string('eventorigin', 'report_log'),
90                 get_string('ip_address')
91                 )
92             ));
93         $this->collapsible(false);
94         $this->sortable(false);
95         $this->pageable(true);
96     }
98     /**
99      * Generate the course column.
100      *
101      * @deprecated since Moodle 2.9 MDL-48595 - please do not use this function any more.
102      * @todo MDL-49291 This will be deleted in 3.1
103      * @param stdClass $event event data.
104      * @return string HTML for the course column.
105      */
106     public function col_course($event) {
108         debugging('col_course() is deprecated, there is no such column', DEBUG_DEVELOPER);
110         if (empty($event->courseid) || empty($this->courseshortnames[$event->courseid])) {
111             return '-';
112         } else {
113             return $this->courseshortnames[$event->courseid];
114         }
115     }
117     /**
118      * Gets the user full name.
119      *
120      * This function is useful because, in the unlikely case that the user is
121      * not already loaded in $this->userfullnames it will fetch it from db.
122      *
123      * @since Moodle 2.9
124      * @param int $userid
125      * @return string|false
126      */
127     protected function get_user_fullname($userid) {
128         global $DB;
130         if (empty($userid)) {
131             return false;
132         }
134         if (!empty($this->userfullnames[$userid])) {
135             return $this->userfullnames[$userid];
136         }
138         // We already looked for the user and it does not exist.
139         if ($this->userfullnames[$userid] === false) {
140             return false;
141         }
143         // If we reach that point new users logs have been generated since the last users db query.
144         list($usql, $uparams) = $DB->get_in_or_equal($userid);
145         $sql = "SELECT id," . get_all_user_name_fields(true) . " FROM {user} WHERE id " . $usql;
146         if (!$user = $DB->get_records_sql($sql, $uparams)) {
147             return false;
148         }
150         $this->userfullnames[$userid] = fullname($user);
151         return $this->userfullnames[$userid];
152     }
154     /**
155      * Generate the time column.
156      *
157      * @param stdClass $event event data.
158      * @return string HTML for the time column
159      */
160     public function col_time($event) {
161         $recenttimestr = get_string('strftimerecent', 'core_langconfig');
162         return userdate($event->timecreated, $recenttimestr);
163     }
165     /**
166      * Generate the username column.
167      *
168      * @param stdClass $event event data.
169      * @return string HTML for the username column
170      */
171     public function col_fullnameuser($event) {
172         // Get extra event data for origin and realuserid.
173         $logextra = $event->get_logextra();
175         // Add username who did the action.
176         if (!empty($logextra['realuserid'])) {
177             $a = new stdClass();
178             if (!$a->realusername = $this->get_user_fullname($logextra['realuserid'])) {
179                 $a->realusername = '-';
180             }
181             if (!$a->asusername = $this->get_user_fullname($event->userid)) {
182                 $a->asusername = '-';
183             }
184             if (empty($this->download)) {
185                 $params = array('id' => $logextra['realuserid']);
186                 if ($event->courseid) {
187                     $params['course'] = $event->courseid;
188                 }
189                 $a->realusername = html_writer::link(new moodle_url('/user/view.php', $params), $a->realusername);
190                 $params['id'] = $event->userid;
191                 $a->asusername = html_writer::link(new moodle_url('/user/view.php', $params), $a->asusername);
192             }
193             $username = get_string('eventloggedas', 'report_log', $a);
195         } else if (!empty($event->userid) && $username = $this->get_user_fullname($event->userid)) {
196             if (empty($this->download)) {
197                 $params = array('id' => $event->userid);
198                 if ($event->courseid) {
199                     $params['course'] = $event->courseid;
200                 }
201                 $username = html_writer::link(new moodle_url('/user/view.php', $params), $username);
202             }
203         } else {
204             $username = '-';
205         }
206         return $username;
207     }
209     /**
210      * Generate the related username column.
211      *
212      * @param stdClass $event event data.
213      * @return string HTML for the related username column
214      */
215     public function col_relatedfullnameuser($event) {
216         // Add affected user.
217         if (!empty($event->relateduserid) && $username = $this->get_user_fullname($event->relateduserid)) {
218             if (empty($this->download)) {
219                 $params = array('id' => $event->relateduserid);
220                 if ($event->courseid) {
221                     $params['course'] = $event->courseid;
222                 }
223                 $username = html_writer::link(new moodle_url('/user/view.php', $params), $username);
224             }
225         } else {
226             $username = '-';
227         }
228         return $username;
229     }
231     /**
232      * Generate the context column.
233      *
234      * @param stdClass $event event data.
235      * @return string HTML for the context column
236      */
237     public function col_context($event) {
238         // Add context name.
239         if ($event->contextid) {
240             // If context name was fetched before then return, else get one.
241             if (isset($this->contextname[$event->contextid])) {
242                 return $this->contextname[$event->contextid];
243             } else {
244                 $context = context::instance_by_id($event->contextid, IGNORE_MISSING);
245                 if ($context) {
246                     $contextname = $context->get_context_name(true);
247                     if (empty($this->download) && $url = $context->get_url()) {
248                         $contextname = html_writer::link($url, $contextname);
249                     }
250                 } else {
251                     $contextname = get_string('other');
252                 }
253             }
254         } else {
255             $contextname = get_string('other');
256         }
258         $this->contextname[$event->contextid] = $contextname;
259         return $contextname;
260     }
262     /**
263      * Generate the component column.
264      *
265      * @param stdClass $event event data.
266      * @return string HTML for the component column
267      */
268     public function col_component($event) {
269         // Component.
270         $componentname = $event->component;
271         if (($event->component === 'core') || ($event->component === 'legacy')) {
272             return  get_string('coresystem');
273         } else if (get_string_manager()->string_exists('pluginname', $event->component)) {
274             return get_string('pluginname', $event->component);
275         } else {
276             return $componentname;
277         }
278     }
280     /**
281      * Generate the event name column.
282      *
283      * @param stdClass $event event data.
284      * @return string HTML for the event name column
285      */
286     public function col_eventname($event) {
287         // Event name.
288         if ($this->filterparams->logreader instanceof logstore_legacy\log\store) {
289             // Hack for support of logstore_legacy.
290             $eventname = $event->eventname;
291         } else {
292             $eventname = $event->get_name();
293         }
294         // Only encode as an action link if we're not downloading.
295         if (($url = $event->get_url()) && empty($this->download)) {
296             $eventname = $this->action_link($url, $eventname, 'action');
297         }
298         return $eventname;
299     }
301     /**
302      * Generate the description column.
303      *
304      * @param stdClass $event event data.
305      * @return string HTML for the description column
306      */
307     public function col_description($event) {
308         // Description.
309         return $event->get_description();
310     }
312     /**
313      * Generate the origin column.
314      *
315      * @param stdClass $event event data.
316      * @return string HTML for the origin column
317      */
318     public function col_origin($event) {
319         // Get extra event data for origin and realuserid.
320         $logextra = $event->get_logextra();
322         // Add event origin, normally IP/cron.
323         return $logextra['origin'];
324     }
326     /**
327      * Generate the ip column.
328      *
329      * @param stdClass $event event data.
330      * @return string HTML for the ip column
331      */
332     public function col_ip($event) {
333         // Get extra event data for origin and realuserid.
334         $logextra = $event->get_logextra();
335         $ip = $logextra['ip'];
337         if (empty($this->download)) {
338             $url = new moodle_url("/iplookup/index.php?ip={$ip}&user={$event->userid}");
339             $ip = $this->action_link($url, $ip, 'ip');
340         }
341         return $ip;
342     }
344     /**
345      * Method to create a link with popup action.
346      *
347      * @param moodle_url $url The url to open.
348      * @param string $text Anchor text for the link.
349      * @param string $name Name of the popup window.
350      *
351      * @return string html to use.
352      */
353     protected function action_link(moodle_url $url, $text, $name = 'popup') {
354         global $OUTPUT;
355         $link = new action_link($url, $text, new popup_action('click', $url, $name, array('height' => 440, 'width' => 700)));
356         return $OUTPUT->render($link);
357     }
359     /**
360      * Helper function to get legacy crud action.
361      *
362      * @param string $crud crud action
363      * @return string legacy action.
364      */
365     public function get_legacy_crud_action($crud) {
366         $legacyactionmap = array('c' => 'add', 'r' => 'view', 'u' => 'update', 'd' => 'delete');
367         if (array_key_exists($crud, $legacyactionmap)) {
368             return $legacyactionmap[$crud];
369         } else {
370             // From old legacy log.
371             return '-view';
372         }
373     }
375     /**
376      * Helper function which is used by build logs to get action sql and param.
377      *
378      * @return array sql and param for action.
379      */
380     public function get_action_sql() {
381         global $DB;
383         // In new logs we have a field to pick, and in legacy try get this from action.
384         if ($this->filterparams->logreader instanceof logstore_legacy\log\store) {
385             $action = $this->get_legacy_crud_action($this->filterparams->action);
386             $firstletter = substr($action, 0, 1);
387             if ($firstletter == '-') {
388                 $sql = $DB->sql_like('action', ':action', false, true, true);
389                 $params['action'] = '%'.substr($action, 1).'%';
390             } else {
391                 $sql = $DB->sql_like('action', ':action', false);
392                 $params['action'] = '%'.$action.'%';
393             }
394         } else if (!empty($this->filterparams->action)) {
395             $sql = "crud = :crud";
396             $params['crud'] = $this->filterparams->action;
397         } else {
398             // Add condition for all possible values of crud (to use db index).
399             list($sql, $params) = $DB->get_in_or_equal(array('c', 'r', 'u', 'd'),
400                     SQL_PARAMS_NAMED, 'crud');
401             $sql = "crud ".$sql;
402         }
403         return array($sql, $params);
404     }
406     /**
407      * Helper function which is used by build logs to get course module sql and param.
408      *
409      * @return array sql and param for action.
410      */
411     public function get_cm_sql() {
412         $joins = array();
413         $params = array();
415         if ($this->filterparams->logreader instanceof logstore_legacy\log\store) {
416             // The legacy store doesn't support context level.
417             $joins[] = "cmid = :cmid";
418             $params['cmid'] = $this->filterparams->modid;
419         } else {
420             $joins[] = "contextinstanceid = :contextinstanceid";
421             $joins[] = "contextlevel = :contextmodule";
422             $params['contextinstanceid'] = $this->filterparams->modid;
423             $params['contextmodule'] = CONTEXT_MODULE;
424         }
426         $sql = implode(' AND ', $joins);
427         return array($sql, $params);
428     }
430     /**
431      * Query the reader. Store results in the object for use by build_table.
432      *
433      * @param int $pagesize size of page for paginated displayed table.
434      * @param bool $useinitialsbar do you want to use the initials bar.
435      */
436     public function query_db($pagesize, $useinitialsbar = true) {
437         global $DB;
439         $joins = array();
440         $params = array();
442         // If we filter by userid and module id we also need to filter by crud and edulevel to ensure DB index is engaged.
443         $useextendeddbindex = !($this->filterparams->logreader instanceof logstore_legacy\log\store)
444                 && !empty($this->filterparams->userid) && !empty($this->filterparams->modid);
446         $groupid = 0;
447         if (!empty($this->filterparams->courseid) && $this->filterparams->courseid != SITEID) {
448             if (!empty($this->filterparams->groupid)) {
449                 $groupid = $this->filterparams->groupid;
450             }
452             $joins[] = "courseid = :courseid";
453             $params['courseid'] = $this->filterparams->courseid;
454         }
456         if (!empty($this->filterparams->siteerrors)) {
457             $joins[] = "( action='error' OR action='infected' OR action='failed' )";
458         }
460         if (!empty($this->filterparams->modid)) {
461             list($actionsql, $actionparams) = $this->get_cm_sql();
462             $joins[] = $actionsql;
463             $params = array_merge($params, $actionparams);
464         }
466         if (!empty($this->filterparams->action) || $useextendeddbindex) {
467             list($actionsql, $actionparams) = $this->get_action_sql();
468             $joins[] = $actionsql;
469             $params = array_merge($params, $actionparams);
470         }
472         // Getting all members of a group.
473         if ($groupid and empty($this->filterparams->userid)) {
474             if ($gusers = groups_get_members($groupid)) {
475                 $gusers = array_keys($gusers);
476                 $joins[] = 'userid IN (' . implode(',', $gusers) . ')';
477             } else {
478                 $joins[] = 'userid = 0'; // No users in groups, so we want something that will always be false.
479             }
480         } else if (!empty($this->filterparams->userid)) {
481             $joins[] = "userid = :userid";
482             $params['userid'] = $this->filterparams->userid;
483         }
485         if (!empty($this->filterparams->date)) {
486             $joins[] = "timecreated > :date AND timecreated < :enddate";
487             $params['date'] = $this->filterparams->date;
488             $params['enddate'] = $this->filterparams->date + DAYSECS; // Show logs only for the selected date.
489         }
491         if (isset($this->filterparams->edulevel) && ($this->filterparams->edulevel >= 0)) {
492             $joins[] = "edulevel = :edulevel";
493             $params['edulevel'] = $this->filterparams->edulevel;
494         } else if ($useextendeddbindex) {
495             list($edulevelsql, $edulevelparams) = $DB->get_in_or_equal(array(\core\event\base::LEVEL_OTHER,
496                 \core\event\base::LEVEL_PARTICIPATING, \core\event\base::LEVEL_TEACHING), SQL_PARAMS_NAMED, 'edulevel');
497             $joins[] = "edulevel ".$edulevelsql;
498             $params = array_merge($params, $edulevelparams);
499         }
501         if (!($this->filterparams->logreader instanceof logstore_legacy\log\store)) {
502             // Filter out anonymous actions, this is N/A for legacy log because it never stores them.
503             $joins[] = "anonymous = 0";
504         }
506         $selector = implode(' AND ', $joins);
508         if (!$this->is_downloading()) {
509             $total = $this->filterparams->logreader->get_events_select_count($selector, $params);
510             $this->pagesize($pagesize, $total);
511         } else {
512             $this->pageable(false);
513         }
515         // Get the users and course data.
516         $this->rawdata = $this->filterparams->logreader->get_events_select_iterator($selector, $params,
517             $this->filterparams->orderby, $this->get_page_start(), $this->get_page_size());
519         // Update list of users which will be displayed on log page.
520         $this->update_users_used();
522         // Get the events. Same query than before; even if it is not likely, logs from new users
523         // may be added since last query so we will need to work around later to prevent problems.
524         // In almost most of the cases this will be better than having two opened recordsets.
525         $this->rawdata = $this->filterparams->logreader->get_events_select_iterator($selector, $params,
526             $this->filterparams->orderby, $this->get_page_start(), $this->get_page_size());
528         // Set initial bars.
529         if ($useinitialsbar && !$this->is_downloading()) {
530             $this->initialbars($total > $pagesize);
531         }
533     }
535     /**
536      * Helper function to create list of course shortname and user fullname shown in log report.
537      *
538      * This will update $this->userfullnames and $this->courseshortnames array with userfullname and courseshortname (with link),
539      * which will be used to render logs in table.
540      *
541      * @deprecated since Moodle 2.9 MDL-48595 - please do not use this function any more.
542      * @todo MDL-49291 This will be deleted in 3.1
543      * @see self::update_users_used()
544      */
545     public function update_users_and_courses_used() {
546         global $SITE, $DB;
548         debugging('update_users_and_courses_used() is deprecated, please use update_users_used() instead.', DEBUG_DEVELOPER);
550         // We should not call self::update_users_used() as would have to iterate twice around the list of logs.
552         $this->userfullnames = array();
553         $this->courseshortnames = array($SITE->id => $SITE->shortname);
554         $userids = array();
555         $courseids = array();
556         // For each event cache full username and course.
557         // Get list of userids and courseids which will be shown in log report.
558         foreach ($this->rawdata as $event) {
559             $logextra = $event->get_logextra();
560             if (!empty($event->userid) && empty($userids[$event->userid])) {
561                 $userids[$event->userid] = $event->userid;
562             }
563             if (!empty($logextra['realuserid']) && empty($userids[$logextra['realuserid']])) {
564                 $userids[$logextra['realuserid']] = $logextra['realuserid'];
565             }
566             if (!empty($event->relateduserid) && empty($userids[$event->relateduserid])) {
567                 $userids[$event->relateduserid] = $event->relateduserid;
568             }
570             if (!empty($event->courseid) && ($event->courseid != $SITE->id) && !in_array($event->courseid, $courseids)) {
571                 $courseids[] = $event->courseid;
572             }
573         }
575         // Closing it just in case, we can not rewind moodle recordsets anyway.
576         if ($this->rawdata instanceof \core\dml\recordset_walk ||
577                 $this->rawdata instanceof moodle_recordset) {
578             $this->rawdata->close();
579         }
581         // Get user fullname and put that in return list.
582         if (!empty($userids)) {
583             list($usql, $uparams) = $DB->get_in_or_equal($userids);
584             $users = $DB->get_records_sql("SELECT id," . get_all_user_name_fields(true) . " FROM {user} WHERE id " . $usql,
585                     $uparams);
586             foreach ($users as $userid => $user) {
587                 $this->userfullnames[$userid] = fullname($user);
588                 unset($userids[$userid]);
589             }
591             // We fill the array with false values for the users that don't exist anymore
592             // in the database so we don't need to query the db again later.
593             foreach ($userids as $userid) {
594                 $this->userfullnames[$userid] = false;
595             }
596         }
598         // Get course shortname and put that in return list.
599         if (!empty($courseids)) { // If all logs don't belog to site level then get course info.
600             list($coursesql, $courseparams) = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED);
601             $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
602             $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
603             $courseparams['contextlevel'] = CONTEXT_COURSE;
604             $sql = "SELECT c.id,c.shortname $ccselect FROM {course} c
605                    $ccjoin
606                      WHERE c.id " . $coursesql;
608             $courses = $DB->get_records_sql($sql, $courseparams);
609             foreach ($courses as $courseid => $course) {
610                 $url = new moodle_url("/course/view.php", array('id' => $courseid));
611                 context_helper::preload_from_record($course);
612                 $context = context_course::instance($courseid, IGNORE_MISSING);
613                 // Method format_string() takes care of missing contexts.
614                 $this->courseshortnames[$courseid] = html_writer::link($url, format_string($course->shortname, true,
615                         array('context' => $context)));
616             }
617         }
618     }
620     /**
621      * Helper function to create list of user fullnames shown in log report.
622      *
623      * This will update $this->userfullnames array with userfullname,
624      * which will be used to render logs in table.
625      *
626      * @since   Moodle 2.9
627      * @return  void
628      */
629     protected function update_users_used() {
630         global $DB;
632         $this->userfullnames = array();
633         $userids = array();
635         // For each event cache full username.
636         // Get list of userids which will be shown in log report.
637         foreach ($this->rawdata as $event) {
638             $logextra = $event->get_logextra();
639             if (!empty($event->userid) && empty($userids[$event->userid])) {
640                 $userids[$event->userid] = $event->userid;
641             }
642             if (!empty($logextra['realuserid']) && empty($userids[$logextra['realuserid']])) {
643                 $userids[$logextra['realuserid']] = $logextra['realuserid'];
644             }
645             if (!empty($event->relateduserid) && empty($userids[$event->relateduserid])) {
646                 $userids[$event->relateduserid] = $event->relateduserid;
647             }
648         }
649         $this->rawdata->close();
651         // Get user fullname and put that in return list.
652         if (!empty($userids)) {
653             list($usql, $uparams) = $DB->get_in_or_equal($userids);
654             $users = $DB->get_records_sql("SELECT id," . get_all_user_name_fields(true) . " FROM {user} WHERE id " . $usql,
655                     $uparams);
656             foreach ($users as $userid => $user) {
657                 $this->userfullnames[$userid] = fullname($user);
658                 unset($userids[$userid]);
659             }
661             // We fill the array with false values for the users that don't exist anymore
662             // in the database so we don't need to query the db again later.
663             foreach ($userids as $userid) {
664                 $this->userfullnames[$userid] = false;
665             }
666         }
667     }