MDL-66625 forumreport_summary: Adding behat
[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      * @var bool Whether the user can see all private replies or not.
77      */
78     protected $canseeprivatereplies;
80     /**
81      * Forum report table constructor.
82      *
83      * @param int $courseid The ID of the course the forum(s) exist within.
84      * @param array $filters Report filters in the format 'type' => [values].
85      * @param bool $bulkoperations Is the user allowed to perform bulk operations?
86      * @param bool $canseeprivatereplies Whether the user can see all private replies or not.
87      */
88     public function __construct(int $courseid, array $filters, bool $bulkoperations, bool $canseeprivatereplies) {
89         global $USER, $OUTPUT;
91         $forumid = $filters['forums'][0];
93         parent::__construct("summaryreport_{$courseid}_{$forumid}");
95         $this->cm = get_coursemodule_from_instance('forum', $forumid, $courseid);
96         $this->context = \context_module::instance($this->cm->id);
97         $this->canseeprivatereplies = $canseeprivatereplies;
99         // Only show their own summary unless they have permission to view all.
100         if (!has_capability('forumreport/summary:viewall', $this->context)) {
101             $this->userid = $USER->id;
102         }
104         $columnheaders = [];
106         if ($bulkoperations) {
107             $mastercheckbox = new \core\output\checkbox_toggleall('summaryreport-table', true, [
108                 'id' => 'select-all-users',
109                 'name' => 'select-all-users',
110                 'label' => get_string('selectall'),
111                 'labelclasses' => 'sr-only',
112                 'classes' => 'm-1',
113                 'checked' => false
114             ]);
115             $columnheaders['select'] = $OUTPUT->render($mastercheckbox);
116         }
118         $columnheaders += [
119             'fullname' => get_string('fullnameuser'),
120             'postcount' => get_string('postcount', 'forumreport_summary'),
121             'replycount' => get_string('replycount', 'forumreport_summary'),
122             'attachmentcount' => get_string('attachmentcount', 'forumreport_summary'),
123         ];
125         $this->logreader = $this->get_internal_log_reader();
126         if ($this->logreader) {
127             $columnheaders['viewcount'] = get_string('viewcount', 'forumreport_summary');
128         }
130         $columnheaders['earliestpost'] = get_string('earliestpost', 'forumreport_summary');
131         $columnheaders['latestpost'] = get_string('latestpost', 'forumreport_summary');
133         $this->define_columns(array_keys($columnheaders));
134         $this->define_headers(array_values($columnheaders));
136         // Define configs.
137         $this->define_table_configs();
139         // Define the basic SQL data and object format.
140         $this->define_base_sql();
142         // Apply relevant filters.
143         $this->apply_filters($filters);
144     }
146     /**
147      * Provides the string name of each filter type.
148      *
149      * @param int $filtertype Type of filter
150      * @return string Name of the filter
151      */
152     public function get_filter_name(int $filtertype): string {
153         $filternames = [
154             self::FILTER_FORUM => 'Forum',
155             self::FILTER_GROUPS => 'Groups',
156         ];
158         return $filternames[$filtertype];
159     }
161     /**
162      * Generate the select column.
163      *
164      * @param \stdClass $data
165      * @return string
166      */
167     public function col_select($data) {
168         global $OUTPUT;
170         $checkbox = new \core\output\checkbox_toggleall('summaryreport-table', false, [
171             'classes' => 'usercheckbox m-1',
172             'id' => 'user' . $data->userid,
173             'name' => 'user' . $data->userid,
174             'checked' => false,
175             'label' => get_string('selectitem', 'moodle', fullname($data)),
176             'labelclasses' => 'accesshide',
177         ]);
179         return $OUTPUT->render($checkbox);
180     }
182     /**
183      * Generate the fullname column.
184      *
185      * @param \stdClass $data The row data.
186      * @return string User's full name.
187      */
188     public function col_fullname($data): string {
189         if ($this->is_downloading()) {
190             return fullname($data);
191         }
193         global $OUTPUT;
194         return $OUTPUT->user_picture($data, array('size' => 35, 'courseid' => $this->cm->course, 'includefullname' => true));
195     }
197     /**
198      * Generate the postcount column.
199      *
200      * @param \stdClass $data The row data.
201      * @return int number of discussion posts made by user.
202      */
203     public function col_postcount(\stdClass $data): int {
204         return $data->postcount;
205     }
207     /**
208      * Generate the replycount column.
209      *
210      * @param \stdClass $data The row data.
211      * @return int number of replies made by user.
212      */
213     public function col_replycount(\stdClass $data): int {
214         return $data->replycount;
215     }
217     /**
218      * Generate the attachmentcount column.
219      *
220      * @param \stdClass $data The row data.
221      * @return int number of files attached to posts by user.
222      */
223     public function col_attachmentcount(\stdClass $data): int {
224         return $data->attachmentcount;
225     }
227     /**
228      * Generate the earliestpost column.
229      *
230      * @param \stdClass $data The row data.
231      * @return string Timestamp of user's earliest post, or a dash if no posts exist.
232      */
233     public function col_earliestpost(\stdClass $data): string {
234         global $USER;
236         return empty($data->earliestpost) ? '-' : userdate($data->earliestpost, "", \core_date::get_user_timezone($USER));
237     }
239     /**
240      * Generate the latestpost column.
241      *
242      * @param \stdClass $data The row data.
243      * @return string Timestamp of user's most recent post, or a dash if no posts exist.
244      */
245     public function col_latestpost(\stdClass $data): string {
246         global $USER;
248         return empty($data->latestpost) ? '-' : userdate($data->latestpost, "", \core_date::get_user_timezone($USER));
249     }
251     /**
252      * Override the default implementation to set a decent heading level.
253      *
254      * @return void.
255      */
256     public function print_nothing_to_display(): void {
257         global $OUTPUT;
259         echo $OUTPUT->heading(get_string('nothingtodisplay'), 4);
260     }
262     /**
263      * Query the db. Store results in the table object for use by build_table.
264      *
265      * @param int $pagesize Size of page for paginated displayed table.
266      * @param bool $useinitialsbar Overridden but unused.
267      * @return void
268      */
269     public function query_db($pagesize, $useinitialsbar = false): void {
270         global $DB;
272         // Set up pagination if not downloading the whole report.
273         if (!$this->is_downloading()) {
274             $totalsql = $this->get_full_sql(false);
276             // Set up pagination.
277             $totalrows = $DB->count_records_sql($totalsql, $this->sql->params);
278             $this->pagesize($pagesize, $totalrows);
279         }
281         // Fetch the data.
282         $sql = $this->get_full_sql();
284         // Only paginate when not downloading.
285         if (!$this->is_downloading()) {
286             $this->rawdata = $DB->get_records_sql($sql, $this->sql->params, $this->get_page_start(), $this->get_page_size());
287         } else {
288             $this->rawdata = $DB->get_records_sql($sql, $this->sql->params);
289         }
290     }
292     /**
293      * Adds the relevant SQL to apply a filter to the report.
294      *
295      * @param int $filtertype Filter type as defined by class constants.
296      * @param array $values Optional array of values passed into the filter type.
297      * @return void
298      * @throws coding_exception
299      */
300     public function add_filter(int $filtertype, array $values = []): void {
301         global $DB;
303         $paramcounterror = false;
305         switch($filtertype) {
306             case self::FILTER_FORUM:
307                 // Requires exactly one forum ID.
308                 if (count($values) != 1) {
309                     $paramcounterror = true;
310                 } else {
311                     // No select fields required - displayed in title.
312                     // No extra joins required, forum is already joined.
313                     $this->sql->filterwhere .= ' AND f.id = :forumid';
314                     $this->sql->params['forumid'] = $values[0];
315                 }
317                 break;
319             case self::FILTER_GROUPS:
320                 // Skip adding filter if not applied, or all options are selected.
321                 if ($this->is_filtered_by_groups($values)) {
322                     // Include users without groups if that option (-1) is selected.
323                     $nonekey = array_search(-1, $values, true);
325                     // Users within selected groups or not in any groups are included.
326                     if ($nonekey !== false && count($values) > 1) {
327                         unset($values[$nonekey]);
328                         list($groupidin, $groupidparams) = $DB->get_in_or_equal($values, SQL_PARAMS_NAMED, 'groupid');
330                         // No select fields required.
331                         // No joins required (handled by where to prevent data duplication).
332                         $this->sql->filterwhere .= "
333                             AND (u.id =
334                                 (SELECT gm.userid
335                                    FROM {groups_members} gm
336                                   WHERE gm.userid = u.id
337                                     AND gm.groupid {$groupidin}
338                                GROUP BY gm.userid
339                                   LIMIT 1)
340                             OR
341                                 (SELECT nogm.userid
342                                    FROM mdl_groups_members nogm
343                                   WHERE nogm.userid = u.id
344                                GROUP BY nogm.userid
345                                   LIMIT 1)
346                             IS NULL)";
347                         $this->sql->params += $groupidparams;
349                     } else if ($nonekey !== false) {
350                         // Only users within no groups are included.
351                         unset($values[$nonekey]);
353                         // No select fields required.
354                         $this->sql->filterfromjoins .= " LEFT JOIN {groups_members} nogm ON nogm.userid = u.id";
355                         $this->sql->filterwhere .= " AND nogm.id IS NULL";
357                     } else if (!empty($values)) {
358                         // Only users within selected groups are included.
359                         list($groupidin, $groupidparams) = $DB->get_in_or_equal($values, SQL_PARAMS_NAMED, 'groupid');
361                         // No select fields required.
362                         // No joins required (handled by where to prevent data duplication).
363                         $this->sql->filterwhere .= "
364                             AND u.id = (
365                                  SELECT gm.userid
366                                    FROM {groups_members} gm
367                                   WHERE gm.userid = u.id
368                                     AND gm.groupid {$groupidin}
369                                GROUP BY gm.userid
370                                   LIMIT 1)";
371                         $this->sql->params += $groupidparams;
372                     }
373                 }
375                 break;
377             default:
378                 throw new coding_exception("Report filter type '{$filtertype}' not found.");
379                 break;
380         }
382         if ($paramcounterror) {
383             $filtername = $this->get_filter_name($filtertype);
384             throw new coding_exception("An invalid number of values have been passed for the '{$filtername}' filter.");
385         }
386     }
388     /**
389      * Define various table config options.
390      *
391      * @return void.
392      */
393     protected function define_table_configs(): void {
394         $this->collapsible(false);
395         $this->sortable(true, 'firstname', SORT_ASC);
396         $this->pageable(true);
397         $this->is_downloadable(true);
398         $this->no_sorting('select');
399         $this->set_attribute('id', 'forumreport_summary_table');
400     }
402     /**
403      * Define the object to store all for the table SQL and initialises the base SQL required.
404      *
405      * @return void.
406      */
407     protected function define_base_sql(): void {
408         global $USER;
410         $this->sql = new \stdClass();
412         $userfields = get_extra_user_fields($this->context);
413         $userfieldssql = \user_picture::fields('u', $userfields);
415         // Define base SQL query format.
416         $this->sql->basefields = ' ue.userid AS userid,
417                                    e.courseid AS courseid,
418                                    f.id as forumid,
419                                    SUM(CASE WHEN p.parent = 0 THEN 1 ELSE 0 END) AS postcount,
420                                    SUM(CASE WHEN p.parent != 0 THEN 1 ELSE 0 END) AS replycount,
421                                    ' . $userfieldssql . ',
422                                    SUM(CASE WHEN att.attcount IS NULL THEN 0 ELSE att.attcount END) AS attachmentcount,
423                                    MIN(p.created) AS earliestpost,
424                                    MAX(p.created) AS latestpost';
426         // Handle private replies.
427         $privaterepliessql = '';
428         $privaterepliesparams = [];
429         if (!$this->canseeprivatereplies) {
430             $privaterepliessql = ' AND (p.privatereplyto = :privatereplyto
431                                         OR p.userid = :privatereplyfrom
432                                         OR p.privatereplyto = 0)';
433             $privaterepliesparams['privatereplyto'] = $USER->id;
434             $privaterepliesparams['privatereplyfrom'] = $USER->id;
435         }
437         $this->sql->basefromjoins = '    {enrol} e
438                                     JOIN {user_enrolments} ue ON ue.enrolid = e.id
439                                     JOIN {user} u ON u.id = ue.userid
440                                     JOIN {forum} f ON f.course = e.courseid
441                                     JOIN {forum_discussions} d ON d.forum = f.id
442                                LEFT JOIN {forum_posts} p ON p.discussion =  d.id
443                                      AND p.userid = ue.userid
444                                      ' . $privaterepliessql . '
445                                LEFT JOIN (
446                                             SELECT COUNT(fi.id) AS attcount, fi.itemid AS postid, fi.userid
447                                               FROM {files} fi
448                                              WHERE fi.component = :component
449                                                AND fi.filesize > 0
450                                           GROUP BY fi.itemid, fi.userid
451                                          ) att ON att.postid = p.id
452                                          AND att.userid = ue.userid';
454         $this->sql->basewhere = 'e.courseid = :courseid';
456         $this->sql->basegroupby = 'ue.userid, e.courseid, f.id, u.id, ' . $userfieldssql;
458         if ($this->logreader) {
459             $this->fill_log_summary_temp_table($this->context->id);
461             $this->sql->basefields .= ', CASE WHEN tmp.viewcount IS NOT NULL THEN tmp.viewcount ELSE 0 END AS viewcount';
462             $this->sql->basefromjoins .= ' LEFT JOIN {' . self::LOG_SUMMARY_TEMP_TABLE . '} tmp ON tmp.userid = u.id';
463             $this->sql->basegroupby .= ', tmp.viewcount';
464         }
466         $this->sql->params = [
467             'component' => 'mod_forum',
468             'courseid' => $this->cm->course,
469         ] + $privaterepliesparams;
471         // Handle if a user is limited to viewing their own summary.
472         if (!empty($this->userid)) {
473             $this->sql->basewhere .= ' AND ue.userid = :userid';
474             $this->sql->params['userid'] = $this->userid;
475         }
477         // Filter values will be populated separately where required.
478         $this->sql->filterfields = '';
479         $this->sql->filterfromjoins = '';
480         $this->sql->filterwhere = '';
481         $this->sql->filtergroupby = '';
482     }
484     /**
485      * Overriding the parent method because it should not be used here.
486      * Filters are applied, so the structure of $this->sql is now different to the way this is set up in the parent.
487      *
488      * @param string $fields Unused.
489      * @param string $from Unused.
490      * @param string $where Unused.
491      * @param array $params Unused.
492      * @return void.
493      *
494      * @throws coding_exception
495      */
496     public function set_sql($fields, $from, $where, array $params = []) {
497         throw new coding_exception('The set_sql method should not be used by the summary_table class.');
498     }
500     /**
501      * Convenience method to call a number of methods for you to display the table.
502      * Overrides the parent so SQL for filters is handled.
503      *
504      * @param int $pagesize Number of rows to fetch.
505      * @param bool $useinitialsbar Whether to include the initials bar with the table.
506      * @param string $downloadhelpbutton Unused.
507      *
508      * @return void.
509      */
510     public function out($pagesize, $useinitialsbar, $downloadhelpbutton = ''): void {
511         global $DB;
513         if (!$this->columns) {
514             $sql = $this->get_full_sql();
516             $onerow = $DB->get_record_sql($sql, $this->sql->params, IGNORE_MULTIPLE);
518             // If columns is not set, define columns as the keys of the rows returned from the db.
519             $this->define_columns(array_keys((array)$onerow));
520             $this->define_headers(array_keys((array)$onerow));
521         }
523         $this->setup();
524         $this->query_db($pagesize, $useinitialsbar);
525         $this->build_table();
526         $this->close_recordset();
527         $this->finish_output();
528     }
530     /**
531      * Apply the relevant filters to the report.
532      *
533      * @param array $filters Report filters in the format 'type' => [values].
534      * @return void.
535      */
536     protected function apply_filters(array $filters): void {
537         // Apply the forums filter.
538         $this->add_filter(self::FILTER_FORUM, $filters['forums']);
540         // Apply groups filter.
541         $this->add_filter(self::FILTER_GROUPS, $filters['groups']);
542     }
544     /**
545      * Prepares a complete SQL statement from the base query and any filters defined.
546      *
547      * @param bool $fullselect Whether to select all relevant columns.
548      *              False selects a count only (used to calculate pagination).
549      * @return string The complete SQL statement.
550      */
551     protected function get_full_sql(bool $fullselect = true): string {
552         $groupby = '';
553         $orderby = '';
555         if ($fullselect) {
556             $selectfields = "{$this->sql->basefields}
557                              {$this->sql->filterfields}";
559             $groupby = ' GROUP BY ' . $this->sql->basegroupby . $this->sql->filtergroupby;
561             if (($sort = $this->get_sql_sort())) {
562                 $orderby = " ORDER BY {$sort}";
563             }
564         } else {
565             $selectfields = 'COUNT(DISTINCT(ue.userid))';
566         }
568         $sql = "SELECT {$selectfields}
569                   FROM {$this->sql->basefromjoins}
570                        {$this->sql->filterfromjoins}
571                  WHERE {$this->sql->basewhere}
572                        {$this->sql->filterwhere}
573                        {$groupby}
574                        {$orderby}";
576         return $sql;
577     }
579     /**
580      * Returns an internal and enabled log reader.
581      *
582      * @return \core\log\sql_reader|false
583      */
584     protected function get_internal_log_reader(): ?\core\log\sql_reader {
585         global $DB;
587         $readers = get_log_manager()->get_readers('core\log\sql_reader');
588         foreach ($readers as $reader) {
590             // If reader is not a sql_internal_table_reader and not legacy store then return.
591             if (!($reader instanceof \core\log\sql_internal_table_reader) && !($reader instanceof logstore_legacy\log\store)) {
592                 continue;
593             }
594             $logreader = $reader;
595         }
597         if (empty($logreader)) {
598             return null;
599         }
601         return $logreader;
602     }
604     /**
605      * Fills the log summary temp table.
606      *
607      * @param int $contextid
608      * @return null
609      */
610     protected function fill_log_summary_temp_table(int $contextid) {
611         global $DB;
613         $this->create_log_summary_temp_table();
615         if ($this->logreader instanceof logstore_legacy\log\store) {
616             $logtable = 'log';
617             // Anonymous actions are never logged in legacy log.
618             $nonanonymous = '';
619         } else {
620             $logtable = $this->logreader->get_internal_log_table_name();
621             $nonanonymous = 'AND anonymous = 0';
622         }
623         $params = ['contextid' => $contextid];
624         $sql = "INSERT INTO {" . self::LOG_SUMMARY_TEMP_TABLE . "} (userid, viewcount)
625                      SELECT userid, COUNT(*) AS viewcount
626                        FROM {" . $logtable . "}
627                       WHERE contextid = :contextid
628                             $nonanonymous
629                    GROUP BY userid";
630         $DB->execute($sql, $params);
631     }
633     /**
634      * Creates a temp table to store summary data from the log table for this request.
635      *
636      * @return null
637      */
638     protected function create_log_summary_temp_table() {
639         global $DB;
641         $dbman = $DB->get_manager();
642         $temptablename = self::LOG_SUMMARY_TEMP_TABLE;
643         $xmldbtable = new \xmldb_table($temptablename);
644         $xmldbtable->add_field('userid', XMLDB_TYPE_INTEGER, 10, null, XMLDB_NOTNULL, null, null);
645         $xmldbtable->add_field('viewcount', XMLDB_TYPE_INTEGER, 10, null, XMLDB_NOTNULL, null, null);
646         $xmldbtable->add_key('primary', XMLDB_KEY_PRIMARY, array('userid'));
648         $dbman->create_temp_table($xmldbtable);
649     }
651     /**
652      * Check whether the groups filter will be applied by checking whether the number of groups selected
653      * matches the total number of options available (all groups plus no groups option).
654      *
655      * @param array $groups The group IDs selected.
656      * @return bool
657      */
658     protected function is_filtered_by_groups(array $groups): bool {
659         static $groupsavailablecount = null;
661         if (empty($groups)) {
662             return false;
663         }
665         // Find total number of options available (groups plus 'no groups'), if not already fetched.
666         if (is_null($groupsavailablecount)) {
667             $groupsavailablecount = 1 + count(groups_get_activity_allowed_groups($this->cm));
668         }
670         return (count($groups) < $groupsavailablecount);
671     }
673     /**
674      * Download the summary report in the selected format.
675      *
676      * @param string $format The format to download the report.
677      */
678     public function download($format) {
679         $filename = 'summary_report_' . userdate(time(), get_string('backupnameformat', 'langconfig'),
680                 99, false);
682         $this->is_downloading($format, $filename);
683         $this->out($this->perpage, false);
684     }