lib/completionlib.php

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