completion MDL-25927 Change print_help_icon to display_help_icon (returns html instea...
[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;
190         // First check global completion
191         if (!isset($CFG->enablecompletion) || $CFG->enablecompletion == COMPLETION_DISABLED) {
192             return COMPLETION_DISABLED;
193         }
195         // Check course completion
196         if ($this->course->enablecompletion == COMPLETION_DISABLED) {
197             return COMPLETION_DISABLED;
198         }
200         // If there was no $cm and we got this far, then it's enabled
201         if (!$cm) {
202             return COMPLETION_ENABLED;
203         }
205         // Return course-module completion value
206         return $cm->completion;
207     }
209     /**
210      * Returns the 'Your progress' help icon, if completion tracking is enabled.
211      * @global object
212      * @return string HTML code for help icon, or blank if not needed
213      */
214     public function display_help_icon() {
215         global $PAGE, $OUTPUT;
216         $result = '';
217         if ($this->is_enabled() && !$PAGE->user_is_editing() && isloggedin() && !isguestuser()) {
218             $result .= '<span id = "completionprogressid" class="completionprogress">'.get_string('yourprogress','completion').' ';
219             $result .= $OUTPUT->help_icon('completionicons', 'completion');
220             $result .= '</span>';
221         }
222         return $result;
223     }
225     /**
226      * Get a course completion for a user
227      * @access  public
228      * @param   $user_id        int     User id
229      * @param   $criteriatype   int     Specific criteria type to return
230      * @return  false|completion_criteria_completion
231      */
232     public function get_completion($user_id, $criteriatype) {
233         $completions = $this->get_completions($user_id, $criteriatype);
235         if (empty($completions)) {
236             return false;
237         } elseif (count($completions) > 1) {
238             print_error('multipleselfcompletioncriteria', 'completion');
239         }
241         return $completions[0];
242     }
244     /**
245      * Get all course criteria's completion objects for a user
246      * @access  public
247      * @param   $user_id        int     User id
248      * @param   $criteriatype   int     optional    Specific criteria type to return
249      * @return  array
250      */
251     public function get_completions($user_id, $criteriatype = null) {
252         $criterion = $this->get_criteria($criteriatype);
254         $completions = array();
256         foreach ($criterion as $criteria) {
257             $params = array(
258                 'course'        => $this->course_id,
259                 'userid'        => $user_id,
260                 'criteriaid'    => $criteria->id
261             );
263             $completion = new completion_criteria_completion($params);
264             $completion->attach_criteria($criteria);
266             $completions[] = $completion;
267         }
269         return $completions;
270     }
272     /**
273      * Get completion object for a user and a criteria
274      * @access  public
275      * @param   $user_id        int     User id
276      * @param   $criteria       completion_criteria     Criteria object
277      * @return  completion_criteria_completion
278      */
279     public function get_user_completion($user_id, $criteria) {
280         $params = array(
281             'criteriaid'    => $criteria->id,
282             'userid'        => $user_id
283         );
285         $completion = new completion_criteria_completion($params);
286         return $completion;
287     }
289     /**
290      * Check if course has completion criteria set
291      *
292      * @access  public
293      * @return  bool
294      */
295     public function has_criteria() {
296         $criteria = $this->get_criteria();
298         return (bool) count($criteria);
299     }
302     /**
303      * Get course completion criteria
304      * @access  public
305      * @param   $criteriatype   int     optional    Specific criteria type to return
306      * @return  void
307      */
308     public function get_criteria($criteriatype = null) {
310         // Fill cache if empty
311         if (!is_array($this->criteria)) {
312             global $DB;
314             $params = array(
315                 'course'    => $this->course->id
316             );
318             // Load criteria from database
319             $records = (array)$DB->get_records('course_completion_criteria', $params);
321             // Build array of criteria objects
322             $this->criteria = array();
323             foreach ($records as $record) {
324                 $this->criteria[$record->id] = completion_criteria::factory($record);
325             }
326         }
328         // If after all criteria
329         if ($criteriatype === null) {
330             return $this->criteria;
331         }
333         // If we are only after a specific criteria type
334         $criteria = array();
335         foreach ($this->criteria as $criterion) {
337             if ($criterion->criteriatype != $criteriatype) {
338                 continue;
339             }
341             $criteria[$criterion->id] = $criterion;
342         }
344         return $criteria;
345     }
347     /**
348      * Get aggregation method
349      * @access  public
350      * @param   $criteriatype   int     optional    If none supplied, get overall aggregation method
351      * @return  int
352      */
353     public function get_aggregation_method($criteriatype = null) {
354         $params = array(
355             'course'        => $this->course_id,
356             'criteriatype'  => $criteriatype
357         );
359         $aggregation = new completion_aggregation($params);
361         if (!$aggregation->id) {
362             $aggregation->method = COMPLETION_AGGREGATION_ALL;
363         }
365         return $aggregation->method;
366     }
368     /**
369      * Get incomplete course completion criteria
370      * @access  public
371      * @return  void
372      */
373     public function get_incomplete_criteria() {
374         $incomplete = array();
376         foreach ($this->get_criteria() as $criteria) {
377             if (!$criteria->is_complete()) {
378                 $incomplete[] = $criteria;
379             }
380         }
382         return $incomplete;
383     }
385     /**
386      * Clear old course completion criteria
387      */
388     public function clear_criteria() {
389         global $DB;
390         $DB->delete_records('course_completion_criteria', array('course' => $this->course_id));
391         $DB->delete_records('course_completion_aggr_methd', array('course' => $this->course_id));
393         $this->delete_course_completion_data();
394     }
396     /**
397      * Has the supplied user completed this course
398      * @access  public
399      * @param   $user_id    int     User's id
400      * @return  boolean
401      */
402     public function is_course_complete($user_id) {
403         $params = array(
404             'userid'    => $user_id,
405             'course'  => $this->course_id
406         );
408         $ccompletion = new completion_completion($params);
409         return $ccompletion->is_complete();
410     }
412     /**
413      * Updates (if necessary) the completion state of activity $cm for the given
414      * user.
415      *
416      * For manual completion, this function is called when completion is toggled
417      * with $possibleresult set to the target state.
418      *
419      * For automatic completion, this function should be called every time a module
420      * does something which might influence a user's completion state. For example,
421      * if a forum provides options for marking itself 'completed' once a user makes
422      * N posts, this function should be called every time a user makes a new post.
423      * [After the post has been saved to the database]. When calling, you do not
424      * need to pass in the new completion state. Instead this function carries out
425      * completion calculation by checking grades and viewed state itself, and
426      * calling the involved module via modulename_get_completion_state() to check
427      * module-specific conditions.
428      *
429      * @global object
430      * @global object
431      * @uses COMPLETION_COMPLETE
432      * @uses COMPLETION_INCOMPLETE
433      * @uses COMPLETION_COMPLETE_PASS
434      * @uses COMPLETION_COMPLETE_FAIL
435      * @uses COMPLETION_TRACKING_MANUAL
436      * @param object $cm Course-module
437      * @param int $possibleresult Expected completion result. If the event that
438      *   has just occurred (e.g. add post) can only result in making the activity
439      *   complete when it wasn't before, use COMPLETION_COMPLETE. If the event that
440      *   has just occurred (e.g. delete post) can only result in making the activity
441      *   not complete when it was previously complete, use COMPLETION_INCOMPLETE.
442      *   Otherwise use COMPLETION_UNKNOWN. Setting this value to something other than
443      *   COMPLETION_UNKNOWN significantly improves performance because it will abandon
444      *   processing early if the user's completion state already matches the expected
445      *   result. For manual events, COMPLETION_COMPLETE or COMPLETION_INCOMPLETE
446      *   must be used; these directly set the specified state.
447      * @param int $userid User ID to be updated. Default 0 = current user
448      * @return void
449      */
450     public function update_state($cm, $possibleresult=COMPLETION_UNKNOWN, $userid=0) {
451         global $USER, $SESSION;
453         // Do nothing if completion is not enabled for that activity
454         if (!$this->is_enabled($cm)) {
455             return;
456         }
458         // Get current value of completion state and do nothing if it's same as
459         // the possible result of this change. If the change is to COMPLETE and the
460         // current value is one of the COMPLETE_xx subtypes, ignore that as well
461         $current = $this->get_data($cm, false, $userid);
462         if ($possibleresult == $current->completionstate ||
463             ($possibleresult == COMPLETION_COMPLETE &&
464                 ($current->completionstate == COMPLETION_COMPLETE_PASS ||
465                 $current->completionstate == COMPLETION_COMPLETE_FAIL))) {
466             return;
467         }
469         if ($cm->completion == COMPLETION_TRACKING_MANUAL) {
470             // For manual tracking we set the result directly
471             switch($possibleresult) {
472                 case COMPLETION_COMPLETE:
473                 case COMPLETION_INCOMPLETE:
474                     $newstate = $possibleresult;
475                     break;
476                 default:
477                     $this->internal_systemerror("Unexpected manual completion state for {$cm->id}: $possibleresult");
478             }
480         } else {
481             // Automatic tracking; get new state
482             $newstate = $this->internal_get_state($cm, $userid, $current);
483         }
485         // If changed, update
486         if ($newstate != $current->completionstate) {
487             $current->completionstate = $newstate;
488             $current->timemodified    = time();
489             $this->internal_set_data($cm, $current);
490         }
491     }
493     /**
494      * Calculates the completion state for an activity and user.
495      *
496      * Internal function. Not private, so we can unit-test it.
497      *
498      * @global object
499      * @global object
500      * @global object
501      * @uses COMPLETION_VIEW_REQUIRED
502      * @uses COMPLETION_NOT_VIEWED
503      * @uses COMPLETION_INCOMPLETE
504      * @uses FEATURE_COMPLETION_HAS_RULES
505      * @uses COMPLETION_COMPLETE
506      * @uses COMPLETION_AND
507      * @param object $cm Activity
508      * @param int $userid ID of user
509      * @param object $current Previous completion information from database
510      * @return mixed
511      */
512     function internal_get_state($cm, $userid, $current) {
513         global $USER, $DB, $CFG;
515         // Get user ID
516         if (!$userid) {
517             $userid = $USER->id;
518         }
520         // Check viewed
521         if ($cm->completionview == COMPLETION_VIEW_REQUIRED &&
522             $current->viewed == COMPLETION_NOT_VIEWED) {
524             return COMPLETION_INCOMPLETE;
525         }
527         // Modname hopefully is provided in $cm but just in case it isn't, let's grab it
528         if (!isset($cm->modname)) {
529             $cm->modname = $DB->get_field('modules', 'name', array('id'=>$cm->module));
530         }
532         $newstate = COMPLETION_COMPLETE;
534         // Check grade
535         if (!is_null($cm->completiongradeitemnumber)) {
536             require_once($CFG->libdir.'/gradelib.php');
537             $item = grade_item::fetch(array('courseid'=>$cm->course, 'itemtype'=>'mod',
538                 'itemmodule'=>$cm->modname, 'iteminstance'=>$cm->instance,
539                 'itemnumber'=>$cm->completiongradeitemnumber));
540             if ($item) {
541                 // Fetch 'grades' (will be one or none)
542                 $grades = grade_grade::fetch_users_grades($item, array($userid), false);
543                 if (empty($grades)) {
544                     // No grade for user
545                     return COMPLETION_INCOMPLETE;
546                 }
547                 if (count($grades) > 1) {
548                     $this->internal_systemerror("Unexpected result: multiple grades for
549                         item '{$item->id}', user '{$userid}'");
550                 }
551                 $newstate = $this->internal_get_grade_state($item, reset($grades));
552                 if ($newstate == COMPLETION_INCOMPLETE) {
553                     return COMPLETION_INCOMPLETE;
554                 }
556             } else {
557                 $this->internal_systemerror("Cannot find grade item for '{$cm->modname}'
558                     cm '{$cm->id}' matching number '{$cm->completiongradeitemnumber}'");
559             }
560         }
562         if (plugin_supports('mod', $cm->modname, FEATURE_COMPLETION_HAS_RULES)) {
563             $function = $cm->modname.'_get_completion_state';
564             if (!function_exists($function)) {
565                 $this->internal_systemerror("Module {$cm->modname} claims to support
566                     FEATURE_COMPLETION_HAS_RULES but does not have required
567                     {$cm->modname}_get_completion_state function");
568             }
569             if (!$function($this->course, $cm, $userid, COMPLETION_AND)) {
570                 return COMPLETION_INCOMPLETE;
571             }
572         }
574         return $newstate;
576     }
579     /**
580      * Marks a module as viewed.
581      *
582      * Should be called whenever a module is 'viewed' (it is up to the module how to
583      * determine that). Has no effect if viewing is not set as a completion condition.
584      *
585      * @uses COMPLETION_VIEW_NOT_REQUIRED
586      * @uses COMPLETION_VIEWED
587      * @uses COMPLETION_COMPLETE
588      * @param object $cm Activity
589      * @param int $userid User ID or 0 (default) for current user
590      * @return void
591      */
592     public function set_module_viewed($cm, $userid=0) {
593         // Don't do anything if view condition is not turned on
594         if ($cm->completionview == COMPLETION_VIEW_NOT_REQUIRED || !$this->is_enabled($cm)) {
595             return;
596         }
597         // Get current completion state
598         $data = $this->get_data($cm, $userid);
599         // If we already viewed it, don't do anything
600         if ($data->viewed == COMPLETION_VIEWED) {
601             return;
602         }
603         // OK, change state, save it, and update completion
604         $data->viewed = COMPLETION_VIEWED;
605         $this->internal_set_data($cm, $data);
606         $this->update_state($cm, COMPLETION_COMPLETE, $userid);
607     }
609     /**
610      * Determines how much completion data exists for an activity. This is used when
611      * deciding whether completion information should be 'locked' in the module
612      * editing form.
613      *
614      * @global object
615      * @param object $cm Activity
616      * @return int The number of users who have completion data stored for this
617      *   activity, 0 if none
618      */
619     public function count_user_data($cm) {
620         global $DB;
622         return $DB->get_field_sql("
623     SELECT
624         COUNT(1)
625     FROM
626         {course_modules_completion}
627     WHERE
628         coursemoduleid=? AND completionstate<>0", array($cm->id));
629     }
631     /**
632      * Determines how much course completion data exists for a course. This is used when
633      * deciding whether completion information should be 'locked' in the completion
634      * settings form and activity completion settings.
635      *
636      * @global object
637      * @param  int $user_id Optionally only get course completion data for a single user
638      * @return int The number of users who have completion data stored for this
639      *   course, 0 if none
640      */
641     public function count_course_user_data($user_id = null) {
642         global $DB;
644         $sql = '
645     SELECT
646         COUNT(1)
647     FROM
648         {course_completion_crit_compl}
649     WHERE
650         course = ?
651         ';
653         $params = array($this->course_id);
655         // Limit data to a single user if an ID is supplied
656         if ($user_id) {
657             $sql .= ' AND userid = ?';
658             $params[] = $user_id;
659         }
661         return $DB->get_field_sql($sql, $params);
662     }
664     /**
665      * Check if this course's completion criteria should be locked
666      *
667      * @return  boolean
668      */
669     public function is_course_locked() {
670         return (bool) $this->count_course_user_data();
671     }
673     /**
674      * Deletes all course completion completion data.
675      *
676      * Intended to be used when unlocking completion criteria settings.
677      *
678      * @global  object
679      * @return  void
680      */
681     public function delete_course_completion_data() {
682         global $DB;
684         $DB->delete_records('course_completions', array('course' => $this->course_id));
685         $DB->delete_records('course_completion_crit_compl', array('course' => $this->course_id));
686     }
688     /**
689      * Deletes completion state related to an activity for all users.
690      *
691      * Intended for use only when the activity itself is deleted.
692      *
693      * @global object
694      * @global object
695      * @param object $cm Activity
696      */
697     public function delete_all_state($cm) {
698         global $SESSION, $DB;
700         // Delete from database
701         $DB->delete_records('course_modules_completion', array('coursemoduleid'=>$cm->id));
703         // Erase cache data for current user if applicable
704         if (isset($SESSION->completioncache) &&
705             array_key_exists($cm->course, $SESSION->completioncache) &&
706             array_key_exists($cm->id, $SESSION->completioncache[$cm->course])) {
708             unset($SESSION->completioncache[$cm->course][$cm->id]);
709         }
711         // Check if there is an associated course completion criteria
712         $criteria = $this->get_criteria(COMPLETION_CRITERIA_TYPE_ACTIVITY);
713         $acriteria = false;
714         foreach ($criteria as $criterion) {
715             if ($criterion->moduleinstance == $cm->id) {
716                 $acriteria = $criterion;
717                 break;
718     }
719         }
721         if ($acriteria) {
722             // Delete all criteria completions relating to this activity
723             $DB->delete_records('course_completion_crit_compl', array('course' => $this->course_id, 'criteriaid' => $acriteria->id));
724             $DB->delete_records('course_completions', array('course' => $this->course_id));
725         }
726     }
728     /**
729      * Recalculates completion state related to an activity for all users.
730      *
731      * Intended for use if completion conditions change. (This should be avoided
732      * as it may cause some things to become incomplete when they were previously
733      * complete, with the effect - for example - of hiding a later activity that
734      * was previously available.)
735      *
736      * Resetting state of manual tickbox has same result as deleting state for
737      * it.
738      *
739      * @global object
740      * @uses COMPLETION_TRACKING_MANUAL
741      * @uses COMPLETION_UNKNOWN
742      * @param object $cm Activity
743      */
744     public function reset_all_state($cm) {
745         global $DB;
747         if ($cm->completion == COMPLETION_TRACKING_MANUAL) {
748             $this->delete_all_state($cm);
749             return;
750         }
751         // Get current list of users with completion state
752         $rs = $DB->get_recordset('course_modules_completion', array('coursemoduleid'=>$cm->id), '', 'userid');
753         $keepusers = array();
754         foreach ($rs as $rec) {
755             $keepusers[] = $rec->userid;
756         }
757         $rs->close();
759         // Delete all existing state [also clears session cache for current user]
760         $this->delete_all_state($cm);
762         // Merge this with list of planned users (according to roles)
763         $trackedusers = $this->get_tracked_users();
764         foreach ($trackedusers as $trackeduser) {
765             $keepusers[] = $trackeduser->id;
766         }
767         $keepusers = array_unique($keepusers);
769         // Recalculate state for each kept user
770         foreach ($keepusers as $keepuser) {
771             $this->update_state($cm, COMPLETION_UNKNOWN, $keepuser);
772         }
773     }
775     /**
776      * Obtains completion data for a particular activity and user (from the
777      * session cache if available, or by SQL query)
778      *
779      * @global object
780      * @global object
781      * @global object
782      * @global object
783      * @uses COMPLETION_CACHE_EXPIRY
784      * @param object $cm Activity; only required field is ->id
785      * @param bool $wholecourse If true (default false) then, when necessary to
786      *   fill the cache, retrieves information from the entire course not just for
787      *   this one activity
788      * @param int $userid User ID or 0 (default) for current user
789      * @param array $modinfo Supply the value here - this is used for unit
790      *   testing and so that it can be called recursively from within
791      *   get_fast_modinfo. (Needs only list of all CMs with IDs.)
792      *   Otherwise the method calls get_fast_modinfo itself.
793      * @return object Completion data (record from course_modules_completion)
794      */
795     public function get_data($cm, $wholecourse=false, $userid=0, $modinfo=null) {
796         global $USER, $CFG, $SESSION, $DB;
798         // Get user ID
799         if (!$userid) {
800             $userid = $USER->id;
801         }
803         // Is this the current user?
804         $currentuser = $userid==$USER->id;
806         if ($currentuser && is_object($SESSION)) {
807             // Make sure cache is present and is for current user (loginas
808             // changes this)
809             if (!isset($SESSION->completioncache) || $SESSION->completioncacheuserid!=$USER->id) {
810                 $SESSION->completioncache = array();
811                 $SESSION->completioncacheuserid = $USER->id;
812             }
813             // Expire any old data from cache
814             foreach ($SESSION->completioncache as $courseid=>$activities) {
815                 if (empty($activities['updated']) || $activities['updated'] < time()-COMPLETION_CACHE_EXPIRY) {
816                     unset($SESSION->completioncache[$courseid]);
817                 }
818             }
819             // See if requested data is present, if so use cache to get it
820             if (isset($SESSION->completioncache) &&
821                 array_key_exists($this->course->id, $SESSION->completioncache) &&
822                 array_key_exists($cm->id, $SESSION->completioncache[$this->course->id])) {
823                 return $SESSION->completioncache[$this->course->id][$cm->id];
824             }
825         }
827         // Not there, get via SQL
828         if ($currentuser && $wholecourse) {
829             // Get whole course data for cache
830             $alldatabycmc = $DB->get_records_sql("
831     SELECT
832         cmc.*
833     FROM
834         {course_modules} cm
835         INNER JOIN {course_modules_completion} cmc ON cmc.coursemoduleid=cm.id
836     WHERE
837         cm.course=? AND cmc.userid=?", array($this->course->id, $userid));
839             // Reindex by cm id
840             $alldata = array();
841             if ($alldatabycmc) {
842                 foreach ($alldatabycmc as $data) {
843                     $alldata[$data->coursemoduleid] = $data;
844                 }
845             }
847             // Get the module info and build up condition info for each one
848             if (empty($modinfo)) {
849                 $modinfo = get_fast_modinfo($this->course, $userid);
850             }
851             foreach ($modinfo->cms as $othercm) {
852                 if (array_key_exists($othercm->id, $alldata)) {
853                     $data = $alldata[$othercm->id];
854                 } else {
855                     // Row not present counts as 'not complete'
856                     $data = new StdClass;
857                     $data->id              = 0;
858                     $data->coursemoduleid  = $othercm->id;
859                     $data->userid          = $userid;
860                     $data->completionstate = 0;
861                     $data->viewed          = 0;
862                     $data->timemodified    = 0;
863                 }
864                 $SESSION->completioncache[$this->course->id][$othercm->id] = $data;
865             }
866             $SESSION->completioncache[$this->course->id]['updated'] = time();
868             if (!isset($SESSION->completioncache[$this->course->id][$cm->id])) {
869                 $this->internal_systemerror("Unexpected error: course-module {$cm->id} could not be found on course {$this->course->id}");
870             }
871             return $SESSION->completioncache[$this->course->id][$cm->id];
873         } else {
874             // Get single record
875             $data = $DB->get_record('course_modules_completion', array('coursemoduleid'=>$cm->id, 'userid'=>$userid));
876             if ($data == false) {
877                 // Row not present counts as 'not complete'
878                 $data = new StdClass;
879                 $data->id              = 0;
880                 $data->coursemoduleid  = $cm->id;
881                 $data->userid          = $userid;
882                 $data->completionstate = 0;
883                 $data->viewed          = 0;
884                 $data->timemodified    = 0;
885             }
887             // Put in cache
888             if ($currentuser) {
889                 $SESSION->completioncache[$this->course->id][$cm->id] = $data;
890                 // For single updates, only set date if it was empty before
891                 if (empty($SESSION->completioncache[$this->course->id]['updated'])) {
892                     $SESSION->completioncache[$this->course->id]['updated'] = time();
893                 }
894             }
895         }
897         return $data;
898     }
900     /**
901      * Updates completion data for a particular coursemodule and user (user is
902      * determined from $data).
903      *
904      * (Internal function. Not private, so we can unit-test it.)
905      *
906      * @global object
907      * @global object
908      * @global object
909      * @param object $cm Activity
910      * @param object $data Data about completion for that user
911      */
912     function internal_set_data($cm, $data) {
913         global $USER, $SESSION, $DB;
915         if ($data->id) {
916             // Has real (nonzero) id meaning that a database row exists
917             $DB->update_record('course_modules_completion', $data);
918         } else {
919             // Didn't exist before, needs creating
920             $data->id = $DB->insert_record('course_modules_completion', $data);
921         }
923         if ($data->userid == $USER->id) {
924             $SESSION->completioncache[$cm->course][$cm->id] = $data;
925         }
926     }
928     /**
929      * Obtains a list of activities for which completion is enabled on the
930      * course. The list is ordered by the section order of those activities.
931      *
932      * @global object
933      * @uses COMPLETION_TRACKING_NONE
934      * @param array $modinfo For unit testing only, supply the value
935      *   here. Otherwise the method calls get_fast_modinfo
936      * @return array Array from $cmid => $cm of all activities with completion enabled,
937      *   empty array if none
938      */
939     public function get_activities($modinfo=null) {
940         global $DB;
942         // Obtain those activities which have completion turned on
943         $withcompletion = $DB->get_records_select('course_modules', 'course='.$this->course->id.
944           ' AND completion<>'.COMPLETION_TRACKING_NONE);
945         if (!$withcompletion) {
946             return array();
947         }
949         // Use modinfo to get section order and also add in names
950         if (empty($modinfo)) {
951             $modinfo = get_fast_modinfo($this->course);
952         }
953         $result = array();
954         foreach ($modinfo->sections as $sectioncms) {
955             foreach ($sectioncms as $cmid) {
956                 if (array_key_exists($cmid, $withcompletion)) {
957                     $result[$cmid] = $withcompletion[$cmid];
958                     $result[$cmid]->modname = $modinfo->cms[$cmid]->modname;
959                     $result[$cmid]->name    = $modinfo->cms[$cmid]->name;
960                 }
961             }
962         }
964         return $result;
965     }
968     /**
969      * Checks to see if the userid supplied has a tracked role in
970      * this course
971      *
972      * @param   $userid     User id
973      * @return  bool
974      */
975     function is_tracked_user($userid) {
976         global $DB;
978         $tracked = $this->generate_tracked_user_sql();
980         $sql  = "SELECT u.id ";
981         $sql .= $tracked->sql;
982         $sql .= ' AND u.id = :user';
984         $params = $tracked->data;
985         $params['user'] = (int)$userid;
986         return $DB->record_exists_sql($sql, $params);
987     }
990     /**
991      * Return number of users whose progress is tracked in this course
992      *
993      * Optionally supply a search's where clause, or a group id
994      *
995      * @param   string  $where          Where clause sql
996      * @param   array   $where_params   Where clause params
997      * @param   int     $groupid    Group id
998      * @return  int
999      */
1000     function get_num_tracked_users($where = '', $where_params = array(), $groupid = 0) {
1001         global $DB;
1003         $tracked = $this->generate_tracked_user_sql($groupid);
1005         $sql  = "SELECT COUNT(u.id) ";
1006         $sql .= $tracked->sql;
1008         if ($where) {
1009             $sql .= " AND $where";
1010         }
1012         $params = array_merge($tracked->data, $where_params);
1013         return $DB->count_records_sql($sql, $params);
1014     }
1017     /**
1018      * Return array of users whose progress is tracked in this course
1019      *
1020      * Optionally supply a search's where caluse, group id, sorting, paging
1021      *
1022      * @param   string      $where          Where clause sql (optional)
1023      * @param   array       $where_params   Where clause params (optional)
1024      * @param   integer     $groupid    Group ID to restrict to (optional)
1025      * @param   string      $sort       Order by clause (optional)
1026      * @param   integer     $limitfrom  Result start (optional)
1027      * @param   integer     $limitnum   Result max size (optional)
1028      * @return  array
1029      */
1030     function get_tracked_users($where = '', $where_params = array(), $groupid = 0,
1031              $sort = '', $limitfrom = '', $limitnum = '') {
1033         global $DB;
1035         $tracked = $this->generate_tracked_user_sql($groupid);
1036         $params = $tracked->data;
1038         $sql = "
1039             SELECT
1040                 u.id,
1041                 u.firstname,
1042                 u.lastname,
1043                 u.idnumber
1044         ";
1046         $sql .= $tracked->sql;
1048         if ($where) {
1049             $sql .= " AND $where";
1050             $params = array_merge($params, $where_params);
1051         }
1053         if ($sort) {
1054             $sql .= " ORDER BY $sort";
1055         }
1057         $users = $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
1058         return $users ? $users : array(); // In case it returns false
1059     }
1062     /**
1063      * Generate the SQL for finding tracked users in this course
1064      *
1065      * Returns an object containing the sql fragment and an array of
1066      * bound data params.
1067      *
1068      * @param   integer $groupid
1069      * @return  object
1070      */
1071     function generate_tracked_user_sql($groupid = 0) {
1072         global $CFG;
1074         $return = new stdClass();
1075         $return->sql = '';
1076         $return->data = array();
1078         if (!empty($CFG->progresstrackedroles)) {
1079             $roles = ' AND ra.roleid IN ('.$CFG->progresstrackedroles.')';
1080         } else {
1081             // This causes it to default to everyone (if there is no student role)
1082             $roles = '';
1083         }
1085         // Build context sql
1086         $context = get_context_instance(CONTEXT_COURSE, $this->course->id);
1087         $parentcontexts = substr($context->path, 1); // kill leading slash
1088         $parentcontexts = str_replace('/', ',', $parentcontexts);
1089         if ($parentcontexts !== '') {
1090             $parentcontexts = ' OR ra.contextid IN ('.$parentcontexts.' )';
1091         }
1093         $groupjoin   = '';
1094         $groupselect = '';
1095         if ($groupid) {
1096             $groupjoin   = "JOIN {groups_members} gm
1097                               ON gm.userid = u.id";
1098             $groupselect = " AND gm.groupid = :groupid ";
1099             
1100             $return->data['groupid'] = $groupid;
1101         }
1103         $return->sql = "
1104             FROM
1105                 {user} u
1106             INNER JOIN
1107                 {role_assignments} ra
1108              ON ra.userid = u.id
1109             INNER JOIN
1110                 {role} r
1111              ON r.id = ra.roleid
1112             INNER JOIN
1113                 {user_enrolments} ue
1114              ON ue.userid = u.id
1115             INNER JOIN
1116                 {enrol} e
1117              ON e.id = ue.enrolid
1118             INNER JOIN
1119                 {course} c
1120              ON c.id = e.courseid
1121             $groupjoin
1122             WHERE
1123                 (ra.contextid = :contextid $parentcontexts)
1124             AND c.id = :courseid
1125             AND ue.status = 0
1126             AND e.status = 0
1127             AND ue.timestart < :now1
1128             AND (ue.timeend > :now2 OR ue.timeend = 0)
1129                 $groupselect
1130                 $roles
1131         ";
1133         $now = time();
1134         $return->data['now1'] = $now;
1135         $return->data['now2'] = $now;
1136         $return->data['contextid'] = $context->id;
1137         $return->data['courseid'] = $this->course->id;
1139         return $return;
1140     }
1142     /**
1143      * Obtains progress information across a course for all users on that course, or
1144      * for all users in a specific group. Intended for use when displaying progress.
1145      *
1146      * This includes only users who, in course context, have one of the roles for
1147      * which progress is tracked (the progresstrackedroles admin option).
1148      *
1149      * Users are included (in the first array) even if they do not have
1150      * completion progress for any course-module.
1151      *
1152      * @global object
1153      * @global object
1154      * @param bool $sortfirstname If true, sort by first name, otherwise sort by
1155      *   last name
1156      * @param string $where Where clause sql (optional)
1157      * @param array $where_params Where clause params (optional)
1158      * @param int $groupid Group ID or 0 (default)/false for all groups
1159      * @param int $pagesize Number of users to actually return (optional)
1160      * @param int $start User to start at if paging (optional)
1161      * @return Object with ->total and ->start (same as $start) and ->users;
1162      *   an array of user objects (like mdl_user id, firstname, lastname)
1163      *   containing an additional ->progress array of coursemoduleid => completionstate
1164      */
1165     public function get_progress_all($where = '', $where_params = array(), $groupid = 0,
1166                                        $sort = '', $pagesize = '', $start = '') {
1167         global $CFG, $DB;
1169         // Get list of applicable users
1170         $users = $this->get_tracked_users($where, $where_params, $groupid, $sort, $start, $pagesize);
1172         // Get progress information for these users in groups of 1, 000 (if needed)
1173         // to avoid making the SQL IN too long
1174         $results = array();
1175         $userids = array();
1176         foreach ($users as $user) {
1177             $userids[] = $user->id;
1178             $results[$user->id] = $user;
1179             $results[$user->id]->progress = array();
1180         }
1182         for($i=0; $i<count($userids); $i+=1000) {
1183             $blocksize = count($userids)-$i < 1000 ? count($userids)-$i : 1000;
1185             list($insql, $params) = $DB->get_in_or_equal(array_slice($userids, $i, $blocksize));
1186             array_splice($params, 0, 0, array($this->course->id));
1187             $rs = $DB->get_recordset_sql("
1188                 SELECT
1189                     cmc.*
1190                 FROM
1191                     {course_modules} cm
1192                     INNER JOIN {course_modules_completion} cmc ON cm.id=cmc.coursemoduleid
1193                 WHERE
1194                     cm.course=? AND cmc.userid $insql
1195     ", $params);
1196             foreach ($rs as $progress) {
1197                 $progress = (object)$progress;
1198                 $results[$progress->userid]->progress[$progress->coursemoduleid] = $progress;
1199             }
1200             $rs->close();
1201         }
1203         return $results;
1204     }
1206     /**
1207      * Called by grade code to inform the completion system when a grade has
1208      * been changed. If the changed grade is used to determine completion for
1209      * the course-module, then the completion status will be updated.
1210      *
1211      * @uses COMPLETION_TRACKING_MANUAL
1212      * @uses COMPLETION_INCOMPLETE
1213      * @param object $cm Course-module for item that owns grade
1214      * @param grade_item $item Grade item
1215      * @param object $grade
1216      * @param bool $deleted
1217      * @return void
1218      */
1219     public function inform_grade_changed($cm, $item, $grade, $deleted) {
1220         // Bail out now if completion is not enabled for course-module, it is enabled
1221         // but is set to manual, grade is not used to compute completion, or this
1222         // is a different numbered grade
1223         if (!$this->is_enabled($cm) ||
1224             $cm->completion == COMPLETION_TRACKING_MANUAL ||
1225             is_null($cm->completiongradeitemnumber) ||
1226             $item->itemnumber != $cm->completiongradeitemnumber) {
1227             return;
1228         }
1230         // What is the expected result based on this grade?
1231         if ($deleted) {
1232             // Grade being deleted, so only change could be to make it incomplete
1233             $possibleresult = COMPLETION_INCOMPLETE;
1234         } else {
1235             $possibleresult = $this->internal_get_grade_state($item, $grade);
1236         }
1237         
1238         // OK, let's update state based on this
1239         $this->update_state($cm, $possibleresult, $grade->userid);
1240     }
1242     /**
1243      * Calculates the completion state that would result from a graded item
1244      * (where grade-based completion is turned on) based on the actual grade
1245      * and settings.
1246      *
1247      * Internal function. Not private, so we can unit-test it.
1248      *
1249      * @uses COMPLETION_INCOMPLETE
1250      * @uses COMPLETION_COMPLETE_PASS
1251      * @uses COMPLETION_COMPLETE_FAIL
1252      * @uses COMPLETION_COMPLETE
1253      * @param object $item grade_item
1254      * @param object $grade grade_grade
1255      * @return int Completion state e.g. COMPLETION_INCOMPLETE
1256      */
1257     function internal_get_grade_state($item, $grade) {
1258         if (!$grade) {
1259             return COMPLETION_INCOMPLETE;
1260         }
1261         // Conditions to show pass/fail:
1262         // a) Grade has pass mark (default is 0.00000 which is boolean true so be careful)
1263         // b) Grade is visible (neither hidden nor hidden-until)
1264         if ($item->gradepass && $item->gradepass > 0.000009 && !$item->hidden) {
1265             // Use final grade if set otherwise raw grade
1266             $score = !is_null($grade->finalgrade) ? $grade->finalgrade : $grade->rawgrade;
1268             // We are displaying and tracking pass/fail
1269             if ($score >= $item->gradepass) {
1270                 return COMPLETION_COMPLETE_PASS;
1271             } else {
1272                 return COMPLETION_COMPLETE_FAIL;
1273             }
1274         } else {
1275             // Not displaying pass/fail, so just if there is a grade
1276             if (!is_null($grade->finalgrade) || !is_null($grade->rawgrade)) {
1277                 // Grade exists, so maybe complete now
1278                 return COMPLETION_COMPLETE;
1279             } else {
1280                 // Grade does not exist, so maybe incomplete now
1281                 return COMPLETION_INCOMPLETE;
1282             }
1283         }
1284     }
1286     /**
1287      * This is to be used only for system errors (things that shouldn't happen)
1288      * and not user-level errors.
1289      *
1290      * @global object
1291      * @param string $error Error string (will not be displayed to user unless
1292      *   debugging is enabled)
1293      * @return void Throws moodle_exception Exception with the error string as debug info
1294      */
1295     function internal_systemerror($error) {
1296         global $CFG;
1297         throw new moodle_exception('err_system','completion',
1298             $CFG->wwwroot.'/course/view.php?id='.$this->course->id,null,$error);
1299     }
1301     /**
1302      * For testing only. Wipes information cached in user session.
1303      *
1304      * @global object
1305      */
1306     static function wipe_session_cache() {
1307         global $SESSION;
1308         unset($SESSION->completioncache);
1309         unset($SESSION->completioncacheuserid);
1310     }