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