c96203790d29c8693fdb632ed297a194e1258805
[moodle.git] / lib / completionlib.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  * Contains classes, functions and constants used during the tracking
19  * of activity completion for users.
20  *
21  * Completion top-level options (admin setting enablecompletion)
22  *
23  * @package core_completion
24  * @category completion
25  * @copyright 1999 onwards Martin Dougiamas   {@link http://moodle.com}
26  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 defined('MOODLE_INTERNAL') || die();
31 /**
32  * Include the required completion libraries
33  */
34 require_once $CFG->dirroot.'/completion/completion_aggregation.php';
35 require_once $CFG->dirroot.'/completion/criteria/completion_criteria.php';
36 require_once $CFG->dirroot.'/completion/completion_completion.php';
37 require_once $CFG->dirroot.'/completion/completion_criteria_completion.php';
40 /**
41  * The completion system is enabled in this site/course
42  */
43 define('COMPLETION_ENABLED', 1);
44 /**
45  * The completion system is not enabled in this site/course
46  */
47 define('COMPLETION_DISABLED', 0);
49 /**
50  * Completion tracking is disabled for this activity
51  * This is a completion tracking option per-activity  (course_modules/completion)
52  */
53 define('COMPLETION_TRACKING_NONE', 0);
55 /**
56  * Manual completion tracking (user ticks box) is enabled for this activity
57  * This is a completion tracking option per-activity  (course_modules/completion)
58  */
59 define('COMPLETION_TRACKING_MANUAL', 1);
60 /**
61  * Automatic completion tracking (system ticks box) is enabled for this activity
62  * This is a completion tracking option per-activity  (course_modules/completion)
63  */
64 define('COMPLETION_TRACKING_AUTOMATIC', 2);
66 /**
67  * The user has not completed this activity.
68  * This is a completion state value (course_modules_completion/completionstate)
69  */
70 define('COMPLETION_INCOMPLETE', 0);
71 /**
72  * The user has completed this activity. It is not specified whether they have
73  * passed or failed it.
74  * This is a completion state value (course_modules_completion/completionstate)
75  */
76 define('COMPLETION_COMPLETE', 1);
77 /**
78  * The user has completed this activity with a grade above the pass mark.
79  * This is a completion state value (course_modules_completion/completionstate)
80  */
81 define('COMPLETION_COMPLETE_PASS', 2);
82 /**
83  * The user has completed this activity but their grade is less than the pass mark
84  * This is a completion state value (course_modules_completion/completionstate)
85  */
86 define('COMPLETION_COMPLETE_FAIL', 3);
88 /**
89  * The effect of this change to completion status is unknown.
90  * A completion effect changes (used only in update_state)
91  */
92 define('COMPLETION_UNKNOWN', -1);
93 /**
94  * The user's grade has changed, so their new state might be
95  * COMPLETION_COMPLETE_PASS or COMPLETION_COMPLETE_FAIL.
96  * A completion effect changes (used only in update_state)
97  */
98 define('COMPLETION_GRADECHANGE', -2);
100 /**
101  * User must view this activity.
102  * Whether view is required to create an activity (course_modules/completionview)
103  */
104 define('COMPLETION_VIEW_REQUIRED', 1);
105 /**
106  * User does not need to view this activity
107  * Whether view is required to create an activity (course_modules/completionview)
108  */
109 define('COMPLETION_VIEW_NOT_REQUIRED', 0);
111 /**
112  * User has viewed this activity.
113  * Completion viewed state (course_modules_completion/viewed)
114  */
115 define('COMPLETION_VIEWED', 1);
116 /**
117  * User has not viewed this activity.
118  * Completion viewed state (course_modules_completion/viewed)
119  */
120 define('COMPLETION_NOT_VIEWED', 0);
122 /**
123  * Cache expiry time in seconds (10 minutes)
124  * Completion cacheing
125  */
126 define('COMPLETION_CACHE_EXPIRY', 10*60);
128 /**
129  * Completion details should be ORed together and you should return false if
130  * none apply.
131  */
132 define('COMPLETION_OR', false);
133 /**
134  * Completion details should be ANDed together and you should return true if
135  * none apply
136  */
137 define('COMPLETION_AND', true);
139 /**
140  * Course completion criteria aggregation method.
141  */
142 define('COMPLETION_AGGREGATION_ALL', 1);
143 /**
144  * Course completion criteria aggregation method.
145  */
146 define('COMPLETION_AGGREGATION_ANY', 2);
149 /**
150  * Class represents completion information for a course.
151  *
152  * Does not contain any data, so you can safely construct it multiple times
153  * without causing any problems.
154  *
155  * @package core
156  * @category completion
157  * @copyright 2008 Sam Marshall
158  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
159  */
160 class completion_info {
162     /* @var stdClass Course object passed during construction */
163     private $course;
165     /* @var int Course id */
166     public $course_id;
168     /* @var array Completion criteria {@link completion_info::get_criteria()}  */
169     private $criteria;
171     /**
172      * Return array of aggregation methods
173      * @return array
174      */
175     public static function get_aggregation_methods() {
176         return array(
177             COMPLETION_AGGREGATION_ALL => get_string('all'),
178             COMPLETION_AGGREGATION_ANY => get_string('any', 'completion'),
179         );
180     }
182     /**
183      * Constructs with course details.
184      *
185      * When instantiating a new completion info object you must provide a course
186      * object with at least id, and enablecompletion properties.
187      *
188      * @param stdClass $course Moodle course object.
189      */
190     public function __construct($course) {
191         $this->course = $course;
192         $this->course_id = $course->id;
193     }
195     /**
196      * Determines whether completion is enabled across entire site.
197      *
198      * @return bool COMPLETION_ENABLED (true) if completion is enabled for the site,
199      *     COMPLETION_DISABLED (false) if it's complete
200      */
201     public static function is_enabled_for_site() {
202         global $CFG;
203         return !empty($CFG->enablecompletion);
204     }
206     /**
207      * Checks whether completion is enabled in a particular course and possibly
208      * activity.
209      *
210      * @param stdClass|cm_info $cm Course-module object. If not specified, returns the course
211      *   completion enable state.
212      * @return mixed COMPLETION_ENABLED or COMPLETION_DISABLED (==0) in the case of
213      *   site and course; COMPLETION_TRACKING_MANUAL, _AUTOMATIC or _NONE (==0)
214      *   for a course-module.
215      */
216     public function is_enabled($cm = null) {
217         global $CFG, $DB;
219         // First check global completion
220         if (!isset($CFG->enablecompletion) || $CFG->enablecompletion == COMPLETION_DISABLED) {
221             return COMPLETION_DISABLED;
222         }
224         // Load data if we do not have enough
225         if (!isset($this->course->enablecompletion)) {
226             $this->course->enablecompletion = $DB->get_field('course', 'enablecompletion', array('id' => $this->course->id));
227         }
229         // Check course completion
230         if ($this->course->enablecompletion == COMPLETION_DISABLED) {
231             return COMPLETION_DISABLED;
232         }
234         // If there was no $cm and we got this far, then it's enabled
235         if (!$cm) {
236             return COMPLETION_ENABLED;
237         }
239         // Return course-module completion value
240         return $cm->completion;
241     }
243     /**
244      * Displays the 'Your progress' help icon, if completion tracking is enabled.
245      * Just prints the result of display_help_icon().
246      *
247      * @deprecated since Moodle 2.0 - Use display_help_icon instead.
248      */
249     public function print_help_icon() {
250         print $this->display_help_icon();
251     }
253     /**
254      * Returns the 'Your progress' help icon, if completion tracking is enabled.
255      *
256      * @return string HTML code for help icon, or blank if not needed
257      */
258     public function display_help_icon() {
259         global $PAGE, $OUTPUT;
260         $result = '';
261         if ($this->is_enabled() && !$PAGE->user_is_editing() && isloggedin() && !isguestuser()) {
262             $result .= '<span id = "completionprogressid" class="completionprogress">'.get_string('yourprogress','completion').' ';
263             $result .= $OUTPUT->help_icon('completionicons', 'completion');
264             $result .= '</span>';
265         }
266         return $result;
267     }
269     /**
270      * Get a course completion for a user
271      *
272      * @param int $user_id User id
273      * @param int $criteriatype Specific criteria type to return
274      * @return bool|completion_criteria_completion returns false on fail
275      */
276     public function get_completion($user_id, $criteriatype) {
277         $completions = $this->get_completions($user_id, $criteriatype);
279         if (empty($completions)) {
280             return false;
281         } elseif (count($completions) > 1) {
282             print_error('multipleselfcompletioncriteria', 'completion');
283         }
285         return $completions[0];
286     }
288     /**
289      * Get all course criteria's completion objects for a user
290      *
291      * @param int $user_id User id
292      * @param int $criteriatype Specific criteria type to return (optional)
293      * @return array
294      */
295     public function get_completions($user_id, $criteriatype = null) {
296         $criterion = $this->get_criteria($criteriatype);
298         $completions = array();
300         foreach ($criterion as $criteria) {
301             $params = array(
302                 'course'        => $this->course_id,
303                 'userid'        => $user_id,
304                 'criteriaid'    => $criteria->id
305             );
307             $completion = new completion_criteria_completion($params);
308             $completion->attach_criteria($criteria);
310             $completions[] = $completion;
311         }
313         return $completions;
314     }
316     /**
317      * Get completion object for a user and a criteria
318      *
319      * @param int $user_id User id
320      * @param completion_criteria $criteria Criteria object
321      * @return completion_criteria_completion
322      */
323     public function get_user_completion($user_id, $criteria) {
324         $params = array(
325             'course'        => $this->course_id,
326             'userid'        => $user_id,
327             'criteriaid'    => $criteria->id,
328         );
330         $completion = new completion_criteria_completion($params);
331         return $completion;
332     }
334     /**
335      * Check if course has completion criteria set
336      *
337      * @return bool Returns true if there are criteria
338      */
339     public function has_criteria() {
340         $criteria = $this->get_criteria();
342         return (bool) count($criteria);
343     }
345     /**
346      * Get course completion criteria
347      *
348      * @param int $criteriatype Specific criteria type to return (optional)
349      */
350     public function get_criteria($criteriatype = null) {
352         // Fill cache if empty
353         if (!is_array($this->criteria)) {
354             global $DB;
356             $params = array(
357                 'course'    => $this->course->id
358             );
360             // Load criteria from database
361             $records = (array)$DB->get_records('course_completion_criteria', $params);
363             // Build array of criteria objects
364             $this->criteria = array();
365             foreach ($records as $record) {
366                 $this->criteria[$record->id] = completion_criteria::factory((array)$record);
367             }
368         }
370         // If after all criteria
371         if ($criteriatype === null) {
372             return $this->criteria;
373         }
375         // If we are only after a specific criteria type
376         $criteria = array();
377         foreach ($this->criteria as $criterion) {
379             if ($criterion->criteriatype != $criteriatype) {
380                 continue;
381             }
383             $criteria[$criterion->id] = $criterion;
384         }
386         return $criteria;
387     }
389     /**
390      * Get aggregation method
391      *
392      * @param int $criteriatype If none supplied, get overall aggregation method (optional)
393      * @return int One of COMPLETION_AGGREGATION_ALL or COMPLETION_AGGREGATION_ANY
394      */
395     public function get_aggregation_method($criteriatype = null) {
396         $params = array(
397             'course'        => $this->course_id,
398             'criteriatype'  => $criteriatype
399         );
401         $aggregation = new completion_aggregation($params);
403         if (!$aggregation->id) {
404             $aggregation->method = COMPLETION_AGGREGATION_ALL;
405         }
407         return $aggregation->method;
408     }
410     /**
411      * Get incomplete course completion criteria
412      *
413      * @return array
414      */
415     public function get_incomplete_criteria() {
416         $incomplete = array();
418         foreach ($this->get_criteria() as $criteria) {
419             if (!$criteria->is_complete()) {
420                 $incomplete[] = $criteria;
421             }
422         }
424         return $incomplete;
425     }
427     /**
428      * Clear old course completion criteria
429      */
430     public function clear_criteria() {
431         global $DB;
432         $DB->delete_records('course_completion_criteria', array('course' => $this->course_id));
433         $DB->delete_records('course_completion_aggr_methd', array('course' => $this->course_id));
435         $this->delete_course_completion_data();
436     }
438     /**
439      * Has the supplied user completed this course
440      *
441      * @param int $user_id User's id
442      * @return boolean
443      */
444     public function is_course_complete($user_id) {
445         $params = array(
446             'userid'    => $user_id,
447             'course'  => $this->course_id
448         );
450         $ccompletion = new completion_completion($params);
451         return $ccompletion->is_complete();
452     }
454     /**
455      * Updates (if necessary) the completion state of activity $cm for the given
456      * user.
457      *
458      * For manual completion, this function is called when completion is toggled
459      * with $possibleresult set to the target state.
460      *
461      * For automatic completion, this function should be called every time a module
462      * does something which might influence a user's completion state. For example,
463      * if a forum provides options for marking itself 'completed' once a user makes
464      * N posts, this function should be called every time a user makes a new post.
465      * [After the post has been saved to the database]. When calling, you do not
466      * need to pass in the new completion state. Instead this function carries out
467      * completion calculation by checking grades and viewed state itself, and
468      * calling the involved module via modulename_get_completion_state() to check
469      * module-specific conditions.
470      *
471      * @param stdClass|cm_info $cm Course-module
472      * @param int $possibleresult Expected completion result. If the event that
473      *   has just occurred (e.g. add post) can only result in making the activity
474      *   complete when it wasn't before, use COMPLETION_COMPLETE. If the event that
475      *   has just occurred (e.g. delete post) can only result in making the activity
476      *   not complete when it was previously complete, use COMPLETION_INCOMPLETE.
477      *   Otherwise use COMPLETION_UNKNOWN. Setting this value to something other than
478      *   COMPLETION_UNKNOWN significantly improves performance because it will abandon
479      *   processing early if the user's completion state already matches the expected
480      *   result. For manual events, COMPLETION_COMPLETE or COMPLETION_INCOMPLETE
481      *   must be used; these directly set the specified state.
482      * @param int $userid User ID to be updated. Default 0 = current user
483      * @return void
484      */
485     public function update_state($cm, $possibleresult=COMPLETION_UNKNOWN, $userid=0) {
486         global $USER, $SESSION;
488         // Do nothing if completion is not enabled for that activity
489         if (!$this->is_enabled($cm)) {
490             return;
491         }
493         // Get current value of completion state and do nothing if it's same as
494         // the possible result of this change. If the change is to COMPLETE and the
495         // current value is one of the COMPLETE_xx subtypes, ignore that as well
496         $current = $this->get_data($cm, false, $userid);
497         if ($possibleresult == $current->completionstate ||
498             ($possibleresult == COMPLETION_COMPLETE &&
499                 ($current->completionstate == COMPLETION_COMPLETE_PASS ||
500                 $current->completionstate == COMPLETION_COMPLETE_FAIL))) {
501             return;
502         }
504         if ($cm->completion == COMPLETION_TRACKING_MANUAL) {
505             // For manual tracking we set the result directly
506             switch($possibleresult) {
507                 case COMPLETION_COMPLETE:
508                 case COMPLETION_INCOMPLETE:
509                     $newstate = $possibleresult;
510                     break;
511                 default:
512                     $this->internal_systemerror("Unexpected manual completion state for {$cm->id}: $possibleresult");
513             }
515         } else {
516             // Automatic tracking; get new state
517             $newstate = $this->internal_get_state($cm, $userid, $current);
518         }
520         // If changed, update
521         if ($newstate != $current->completionstate) {
522             $current->completionstate = $newstate;
523             $current->timemodified    = time();
524             $this->internal_set_data($cm, $current);
525         }
526     }
528     /**
529      * Calculates the completion state for an activity and user.
530      *
531      * Internal function. Not private, so we can unit-test it.
532      *
533      * @param stdClass|cm_info $cm Activity
534      * @param int $userid ID of user
535      * @param stdClass $current Previous completion information from database
536      * @return mixed
537      */
538     public function internal_get_state($cm, $userid, $current) {
539         global $USER, $DB, $CFG;
541         // Get user ID
542         if (!$userid) {
543             $userid = $USER->id;
544         }
546         // Check viewed
547         if ($cm->completionview == COMPLETION_VIEW_REQUIRED &&
548             $current->viewed == COMPLETION_NOT_VIEWED) {
550             return COMPLETION_INCOMPLETE;
551         }
553         // Modname hopefully is provided in $cm but just in case it isn't, let's grab it
554         if (!isset($cm->modname)) {
555             $cm->modname = $DB->get_field('modules', 'name', array('id'=>$cm->module));
556         }
558         $newstate = COMPLETION_COMPLETE;
560         // Check grade
561         if (!is_null($cm->completiongradeitemnumber)) {
562             require_once($CFG->libdir.'/gradelib.php');
563             $item = grade_item::fetch(array('courseid'=>$cm->course, 'itemtype'=>'mod',
564                 'itemmodule'=>$cm->modname, 'iteminstance'=>$cm->instance,
565                 'itemnumber'=>$cm->completiongradeitemnumber));
566             if ($item) {
567                 // Fetch 'grades' (will be one or none)
568                 $grades = grade_grade::fetch_users_grades($item, array($userid), false);
569                 if (empty($grades)) {
570                     // No grade for user
571                     return COMPLETION_INCOMPLETE;
572                 }
573                 if (count($grades) > 1) {
574                     $this->internal_systemerror("Unexpected result: multiple grades for
575                         item '{$item->id}', user '{$userid}'");
576                 }
577                 $newstate = self::internal_get_grade_state($item, reset($grades));
578                 if ($newstate == COMPLETION_INCOMPLETE) {
579                     return COMPLETION_INCOMPLETE;
580                 }
582             } else {
583                 $this->internal_systemerror("Cannot find grade item for '{$cm->modname}'
584                     cm '{$cm->id}' matching number '{$cm->completiongradeitemnumber}'");
585             }
586         }
588         if (plugin_supports('mod', $cm->modname, FEATURE_COMPLETION_HAS_RULES)) {
589             $function = $cm->modname.'_get_completion_state';
590             if (!function_exists($function)) {
591                 $this->internal_systemerror("Module {$cm->modname} claims to support
592                     FEATURE_COMPLETION_HAS_RULES but does not have required
593                     {$cm->modname}_get_completion_state function");
594             }
595             if (!$function($this->course, $cm, $userid, COMPLETION_AND)) {
596                 return COMPLETION_INCOMPLETE;
597             }
598         }
600         return $newstate;
602     }
604     /**
605      * Marks a module as viewed.
606      *
607      * Should be called whenever a module is 'viewed' (it is up to the module how to
608      * determine that). Has no effect if viewing is not set as a completion condition.
609      *
610      * Note that this function must be called before you print the page header because
611      * it is possible that the navigation block may depend on it. If you call it after
612      * printing the header, it shows a developer debug warning.
613      *
614      * @param stdClass|cm_info $cm Activity
615      * @param int $userid User ID or 0 (default) for current user
616      * @return void
617      */
618     public function set_module_viewed($cm, $userid=0) {
619         global $PAGE;
620         if ($PAGE->headerprinted) {
621             debugging('set_module_viewed must be called before header is printed',
622                     DEBUG_DEVELOPER);
623         }
624         // Don't do anything if view condition is not turned on
625         if ($cm->completionview == COMPLETION_VIEW_NOT_REQUIRED || !$this->is_enabled($cm)) {
626             return;
627         }
628         // Get current completion state
629         $data = $this->get_data($cm, $userid);
630         // If we already viewed it, don't do anything
631         if ($data->viewed == COMPLETION_VIEWED) {
632             return;
633         }
634         // OK, change state, save it, and update completion
635         $data->viewed = COMPLETION_VIEWED;
636         $this->internal_set_data($cm, $data);
637         $this->update_state($cm, COMPLETION_COMPLETE, $userid);
638     }
640     /**
641      * Determines how much completion data exists for an activity. This is used when
642      * deciding whether completion information should be 'locked' in the module
643      * editing form.
644      *
645      * @param cm_info $cm Activity
646      * @return int The number of users who have completion data stored for this
647      *   activity, 0 if none
648      */
649     public function count_user_data($cm) {
650         global $DB;
652         return $DB->get_field_sql("
653     SELECT
654         COUNT(1)
655     FROM
656         {course_modules_completion}
657     WHERE
658         coursemoduleid=? AND completionstate<>0", array($cm->id));
659     }
661     /**
662      * Determines how much course completion data exists for a course. This is used when
663      * deciding whether completion information should be 'locked' in the completion
664      * settings form and activity completion settings.
665      *
666      * @param int $user_id Optionally only get course completion data for a single user
667      * @return int The number of users who have completion data stored for this
668      *     course, 0 if none
669      */
670     public function count_course_user_data($user_id = null) {
671         global $DB;
673         $sql = '
674     SELECT
675         COUNT(1)
676     FROM
677         {course_completion_crit_compl}
678     WHERE
679         course = ?
680         ';
682         $params = array($this->course_id);
684         // Limit data to a single user if an ID is supplied
685         if ($user_id) {
686             $sql .= ' AND userid = ?';
687             $params[] = $user_id;
688         }
690         return $DB->get_field_sql($sql, $params);
691     }
693     /**
694      * Check if this course's completion criteria should be locked
695      *
696      * @return boolean
697      */
698     public function is_course_locked() {
699         return (bool) $this->count_course_user_data();
700     }
702     /**
703      * Deletes all course completion completion data.
704      *
705      * Intended to be used when unlocking completion criteria settings.
706      */
707     public function delete_course_completion_data() {
708         global $DB;
710         $DB->delete_records('course_completions', array('course' => $this->course_id));
711         $DB->delete_records('course_completion_crit_compl', array('course' => $this->course_id));
712     }
714     /**
715      * Deletes all activity and course completion data for an entire course
716      * (the below delete_all_state function does this for a single activity).
717      *
718      * Used by course reset page.
719      */
720     public function delete_all_completion_data() {
721         global $DB, $SESSION;
723         // Delete from database.
724         $DB->delete_records_select('course_modules_completion',
725                 'coursemoduleid IN (SELECT id FROM {course_modules} WHERE course=?)',
726                 array($this->course_id));
728         // Reset cache for current user.
729         if (isset($SESSION->completioncache) &&
730             array_key_exists($this->course_id, $SESSION->completioncache)) {
732             unset($SESSION->completioncache[$this->course_id]);
733         }
735         // Wipe course completion data too.
736         $this->delete_course_completion_data();
737     }
739     /**
740      * Deletes completion state related to an activity for all users.
741      *
742      * Intended for use only when the activity itself is deleted.
743      *
744      * @param stdClass|cm_info $cm Activity
745      */
746     public function delete_all_state($cm) {
747         global $SESSION, $DB;
749         // Delete from database
750         $DB->delete_records('course_modules_completion', array('coursemoduleid'=>$cm->id));
752         // Erase cache data for current user if applicable
753         if (isset($SESSION->completioncache) &&
754             array_key_exists($cm->course, $SESSION->completioncache) &&
755             array_key_exists($cm->id, $SESSION->completioncache[$cm->course])) {
757             unset($SESSION->completioncache[$cm->course][$cm->id]);
758         }
760         // Check if there is an associated course completion criteria
761         $criteria = $this->get_criteria(COMPLETION_CRITERIA_TYPE_ACTIVITY);
762         $acriteria = false;
763         foreach ($criteria as $criterion) {
764             if ($criterion->moduleinstance == $cm->id) {
765                 $acriteria = $criterion;
766                 break;
767             }
768         }
770         if ($acriteria) {
771             // Delete all criteria completions relating to this activity
772             $DB->delete_records('course_completion_crit_compl', array('course' => $this->course_id, 'criteriaid' => $acriteria->id));
773             $DB->delete_records('course_completions', array('course' => $this->course_id));
774         }
775     }
777     /**
778      * Recalculates completion state related to an activity for all users.
779      *
780      * Intended for use if completion conditions change. (This should be avoided
781      * as it may cause some things to become incomplete when they were previously
782      * complete, with the effect - for example - of hiding a later activity that
783      * was previously available.)
784      *
785      * Resetting state of manual tickbox has same result as deleting state for
786      * it.
787      *
788      * @param stcClass|cm_info $cm Activity
789      */
790     public function reset_all_state($cm) {
791         global $DB;
793         if ($cm->completion == COMPLETION_TRACKING_MANUAL) {
794             $this->delete_all_state($cm);
795             return;
796         }
797         // Get current list of users with completion state
798         $rs = $DB->get_recordset('course_modules_completion', array('coursemoduleid'=>$cm->id), '', 'userid');
799         $keepusers = array();
800         foreach ($rs as $rec) {
801             $keepusers[] = $rec->userid;
802         }
803         $rs->close();
805         // Delete all existing state [also clears session cache for current user]
806         $this->delete_all_state($cm);
808         // Merge this with list of planned users (according to roles)
809         $trackedusers = $this->get_tracked_users();
810         foreach ($trackedusers as $trackeduser) {
811             $keepusers[] = $trackeduser->id;
812         }
813         $keepusers = array_unique($keepusers);
815         // Recalculate state for each kept user
816         foreach ($keepusers as $keepuser) {
817             $this->update_state($cm, COMPLETION_UNKNOWN, $keepuser);
818         }
819     }
821     /**
822      * Obtains completion data for a particular activity and user (from the
823      * session cache if available, or by SQL query)
824      *
825      * @param stcClass|cm_info $cm Activity; only required field is ->id
826      * @param bool $wholecourse If true (default false) then, when necessary to
827      *   fill the cache, retrieves information from the entire course not just for
828      *   this one activity
829      * @param int $userid User ID or 0 (default) for current user
830      * @param array $modinfo Supply the value here - this is used for unit
831      *   testing and so that it can be called recursively from within
832      *   get_fast_modinfo. (Needs only list of all CMs with IDs.)
833      *   Otherwise the method calls get_fast_modinfo itself.
834      * @return object Completion data (record from course_modules_completion)
835      */
836     public function get_data($cm, $wholecourse = false, $userid = 0, $modinfo = null) {
837         global $USER, $CFG, $SESSION, $DB;
839         // Get user ID
840         if (!$userid) {
841             $userid = $USER->id;
842         }
844         // Is this the current user?
845         $currentuser = $userid==$USER->id;
847         if ($currentuser && is_object($SESSION)) {
848             // Make sure cache is present and is for current user (loginas
849             // changes this)
850             if (!isset($SESSION->completioncache) || $SESSION->completioncacheuserid!=$USER->id) {
851                 $SESSION->completioncache = array();
852                 $SESSION->completioncacheuserid = $USER->id;
853             }
854             // Expire any old data from cache
855             foreach ($SESSION->completioncache as $courseid=>$activities) {
856                 if (empty($activities['updated']) || $activities['updated'] < time()-COMPLETION_CACHE_EXPIRY) {
857                     unset($SESSION->completioncache[$courseid]);
858                 }
859             }
860             // See if requested data is present, if so use cache to get it
861             if (isset($SESSION->completioncache) &&
862                 array_key_exists($this->course->id, $SESSION->completioncache) &&
863                 array_key_exists($cm->id, $SESSION->completioncache[$this->course->id])) {
864                 return $SESSION->completioncache[$this->course->id][$cm->id];
865             }
866         }
868         // Not there, get via SQL
869         if ($currentuser && $wholecourse) {
870             // Get whole course data for cache
871             $alldatabycmc = $DB->get_records_sql("
872     SELECT
873         cmc.*
874     FROM
875         {course_modules} cm
876         INNER JOIN {course_modules_completion} cmc ON cmc.coursemoduleid=cm.id
877     WHERE
878         cm.course=? AND cmc.userid=?", array($this->course->id, $userid));
880             // Reindex by cm id
881             $alldata = array();
882             if ($alldatabycmc) {
883                 foreach ($alldatabycmc as $data) {
884                     $alldata[$data->coursemoduleid] = $data;
885                 }
886             }
888             // Get the module info and build up condition info for each one
889             if (empty($modinfo)) {
890                 $modinfo = get_fast_modinfo($this->course, $userid);
891             }
892             foreach ($modinfo->cms as $othercm) {
893                 if (array_key_exists($othercm->id, $alldata)) {
894                     $data = $alldata[$othercm->id];
895                 } else {
896                     // Row not present counts as 'not complete'
897                     $data = new StdClass;
898                     $data->id              = 0;
899                     $data->coursemoduleid  = $othercm->id;
900                     $data->userid          = $userid;
901                     $data->completionstate = 0;
902                     $data->viewed          = 0;
903                     $data->timemodified    = 0;
904                 }
905                 $SESSION->completioncache[$this->course->id][$othercm->id] = $data;
906             }
907             $SESSION->completioncache[$this->course->id]['updated'] = time();
909             if (!isset($SESSION->completioncache[$this->course->id][$cm->id])) {
910                 $this->internal_systemerror("Unexpected error: course-module {$cm->id} could not be found on course {$this->course->id}");
911             }
912             return $SESSION->completioncache[$this->course->id][$cm->id];
914         } else {
915             // Get single record
916             $data = $DB->get_record('course_modules_completion', array('coursemoduleid'=>$cm->id, 'userid'=>$userid));
917             if ($data == false) {
918                 // Row not present counts as 'not complete'
919                 $data = new StdClass;
920                 $data->id              = 0;
921                 $data->coursemoduleid  = $cm->id;
922                 $data->userid          = $userid;
923                 $data->completionstate = 0;
924                 $data->viewed          = 0;
925                 $data->timemodified    = 0;
926             }
928             // Put in cache
929             if ($currentuser) {
930                 $SESSION->completioncache[$this->course->id][$cm->id] = $data;
931                 // For single updates, only set date if it was empty before
932                 if (empty($SESSION->completioncache[$this->course->id]['updated'])) {
933                     $SESSION->completioncache[$this->course->id]['updated'] = time();
934                 }
935             }
936         }
938         return $data;
939     }
941     /**
942      * Updates completion data for a particular coursemodule and user (user is
943      * determined from $data).
944      *
945      * (Internal function. Not private, so we can unit-test it.)
946      *
947      * @param stdClass|cm_info $cm Activity
948      * @param stdClass $data Data about completion for that user
949      */
950     public function internal_set_data($cm, $data) {
951         global $USER, $SESSION, $DB;
953         $transaction = $DB->start_delegated_transaction();
954         if (!$data->id) {
955             // Check there isn't really a row
956             $data->id = $DB->get_field('course_modules_completion', 'id',
957                     array('coursemoduleid'=>$data->coursemoduleid, 'userid'=>$data->userid));
958         }
959         if (!$data->id) {
960             // Didn't exist before, needs creating
961             $data->id = $DB->insert_record('course_modules_completion', $data);
962         } else {
963             // Has real (nonzero) id meaning that a database row exists, update
964             $DB->update_record('course_modules_completion', $data);
965         }
966         $transaction->allow_commit();
968         if ($data->userid == $USER->id) {
969             $SESSION->completioncache[$cm->course][$cm->id] = $data;
970             $reset = 'reset';
971             get_fast_modinfo($reset);
972         }
973     }
975     /**
976      * Obtains a list of activities for which completion is enabled on the
977      * course. The list is ordered by the section order of those activities.
978      *
979      * @param array $modinfo For unit testing only, supply the value
980      *   here. Otherwise the method calls get_fast_modinfo
981      * @return array Array from $cmid => $cm of all activities with completion enabled,
982      *   empty array if none
983      */
984     public function get_activities($modinfo=null) {
985         global $DB;
987         // Obtain those activities which have completion turned on
988         $withcompletion = $DB->get_records_select('course_modules', 'course='.$this->course->id.
989           ' AND completion<>'.COMPLETION_TRACKING_NONE);
990         if (!$withcompletion) {
991             return array();
992         }
994         // Use modinfo to get section order and also add in names
995         if (empty($modinfo)) {
996             $modinfo = get_fast_modinfo($this->course);
997         }
998         $result = array();
999         foreach ($modinfo->sections as $sectioncms) {
1000             foreach ($sectioncms as $cmid) {
1001                 if (array_key_exists($cmid, $withcompletion)) {
1002                     $result[$cmid] = $withcompletion[$cmid];
1003                     $result[$cmid]->modname = $modinfo->cms[$cmid]->modname;
1004                     $result[$cmid]->name    = $modinfo->cms[$cmid]->name;
1005                 }
1006             }
1007         }
1009         return $result;
1010     }
1012     /**
1013      * Checks to see if the userid supplied has a tracked role in
1014      * this course
1015      *
1016      * @param int $userid User id
1017      * @return bool
1018      */
1019     public function is_tracked_user($userid) {
1020         return is_enrolled(context_course::instance($this->course->id), $userid, '', true);
1021     }
1023     /**
1024      * Returns the number of users whose progress is tracked in this course.
1025      *
1026      * Optionally supply a search's where clause, or a group id.
1027      *
1028      * @param string $where Where clause sql (use 'u.whatever' for user table fields)
1029      * @param array $whereparams Where clause params
1030      * @param int $groupid Group id
1031      * @return int Number of tracked users
1032      */
1033     public function get_num_tracked_users($where = '', $whereparams = array(), $groupid = 0) {
1034         global $DB;
1036         list($enrolledsql, $enrolledparams) = get_enrolled_sql(
1037                 context_course::instance($this->course->id), '', $groupid, true);
1038         $sql  = 'SELECT COUNT(eu.id) FROM (' . $enrolledsql . ') eu JOIN {user} u ON u.id = eu.id';
1039         if ($where) {
1040             $sql .= " WHERE $where";
1041         }
1043         $params = array_merge($enrolledparams, $whereparams);
1044         return $DB->count_records_sql($sql, $params);
1045     }
1047     /**
1048      * Return array of users whose progress is tracked in this course.
1049      *
1050      * Optionally supply a search's where clause, group id, sorting, paging.
1051      *
1052      * @param string $where Where clause sql, referring to 'u.' fields (optional)
1053      * @param array $whereparams Where clause params (optional)
1054      * @param int $groupid Group ID to restrict to (optional)
1055      * @param string $sort Order by clause (optional)
1056      * @param int $limitfrom Result start (optional)
1057      * @param int $limitnum Result max size (optional)
1058      * @param context $extracontext If set, includes extra user information fields
1059      *   as appropriate to display for current user in this context
1060      * @return array Array of user objects with standard user fields
1061      */
1062     public function get_tracked_users($where = '', $whereparams = array(), $groupid = 0,
1063              $sort = '', $limitfrom = '', $limitnum = '', context $extracontext = null) {
1065         global $DB;
1067         list($enrolledsql, $params) = get_enrolled_sql(
1068                 context_course::instance($this->course->id), '', $groupid, true);
1070         $sql = 'SELECT u.id, u.firstname, u.lastname, u.idnumber';
1071         if ($extracontext) {
1072             $sql .= get_extra_user_fields_sql($extracontext, 'u', '', array('idnumber'));
1073         }
1074         $sql .= ' FROM (' . $enrolledsql . ') eu JOIN {user} u ON u.id = eu.id';
1076         if ($where) {
1077             $sql .= " AND $where";
1078             $params = array_merge($params, $whereparams);
1079         }
1081         if ($sort) {
1082             $sql .= " ORDER BY $sort";
1083         }
1085         return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
1086     }
1088     /**
1089      * Obtains progress information across a course for all users on that course, or
1090      * for all users in a specific group. Intended for use when displaying progress.
1091      *
1092      * This includes only users who, in course context, have one of the roles for
1093      * which progress is tracked (the gradebookroles admin option) and are enrolled in course.
1094      *
1095      * Users are included (in the first array) even if they do not have
1096      * completion progress for any course-module.
1097      *
1098      * @param bool $sortfirstname If true, sort by first name, otherwise sort by
1099      *   last name
1100      * @param string $where Where clause sql (optional)
1101      * @param array $where_params Where clause params (optional)
1102      * @param int $groupid Group ID or 0 (default)/false for all groups
1103      * @param int $pagesize Number of users to actually return (optional)
1104      * @param int $start User to start at if paging (optional)
1105      * @param context $extracontext If set, includes extra user information fields
1106      *   as appropriate to display for current user in this context
1107      * @return stdClass with ->total and ->start (same as $start) and ->users;
1108      *   an array of user objects (like mdl_user id, firstname, lastname)
1109      *   containing an additional ->progress array of coursemoduleid => completionstate
1110      */
1111     public function get_progress_all($where = '', $where_params = array(), $groupid = 0,
1112             $sort = '', $pagesize = '', $start = '', context $extracontext = null) {
1113         global $CFG, $DB;
1115         // Get list of applicable users
1116         $users = $this->get_tracked_users($where, $where_params, $groupid, $sort,
1117                 $start, $pagesize, $extracontext);
1119         // Get progress information for these users in groups of 1, 000 (if needed)
1120         // to avoid making the SQL IN too long
1121         $results = array();
1122         $userids = array();
1123         foreach ($users as $user) {
1124             $userids[] = $user->id;
1125             $results[$user->id] = $user;
1126             $results[$user->id]->progress = array();
1127         }
1129         for($i=0; $i<count($userids); $i+=1000) {
1130             $blocksize = count($userids)-$i < 1000 ? count($userids)-$i : 1000;
1132             list($insql, $params) = $DB->get_in_or_equal(array_slice($userids, $i, $blocksize));
1133             array_splice($params, 0, 0, array($this->course->id));
1134             $rs = $DB->get_recordset_sql("
1135                 SELECT
1136                     cmc.*
1137                 FROM
1138                     {course_modules} cm
1139                     INNER JOIN {course_modules_completion} cmc ON cm.id=cmc.coursemoduleid
1140                 WHERE
1141                     cm.course=? AND cmc.userid $insql", $params);
1142             foreach ($rs as $progress) {
1143                 $progress = (object)$progress;
1144                 $results[$progress->userid]->progress[$progress->coursemoduleid] = $progress;
1145             }
1146             $rs->close();
1147         }
1149         return $results;
1150     }
1152     /**
1153      * Called by grade code to inform the completion system when a grade has
1154      * been changed. If the changed grade is used to determine completion for
1155      * the course-module, then the completion status will be updated.
1156      *
1157      * @param stdClass|cm_info $cm Course-module for item that owns grade
1158      * @param grade_item $item Grade item
1159      * @param stdClass $grade
1160      * @param bool $deleted
1161      */
1162     public function inform_grade_changed($cm, $item, $grade, $deleted) {
1163         // Bail out now if completion is not enabled for course-module, it is enabled
1164         // but is set to manual, grade is not used to compute completion, or this
1165         // is a different numbered grade
1166         if (!$this->is_enabled($cm) ||
1167             $cm->completion == COMPLETION_TRACKING_MANUAL ||
1168             is_null($cm->completiongradeitemnumber) ||
1169             $item->itemnumber != $cm->completiongradeitemnumber) {
1170             return;
1171         }
1173         // What is the expected result based on this grade?
1174         if ($deleted) {
1175             // Grade being deleted, so only change could be to make it incomplete
1176             $possibleresult = COMPLETION_INCOMPLETE;
1177         } else {
1178             $possibleresult = self::internal_get_grade_state($item, $grade);
1179         }
1181         // OK, let's update state based on this
1182         $this->update_state($cm, $possibleresult, $grade->userid);
1183     }
1185     /**
1186      * Calculates the completion state that would result from a graded item
1187      * (where grade-based completion is turned on) based on the actual grade
1188      * and settings.
1189      *
1190      * Internal function. Not private, so we can unit-test it.
1191      *
1192      * @param grade_item $item an instance of grade_item
1193      * @param grade_grade $grade an instance of grade_grade
1194      * @return int Completion state e.g. COMPLETION_INCOMPLETE
1195      */
1196     public static function internal_get_grade_state($item, $grade) {
1197         if (!$grade) {
1198             return COMPLETION_INCOMPLETE;
1199         }
1200         // Conditions to show pass/fail:
1201         // a) Grade has pass mark (default is 0.00000 which is boolean true so be careful)
1202         // b) Grade is visible (neither hidden nor hidden-until)
1203         if ($item->gradepass && $item->gradepass > 0.000009 && !$item->hidden) {
1204             // Use final grade if set otherwise raw grade
1205             $score = !is_null($grade->finalgrade) ? $grade->finalgrade : $grade->rawgrade;
1207             // We are displaying and tracking pass/fail
1208             if ($score >= $item->gradepass) {
1209                 return COMPLETION_COMPLETE_PASS;
1210             } else {
1211                 return COMPLETION_COMPLETE_FAIL;
1212             }
1213         } else {
1214             // Not displaying pass/fail, so just if there is a grade
1215             if (!is_null($grade->finalgrade) || !is_null($grade->rawgrade)) {
1216                 // Grade exists, so maybe complete now
1217                 return COMPLETION_COMPLETE;
1218             } else {
1219                 // Grade does not exist, so maybe incomplete now
1220                 return COMPLETION_INCOMPLETE;
1221             }
1222         }
1223     }
1225     /**
1226      * Aggregate activity completion state
1227      *
1228      * @param   int     $type   Aggregation type (COMPLETION_* constant)
1229      * @param   bool    $old    Old state
1230      * @param   bool    $new    New state
1231      * @return  bool
1232      */
1233     public static function aggregate_completion_states($type, $old, $new) {
1234         if ($type == COMPLETION_AND) {
1235             return $old && $new;
1236         } else {
1237             return $old || $new;
1238         }
1239     }
1241     /**
1242      * This is to be used only for system errors (things that shouldn't happen)
1243      * and not user-level errors.
1244      *
1245      * @global type $CFG
1246      * @param string $error Error string (will not be displayed to user unless debugging is enabled)
1247      * @throws moodle_exception Exception with the error string as debug info
1248      */
1249     public function internal_systemerror($error) {
1250         global $CFG;
1251         throw new moodle_exception('err_system','completion',
1252             $CFG->wwwroot.'/course/view.php?id='.$this->course->id,null,$error);
1253     }
1255     /**
1256      * For testing only. Wipes information cached in user session.
1257      */
1258     public static function wipe_session_cache() {
1259         global $SESSION;
1260         unset($SESSION->completioncache);
1261         unset($SESSION->completioncacheuserid);
1262     }