1db6814d32865e8b4c7bf510c932cfdf8d7af723
[moodle.git] / mod / forum / report / summary / classes / summary_table.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  * The class for displaying the forum report table.
19  *
20  * @package   forumreport_summary
21  * @copyright 2019 Michael Hawkins <michaelh@moodle.com>
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace forumreport_summary;
26 defined('MOODLE_INTERNAL') || die();
28 require_once($CFG->libdir . '/tablelib.php');
30 use coding_exception;
31 use table_sql;
33 /**
34  * The class for displaying the forum report table.
35  *
36  * @copyright  2019 Michael Hawkins <michaelh@moodle.com>
37  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class summary_table extends table_sql {
41     /** Forum filter type */
42     const FILTER_FORUM = 1;
44     /** Groups filter type */
45     const FILTER_GROUPS = 2;
47     /** Table to store summary data extracted from the log table */
48     const LOG_SUMMARY_TEMP_TABLE = 'forum_report_summary_counts';
50     /** @var \stdClass The various SQL segments that will be combined to form queries to fetch various information. */
51     public $sql;
53     /** @var int The number of rows to be displayed per page. */
54     protected $perpage = 25;
56     /** @var \stdClass The course module object of the forum being reported on. */
57     protected $cm;
59     /**
60      * @var int The user ID if only one user's summary will be generated.
61      * This will apply to users without permission to view others' summaries.
62      */
63     protected $userid;
65     /**
66      * @var \core\log\sql_reader|null
67      */
68     protected $logreader = null;
70     /**
71      * @var \context|null
72      */
73     protected $context = null;
75     /**
76      * Forum report table constructor.
77      *
78      * @param int $courseid The ID of the course the forum(s) exist within.
79      * @param array $filters Report filters in the format 'type' => [values].
80      * @param bool $bulkoperations Is the user allowed to perform bulk operations?
81      */
82     public function __construct(int $courseid, array $filters, bool $bulkoperations) {
83         global $USER, $OUTPUT;
85         $forumid = $filters['forums'][0];
87         parent::__construct("summaryreport_{$courseid}_{$forumid}");
89         $this->cm = get_coursemodule_from_instance('forum', $forumid, $courseid);
90         $this->context = \context_module::instance($this->cm->id);
92         // Only show their own summary unless they have permission to view all.
93         if (!has_capability('forumreport/summary:viewall', $this->context)) {
94             $this->userid = $USER->id;
95         }
97         $columnheaders = [];
99         if ($bulkoperations) {
100             $mastercheckbox = new \core\output\checkbox_toggleall('summaryreport-table', true, [
101                 'id' => 'select-all-users',
102                 'name' => 'select-all-users',
103                 'label' => get_string('selectall'),
104                 'labelclasses' => 'sr-only',
105                 'classes' => 'm-1',
106                 'checked' => false
107             ]);
108             $columnheaders['select'] = $OUTPUT->render($mastercheckbox);
109         }
111         $columnheaders += [
112             'fullname' => get_string('fullnameuser'),
113             'postcount' => get_string('postcount', 'forumreport_summary'),
114             'replycount' => get_string('replycount', 'forumreport_summary'),
115             'attachmentcount' => get_string('attachmentcount', 'forumreport_summary'),
116         ];
118         $this->logreader = $this->get_internal_log_reader();
119         if ($this->logreader) {
120             $columnheaders['viewcount'] = get_string('viewcount', 'forumreport_summary');
121         }
123         $columnheaders['earliestpost'] = get_string('earliestpost', 'forumreport_summary');
124         $columnheaders['latestpost'] = get_string('latestpost', 'forumreport_summary');
126         $this->define_columns(array_keys($columnheaders));
127         $this->define_headers(array_values($columnheaders));
129         // Define configs.
130         $this->define_table_configs();
132         // Define the basic SQL data and object format.
133         $this->define_base_sql();
135         // Apply relevant filters.
136         $this->apply_filters($filters);
137     }
139     /**
140      * Provides the string name of each filter type.
141      *
142      * @param int $filtertype Type of filter
143      * @return string Name of the filter
144      */
145     public function get_filter_name(int $filtertype): string {
146         $filternames = [
147             self::FILTER_FORUM => 'Forum',
148             self::FILTER_GROUPS => 'Groups',
149         ];
151         return $filternames[$filtertype];
152     }
154     /**
155      * Generate the select column.
156      *
157      * @param \stdClass $data
158      * @return string
159      */
160     public function col_select($data) {
161         global $OUTPUT;
163         $checkbox = new \core\output\checkbox_toggleall('summaryreport-table', false, [
164             'classes' => 'usercheckbox m-1',
165             'id' => 'user' . $data->userid,
166             'name' => 'user' . $data->userid,
167             'checked' => false,
168             'label' => get_string('selectitem', 'moodle', fullname($data)),
169             'labelclasses' => 'accesshide',
170         ]);
172         return $OUTPUT->render($checkbox);
173     }
175     /**
176      * Generate the fullname column.
177      *
178      * @param \stdClass $data The row data.
179      * @return string User's full name.
180      */
181     public function col_fullname($data): string {
182         global $OUTPUT;
184         return $OUTPUT->user_picture($data, array('size' => 35, 'courseid' => $this->cm->course, 'includefullname' => true));
185     }
187     /**
188      * Generate the postcount column.
189      *
190      * @param \stdClass $data The row data.
191      * @return int number of discussion posts made by user.
192      */
193     public function col_postcount(\stdClass $data): int {
194         return $data->postcount;
195     }
197     /**
198      * Generate the replycount column.
199      *
200      * @param \stdClass $data The row data.
201      * @return int number of replies made by user.
202      */
203     public function col_replycount(\stdClass $data): int {
204         return $data->replycount;
205     }
207     /**
208      * Generate the attachmentcount column.
209      *
210      * @param \stdClass $data The row data.
211      * @return int number of files attached to posts by user.
212      */
213     public function col_attachmentcount(\stdClass $data): int {
214         return $data->attachmentcount;
215     }
217     /**
218      * Generate the earliestpost column.
219      *
220      * @param \stdClass $data The row data.
221      * @return string Timestamp of user's earliest post, or a dash if no posts exist.
222      */
223     public function col_earliestpost(\stdClass $data): string {
224         global $USER;
226         return empty($data->earliestpost) ? '-' : userdate($data->earliestpost, "", \core_date::get_user_timezone($USER));
227     }
229     /**
230      * Generate the latestpost column.
231      *
232      * @param \stdClass $data The row data.
233      * @return string Timestamp of user's most recent post, or a dash if no posts exist.
234      */
235     public function col_latestpost(\stdClass $data): string {
236         global $USER;
238         return empty($data->latestpost) ? '-' : userdate($data->latestpost, "", \core_date::get_user_timezone($USER));
239     }
241     /**
242      * Override the default implementation to set a decent heading level.
243      *
244      * @return void.
245      */
246     public function print_nothing_to_display(): void {
247         global $OUTPUT;
249         echo $OUTPUT->heading(get_string('nothingtodisplay'), 4);
250     }
252     /**
253      * Query the db. Store results in the table object for use by build_table.
254      *
255      * @param int $pagesize Size of page for paginated displayed table.
256      * @param bool $useinitialsbar Overridden but unused.
257      * @return void
258      */
259     public function query_db($pagesize, $useinitialsbar = false): void {
260         global $DB;
262         // Set up pagination if not downloading the whole report.
263         if (!$this->is_downloading()) {
264             $totalsql = $this->get_full_sql(false);
266             // Set up pagination.
267             $totalrows = $DB->count_records_sql($totalsql, $this->sql->params);
268             $this->pagesize($pagesize, $totalrows);
269         }
271         // Fetch the data.
272         $sql = $this->get_full_sql();
274         // Only paginate when not downloading.
275         if (!$this->is_downloading()) {
276             $this->rawdata = $DB->get_records_sql($sql, $this->sql->params, $this->get_page_start(), $this->get_page_size());
277         } else {
278             $this->rawdata = $DB->get_records_sql($sql, $this->sql->params);
279         }
280     }
282     /**
283      * Adds the relevant SQL to apply a filter to the report.
284      *
285      * @param int $filtertype Filter type as defined by class constants.
286      * @param array $values Optional array of values passed into the filter type.
287      * @return void
288      * @throws coding_exception
289      */
290     public function add_filter(int $filtertype, array $values = []): void {
291         global $DB;
293         $paramcounterror = false;
295         switch($filtertype) {
296             case self::FILTER_FORUM:
297                 // Requires exactly one forum ID.
298                 if (count($values) != 1) {
299                     $paramcounterror = true;
300                 } else {
301                     // No select fields required - displayed in title.
302                     // No extra joins required, forum is already joined.
303                     $this->sql->filterwhere .= ' AND f.id = :forumid';
304                     $this->sql->params['forumid'] = $values[0];
305                 }
307                 break;
309             case self::FILTER_GROUPS:
310                 // Skip adding filter if not applied, or all options are selected.
311                 if ($this->is_filtered_by_groups($values)) {
312                     // Include users without groups if that option (-1) is selected.
313                     $nonekey = array_search(-1, $values, true);
315                     // Users within selected groups or not in any groups are included.
316                     if ($nonekey !== false && count($values) > 1) {
317                         unset($values[$nonekey]);
318                         list($groupidin, $groupidparams) = $DB->get_in_or_equal($values, SQL_PARAMS_NAMED, 'groupid');
320                         // No select fields required.
321                         // No joins required (handled by where to prevent data duplication).
322                         $this->sql->filterwhere .= "
323                             AND (u.id =
324                                 (SELECT gm.userid
325                                    FROM {groups_members} gm
326                                   WHERE gm.userid = u.id
327                                     AND gm.groupid {$groupidin}
328                                GROUP BY gm.userid
329                                   LIMIT 1)
330                             OR
331                                 (SELECT nogm.userid
332                                    FROM mdl_groups_members nogm
333                                   WHERE nogm.userid = u.id
334                                GROUP BY nogm.userid
335                                   LIMIT 1)
336                             IS NULL)";
337                         $this->sql->params += $groupidparams;
339                     } else if ($nonekey !== false) {
340                         // Only users within no groups are included.
341                         unset($values[$nonekey]);
343                         // No select fields required.
344                         $this->sql->filterfromjoins .= " LEFT JOIN {groups_members} nogm ON nogm.userid = u.id";
345                         $this->sql->filterwhere .= " AND nogm.id IS NULL";
347                     } else if (!empty($values)) {
348                         // Only users within selected groups are included.
349                         list($groupidin, $groupidparams) = $DB->get_in_or_equal($values, SQL_PARAMS_NAMED, 'groupid');
351                         // No select fields required.
352                         // No joins required (handled by where to prevent data duplication).
353                         $this->sql->filterwhere .= "
354                             AND u.id = (
355                                  SELECT gm.userid
356                                    FROM {groups_members} gm
357                                   WHERE gm.userid = u.id
358                                     AND gm.groupid {$groupidin}
359                                GROUP BY gm.userid
360                                   LIMIT 1)";
361                         $this->sql->params += $groupidparams;
362                     }
363                 }
365                 break;
367             default:
368                 throw new coding_exception("Report filter type '{$filtertype}' not found.");
369                 break;
370         }
372         if ($paramcounterror) {
373             $filtername = $this->get_filter_name($filtertype);
374             throw new coding_exception("An invalid number of values have been passed for the '{$filtername}' filter.");
375         }
376     }
378     /**
379      * Define various table config options.
380      *
381      * @return void.
382      */
383     protected function define_table_configs(): void {
384         $this->collapsible(false);
385         $this->sortable(true, 'firstname', SORT_ASC);
386         $this->pageable(true);
387         $this->no_sorting('select');
388         $this->set_attribute('id', 'forumreport_summary_table');
389     }
391     /**
392      * Define the object to store all for the table SQL and initialises the base SQL required.
393      *
394      * @return void.
395      */
396     protected function define_base_sql(): void {
397         $this->sql = new \stdClass();
399         $userfields = get_extra_user_fields($this->context);
400         $userfieldssql = \user_picture::fields('u', $userfields);
402         // Define base SQL query format.
403         // Ignores private replies as they are not visible to all participants.
404         $this->sql->basefields = ' ue.userid AS userid,
405                                    e.courseid AS courseid,
406                                    f.id as forumid,
407                                    SUM(CASE WHEN p.parent = 0 THEN 1 ELSE 0 END) AS postcount,
408                                    SUM(CASE WHEN p.parent != 0 THEN 1 ELSE 0 END) AS replycount,
409                                    ' . $userfieldssql . ',
410                                    SUM(CASE WHEN att.attcount IS NULL THEN 0 ELSE att.attcount END) AS attachmentcount,
411                                    MIN(p.created) AS earliestpost,
412                                    MAX(p.created) AS latestpost';
414         $this->sql->basefromjoins = '    {enrol} e
415                                     JOIN {user_enrolments} ue ON ue.enrolid = e.id
416                                     JOIN {user} u ON u.id = ue.userid
417                                     JOIN {forum} f ON f.course = e.courseid
418                                     JOIN {forum_discussions} d ON d.forum = f.id
419                                LEFT JOIN {forum_posts} p ON p.discussion =  d.id
420                                      AND p.userid = ue.userid
421                                      AND p.privatereplyto = 0
422                                LEFT JOIN (
423                                             SELECT COUNT(fi.id) AS attcount, fi.itemid AS postid, fi.userid
424                                               FROM {files} fi
425                                              WHERE fi.component = :component
426                                                AND fi.filesize > 0
427                                           GROUP BY fi.itemid, fi.userid
428                                          ) att ON att.postid = p.id
429                                          AND att.userid = ue.userid';
431         $this->sql->basewhere = 'e.courseid = :courseid';
433         $this->sql->basegroupby = 'ue.userid, e.courseid, f.id, u.id';
435         if ($this->logreader) {
436             $this->fill_log_summary_temp_table($this->context->id);
438             $this->sql->basefields .= ', CASE WHEN tmp.viewcount IS NOT NULL THEN tmp.viewcount ELSE 0 END AS viewcount';
439             $this->sql->basefromjoins .= ' LEFT JOIN {' . self::LOG_SUMMARY_TEMP_TABLE . '} tmp ON tmp.userid = u.id';
440             $this->sql->basegroupby .= ', tmp.viewcount';
441         }
443         $this->sql->params = [
444             'component' => 'mod_forum',
445             'courseid' => $this->cm->course,
446         ];
448         // Handle if a user is limited to viewing their own summary.
449         if (!empty($this->userid)) {
450             $this->sql->basewhere .= ' AND ue.userid = :userid';
451             $this->sql->params['userid'] = $this->userid;
452         }
454         // Filter values will be populated separately where required.
455         $this->sql->filterfields = '';
456         $this->sql->filterfromjoins = '';
457         $this->sql->filterwhere = '';
458         $this->sql->filtergroupby = '';
459     }
461     /**
462      * Overriding the parent method because it should not be used here.
463      * Filters are applied, so the structure of $this->sql is now different to the way this is set up in the parent.
464      *
465      * @param string $fields Unused.
466      * @param string $from Unused.
467      * @param string $where Unused.
468      * @param array $params Unused.
469      * @return void.
470      *
471      * @throws coding_exception
472      */
473     public function set_sql($fields, $from, $where, array $params = []) {
474         throw new coding_exception('The set_sql method should not be used by the summary_table class.');
475     }
477     /**
478      * Convenience method to call a number of methods for you to display the table.
479      * Overrides the parent so SQL for filters is handled.
480      *
481      * @param int $pagesize Number of rows to fetch.
482      * @param bool $useinitialsbar Whether to include the initials bar with the table.
483      * @param string $downloadhelpbutton Unused.
484      *
485      * @return void.
486      */
487     public function out($pagesize, $useinitialsbar, $downloadhelpbutton = ''): void {
488         global $DB;
490         if (!$this->columns) {
491             $sql = $this->get_full_sql();
493             $onerow = $DB->get_record_sql($sql, $this->sql->params, IGNORE_MULTIPLE);
495             // If columns is not set, define columns as the keys of the rows returned from the db.
496             $this->define_columns(array_keys((array)$onerow));
497             $this->define_headers(array_keys((array)$onerow));
498         }
500         $this->setup();
501         $this->query_db($pagesize, $useinitialsbar);
502         $this->build_table();
503         $this->close_recordset();
504         $this->finish_output();
505     }
507     /**
508      * Apply the relevant filters to the report.
509      *
510      * @param array $filters Report filters in the format 'type' => [values].
511      * @return void.
512      */
513     protected function apply_filters(array $filters): void {
514         // Apply the forums filter.
515         $this->add_filter(self::FILTER_FORUM, $filters['forums']);
517         // Apply groups filter.
518         $this->add_filter(self::FILTER_GROUPS, $filters['groups']);
519     }
521     /**
522      * Prepares a complete SQL statement from the base query and any filters defined.
523      *
524      * @param bool $fullselect Whether to select all relevant columns.
525      *              False selects a count only (used to calculate pagination).
526      * @return string The complete SQL statement.
527      */
528     protected function get_full_sql(bool $fullselect = true): string {
529         $selectfields = '';
530         $groupby = '';
531         $orderby = '';
533         if ($fullselect) {
534             $selectfields = "{$this->sql->basefields}
535                              {$this->sql->filterfields}";
537             $groupby = ' GROUP BY ' . $this->sql->basegroupby . $this->sql->filtergroupby;
539             if (($sort = $this->get_sql_sort())) {
540                 $orderby = " ORDER BY {$sort}";
541             }
542         } else {
543             $selectfields = 'COUNT(DISTINCT(ue.userid))';
544         }
546         $sql = "SELECT {$selectfields}
547                   FROM {$this->sql->basefromjoins}
548                        {$this->sql->filterfromjoins}
549                  WHERE {$this->sql->basewhere}
550                        {$this->sql->filterwhere}
551                        {$groupby}
552                        {$orderby}";
554         return $sql;
555     }
557     /**
558      * Returns an internal and enabled log reader.
559      *
560      * @return \core\log\sql_reader|false
561      */
562     protected function get_internal_log_reader(): ?\core\log\sql_reader {
563         global $DB;
565         $readers = get_log_manager()->get_readers('core\log\sql_reader');
566         foreach ($readers as $reader) {
568             // If reader is not a sql_internal_table_reader and not legacy store then return.
569             if (!($reader instanceof \core\log\sql_internal_table_reader) && !($reader instanceof logstore_legacy\log\store)) {
570                 continue;
571             }
572             $logreader = $reader;
573         }
575         if (empty($logreader)) {
576             return null;
577         }
579         return $logreader;
580     }
582     /**
583      * Fills the log summary temp table.
584      *
585      * @param int $contextid
586      * @return null
587      */
588     protected function fill_log_summary_temp_table(int $contextid) {
589         global $DB;
591         $this->create_log_summary_temp_table();
593         if ($this->logreader instanceof logstore_legacy\log\store) {
594             $logtable = 'log';
595             // Anonymous actions are never logged in legacy log.
596             $nonanonymous = '';
597         } else {
598             $logtable = $this->logreader->get_internal_log_table_name();
599             $nonanonymous = 'AND anonymous = 0';
600         }
601         $params = ['contextid' => $contextid];
602         $sql = "INSERT INTO {" . self::LOG_SUMMARY_TEMP_TABLE . "} (userid, viewcount)
603                      SELECT userid, COUNT(*) AS viewcount
604                        FROM {" . $logtable . "}
605                       WHERE contextid = :contextid
606                             $nonanonymous
607                    GROUP BY userid";
608         $DB->execute($sql, $params);
609     }
611     /**
612      * Creates a temp table to store summary data from the log table for this request.
613      *
614      * @return null
615      */
616     protected function create_log_summary_temp_table() {
617         global $DB;
619         $dbman = $DB->get_manager();
620         $temptablename = self::LOG_SUMMARY_TEMP_TABLE;
621         $xmldbtable = new \xmldb_table($temptablename);
622         $xmldbtable->add_field('userid', XMLDB_TYPE_INTEGER, 10, null, XMLDB_NOTNULL, null, null);
623         $xmldbtable->add_field('viewcount', XMLDB_TYPE_INTEGER, 10, null, XMLDB_NOTNULL, null, null);
624         $xmldbtable->add_key('primary', XMLDB_KEY_PRIMARY, array('userid'));
626         $dbman->create_temp_table($xmldbtable);
627     }
629     /**
630      * Check whether the groups filter will be applied by checking whether the number of groups selected
631      * matches the total number of options available (all groups plus no groups option).
632      *
633      * @param array $groups The group IDs selected.
634      * @return bool
635      */
636     protected function is_filtered_by_groups(array $groups): bool {
637         static $groupsavailablecount = null;
639         if (empty($groups)) {
640             return false;
641         }
643         // Find total number of options available (groups plus 'no groups'), if not already fetched.
644         if (is_null($groupsavailablecount)) {
645             $groupsavailablecount = 1 + count(groups_get_activity_allowed_groups($this->cm));
646         }
648         return (count($groups) < $groupsavailablecount);
649     }