MDL-27757 lib/completionlib.php: Load "enablecompletion" property if required
[moodle.git] / lib / completionlib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Contains a class used for tracking whether activities have been completed
20  * by students ('completion')
21  *
22  * Completion top-level options (admin setting enablecompletion)
23  *
24  * @package    core
25  * @subpackage completion
26  * @copyright  1999 onwards Martin Dougiamas   {@link http://moodle.com}
27  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28  */
30 defined('MOODLE_INTERNAL') || die();
32 require_once $CFG->libdir.'/completion/completion_aggregation.php';
33 require_once $CFG->libdir.'/completion/completion_criteria.php';
34 require_once $CFG->libdir.'/completion/completion_completion.php';
35 require_once $CFG->libdir.'/completion/completion_criteria_completion.php';
38 /** The completion system is enabled in this site/course */
39 define('COMPLETION_ENABLED', 1);
40 /** The completion system is not enabled in this site/course */
41 define('COMPLETION_DISABLED', 0);
43 // Completion tracking options per-activity (course_modules/completion)
45 /** Completion tracking is disabled for this activity */
46 define('COMPLETION_TRACKING_NONE', 0);
47 /** Manual completion tracking (user ticks box) is enabled for this activity */
48 define('COMPLETION_TRACKING_MANUAL', 1);
49 /** Automatic completion tracking (system ticks box) is enabled for this activity */
50 define('COMPLETION_TRACKING_AUTOMATIC', 2);
52 // Completion state values (course_modules_completion/completionstate)
54 /** The user has not completed this activity. */
55 define('COMPLETION_INCOMPLETE', 0);
56 /** The user has completed this activity. It is not specified whether they have
57  * passed or failed it. */
58 define('COMPLETION_COMPLETE', 1);
59 /** The user has completed this activity with a grade above the pass mark. */
60 define('COMPLETION_COMPLETE_PASS', 2);
61 /** The user has completed this activity but their grade is less than the pass mark */
62 define('COMPLETION_COMPLETE_FAIL', 3);
64 // Completion effect changes (used only in update_state)
66 /** The effect of this change to completion status is unknown. */
67 define('COMPLETION_UNKNOWN', -1);
68 /** The user's grade has changed, so their new state might be
69  * COMPLETION_COMPLETE_PASS or COMPLETION_COMPLETE_FAIL. */
70 // TODO Is this useful?
71 define('COMPLETION_GRADECHANGE', -2);
73 // Whether view is required to create an activity (course_modules/completionview)
75 /** User must view this activity */
76 define('COMPLETION_VIEW_REQUIRED', 1);
77 /** User does not need to view this activity */
78 define('COMPLETION_VIEW_NOT_REQUIRED', 0);
80 // Completion viewed state (course_modules_completion/viewed)
82 /** User has viewed this activity */
83 define('COMPLETION_VIEWED', 1);
84 /** User has not viewed this activity */
85 define('COMPLETION_NOT_VIEWED', 0);
87 // Completion cacheing
89 /** Cache expiry time in seconds (10 minutes) */
90 define('COMPLETION_CACHE_EXPIRY', 10*60);
92 // Combining completion condition. This is also the value you should return
93 // if you don't have any applicable conditions. Used for activity completion.
94 /** Completion details should be ORed together and you should return false if
95  none apply */
96 define('COMPLETION_OR', false);
97 /** Completion details should be ANDed together and you should return true if
98  none apply */
99 define('COMPLETION_AND', true);
101 // Course completion criteria aggregation methods
102 define('COMPLETION_AGGREGATION_ALL',        1);
103 define('COMPLETION_AGGREGATION_ANY',        2);
106 /**
107  * Class represents completion information for a course.
108  *
109  * Does not contain any data, so you can safely construct it multiple times
110  * without causing any problems.
111  *
112  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
113  * @package moodlecore
114  */
115 class completion_info {
116     /**
117      * Course object passed during construction
118      * @access  private
119      * @var     object
120      */
121     private $course;
123     /**
124      * Course id
125      * @access  public
126      * @var     int
127      */
128     public $course_id;
130     /**
131      * Completion criteria
132      * @access  private
133      * @var     array
134      * @see     completion_info->get_criteria()
135      */
136     private $criteria;
138     /**
139      * Return array of aggregation methods
140      * @access  public
141      * @return  array
142      */
143     public static function get_aggregation_methods() {
144         return array(
145             COMPLETION_AGGREGATION_ALL       => get_string('all'),
146             COMPLETION_AGGREGATION_ANY       => get_string('any', 'completion'),
147         );
148     }
150     /**
151      * Constructs with course details.
152      *
153      * @param object $course Moodle course object. Must have at least ->id, ->enablecompletion
154      */
155     public function __construct($course) {
156         $this->course = $course;
157         $this->course_id = $course->id;
158     }
160     /**
161      * Determines whether completion is enabled across entire site.
162      *
163      * Static function.
164      *
165      * @global object
166      * @return int COMPLETION_ENABLED (true) if completion is enabled for the site,
167      *     COMPLETION_DISABLED (false) if it's complete
168      */
169     public static function is_enabled_for_site() {
170         global $CFG;
171         return !empty($CFG->enablecompletion);
172     }
174     /**
175      * Checks whether completion is enabled in a particular course and possibly
176      * activity.
177      *
178      * @global object
179      * @uses COMPLETION_DISABLED
180      * @uses COMPLETION_ENABLED
181      * @param object $cm Course-module object. If not specified, returns the course
182      *   completion enable state.
183      * @return mixed COMPLETION_ENABLED or COMPLETION_DISABLED (==0) in the case of
184      *   site and course; COMPLETION_TRACKING_MANUAL, _AUTOMATIC or _NONE (==0)
185      *   for a course-module.
186      */
187     public function is_enabled($cm=null) {
188         global $CFG, $DB;
190         // First check global completion
191         if (!isset($CFG->enablecompletion) || $CFG->enablecompletion == COMPLETION_DISABLED) {
192             return COMPLETION_DISABLED;
193         }
195         // Load data if we do not have enough
196         if (!isset($this->course->enablecompletion)) {
197             $this->course->enablecompletion = $DB->get_field('course', 'enablecompletion', array('id' => $this->course->id));
198         }
200         // Check course completion
201         if ($this->course->enablecompletion == COMPLETION_DISABLED) {
202             return COMPLETION_DISABLED;
203         }
205         // If there was no $cm and we got this far, then it's enabled
206         if (!$cm) {
207             return COMPLETION_ENABLED;
208         }
210         // Return course-module completion value
211         return $cm->completion;
212     }
214     /**
215      * Displays the 'Your progress' help icon, if completion tracking is enabled.
216      * Just prints the result of display_help_icon().
217      * @deprecated Use display_help_icon instead.
218      * @return void
219      */
220     public function print_help_icon() {
221         print $this->display_help_icon();
222     }
224     /**
225      * Returns the 'Your progress' help icon, if completion tracking is enabled.
226      * @global object
227      * @return string HTML code for help icon, or blank if not needed
228      */
229     public function display_help_icon() {
230         global $PAGE, $OUTPUT;
231         $result = '';
232         if ($this->is_enabled() && !$PAGE->user_is_editing() && isloggedin() && !isguestuser()) {
233             $result .= '<span id = "completionprogressid" class="completionprogress">'.get_string('yourprogress','completion').' ';
234             $result .= $OUTPUT->help_icon('completionicons', 'completion');
235             $result .= '</span>';
236         }
237         return $result;
238     }
240     /**
241      * Get a course completion for a user
242      * @access  public
243      * @param   $user_id        int     User id
244      * @param   $criteriatype   int     Specific criteria type to return
245      * @return  false|completion_criteria_completion
246      */
247     public function get_completion($user_id, $criteriatype) {
248         $completions = $this->get_completions($user_id, $criteriatype);
250         if (empty($completions)) {
251             return false;
252         } elseif (count($completions) > 1) {
253             print_error('multipleselfcompletioncriteria', 'completion');
254         }
256         return $completions[0];
257     }
259     /**
260      * Get all course criteria's completion objects for a user
261      * @access  public
262      * @param   $user_id        int     User id
263      * @param   $criteriatype   int     optional    Specific criteria type to return
264      * @return  array
265      */
266     public function get_completions($user_id, $criteriatype = null) {
267         $criterion = $this->get_criteria($criteriatype);
269         $completions = array();
271         foreach ($criterion as $criteria) {
272             $params = array(
273                 'course'        => $this->course_id,
274                 'userid'        => $user_id,
275                 'criteriaid'    => $criteria->id
276             );
278             $completion = new completion_criteria_completion($params);
279             $completion->attach_criteria($criteria);
281             $completions[] = $completion;
282         }
284         return $completions;
285     }
287     /**
288      * Get completion object for a user and a criteria
289      * @access  public
290      * @param   $user_id        int     User id
291      * @param   $criteria       completion_criteria     Criteria object
292      * @return  completion_criteria_completion
293      */
294     public function get_user_completion($user_id, $criteria) {
295         $params = array(
296             'criteriaid'    => $criteria->id,
297             'userid'        => $user_id
298         );
300         $completion = new completion_criteria_completion($params);
301         return $completion;
302     }
304     /**
305      * Check if course has completion criteria set
306      *
307      * @access  public
308      * @return  bool
309      */
310     public function has_criteria() {
311         $criteria = $this->get_criteria();
313         return (bool) count($criteria);
314     }
317     /**
318      * Get course completion criteria
319      * @access  public
320      * @param   $criteriatype   int     optional    Specific criteria type to return
321      * @return  void
322      */
323     public function get_criteria($criteriatype = null) {
325         // Fill cache if empty
326         if (!is_array($this->criteria)) {
327             global $DB;
329             $params = array(
330                 'course'    => $this->course->id
331             );
333             // Load criteria from database
334             $records = (array)$DB->get_records('course_completion_criteria', $params);
336             // Build array of criteria objects
337             $this->criteria = array();
338             foreach ($records as $record) {
339                 $this->criteria[$record->id] = completion_criteria::factory($record);
340             }
341         }
343         // If after all criteria
344         if ($criteriatype === null) {
345             return $this->criteria;
346         }
348         // If we are only after a specific criteria type
349         $criteria = array();
350         foreach ($this->criteria as $criterion) {
352             if ($criterion->criteriatype != $criteriatype) {
353                 continue;
354             }
356             $criteria[$criterion->id] = $criterion;
357         }
359         return $criteria;
360     }
362     /**
363      * Get aggregation method
364      * @access  public
365      * @param   $criteriatype   int     optional    If none supplied, get overall aggregation method
366      * @return  int
367      */
368     public function get_aggregation_method($criteriatype = null) {
369         $params = array(
370             'course'        => $this->course_id,
371             'criteriatype'  => $criteriatype
372         );
374         $aggregation = new completion_aggregation($params);
376         if (!$aggregation->id) {
377             $aggregation->method = COMPLETION_AGGREGATION_ALL;
378         }
380         return $aggregation->method;
381     }
383     /**
384      * Get incomplete course completion criteria
385      * @access  public
386      * @return  void
387      */
388     public function get_incomplete_criteria() {
389         $incomplete = array();
391         foreach ($this->get_criteria() as $criteria) {
392             if (!$criteria->is_complete()) {
393                 $incomplete[] = $criteria;
394             }
395         }
397         return $incomplete;
398     }
400     /**
401      * Clear old course completion criteria
402      */
403     public function clear_criteria() {
404         global $DB;
405         $DB->delete_records('course_completion_criteria', array('course' => $this->course_id));
406         $DB->delete_records('course_completion_aggr_methd', array('course' => $this->course_id));
408         $this->delete_course_completion_data();
409     }
411     /**
412      * Has the supplied user completed this course
413      * @access  public
414      * @param   $user_id    int     User's id
415      * @return  boolean
416      */
417     public function is_course_complete($user_id) {
418         $params = array(
419             'userid'    => $user_id,
420             'course'  => $this->course_id
421         );
423         $ccompletion = new completion_completion($params);
424         return $ccompletion->is_complete();
425     }
427     /**
428      * Updates (if necessary) the completion state of activity $cm for the given
429      * user.
430      *
431      * For manual completion, this function is called when completion is toggled
432      * with $possibleresult set to the target state.
433      *
434      * For automatic completion, this function should be called every time a module
435      * does something which might influence a user's completion state. For example,
436      * if a forum provides options for marking itself 'completed' once a user makes
437      * N posts, this function should be called every time a user makes a new post.
438      * [After the post has been saved to the database]. When calling, you do not
439      * need to pass in the new completion state. Instead this function carries out
440      * completion calculation by checking grades and viewed state itself, and
441      * calling the involved module via modulename_get_completion_state() to check
442      * module-specific conditions.
443      *
444      * @global object
445      * @global object
446      * @uses COMPLETION_COMPLETE
447      * @uses COMPLETION_INCOMPLETE
448      * @uses COMPLETION_COMPLETE_PASS
449      * @uses COMPLETION_COMPLETE_FAIL
450      * @uses COMPLETION_TRACKING_MANUAL
451      * @param object $cm Course-module
452      * @param int $possibleresult Expected completion result. If the event that
453      *   has just occurred (e.g. add post) can only result in making the activity
454      *   complete when it wasn't before, use COMPLETION_COMPLETE. If the event that
455      *   has just occurred (e.g. delete post) can only result in making the activity
456      *   not complete when it was previously complete, use COMPLETION_INCOMPLETE.
457      *   Otherwise use COMPLETION_UNKNOWN. Setting this value to something other than
458      *   COMPLETION_UNKNOWN significantly improves performance because it will abandon
459      *   processing early if the user's completion state already matches the expected
460      *   result. For manual events, COMPLETION_COMPLETE or COMPLETION_INCOMPLETE
461      *   must be used; these directly set the specified state.
462      * @param int $userid User ID to be updated. Default 0 = current user
463      * @return void
464      */
465     public function update_state($cm, $possibleresult=COMPLETION_UNKNOWN, $userid=0) {
466         global $USER, $SESSION;
468         // Do nothing if completion is not enabled for that activity
469         if (!$this->is_enabled($cm)) {
470             return;
471         }
473         // Get current value of completion state and do nothing if it's same as
474         // the possible result of this change. If the change is to COMPLETE and the
475         // current value is one of the COMPLETE_xx subtypes, ignore that as well
476         $current = $this->get_data($cm, false, $userid);
477         if ($possibleresult == $current->completionstate ||
478             ($possibleresult == COMPLETION_COMPLETE &&
479                 ($current->completionstate == COMPLETION_COMPLETE_PASS ||
480                 $current->completionstate == COMPLETION_COMPLETE_FAIL))) {
481             return;
482         }
484         if ($cm->completion == COMPLETION_TRACKING_MANUAL) {
485             // For manual tracking we set the result directly
486             switch($possibleresult) {
487                 case COMPLETION_COMPLETE:
488                 case COMPLETION_INCOMPLETE:
489                     $newstate = $possibleresult;
490                     break;
491                 default:
492                     $this->internal_systemerror("Unexpected manual completion state for {$cm->id}: $possibleresult");
493             }
495         } else {
496             // Automatic tracking; get new state
497             $newstate = $this->internal_get_state($cm, $userid, $current);
498         }
500         // If changed, update
501         if ($newstate != $current->completionstate) {
502             $current->completionstate = $newstate;
503             $current->timemodified    = time();
504             $this->internal_set_data($cm, $current);
505         }
506     }
508     /**
509      * Calculates the completion state for an activity and user.
510      *
511      * Internal function. Not private, so we can unit-test it.
512      *
513      * @global object
514      * @global object
515      * @global object
516      * @uses COMPLETION_VIEW_REQUIRED
517      * @uses COMPLETION_NOT_VIEWED
518      * @uses COMPLETION_INCOMPLETE
519      * @uses FEATURE_COMPLETION_HAS_RULES
520      * @uses COMPLETION_COMPLETE
521      * @uses COMPLETION_AND
522      * @param object $cm Activity
523      * @param int $userid ID of user
524      * @param object $current Previous completion information from database
525      * @return mixed
526      */
527     function internal_get_state($cm, $userid, $current) {
528         global $USER, $DB, $CFG;
530         // Get user ID
531         if (!$userid) {
532             $userid = $USER->id;
533         }
535         // Check viewed
536         if ($cm->completionview == COMPLETION_VIEW_REQUIRED &&
537             $current->viewed == COMPLETION_NOT_VIEWED) {
539             return COMPLETION_INCOMPLETE;
540         }
542         // Modname hopefully is provided in $cm but just in case it isn't, let's grab it
543         if (!isset($cm->modname)) {
544             $cm->modname = $DB->get_field('modules', 'name', array('id'=>$cm->module));
545         }
547         $newstate = COMPLETION_COMPLETE;
549         // Check grade
550         if (!is_null($cm->completiongradeitemnumber)) {
551             require_once($CFG->libdir.'/gradelib.php');
552             $item = grade_item::fetch(array('courseid'=>$cm->course, 'itemtype'=>'mod',
553                 'itemmodule'=>$cm->modname, 'iteminstance'=>$cm->instance,
554                 'itemnumber'=>$cm->completiongradeitemnumber));
555             if ($item) {
556                 // Fetch 'grades' (will be one or none)
557                 $grades = grade_grade::fetch_users_grades($item, array($userid), false);
558                 if (empty($grades)) {
559                     // No grade for user
560                     return COMPLETION_INCOMPLETE;
561                 }
562                 if (count($grades) > 1) {
563                     $this->internal_systemerror("Unexpected result: multiple grades for
564                         item '{$item->id}', user '{$userid}'");
565                 }
566                 $newstate = $this->internal_get_grade_state($item, reset($grades));
567                 if ($newstate == COMPLETION_INCOMPLETE) {
568                     return COMPLETION_INCOMPLETE;
569                 }
571             } else {
572                 $this->internal_systemerror("Cannot find grade item for '{$cm->modname}'
573                     cm '{$cm->id}' matching number '{$cm->completiongradeitemnumber}'");
574             }
575         }
577         if (plugin_supports('mod', $cm->modname, FEATURE_COMPLETION_HAS_RULES)) {
578             $function = $cm->modname.'_get_completion_state';
579             if (!function_exists($function)) {
580                 $this->internal_systemerror("Module {$cm->modname} claims to support
581                     FEATURE_COMPLETION_HAS_RULES but does not have required
582                     {$cm->modname}_get_completion_state function");
583             }
584             if (!$function($this->course, $cm, $userid, COMPLETION_AND)) {
585                 return COMPLETION_INCOMPLETE;
586             }
587         }
589         return $newstate;
591     }
594     /**
595      * Marks a module as viewed.
596      *
597      * Should be called whenever a module is 'viewed' (it is up to the module how to
598      * determine that). Has no effect if viewing is not set as a completion condition.
599      *
600      * Note that this function must be called before you print the page header because
601      * it is possible that the navigation block may depend on it. If you call it after
602      * printing the header, it shows a developer debug warning.
603      * @uses COMPLETION_VIEW_NOT_REQUIRED
604      * @uses COMPLETION_VIEWED
605      * @uses COMPLETION_COMPLETE
606      * @param object $cm Activity
607      * @param int $userid User ID or 0 (default) for current user
608      * @return void
609      */
610     public function set_module_viewed($cm, $userid=0) {
611         global $PAGE, $UNITTEST;
612         if ($PAGE->headerprinted && empty($UNITTEST->running)) {
613             debugging('set_module_viewed must be called before header is printed',
614                     DEBUG_DEVELOPER);
615         }
616         // Don't do anything if view condition is not turned on
617         if ($cm->completionview == COMPLETION_VIEW_NOT_REQUIRED || !$this->is_enabled($cm)) {
618             return;
619         }
620         // Get current completion state
621         $data = $this->get_data($cm, $userid);
622         // If we already viewed it, don't do anything
623         if ($data->viewed == COMPLETION_VIEWED) {
624             return;
625         }
626         // OK, change state, save it, and update completion
627         $data->viewed = COMPLETION_VIEWED;
628         $this->internal_set_data($cm, $data);
629         $this->update_state($cm, COMPLETION_COMPLETE, $userid);
630     }
632     /**
633      * Determines how much completion data exists for an activity. This is used when
634      * deciding whether completion information should be 'locked' in the module
635      * editing form.
636      *
637      * @global object
638      * @param object $cm Activity
639      * @return int The number of users who have completion data stored for this
640      *   activity, 0 if none
641      */
642     public function count_user_data($cm) {
643         global $DB;
645         return $DB->get_field_sql("
646     SELECT
647         COUNT(1)
648     FROM
649         {course_modules_completion}
650     WHERE
651         coursemoduleid=? AND completionstate<>0", array($cm->id));
652     }
654     /**
655      * Determines how much course completion data exists for a course. This is used when
656      * deciding whether completion information should be 'locked' in the completion
657      * settings form and activity completion settings.
658      *
659      * @global object
660      * @param  int $user_id Optionally only get course completion data for a single user
661      * @return int The number of users who have completion data stored for this
662      *   course, 0 if none
663      */
664     public function count_course_user_data($user_id = null) {
665         global $DB;
667         $sql = '
668     SELECT
669         COUNT(1)
670     FROM
671         {course_completion_crit_compl}
672     WHERE
673         course = ?
674         ';
676         $params = array($this->course_id);
678         // Limit data to a single user if an ID is supplied
679         if ($user_id) {
680             $sql .= ' AND userid = ?';
681             $params[] = $user_id;
682         }
684         return $DB->get_field_sql($sql, $params);
685     }
687     /**
688      * Check if this course's completion criteria should be locked
689      *
690      * @return  boolean
691      */
692     public function is_course_locked() {
693         return (bool) $this->count_course_user_data();
694     }
696     /**
697      * Deletes all course completion completion data.
698      *
699      * Intended to be used when unlocking completion criteria settings.
700      *
701      * @global  object
702      * @return  void
703      */
704     public function delete_course_completion_data() {
705         global $DB;
707         $DB->delete_records('course_completions', array('course' => $this->course_id));
708         $DB->delete_records('course_completion_crit_compl', array('course' => $this->course_id));
709     }
711     /**
712      * Deletes completion state related to an activity for all users.
713      *
714      * Intended for use only when the activity itself is deleted.
715      *
716      * @global object
717      * @global object
718      * @param object $cm Activity
719      */
720     public function delete_all_state($cm) {
721         global $SESSION, $DB;
723         // Delete from database
724         $DB->delete_records('course_modules_completion', array('coursemoduleid'=>$cm->id));
726         // Erase cache data for current user if applicable
727         if (isset($SESSION->completioncache) &&
728             array_key_exists($cm->course, $SESSION->completioncache) &&
729             array_key_exists($cm->id, $SESSION->completioncache[$cm->course])) {
731             unset($SESSION->completioncache[$cm->course][$cm->id]);
732         }
734         // Check if there is an associated course completion criteria
735         $criteria = $this->get_criteria(COMPLETION_CRITERIA_TYPE_ACTIVITY);
736         $acriteria = false;
737         foreach ($criteria as $criterion) {
738             if ($criterion->moduleinstance == $cm->id) {
739                 $acriteria = $criterion;
740                 break;
741     }
742         }
744         if ($acriteria) {
745             // Delete all criteria completions relating to this activity
746             $DB->delete_records('course_completion_crit_compl', array('course' => $this->course_id, 'criteriaid' => $acriteria->id));
747             $DB->delete_records('course_completions', array('course' => $this->course_id));
748         }
749     }
751     /**
752      * Recalculates completion state related to an activity for all users.
753      *
754      * Intended for use if completion conditions change. (This should be avoided
755      * as it may cause some things to become incomplete when they were previously
756      * complete, with the effect - for example - of hiding a later activity that
757      * was previously available.)
758      *
759      * Resetting state of manual tickbox has same result as deleting state for
760      * it.
761      *
762      * @global object
763      * @uses COMPLETION_TRACKING_MANUAL
764      * @uses COMPLETION_UNKNOWN
765      * @param object $cm Activity
766      */
767     public function reset_all_state($cm) {
768         global $DB;
770         if ($cm->completion == COMPLETION_TRACKING_MANUAL) {
771             $this->delete_all_state($cm);
772             return;
773         }
774         // Get current list of users with completion state
775         $rs = $DB->get_recordset('course_modules_completion', array('coursemoduleid'=>$cm->id), '', 'userid');
776         $keepusers = array();
777         foreach ($rs as $rec) {
778             $keepusers[] = $rec->userid;
779         }
780         $rs->close();
782         // Delete all existing state [also clears session cache for current user]
783         $this->delete_all_state($cm);
785         // Merge this with list of planned users (according to roles)
786         $trackedusers = $this->get_tracked_users();
787         foreach ($trackedusers as $trackeduser) {
788             $keepusers[] = $trackeduser->id;
789         }
790         $keepusers = array_unique($keepusers);
792         // Recalculate state for each kept user
793         foreach ($keepusers as $keepuser) {
794             $this->update_state($cm, COMPLETION_UNKNOWN, $keepuser);
795         }
796     }
798     /**
799      * Obtains completion data for a particular activity and user (from the
800      * session cache if available, or by SQL query)
801      *
802      * @global object
803      * @global object
804      * @global object
805      * @global object
806      * @uses COMPLETION_CACHE_EXPIRY
807      * @param object $cm Activity; only required field is ->id
808      * @param bool $wholecourse If true (default false) then, when necessary to
809      *   fill the cache, retrieves information from the entire course not just for
810      *   this one activity
811      * @param int $userid User ID or 0 (default) for current user
812      * @param array $modinfo Supply the value here - this is used for unit
813      *   testing and so that it can be called recursively from within
814      *   get_fast_modinfo. (Needs only list of all CMs with IDs.)
815      *   Otherwise the method calls get_fast_modinfo itself.
816      * @return object Completion data (record from course_modules_completion)
817      */
818     public function get_data($cm, $wholecourse=false, $userid=0, $modinfo=null) {
819         global $USER, $CFG, $SESSION, $DB;
821         // Get user ID
822         if (!$userid) {
823             $userid = $USER->id;
824         }
826         // Is this the current user?
827         $currentuser = $userid==$USER->id;
829         if ($currentuser && is_object($SESSION)) {
830             // Make sure cache is present and is for current user (loginas
831             // changes this)
832             if (!isset($SESSION->completioncache) || $SESSION->completioncacheuserid!=$USER->id) {
833                 $SESSION->completioncache = array();
834                 $SESSION->completioncacheuserid = $USER->id;
835             }
836             // Expire any old data from cache
837             foreach ($SESSION->completioncache as $courseid=>$activities) {
838                 if (empty($activities['updated']) || $activities['updated'] < time()-COMPLETION_CACHE_EXPIRY) {
839                     unset($SESSION->completioncache[$courseid]);
840                 }
841             }
842             // See if requested data is present, if so use cache to get it
843             if (isset($SESSION->completioncache) &&
844                 array_key_exists($this->course->id, $SESSION->completioncache) &&
845                 array_key_exists($cm->id, $SESSION->completioncache[$this->course->id])) {
846                 return $SESSION->completioncache[$this->course->id][$cm->id];
847             }
848         }
850         // Not there, get via SQL
851         if ($currentuser && $wholecourse) {
852             // Get whole course data for cache
853             $alldatabycmc = $DB->get_records_sql("
854     SELECT
855         cmc.*
856     FROM
857         {course_modules} cm
858         INNER JOIN {course_modules_completion} cmc ON cmc.coursemoduleid=cm.id
859     WHERE
860         cm.course=? AND cmc.userid=?", array($this->course->id, $userid));
862             // Reindex by cm id
863             $alldata = array();
864             if ($alldatabycmc) {
865                 foreach ($alldatabycmc as $data) {
866                     $alldata[$data->coursemoduleid] = $data;
867                 }
868             }
870             // Get the module info and build up condition info for each one
871             if (empty($modinfo)) {
872                 $modinfo = get_fast_modinfo($this->course, $userid);
873             }
874             foreach ($modinfo->cms as $othercm) {
875                 if (array_key_exists($othercm->id, $alldata)) {
876                     $data = $alldata[$othercm->id];
877                 } else {
878                     // Row not present counts as 'not complete'
879                     $data = new StdClass;
880                     $data->id              = 0;
881                     $data->coursemoduleid  = $othercm->id;
882                     $data->userid          = $userid;
883                     $data->completionstate = 0;
884                     $data->viewed          = 0;
885                     $data->timemodified    = 0;
886                 }
887                 $SESSION->completioncache[$this->course->id][$othercm->id] = $data;
888             }
889             $SESSION->completioncache[$this->course->id]['updated'] = time();
891             if (!isset($SESSION->completioncache[$this->course->id][$cm->id])) {
892                 $this->internal_systemerror("Unexpected error: course-module {$cm->id} could not be found on course {$this->course->id}");
893             }
894             return $SESSION->completioncache[$this->course->id][$cm->id];
896         } else {
897             // Get single record
898             $data = $DB->get_record('course_modules_completion', array('coursemoduleid'=>$cm->id, 'userid'=>$userid));
899             if ($data == false) {
900                 // Row not present counts as 'not complete'
901                 $data = new StdClass;
902                 $data->id              = 0;
903                 $data->coursemoduleid  = $cm->id;
904                 $data->userid          = $userid;
905                 $data->completionstate = 0;
906                 $data->viewed          = 0;
907                 $data->timemodified    = 0;
908             }
910             // Put in cache
911             if ($currentuser) {
912                 $SESSION->completioncache[$this->course->id][$cm->id] = $data;
913                 // For single updates, only set date if it was empty before
914                 if (empty($SESSION->completioncache[$this->course->id]['updated'])) {
915                     $SESSION->completioncache[$this->course->id]['updated'] = time();
916                 }
917             }
918         }
920         return $data;
921     }
923     /**
924      * Updates completion data for a particular coursemodule and user (user is
925      * determined from $data).
926      *
927      * (Internal function. Not private, so we can unit-test it.)
928      *
929      * @global object
930      * @global object
931      * @global object
932      * @param object $cm Activity
933      * @param object $data Data about completion for that user
934      */
935     function internal_set_data($cm, $data) {
936         global $USER, $SESSION, $DB;
938         if ($data->id) {
939             // Has real (nonzero) id meaning that a database row exists
940             $DB->update_record('course_modules_completion', $data);
941         } else {
942             // Didn't exist before, needs creating
943             $data->id = $DB->insert_record('course_modules_completion', $data);
944         }
946         if ($data->userid == $USER->id) {
947             $SESSION->completioncache[$cm->course][$cm->id] = $data;
948             $reset = 'reset';
949             get_fast_modinfo($reset);
950         }
951     }
953     /**
954      * Obtains a list of activities for which completion is enabled on the
955      * course. The list is ordered by the section order of those activities.
956      *
957      * @global object
958      * @uses COMPLETION_TRACKING_NONE
959      * @param array $modinfo For unit testing only, supply the value
960      *   here. Otherwise the method calls get_fast_modinfo
961      * @return array Array from $cmid => $cm of all activities with completion enabled,
962      *   empty array if none
963      */
964     public function get_activities($modinfo=null) {
965         global $DB;
967         // Obtain those activities which have completion turned on
968         $withcompletion = $DB->get_records_select('course_modules', 'course='.$this->course->id.
969           ' AND completion<>'.COMPLETION_TRACKING_NONE);
970         if (!$withcompletion) {
971             return array();
972         }
974         // Use modinfo to get section order and also add in names
975         if (empty($modinfo)) {
976             $modinfo = get_fast_modinfo($this->course);
977         }
978         $result = array();
979         foreach ($modinfo->sections as $sectioncms) {
980             foreach ($sectioncms as $cmid) {
981                 if (array_key_exists($cmid, $withcompletion)) {
982                     $result[$cmid] = $withcompletion[$cmid];
983                     $result[$cmid]->modname = $modinfo->cms[$cmid]->modname;
984                     $result[$cmid]->name    = $modinfo->cms[$cmid]->name;
985                 }
986             }
987         }
989         return $result;
990     }
993     /**
994      * Checks to see if the userid supplied has a tracked role in
995      * this course
996      *
997      * @param   $userid     User id
998      * @return  bool
999      */
1000     function is_tracked_user($userid) {
1001         global $DB;
1003         $tracked = $this->generate_tracked_user_sql();
1005         $sql  = "SELECT u.id ";
1006         $sql .= $tracked->sql;
1007         $sql .= ' AND u.id = :userid';
1009         $params = $tracked->data;
1010         $params['userid'] = (int)$userid;
1011         return $DB->record_exists_sql($sql, $params);
1012     }
1015     /**
1016      * Return number of users whose progress is tracked in this course
1017      *
1018      * Optionally supply a search's where clause, or a group id
1019      *
1020      * @param   string  $where          Where clause sql
1021      * @param   array   $where_params   Where clause params
1022      * @param   int     $groupid    Group id
1023      * @return  int
1024      */
1025     function get_num_tracked_users($where = '', $where_params = array(), $groupid = 0) {
1026         global $DB;
1028         $tracked = $this->generate_tracked_user_sql($groupid);
1030         $sql  = "SELECT COUNT(u.id) ";
1031         $sql .= $tracked->sql;
1033         if ($where) {
1034             $sql .= " AND $where";
1035         }
1037         $params = array_merge($tracked->data, $where_params);
1038         return $DB->count_records_sql($sql, $params);
1039     }
1042     /**
1043      * Return array of users whose progress is tracked in this course
1044      *
1045      * Optionally supply a search's where caluse, group id, sorting, paging
1046      *
1047      * @param   string      $where          Where clause sql (optional)
1048      * @param   array       $where_params   Where clause params (optional)
1049      * @param   integer     $groupid    Group ID to restrict to (optional)
1050      * @param   string      $sort       Order by clause (optional)
1051      * @param   integer     $limitfrom  Result start (optional)
1052      * @param   integer     $limitnum   Result max size (optional)
1053      * @return  array
1054      */
1055     function get_tracked_users($where = '', $where_params = array(), $groupid = 0,
1056              $sort = '', $limitfrom = '', $limitnum = '') {
1058         global $DB;
1060         $tracked = $this->generate_tracked_user_sql($groupid);
1061         $params = $tracked->data;
1063         $sql = "
1064             SELECT
1065                 u.id,
1066                 u.firstname,
1067                 u.lastname,
1068                 u.idnumber
1069         ";
1071         $sql .= $tracked->sql;
1073         if ($where) {
1074             $sql .= " AND $where";
1075             $params = array_merge($params, $where_params);
1076         }
1078         if ($sort) {
1079             $sql .= " ORDER BY $sort";
1080         }
1082         $users = $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
1083         return $users ? $users : array(); // In case it returns false
1084     }
1087     /**
1088      * Generate the SQL for finding tracked users in this course
1089      *
1090      * Returns an object containing the sql fragment and an array of
1091      * bound data params.
1092      *
1093      * @param   integer $groupid
1094      * @return  object
1095      */
1096     function generate_tracked_user_sql($groupid = 0) {
1097         global $CFG;
1099         $return = new stdClass();
1100         $return->sql = '';
1101         $return->data = array();
1103         if (!empty($CFG->gradebookroles)) {
1104             $roles = ' AND ra.roleid IN ('.$CFG->gradebookroles.')';
1105         } else {
1106             // This causes it to default to everyone (if there is no student role)
1107             $roles = '';
1108         }
1110         // Build context sql
1111         $context = get_context_instance(CONTEXT_COURSE, $this->course->id);
1112         $parentcontexts = substr($context->path, 1); // kill leading slash
1113         $parentcontexts = str_replace('/', ',', $parentcontexts);
1114         if ($parentcontexts !== '') {
1115             $parentcontexts = ' OR ra.contextid IN ('.$parentcontexts.' )';
1116         }
1118         $groupjoin   = '';
1119         $groupselect = '';
1120         if ($groupid) {
1121             $groupjoin   = "JOIN {groups_members} gm
1122                               ON gm.userid = u.id";
1123             $groupselect = " AND gm.groupid = :groupid ";
1124             
1125             $return->data['groupid'] = $groupid;
1126         }
1128         $return->sql = "
1129             FROM
1130                 {user} u
1131             INNER JOIN
1132                 {role_assignments} ra
1133              ON ra.userid = u.id
1134             INNER JOIN
1135                 {role} r
1136              ON r.id = ra.roleid
1137             INNER JOIN
1138                 {user_enrolments} ue
1139              ON ue.userid = u.id
1140             INNER JOIN
1141                 {enrol} e
1142              ON e.id = ue.enrolid
1143             INNER JOIN
1144                 {course} c
1145              ON c.id = e.courseid
1146             $groupjoin
1147             WHERE
1148                 (ra.contextid = :contextid $parentcontexts)
1149             AND c.id = :courseid
1150             AND ue.status = 0
1151             AND e.status = 0
1152             AND ue.timestart < :now1
1153             AND (ue.timeend > :now2 OR ue.timeend = 0)
1154                 $groupselect
1155                 $roles
1156         ";
1158         $now = time();
1159         $return->data['now1'] = $now;
1160         $return->data['now2'] = $now;
1161         $return->data['contextid'] = $context->id;
1162         $return->data['courseid'] = $this->course->id;
1164         return $return;
1165     }
1167     /**
1168      * Obtains progress information across a course for all users on that course, or
1169      * for all users in a specific group. Intended for use when displaying progress.
1170      *
1171      * This includes only users who, in course context, have one of the roles for
1172      * which progress is tracked (the gradebookroles admin option) and are enrolled in course.
1173      *
1174      * Users are included (in the first array) even if they do not have
1175      * completion progress for any course-module.
1176      *
1177      * @global object
1178      * @global object
1179      * @param bool $sortfirstname If true, sort by first name, otherwise sort by
1180      *   last name
1181      * @param string $where Where clause sql (optional)
1182      * @param array $where_params Where clause params (optional)
1183      * @param int $groupid Group ID or 0 (default)/false for all groups
1184      * @param int $pagesize Number of users to actually return (optional)
1185      * @param int $start User to start at if paging (optional)
1186      * @return Object with ->total and ->start (same as $start) and ->users;
1187      *   an array of user objects (like mdl_user id, firstname, lastname)
1188      *   containing an additional ->progress array of coursemoduleid => completionstate
1189      */
1190     public function get_progress_all($where = '', $where_params = array(), $groupid = 0,
1191                                        $sort = '', $pagesize = '', $start = '') {
1192         global $CFG, $DB;
1194         // Get list of applicable users
1195         $users = $this->get_tracked_users($where, $where_params, $groupid, $sort, $start, $pagesize);
1197         // Get progress information for these users in groups of 1, 000 (if needed)
1198         // to avoid making the SQL IN too long
1199         $results = array();
1200         $userids = array();
1201         foreach ($users as $user) {
1202             $userids[] = $user->id;
1203             $results[$user->id] = $user;
1204             $results[$user->id]->progress = array();
1205         }
1207         for($i=0; $i<count($userids); $i+=1000) {
1208             $blocksize = count($userids)-$i < 1000 ? count($userids)-$i : 1000;
1210             list($insql, $params) = $DB->get_in_or_equal(array_slice($userids, $i, $blocksize));
1211             array_splice($params, 0, 0, array($this->course->id));
1212             $rs = $DB->get_recordset_sql("
1213                 SELECT
1214                     cmc.*
1215                 FROM
1216                     {course_modules} cm
1217                     INNER JOIN {course_modules_completion} cmc ON cm.id=cmc.coursemoduleid
1218                 WHERE
1219                     cm.course=? AND cmc.userid $insql
1220     ", $params);
1221             foreach ($rs as $progress) {
1222                 $progress = (object)$progress;
1223                 $results[$progress->userid]->progress[$progress->coursemoduleid] = $progress;
1224             }
1225             $rs->close();
1226         }
1228         return $results;
1229     }
1231     /**
1232      * Called by grade code to inform the completion system when a grade has
1233      * been changed. If the changed grade is used to determine completion for
1234      * the course-module, then the completion status will be updated.
1235      *
1236      * @uses COMPLETION_TRACKING_MANUAL
1237      * @uses COMPLETION_INCOMPLETE
1238      * @param object $cm Course-module for item that owns grade
1239      * @param grade_item $item Grade item
1240      * @param object $grade
1241      * @param bool $deleted
1242      * @return void
1243      */
1244     public function inform_grade_changed($cm, $item, $grade, $deleted) {
1245         // Bail out now if completion is not enabled for course-module, it is enabled
1246         // but is set to manual, grade is not used to compute completion, or this
1247         // is a different numbered grade
1248         if (!$this->is_enabled($cm) ||
1249             $cm->completion == COMPLETION_TRACKING_MANUAL ||
1250             is_null($cm->completiongradeitemnumber) ||
1251             $item->itemnumber != $cm->completiongradeitemnumber) {
1252             return;
1253         }
1255         // What is the expected result based on this grade?
1256         if ($deleted) {
1257             // Grade being deleted, so only change could be to make it incomplete
1258             $possibleresult = COMPLETION_INCOMPLETE;
1259         } else {
1260             $possibleresult = $this->internal_get_grade_state($item, $grade);
1261         }
1262         
1263         // OK, let's update state based on this
1264         $this->update_state($cm, $possibleresult, $grade->userid);
1265     }
1267     /**
1268      * Calculates the completion state that would result from a graded item
1269      * (where grade-based completion is turned on) based on the actual grade
1270      * and settings.
1271      *
1272      * Internal function. Not private, so we can unit-test it.
1273      *
1274      * @uses COMPLETION_INCOMPLETE
1275      * @uses COMPLETION_COMPLETE_PASS
1276      * @uses COMPLETION_COMPLETE_FAIL
1277      * @uses COMPLETION_COMPLETE
1278      * @param object $item grade_item
1279      * @param object $grade grade_grade
1280      * @return int Completion state e.g. COMPLETION_INCOMPLETE
1281      */
1282     function internal_get_grade_state($item, $grade) {
1283         if (!$grade) {
1284             return COMPLETION_INCOMPLETE;
1285         }
1286         // Conditions to show pass/fail:
1287         // a) Grade has pass mark (default is 0.00000 which is boolean true so be careful)
1288         // b) Grade is visible (neither hidden nor hidden-until)
1289         if ($item->gradepass && $item->gradepass > 0.000009 && !$item->hidden) {
1290             // Use final grade if set otherwise raw grade
1291             $score = !is_null($grade->finalgrade) ? $grade->finalgrade : $grade->rawgrade;
1293             // We are displaying and tracking pass/fail
1294             if ($score >= $item->gradepass) {
1295                 return COMPLETION_COMPLETE_PASS;
1296             } else {
1297                 return COMPLETION_COMPLETE_FAIL;
1298             }
1299         } else {
1300             // Not displaying pass/fail, so just if there is a grade
1301             if (!is_null($grade->finalgrade) || !is_null($grade->rawgrade)) {
1302                 // Grade exists, so maybe complete now
1303                 return COMPLETION_COMPLETE;
1304             } else {
1305                 // Grade does not exist, so maybe incomplete now
1306                 return COMPLETION_INCOMPLETE;
1307             }
1308         }
1309     }
1311     /**
1312      * This is to be used only for system errors (things that shouldn't happen)
1313      * and not user-level errors.
1314      *
1315      * @global object
1316      * @param string $error Error string (will not be displayed to user unless
1317      *   debugging is enabled)
1318      * @return void Throws moodle_exception Exception with the error string as debug info
1319      */
1320     function internal_systemerror($error) {
1321         global $CFG;
1322         throw new moodle_exception('err_system','completion',
1323             $CFG->wwwroot.'/course/view.php?id='.$this->course->id,null,$error);
1324     }
1326     /**
1327      * For testing only. Wipes information cached in user session.
1328      *
1329      * @global object
1330      */
1331     static function wipe_session_cache() {
1332         global $SESSION;
1333         unset($SESSION->completioncache);
1334         unset($SESSION->completioncacheuserid);
1335     }