MDL-63657 completion: Coding style fix
[moodle.git] / completion / classes / privacy / provider.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  * Privacy class for requesting user data.
19  *
20  * @package    core_completion
21  * @copyright  2018 Adrian Greeve <adrian@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core_completion\privacy;
27 defined('MOODLE_INTERNAL') || die();
29 use core_privacy\local\metadata\collection;
30 use core_privacy\local\request\approved_userlist;
31 use core_privacy\local\request\contextlist;
32 use core_privacy\local\request\transform;
33 use core_privacy\local\request\userlist;
35 require_once($CFG->dirroot . '/comment/lib.php');
37 /**
38  * Privacy class for requesting user data.
39  *
40  * @package    core_completion
41  * @copyright  2018 Adrian Greeve <adrian@moodle.com>
42  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
43  */
44 class provider implements \core_privacy\local\metadata\provider, \core_privacy\local\request\subsystem\plugin_provider {
46     /**
47      * Returns meta data about this system.
48      *
49      * @param   collection $collection The initialised collection to add items to.
50      * @return  collection A listing of user data stored through this system.
51      */
52     public static function get_metadata(collection $collection) : collection {
53         $collection->add_database_table('course_completions', [
54                 'userid' => 'privacy:metadata:userid',
55                 'course' => 'privacy:metadata:course',
56                 'timeenrolled' => 'privacy:metadata:timeenrolled',
57                 'timestarted' => 'privacy:metadata:timestarted',
58                 'timecompleted' => 'privacy:metadata:timecompleted',
59                 'reaggregate' => 'privacy:metadata:reaggregate'
60             ], 'privacy:metadata:coursesummary');
61         $collection->add_database_table('course_modules_completion', [
62                 'userid' => 'privacy:metadata:userid',
63                 'coursemoduleid' => 'privacy:metadata:coursemoduleid',
64                 'completionstate' => 'privacy:metadata:completionstate',
65                 'viewed' => 'privacy:metadata:viewed',
66                 'overrideby' => 'privacy:metadata:overrideby',
67                 'timemodified' => 'privacy:metadata:timemodified'
68             ], 'privacy:metadata:coursemodulesummary');
69         $collection->add_database_table('course_completion_crit_compl', [
70                 'userid' => 'privacy:metadata:userid',
71                 'course' => 'privacy:metadata:course',
72                 'gradefinal' => 'privacy:metadata:gradefinal',
73                 'unenroled' => 'privacy:metadata:unenroled',
74                 'timecompleted' => 'privacy:metadata:timecompleted'
75             ], 'privacy:metadata:coursecompletedsummary');
76         return $collection;
77     }
79     /**
80      * Get join sql to retrieve courses the user is in.
81      *
82      * @param  int $userid The user ID
83      * @param  string $prefix A unique prefix for these joins.
84      * @param  string $joinfield A field to join these tables to. Joins to course ID.
85      * @return array The join, where, and params for this join.
86      */
87     public static function get_course_completion_join_sql(int $userid, string $prefix, string $joinfield) : array {
88         $cccalias = "{$prefix}_ccc"; // Course completion criteria.
89         $cmcalias = "{$prefix}_cmc"; // Course modules completion.
90         $ccccalias = "{$prefix}_cccc"; // Course completion criteria completion.
92         $join = "JOIN {course_completion_criteria} {$cccalias} ON {$joinfield} = {$cccalias}.course
93              LEFT JOIN {course_modules_completion} {$cmcalias} ON {$cccalias}.moduleinstance = {$cmcalias}.coursemoduleid
94                         AND {$cmcalias}.userid = :{$prefix}_moduleuserid
95              LEFT JOIN {course_completion_crit_compl} {$ccccalias} ON {$ccccalias}.criteriaid = {$cccalias}.id
96                         AND {$ccccalias}.userid = :{$prefix}_courseuserid";
97         $where = "{$cmcalias}.id IS NOT NULL OR {$ccccalias}.id IS NOT NULL";
98         $params = ["{$prefix}_moduleuserid" => $userid, "{$prefix}_courseuserid" => $userid];
100         return [$join, $where, $params];
101     }
103     /**
104      * Find users' course completion by context and add to the provided userlist.
105      *
106      * @param userlist $userlist The userlist to add to.
107      */
108     public static function add_course_completion_users_to_userlist(userlist $userlist) {
109         $params = [
110             'contextid' => $userlist->get_context()->id,
111             'contextcourse' => CONTEXT_COURSE,
112         ];
114         $sql = "SELECT cmc.userid
115                  FROM {context} ctx
116                  JOIN {course} c ON ctx.instanceid = c.id
117                  JOIN {course_completion_criteria} ccc ON ccc.course = c.id
118                  JOIN {course_modules_completion} cmc ON cmc.coursemoduleid = ccc.moduleinstance
119                 WHERE ctx.id = :contextid
120                   AND ctx.contextlevel = :contextcourse";
122         $userlist->add_from_sql('userid', $sql, $params);
124         $sql = "SELECT ccc_compl.userid
125                  FROM {context} ctx
126                  JOIN {course} c ON ctx.instanceid = c.id
127                  JOIN {course_completion_criteria} ccc ON ccc.course = c.id
128                  JOIN {course_completion_crit_compl} ccc_compl ON ccc_compl.criteriaid = ccc.id
129                 WHERE ctx.id = :contextid
130                   AND ctx.contextlevel = :contextcourse";
132         $userlist->add_from_sql('userid', $sql, $params);
133     }
135     /**
136      * Returns activity completion information about a user.
137      *
138      * @param  \stdClass $user The user to return information about.
139      * @param  \stdClass $course The course the user is in.
140      * @param  \stdClass $cm Course module information.
141      * @return \stdClass Activity completion information.
142      */
143     public static function get_activity_completion_info(\stdClass $user, \stdClass $course, $cm) : \stdClass {
144         $completioninfo = new \completion_info($course);
145         $completion = $completioninfo->is_enabled($cm);
146         return ($completion != COMPLETION_TRACKING_NONE) ? $completioninfo->get_data($cm, true, $user->id) : new \stdClass();
147     }
149     /**
150      * Returns course completion information for a user.
151      *
152      * @param  \stdClass $user The user that we are getting completion information for.
153      * @param  \stdClass $course The course we are interested in.
154      * @return \stdClass Course completion information.
155      */
156     public static function get_course_completion_info(\stdClass $user, \stdClass $course) : array {
157         $completioninfo = new \completion_info($course);
158         $completion = $completioninfo->is_enabled();
160         if ($completion == COMPLETION_ENABLED) {
162             $coursecomplete = $completioninfo->is_course_complete($user->id);
163             $criteriacomplete = $completioninfo->count_course_user_data($user->id);
164             $ccompletion = new \completion_completion(['userid' => $user->id, 'course' => $course->id]);
166             $status = ($coursecomplete) ? get_string('complete') : '';
167             $status = (!$criteriacomplete && !$ccompletion->timestarted) ? get_string('notyetstarted', 'completion') :
168                     get_string('inprogress', 'completion');
170             $completions = $completioninfo->get_completions($user->id);
171             $overall = get_string('nocriteriaset', 'completion');
172             if (!empty($completions)) {
173                 if ($completioninfo->get_aggregation_method() == COMPLETION_AGGREGATION_ALL) {
174                     $overall = get_string('criteriarequiredall', 'completion');
175                 } else {
176                     $overall = get_string('criteriarequiredany', 'completion');
177                 }
178             }
180             $coursecompletiondata = [
181                 'status' => $status,
182                 'required' => $overall,
183             ];
185             $coursecompletiondata['criteria'] = array_map(function($completion) use ($completioninfo) {
186                 $criteria = $completion->get_criteria();
187                 $aggregation = $completioninfo->get_aggregation_method($criteria->criteriatype);
188                 $required = ($aggregation == COMPLETION_AGGREGATION_ALL) ? get_string('all', 'completion') :
189                         get_string('any', 'completion');
190                 $data = [
191                     'required' => $required,
192                     'completed' => transform::yesno($completion->is_complete()),
193                     'timecompleted' => isset($completion->timecompleted) ? transform::datetime($completion->timecompleted) : ''
194                 ];
195                 $details = $criteria->get_details($completion);
196                 $data = array_merge($data, $details);
197                 return $data;
198             }, $completions);
199             return $coursecompletiondata;
200         }
201     }
203     /**
204      * Delete completion information for users.
205      *
206      * @param \stdClass $user The user. If provided will delete completion information for just this user. Else all users.
207      * @param int $courseid The course id. Provide this if you want course completion and activity completion deleted.
208      * @param int $cmid The course module id. Provide this if you only want activity completion deleted.
209      */
210     public static function delete_completion(\stdClass $user = null, int $courseid = null, int $cmid = null) {
211         global $DB;
213         if (isset($cmid)) {
214             $params = (isset($user)) ? ['userid' => $user->id, 'coursemoduleid' => $cmid] : ['coursemoduleid' => $cmid];
215             // Only delete the record for course modules completion.
216             $DB->delete_records('course_modules_completion', $params);
217             return;
218         }
220         if (isset($courseid)) {
222             $usersql = isset($user) ? 'AND cmc.userid = :userid' : '';
223             $params = isset($user) ? ['course' => $courseid, 'userid' => $user->id] : ['course' => $courseid];
225             // Find records relating to course modules.
226             $sql = "SELECT cmc.id
227                       FROM {course_completion_criteria} ccc
228                       JOIN {course_modules_completion} cmc ON ccc.moduleinstance = cmc.coursemoduleid
229                      WHERE ccc.course = :course $usersql";
230             $recordids = $DB->get_records_sql($sql, $params);
231             $ids = array_keys($recordids);
232             if (!empty($ids)) {
233                 list($deletesql, $deleteparams) = $DB->get_in_or_equal($ids);
234                 $deletesql = 'id ' . $deletesql;
235                 $DB->delete_records_select('course_modules_completion', $deletesql, $deleteparams);
236             }
237             $DB->delete_records('course_completion_crit_compl', $params);
238             $DB->delete_records('course_completions', $params);
239         }
240     }
242     /**
243      * Delete completion information for users within an approved userlist.
244      *
245      * @param approved_userlist $userlist The approved userlist of users to delete completion information for.
246      * @param int $courseid The course id. Provide this if you want course completion and activity completion deleted.
247      * @param int $cmid The course module id. Provide this if you only want activity completion deleted.
248      */
249     public static function delete_completion_by_approved_userlist(approved_userlist $userlist, int $courseid = null, int $cmid = null) {
250         global $DB;
251         $userids = $userlist->get_userids();
253         if (empty($userids)) {
254             return;
255         }
257         list($useridsql, $params) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
259         if (isset($cmid)) {
260             $params['coursemoduleid'] = $cmid;
262             // Only delete the record for course modules completion.
263             $sql = "coursemoduleid = :coursemoduleid AND userid {$useridsql}";
264             $DB->delete_records_select('course_modules_completion', $sql, $params);
265             return;
266         }
268         if (isset($courseid)) {
269             $params['course'] = $courseid;
271             // Find records relating to course modules.
272             $sql = "SELECT cmc.id
273                       FROM {course_completion_criteria} ccc
274                       JOIN {course_modules_completion} cmc ON ccc.moduleinstance = cmc.coursemoduleid
275                      WHERE ccc.course = :course AND cmc.userid {$useridsql}";
276             $recordids = $DB->get_records_sql($sql, $params);
277             $ids = array_keys($recordids);
278             if (!empty($ids)) {
279                 list($deletesql, $deleteparams) = $DB->get_in_or_equal($ids);
280                 $deletesql = 'id ' . $deletesql;
281                 $DB->delete_records_select('course_modules_completion', $deletesql, $deleteparams);
282             }
284             $sql = "course = :course AND userid {$useridsql}";
285             $DB->delete_records_select('course_completion_crit_compl', $sql, $params);
286             $DB->delete_records_select('course_completions', $sql, $params);
287         }
288     }