lib/completionlib.php

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