6fc05cfe434e43641395a4834c329b3ce1e5e208
[moodle.git] / lib / grade / grade_item.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/>.
17 /**
18  * Definition of a class to represent a grade item
19  *
20  * @package   core_grades
21  * @category  grade
22  * @copyright 2006 Nicolas Connault
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
27 require_once('grade_object.php');
29 /**
30  * Class representing a grade item.
31  *
32  * It is responsible for handling its DB representation, modifying and returning its metadata.
33  *
34  * @package   core_grades
35  * @category  grade
36  * @copyright 2006 Nicolas Connault
37  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class grade_item extends grade_object {
40     /**
41      * DB Table (used by grade_object).
42      * @var string $table
43      */
44     public $table = 'grade_items';
46     /**
47      * Array of required table fields, must start with 'id'.
48      * @var array $required_fields
49      */
50     public $required_fields = array('id', 'courseid', 'categoryid', 'itemname', 'itemtype', 'itemmodule', 'iteminstance',
51                                  'itemnumber', 'iteminfo', 'idnumber', 'calculation', 'gradetype', 'grademax', 'grademin',
52                                  'scaleid', 'outcomeid', 'gradepass', 'multfactor', 'plusfactor', 'aggregationcoef',
53                                  'aggregationcoef2', 'sortorder', 'display', 'decimals', 'hidden', 'locked', 'locktime',
54                                  'needsupdate', 'weightoverride', 'timecreated', 'timemodified');
56     /**
57      * The course this grade_item belongs to.
58      * @var int $courseid
59      */
60     public $courseid;
62     /**
63      * The category this grade_item belongs to (optional).
64      * @var int $categoryid
65      */
66     public $categoryid;
68     /**
69      * The grade_category object referenced $this->iteminstance if itemtype == 'category' or == 'course'.
70      * @var grade_category $item_category
71      */
72     public $item_category;
74     /**
75      * The grade_category object referenced by $this->categoryid.
76      * @var grade_category $parent_category
77      */
78     public $parent_category;
81     /**
82      * The name of this grade_item (pushed by the module).
83      * @var string $itemname
84      */
85     public $itemname;
87     /**
88      * e.g. 'category', 'course' and 'mod', 'blocks', 'import', etc...
89      * @var string $itemtype
90      */
91     public $itemtype;
93     /**
94      * The module pushing this grade (e.g. 'forum', 'quiz', 'assignment' etc).
95      * @var string $itemmodule
96      */
97     public $itemmodule;
99     /**
100      * ID of the item module
101      * @var int $iteminstance
102      */
103     public $iteminstance;
105     /**
106      * Number of the item in a series of multiple grades pushed by an activity.
107      * @var int $itemnumber
108      */
109     public $itemnumber;
111     /**
112      * Info and notes about this item.
113      * @var string $iteminfo
114      */
115     public $iteminfo;
117     /**
118      * Arbitrary idnumber provided by the module responsible.
119      * @var string $idnumber
120      */
121     public $idnumber;
123     /**
124      * Calculation string used for this item.
125      * @var string $calculation
126      */
127     public $calculation;
129     /**
130      * Indicates if we already tried to normalize the grade calculation formula.
131      * This flag helps to minimize db access when broken formulas used in calculation.
132      * @var bool
133      */
134     public $calculation_normalized;
135     /**
136      * Math evaluation object
137      * @var calc_formula A formula object
138      */
139     public $formula;
141     /**
142      * The type of grade (0 = none, 1 = value, 2 = scale, 3 = text)
143      * @var int $gradetype
144      */
145     public $gradetype = GRADE_TYPE_VALUE;
147     /**
148      * Maximum allowable grade.
149      * @var float $grademax
150      */
151     public $grademax = 100;
153     /**
154      * Minimum allowable grade.
155      * @var float $grademin
156      */
157     public $grademin = 0;
159     /**
160      * id of the scale, if this grade is based on a scale.
161      * @var int $scaleid
162      */
163     public $scaleid;
165     /**
166      * The grade_scale object referenced by $this->scaleid.
167      * @var grade_scale $scale
168      */
169     public $scale;
171     /**
172      * The id of the optional grade_outcome associated with this grade_item.
173      * @var int $outcomeid
174      */
175     public $outcomeid;
177     /**
178      * The grade_outcome this grade is associated with, if applicable.
179      * @var grade_outcome $outcome
180      */
181     public $outcome;
183     /**
184      * grade required to pass. (grademin <= gradepass <= grademax)
185      * @var float $gradepass
186      */
187     public $gradepass = 0;
189     /**
190      * Multiply all grades by this number.
191      * @var float $multfactor
192      */
193     public $multfactor = 1.0;
195     /**
196      * Add this to all grades.
197      * @var float $plusfactor
198      */
199     public $plusfactor = 0;
201     /**
202      * Aggregation coeficient used for weighted averages or extra credit
203      * @var float $aggregationcoef
204      */
205     public $aggregationcoef = 0;
207     /**
208      * Aggregation coeficient used for weighted averages only
209      * @var float $aggregationcoef2
210      */
211     public $aggregationcoef2 = 0;
213     /**
214      * Sorting order of the columns.
215      * @var int $sortorder
216      */
217     public $sortorder = 0;
219     /**
220      * Display type of the grades (Real, Percentage, Letter, or default).
221      * @var int $display
222      */
223     public $display = GRADE_DISPLAY_TYPE_DEFAULT;
225     /**
226      * The number of digits after the decimal point symbol. Applies only to REAL and PERCENTAGE grade display types.
227      * @var int $decimals
228      */
229     public $decimals = null;
231     /**
232      * Grade item lock flag. Empty if not locked, locked if any value present, usually date when item was locked. Locking prevents updating.
233      * @var int $locked
234      */
235     public $locked = 0;
237     /**
238      * Date after which the grade will be locked. Empty means no automatic locking.
239      * @var int $locktime
240      */
241     public $locktime = 0;
243     /**
244      * If set, the whole column will be recalculated, then this flag will be switched off.
245      * @var bool $needsupdate
246      */
247     public $needsupdate = 1;
249     /**
250      * If set, the grade item's weight has been overridden by a user and should not be automatically adjusted.
251      */
252     public $weightoverride = 0;
254     /**
255      * Cached dependson array
256      * @var array An array of cached grade item dependencies.
257      */
258     public $dependson_cache = null;
260     /**
261      * In addition to update() as defined in grade_object, handle the grade_outcome and grade_scale objects.
262      * Force regrading if necessary, rounds the float numbers using php function,
263      * the reason is we need to compare the db value with computed number to skip regrading if possible.
264      *
265      * @param string $source from where was the object inserted (mod/forum, manual, etc.)
266      * @return bool success
267      */
268     public function update($source=null) {
269         // reset caches
270         $this->dependson_cache = null;
272         // Retrieve scale and infer grademax/min from it if needed
273         $this->load_scale();
275         // make sure there is not 0 in outcomeid
276         if (empty($this->outcomeid)) {
277             $this->outcomeid = null;
278         }
280         if ($this->qualifies_for_regrading()) {
281             $this->force_regrading();
282         }
284         $this->timemodified = time();
286         $this->grademin        = grade_floatval($this->grademin);
287         $this->grademax        = grade_floatval($this->grademax);
288         $this->multfactor      = grade_floatval($this->multfactor);
289         $this->plusfactor      = grade_floatval($this->plusfactor);
290         $this->aggregationcoef = grade_floatval($this->aggregationcoef);
291         $this->aggregationcoef2 = grade_floatval($this->aggregationcoef2);
293         return parent::update($source);
294     }
296     /**
297      * Compares the values held by this object with those of the matching record in DB, and returns
298      * whether or not these differences are sufficient to justify an update of all parent objects.
299      * This assumes that this object has an id number and a matching record in DB. If not, it will return false.
300      *
301      * @return bool
302      */
303     public function qualifies_for_regrading() {
304         if (empty($this->id)) {
305             return false;
306         }
308         $db_item = new grade_item(array('id' => $this->id));
310         $calculationdiff = $db_item->calculation != $this->calculation;
311         $categorydiff    = $db_item->categoryid  != $this->categoryid;
312         $gradetypediff   = $db_item->gradetype   != $this->gradetype;
313         $scaleiddiff     = $db_item->scaleid     != $this->scaleid;
314         $outcomeiddiff   = $db_item->outcomeid   != $this->outcomeid;
315         $locktimediff    = $db_item->locktime    != $this->locktime;
316         $grademindiff    = grade_floats_different($db_item->grademin,        $this->grademin);
317         $grademaxdiff    = grade_floats_different($db_item->grademax,        $this->grademax);
318         $multfactordiff  = grade_floats_different($db_item->multfactor,      $this->multfactor);
319         $plusfactordiff  = grade_floats_different($db_item->plusfactor,      $this->plusfactor);
320         $acoefdiff       = grade_floats_different($db_item->aggregationcoef, $this->aggregationcoef);
321         $acoefdiff2      = grade_floats_different($db_item->aggregationcoef2, $this->aggregationcoef2);
322         $weightoverride  = grade_floats_different($db_item->weightoverride, $this->weightoverride);
324         $needsupdatediff = !$db_item->needsupdate &&  $this->needsupdate;    // force regrading only if setting the flag first time
325         $lockeddiff      = !empty($db_item->locked) && empty($this->locked); // force regrading only when unlocking
327         return ($calculationdiff || $categorydiff || $gradetypediff || $grademaxdiff || $grademindiff || $scaleiddiff
328              || $outcomeiddiff || $multfactordiff || $plusfactordiff || $needsupdatediff
329              || $lockeddiff || $acoefdiff || $acoefdiff2 || $weightoverride || $locktimediff);
330     }
332     /**
333      * Finds and returns a grade_item instance based on params.
334      *
335      * @static
336      * @param array $params associative arrays varname=>value
337      * @return grade_item|bool Returns a grade_item instance or false if none found
338      */
339     public static function fetch($params) {
340         return grade_object::fetch_helper('grade_items', 'grade_item', $params);
341     }
343     /**
344      * Finds and returns all grade_item instances based on params.
345      *
346      * @static
347      * @param array $params associative arrays varname=>value
348      * @return array array of grade_item instances or false if none found.
349      */
350     public static function fetch_all($params) {
351         return grade_object::fetch_all_helper('grade_items', 'grade_item', $params);
352     }
354     /**
355      * Delete all grades and force_regrading of parent category.
356      *
357      * @param string $source from where was the object deleted (mod/forum, manual, etc.)
358      * @return bool success
359      */
360     public function delete($source=null) {
361         $this->delete_all_grades($source);
362         return parent::delete($source);
363     }
365     /**
366      * Delete all grades
367      *
368      * @param string $source from where was the object deleted (mod/forum, manual, etc.)
369      * @return bool
370      */
371     public function delete_all_grades($source=null) {
372         if (!$this->is_course_item()) {
373             $this->force_regrading();
374         }
376         if ($grades = grade_grade::fetch_all(array('itemid'=>$this->id))) {
377             foreach ($grades as $grade) {
378                 $grade->delete($source);
379             }
380         }
382         return true;
383     }
385     /**
386      * In addition to perform parent::insert(), calls force_regrading() method too.
387      *
388      * @param string $source From where was the object inserted (mod/forum, manual, etc.)
389      * @return int PK ID if successful, false otherwise
390      */
391     public function insert($source=null) {
392         global $CFG, $DB;
394         if (empty($this->courseid)) {
395             print_error('cannotinsertgrade');
396         }
398         // load scale if needed
399         $this->load_scale();
401         // add parent category if needed
402         if (empty($this->categoryid) and !$this->is_course_item() and !$this->is_category_item()) {
403             $course_category = grade_category::fetch_course_category($this->courseid);
404             $this->categoryid = $course_category->id;
406         }
408         // always place the new items at the end, move them after insert if needed
409         $last_sortorder = $DB->get_field_select('grade_items', 'MAX(sortorder)', "courseid = ?", array($this->courseid));
410         if (!empty($last_sortorder)) {
411             $this->sortorder = $last_sortorder + 1;
412         } else {
413             $this->sortorder = 1;
414         }
416         // add proper item numbers to manual items
417         if ($this->itemtype == 'manual') {
418             if (empty($this->itemnumber)) {
419                 $this->itemnumber = 0;
420             }
421         }
423         // make sure there is not 0 in outcomeid
424         if (empty($this->outcomeid)) {
425             $this->outcomeid = null;
426         }
428         $this->timecreated = $this->timemodified = time();
430         if (parent::insert($source)) {
431             // force regrading of items if needed
432             $this->force_regrading();
433             return $this->id;
435         } else {
436             debugging("Could not insert this grade_item in the database!");
437             return false;
438         }
439     }
441     /**
442      * Set idnumber of grade item, updates also course_modules table
443      *
444      * @param string $idnumber (without magic quotes)
445      * @return bool success
446      */
447     public function add_idnumber($idnumber) {
448         global $DB;
449         if (!empty($this->idnumber)) {
450             return false;
451         }
453         if ($this->itemtype == 'mod' and !$this->is_outcome_item()) {
454             if ($this->itemnumber == 0) {
455                 // for activity modules, itemnumber 0 is synced with the course_modules
456                 if (!$cm = get_coursemodule_from_instance($this->itemmodule, $this->iteminstance, $this->courseid)) {
457                     return false;
458                 }
459                 if (!empty($cm->idnumber)) {
460                     return false;
461                 }
462                 $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
463                 $this->idnumber = $idnumber;
464                 return $this->update();
465             } else {
466                 $this->idnumber = $idnumber;
467                 return $this->update();
468             }
470         } else {
471             $this->idnumber = $idnumber;
472             return $this->update();
473         }
474     }
476     /**
477      * Returns the locked state of this grade_item (if the grade_item is locked OR no specific
478      * $userid is given) or the locked state of a specific grade within this item if a specific
479      * $userid is given and the grade_item is unlocked.
480      *
481      * @param int $userid The user's ID
482      * @return bool Locked state
483      */
484     public function is_locked($userid=NULL) {
485         if (!empty($this->locked)) {
486             return true;
487         }
489         if (!empty($userid)) {
490             if ($grade = grade_grade::fetch(array('itemid'=>$this->id, 'userid'=>$userid))) {
491                 $grade->grade_item =& $this; // prevent db fetching of cached grade_item
492                 return $grade->is_locked();
493             }
494         }
496         return false;
497     }
499     /**
500      * Locks or unlocks this grade_item and (optionally) all its associated final grades.
501      *
502      * @param int $lockedstate 0, 1 or a timestamp int(10) after which date the item will be locked.
503      * @param bool $cascade Lock/unlock child objects too
504      * @param bool $refresh Refresh grades when unlocking
505      * @return bool True if grade_item all grades updated, false if at least one update fails
506      */
507     public function set_locked($lockedstate, $cascade=false, $refresh=true) {
508         if ($lockedstate) {
509         /// setting lock
510             if ($this->needsupdate) {
511                 return false; // can not lock grade without first having final grade
512             }
514             $this->locked = time();
515             $this->update();
517             if ($cascade) {
518                 $grades = $this->get_final();
519                 foreach($grades as $g) {
520                     $grade = new grade_grade($g, false);
521                     $grade->grade_item =& $this;
522                     $grade->set_locked(1, null, false);
523                 }
524             }
526             return true;
528         } else {
529         /// removing lock
530             if (!empty($this->locked) and $this->locktime < time()) {
531                 //we have to reset locktime or else it would lock up again
532                 $this->locktime = 0;
533             }
535             $this->locked = 0;
536             $this->update();
538             if ($cascade) {
539                 if ($grades = grade_grade::fetch_all(array('itemid'=>$this->id))) {
540                     foreach($grades as $grade) {
541                         $grade->grade_item =& $this;
542                         $grade->set_locked(0, null, false);
543                     }
544                 }
545             }
547             if ($refresh) {
548                 //refresh when unlocking
549                 $this->refresh_grades();
550             }
552             return true;
553         }
554     }
556     /**
557      * Lock the grade if needed. Make sure this is called only when final grades are valid
558      */
559     public function check_locktime() {
560         if (!empty($this->locked)) {
561             return; // already locked
562         }
564         if ($this->locktime and $this->locktime < time()) {
565             $this->locked = time();
566             $this->update('locktime');
567         }
568     }
570     /**
571      * Set the locktime for this grade item.
572      *
573      * @param int $locktime timestamp for lock to activate
574      * @return void
575      */
576     public function set_locktime($locktime) {
577         $this->locktime = $locktime;
578         $this->update();
579     }
581     /**
582      * Set the locktime for this grade item.
583      *
584      * @return int $locktime timestamp for lock to activate
585      */
586     public function get_locktime() {
587         return $this->locktime;
588     }
590     /**
591      * Set the hidden status of grade_item and all grades.
592      *
593      * 0 mean always visible, 1 means always hidden and a number > 1 is a timestamp to hide until
594      *
595      * @param int $hidden new hidden status
596      * @param bool $cascade apply to child objects too
597      */
598     public function set_hidden($hidden, $cascade=false) {
599         parent::set_hidden($hidden, $cascade);
601         if ($cascade) {
602             if ($grades = grade_grade::fetch_all(array('itemid'=>$this->id))) {
603                 foreach($grades as $grade) {
604                     $grade->grade_item =& $this;
605                     $grade->set_hidden($hidden, $cascade);
606                 }
607             }
608         }
610         //if marking item visible make sure category is visible MDL-21367
611         if( !$hidden ) {
612             $category_array = grade_category::fetch_all(array('id'=>$this->categoryid));
613             if ($category_array && array_key_exists($this->categoryid, $category_array)) {
614                 $category = $category_array[$this->categoryid];
615                 //call set_hidden on the category regardless of whether it is hidden as its parent might be hidden
616                 //if($category->is_hidden()) {
617                     $category->set_hidden($hidden, false);
618                 //}
619             }
620         }
621     }
623     /**
624      * Returns the number of grades that are hidden
625      *
626      * @param string $groupsql SQL to limit the query by group
627      * @param array $params SQL params for $groupsql
628      * @param string $groupwheresql Where conditions for $groupsql
629      * @return int The number of hidden grades
630      */
631     public function has_hidden_grades($groupsql="", array $params=null, $groupwheresql="") {
632         global $DB;
633         $params = (array)$params;
634         $params['itemid'] = $this->id;
636         return $DB->get_field_sql("SELECT COUNT(*) FROM {grade_grades} g LEFT JOIN "
637                             ."{user} u ON g.userid = u.id $groupsql WHERE itemid = :itemid AND hidden = 1 $groupwheresql", $params);
638     }
640     /**
641      * Mark regrading as finished successfully.
642      */
643     public function regrading_finished() {
644         global $DB;
645         $this->needsupdate = 0;
646         //do not use $this->update() because we do not want this logged in grade_item_history
647         $DB->set_field('grade_items', 'needsupdate', 0, array('id' => $this->id));
648     }
650     /**
651      * Performs the necessary calculations on the grades_final referenced by this grade_item.
652      * Also resets the needsupdate flag once successfully performed.
653      *
654      * This function must be used ONLY from lib/gradeslib.php/grade_regrade_final_grades(),
655      * because the regrading must be done in correct order!!
656      *
657      * @param int $userid Supply a user ID to limit the regrading to a single user
658      * @return bool true if ok, error string otherwise
659      */
660     public function regrade_final_grades($userid=null) {
661         global $CFG, $DB;
663         // locked grade items already have correct final grades
664         if ($this->is_locked()) {
665             return true;
666         }
668         // calculation produces final value using formula from other final values
669         if ($this->is_calculated()) {
670             if ($this->compute($userid)) {
671                 return true;
672             } else {
673                 return "Could not calculate grades for grade item"; // TODO: improve and localize
674             }
676         // noncalculated outcomes already have final values - raw grades not used
677         } else if ($this->is_outcome_item()) {
678             return true;
680         // aggregate the category grade
681         } else if ($this->is_category_item() or $this->is_course_item()) {
682             // aggregate category grade item
683             $category = $this->get_item_category();
684             $category->grade_item =& $this;
685             if ($category->generate_grades($userid)) {
686                 return true;
687             } else {
688                 return "Could not aggregate final grades for category:".$this->id; // TODO: improve and localize
689             }
691         } else if ($this->is_manual_item()) {
692             // manual items track only final grades, no raw grades
693             return true;
695         } else if (!$this->is_raw_used()) {
696             // hmm - raw grades are not used- nothing to regrade
697             return true;
698         }
700         // normal grade item - just new final grades
701         $result = true;
702         $grade_inst = new grade_grade();
703         $fields = implode(',', $grade_inst->required_fields);
704         if ($userid) {
705             $params = array($this->id, $userid);
706             $rs = $DB->get_recordset_select('grade_grades', "itemid=? AND userid=?", $params, '', $fields);
707         } else {
708             $rs = $DB->get_recordset('grade_grades', array('itemid' => $this->id), '', $fields);
709         }
710         if ($rs) {
711             foreach ($rs as $grade_record) {
712                 $grade = new grade_grade($grade_record, false);
714                 if (!empty($grade_record->locked) or !empty($grade_record->overridden)) {
715                     // this grade is locked - final grade must be ok
716                     continue;
717                 }
719                 $grade->finalgrade = $this->adjust_raw_grade($grade->rawgrade, $grade->rawgrademin, $grade->rawgrademax);
721                 if (grade_floats_different($grade_record->finalgrade, $grade->finalgrade)) {
722                     if (!$grade->update('system')) {
723                         $result = "Internal error updating final grade";
724                     }
725                 }
726             }
727             $rs->close();
728         }
730         return $result;
731     }
733     /**
734      * Given a float grade value or integer grade scale, applies a number of adjustment based on
735      * grade_item variables and returns the result.
736      *
737      * @param float $rawgrade The raw grade value
738      * @param float $rawmin original rawmin
739      * @param float $rawmax original rawmax
740      * @return mixed
741      */
742     public function adjust_raw_grade($rawgrade, $rawmin, $rawmax) {
743         if (is_null($rawgrade)) {
744             return null;
745         }
747         if ($this->gradetype == GRADE_TYPE_VALUE) { // Dealing with numerical grade
749             if ($this->grademax < $this->grademin) {
750                 return null;
751             }
753             if ($this->grademax == $this->grademin) {
754                 return $this->grademax; // no range
755             }
757             // Standardise score to the new grade range
758             // NOTE: this is not compatible with current assignment grading
759             $isassignmentmodule = ($this->itemmodule == 'assignment') || ($this->itemmodule == 'assign');
760             if (!$isassignmentmodule && ($rawmin != $this->grademin or $rawmax != $this->grademax)) {
761                 $rawgrade = grade_grade::standardise_score($rawgrade, $rawmin, $rawmax, $this->grademin, $this->grademax);
762             }
764             // Apply other grade_item factors
765             $rawgrade *= $this->multfactor;
766             $rawgrade += $this->plusfactor;
768             return $this->bounded_grade($rawgrade);
770         } else if ($this->gradetype == GRADE_TYPE_SCALE) { // Dealing with a scale value
771             if (empty($this->scale)) {
772                 $this->load_scale();
773             }
775             if ($this->grademax < 0) {
776                 return null; // scale not present - no grade
777             }
779             if ($this->grademax == 0) {
780                 return $this->grademax; // only one option
781             }
783             // Convert scale if needed
784             // NOTE: this is not compatible with current assignment grading
785             if ($this->itemmodule != 'assignment' and ($rawmin != $this->grademin or $rawmax != $this->grademax)) {
786                 $rawgrade = grade_grade::standardise_score($rawgrade, $rawmin, $rawmax, $this->grademin, $this->grademax);
787             }
789             return $this->bounded_grade($rawgrade);
792         } else if ($this->gradetype == GRADE_TYPE_TEXT or $this->gradetype == GRADE_TYPE_NONE) { // no value
793             // somebody changed the grading type when grades already existed
794             return null;
796         } else {
797             debugging("Unknown grade type");
798             return null;
799         }
800     }
802     /**
803      * Sets this grade_item's needsupdate to true. Also marks the course item as needing update.
804      *
805      * @return void
806      */
807     public function force_regrading() {
808         global $DB;
809         $this->needsupdate = 1;
810         //mark this item and course item only - categories and calculated items are always regraded
811         $wheresql = "(itemtype='course' OR id=?) AND courseid=?";
812         $params   = array($this->id, $this->courseid);
813         $DB->set_field_select('grade_items', 'needsupdate', 1, $wheresql, $params);
814     }
816     /**
817      * Instantiates a grade_scale object from the DB if this item's scaleid variable is set
818      *
819      * @return grade_scale Returns a grade_scale object or null if no scale used
820      */
821     public function load_scale() {
822         if ($this->gradetype != GRADE_TYPE_SCALE) {
823             $this->scaleid = null;
824         }
826         if (!empty($this->scaleid)) {
827             //do not load scale if already present
828             if (empty($this->scale->id) or $this->scale->id != $this->scaleid) {
829                 $this->scale = grade_scale::fetch(array('id'=>$this->scaleid));
830                 if (!$this->scale) {
831                     debugging('Incorrect scale id: '.$this->scaleid);
832                     $this->scale = null;
833                     return null;
834                 }
835                 $this->scale->load_items();
836             }
838             // Until scales are uniformly set to min=0 max=count(scaleitems)-1 throughout Moodle, we
839             // stay with the current min=1 max=count(scaleitems)
840             $this->grademax = count($this->scale->scale_items);
841             $this->grademin = 1;
843         } else {
844             $this->scale = null;
845         }
847         return $this->scale;
848     }
850     /**
851      * Instantiates a grade_outcome object from the DB if this item's outcomeid variable is set
852      *
853      * @return grade_outcome This grade item's associated grade_outcome or null
854      */
855     public function load_outcome() {
856         if (!empty($this->outcomeid)) {
857             $this->outcome = grade_outcome::fetch(array('id'=>$this->outcomeid));
858         }
859         return $this->outcome;
860     }
862     /**
863      * Returns the grade_category object this grade_item belongs to (referenced by categoryid)
864      * or category attached to category item.
865      *
866      * @return grade_category|bool Returns a grade_category object if applicable or false if this is a course item
867      */
868     public function get_parent_category() {
869         if ($this->is_category_item() or $this->is_course_item()) {
870             return $this->get_item_category();
872         } else {
873             return grade_category::fetch(array('id'=>$this->categoryid));
874         }
875     }
877     /**
878      * Calls upon the get_parent_category method to retrieve the grade_category object
879      * from the DB and assigns it to $this->parent_category. It also returns the object.
880      *
881      * @return grade_category This grade item's parent grade_category.
882      */
883     public function load_parent_category() {
884         if (empty($this->parent_category->id)) {
885             $this->parent_category = $this->get_parent_category();
886         }
887         return $this->parent_category;
888     }
890     /**
891      * Returns the grade_category for a grade category grade item
892      *
893      * @return grade_category|bool Returns a grade_category instance if applicable or false otherwise
894      */
895     public function get_item_category() {
896         if (!$this->is_course_item() and !$this->is_category_item()) {
897             return false;
898         }
899         return grade_category::fetch(array('id'=>$this->iteminstance));
900     }
902     /**
903      * Calls upon the get_item_category method to retrieve the grade_category object
904      * from the DB and assigns it to $this->item_category. It also returns the object.
905      *
906      * @return grade_category
907      */
908     public function load_item_category() {
909         if (empty($this->item_category->id)) {
910             $this->item_category = $this->get_item_category();
911         }
912         return $this->item_category;
913     }
915     /**
916      * Is the grade item associated with category?
917      *
918      * @return bool
919      */
920     public function is_category_item() {
921         return ($this->itemtype == 'category');
922     }
924     /**
925      * Is the grade item associated with course?
926      *
927      * @return bool
928      */
929     public function is_course_item() {
930         return ($this->itemtype == 'course');
931     }
933     /**
934      * Is this a manually graded item?
935      *
936      * @return bool
937      */
938     public function is_manual_item() {
939         return ($this->itemtype == 'manual');
940     }
942     /**
943      * Is this an outcome item?
944      *
945      * @return bool
946      */
947     public function is_outcome_item() {
948         return !empty($this->outcomeid);
949     }
951     /**
952      * Is the grade item external - associated with module, plugin or something else?
953      *
954      * @return bool
955      */
956     public function is_external_item() {
957         return ($this->itemtype == 'mod');
958     }
960     /**
961      * Is the grade item overridable
962      *
963      * @return bool
964      */
965     public function is_overridable_item() {
966         if ($this->is_course_item() or $this->is_category_item()) {
967             $overridable = (bool) get_config('moodle', 'grade_overridecat');
968         } else {
969             $overridable = false;
970         }
972         return !$this->is_outcome_item() and ($this->is_external_item() or $this->is_calculated() or $overridable);
973     }
975     /**
976      * Is the grade item feedback overridable
977      *
978      * @return bool
979      */
980     public function is_overridable_item_feedback() {
981         return !$this->is_outcome_item() and $this->is_external_item();
982     }
984     /**
985      * Returns true if grade items uses raw grades
986      *
987      * @return bool
988      */
989     public function is_raw_used() {
990         return ($this->is_external_item() and !$this->is_calculated() and !$this->is_outcome_item());
991     }
993     /**
994      * Returns the grade item associated with the course
995      *
996      * @param int $courseid
997      * @return grade_item Course level grade item object
998      */
999     public static function fetch_course_item($courseid) {
1000         if ($course_item = grade_item::fetch(array('courseid'=>$courseid, 'itemtype'=>'course'))) {
1001             return $course_item;
1002         }
1004         // first get category - it creates the associated grade item
1005         $course_category = grade_category::fetch_course_category($courseid);
1006         return $course_category->get_grade_item();
1007     }
1009     /**
1010      * Is grading object editable?
1011      *
1012      * @return bool
1013      */
1014     public function is_editable() {
1015         return true;
1016     }
1018     /**
1019      * Checks if grade calculated. Returns this object's calculation.
1020      *
1021      * @return bool true if grade item calculated.
1022      */
1023     public function is_calculated() {
1024         if (empty($this->calculation)) {
1025             return false;
1026         }
1028         /*
1029          * The main reason why we use the ##gixxx## instead of [[idnumber]] is speed of depends_on(),
1030          * we would have to fetch all course grade items to find out the ids.
1031          * Also if user changes the idnumber the formula does not need to be updated.
1032          */
1034         // first detect if we need to change calculation formula from [[idnumber]] to ##giXXX## (after backup, etc.)
1035         if (!$this->calculation_normalized and strpos($this->calculation, '[[') !== false) {
1036             $this->set_calculation($this->calculation);
1037         }
1039         return !empty($this->calculation);
1040     }
1042     /**
1043      * Returns calculation string if grade calculated.
1044      *
1045      * @return string Returns the grade item's calculation if calculation is used, null if not
1046      */
1047     public function get_calculation() {
1048         if ($this->is_calculated()) {
1049             return grade_item::denormalize_formula($this->calculation, $this->courseid);
1051         } else {
1052             return NULL;
1053         }
1054     }
1056     /**
1057      * Sets this item's calculation (creates it) if not yet set, or
1058      * updates it if already set (in the DB). If no calculation is given,
1059      * the calculation is removed.
1060      *
1061      * @param string $formula string representation of formula used for calculation
1062      * @return bool success
1063      */
1064     public function set_calculation($formula) {
1065         $this->calculation = grade_item::normalize_formula($formula, $this->courseid);
1066         $this->calculation_normalized = true;
1067         return $this->update();
1068     }
1070     /**
1071      * Denormalizes the calculation formula to [idnumber] form
1072      *
1073      * @param string $formula A string representation of the formula
1074      * @param int $courseid The course ID
1075      * @return string The denormalized formula as a string
1076      */
1077     public static function denormalize_formula($formula, $courseid) {
1078         if (empty($formula)) {
1079             return '';
1080         }
1082         // denormalize formula - convert ##giXX## to [[idnumber]]
1083         if (preg_match_all('/##gi(\d+)##/', $formula, $matches)) {
1084             foreach ($matches[1] as $id) {
1085                 if ($grade_item = grade_item::fetch(array('id'=>$id, 'courseid'=>$courseid))) {
1086                     if (!empty($grade_item->idnumber)) {
1087                         $formula = str_replace('##gi'.$grade_item->id.'##', '[['.$grade_item->idnumber.']]', $formula);
1088                     }
1089                 }
1090             }
1091         }
1093         return $formula;
1095     }
1097     /**
1098      * Normalizes the calculation formula to [#giXX#] form
1099      *
1100      * @param string $formula The formula
1101      * @param int $courseid The course ID
1102      * @return string The normalized formula as a string
1103      */
1104     public static function normalize_formula($formula, $courseid) {
1105         $formula = trim($formula);
1107         if (empty($formula)) {
1108             return NULL;
1110         }
1112         // normalize formula - we want grade item ids ##giXXX## instead of [[idnumber]]
1113         if ($grade_items = grade_item::fetch_all(array('courseid'=>$courseid))) {
1114             foreach ($grade_items as $grade_item) {
1115                 $formula = str_replace('[['.$grade_item->idnumber.']]', '##gi'.$grade_item->id.'##', $formula);
1116             }
1117         }
1119         return $formula;
1120     }
1122     /**
1123      * Returns the final values for this grade item (as imported by module or other source).
1124      *
1125      * @param int $userid Optional: to retrieve a single user's final grade
1126      * @return array|grade_grade An array of all grade_grade instances for this grade_item, or a single grade_grade instance.
1127      */
1128     public function get_final($userid=NULL) {
1129         global $DB;
1130         if ($userid) {
1131             if ($user = $DB->get_record('grade_grades', array('itemid' => $this->id, 'userid' => $userid))) {
1132                 return $user;
1133             }
1135         } else {
1136             if ($grades = $DB->get_records('grade_grades', array('itemid' => $this->id))) {
1137                 //TODO: speed up with better SQL (MDL-31380)
1138                 $result = array();
1139                 foreach ($grades as $grade) {
1140                     $result[$grade->userid] = $grade;
1141                 }
1142                 return $result;
1143             } else {
1144                 return array();
1145             }
1146         }
1147     }
1149     /**
1150      * Get (or create if not exist yet) grade for this user
1151      *
1152      * @param int $userid The user ID
1153      * @param bool $create If true and the user has no grade for this grade item a new grade_grade instance will be inserted
1154      * @return grade_grade The grade_grade instance for the user for this grade item
1155      */
1156     public function get_grade($userid, $create=true) {
1157         if (empty($this->id)) {
1158             debugging('Can not use before insert');
1159             return false;
1160         }
1162         $grade = new grade_grade(array('userid'=>$userid, 'itemid'=>$this->id));
1163         if (empty($grade->id) and $create) {
1164             $grade->insert();
1165         }
1167         return $grade;
1168     }
1170     /**
1171      * Returns the sortorder of this grade_item. This method is also available in
1172      * grade_category, for cases where the object type is not know.
1173      *
1174      * @return int Sort order
1175      */
1176     public function get_sortorder() {
1177         return $this->sortorder;
1178     }
1180     /**
1181      * Returns the idnumber of this grade_item. This method is also available in
1182      * grade_category, for cases where the object type is not know.
1183      *
1184      * @return string The grade item idnumber
1185      */
1186     public function get_idnumber() {
1187         return $this->idnumber;
1188     }
1190     /**
1191      * Returns this grade_item. This method is also available in
1192      * grade_category, for cases where the object type is not know.
1193      *
1194      * @return grade_item
1195      */
1196     public function get_grade_item() {
1197         return $this;
1198     }
1200     /**
1201      * Sets the sortorder of this grade_item. This method is also available in
1202      * grade_category, for cases where the object type is not know.
1203      *
1204      * @param int $sortorder
1205      */
1206     public function set_sortorder($sortorder) {
1207         if ($this->sortorder == $sortorder) {
1208             return;
1209         }
1210         $this->sortorder = $sortorder;
1211         $this->update();
1212     }
1214     /**
1215      * Update this grade item's sortorder so that it will appear after $sortorder
1216      *
1217      * @param int $sortorder The sort order to place this grade item after
1218      */
1219     public function move_after_sortorder($sortorder) {
1220         global $CFG, $DB;
1222         //make some room first
1223         $params = array($sortorder, $this->courseid);
1224         $sql = "UPDATE {grade_items}
1225                    SET sortorder = sortorder + 1
1226                  WHERE sortorder > ? AND courseid = ?";
1227         $DB->execute($sql, $params);
1229         $this->set_sortorder($sortorder + 1);
1230     }
1232     /**
1233      * Detect duplicate grade item's sortorder and re-sort them.
1234      * Note: Duplicate sortorder will be introduced while duplicating activities or
1235      * merging two courses.
1236      *
1237      * @param int $courseid id of the course for which grade_items sortorder need to be fixed.
1238      */
1239     public static function fix_duplicate_sortorder($courseid) {
1240         global $DB;
1242         $transaction = $DB->start_delegated_transaction();
1244         $sql = "SELECT DISTINCT g1.id, g1.courseid, g1.sortorder
1245                     FROM {grade_items} g1
1246                     JOIN {grade_items} g2 ON g1.courseid = g2.courseid
1247                 WHERE g1.sortorder = g2.sortorder AND g1.id != g2.id AND g1.courseid = :courseid
1248                 ORDER BY g1.sortorder DESC, g1.id DESC";
1250         // Get all duplicates in course highest sort order, and higest id first so that we can make space at the
1251         // bottom higher end of the sort orders and work down by id.
1252         $rs = $DB->get_recordset_sql($sql, array('courseid' => $courseid));
1254         foreach($rs as $duplicate) {
1255             $DB->execute("UPDATE {grade_items}
1256                             SET sortorder = sortorder + 1
1257                           WHERE courseid = :courseid AND
1258                           (sortorder > :sortorder OR (sortorder = :sortorder2 AND id > :id))",
1259                 array('courseid' => $duplicate->courseid,
1260                     'sortorder' => $duplicate->sortorder,
1261                     'sortorder2' => $duplicate->sortorder,
1262                     'id' => $duplicate->id));
1263         }
1264         $rs->close();
1265         $transaction->allow_commit();
1266     }
1268     /**
1269      * Returns the most descriptive field for this object.
1270      *
1271      * Determines what type of grade item it is then returns the appropriate string
1272      *
1273      * @param bool $fulltotal If the item is a category total, returns $categoryname."total" instead of "Category total" or "Course total"
1274      * @return string name
1275      */
1276     public function get_name($fulltotal=false) {
1277         if (!empty($this->itemname)) {
1278             // MDL-10557
1279             return format_string($this->itemname);
1281         } else if ($this->is_course_item()) {
1282             return get_string('coursetotal', 'grades');
1284         } else if ($this->is_category_item()) {
1285             if ($fulltotal) {
1286                 $category = $this->load_parent_category();
1287                 $a = new stdClass();
1288                 $a->category = $category->get_name();
1289                 return get_string('categorytotalfull', 'grades', $a);
1290             } else {
1291             return get_string('categorytotal', 'grades');
1292             }
1294         } else {
1295             return get_string('grade');
1296         }
1297     }
1299     /**
1300      * A grade item can return a more detailed description which will be added to the header of the column/row in some reports.
1301      *
1302      * @return string description
1303      */
1304     public function get_description() {
1305         if ($this->is_course_item() || $this->is_category_item()) {
1306             $categoryitem = $this->load_item_category();
1307             return $categoryitem->get_description();
1308         }
1309         return '';
1310     }
1312     /**
1313      * Sets this item's categoryid. A generic method shared by objects that have a parent id of some kind.
1314      *
1315      * @param int $parentid The ID of the new parent
1316      * @return bool True if success
1317      */
1318     public function set_parent($parentid) {
1319         if ($this->is_course_item() or $this->is_category_item()) {
1320             print_error('cannotsetparentforcatoritem');
1321         }
1323         if ($this->categoryid == $parentid) {
1324             return true;
1325         }
1327         // find parent and check course id
1328         if (!$parent_category = grade_category::fetch(array('id'=>$parentid, 'courseid'=>$this->courseid))) {
1329             return false;
1330         }
1332         // MDL-19407 If moving from a non-SWM category to a SWM category, convert aggregationcoef to 0
1333         $currentparent = $this->load_parent_category();
1335         if ($currentparent->aggregation != GRADE_AGGREGATE_WEIGHTED_MEAN2 && $parent_category->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2) {
1336             $this->aggregationcoef = 0;
1337         }
1339         $this->force_regrading();
1341         // set new parent
1342         $this->categoryid = $parent_category->id;
1343         $this->parent_category =& $parent_category;
1345         return $this->update();
1346     }
1348     /**
1349      * Makes sure value is a valid grade value.
1350      *
1351      * @param float $gradevalue
1352      * @return mixed float or int fixed grade value
1353      */
1354     public function bounded_grade($gradevalue) {
1355         global $CFG;
1357         if (is_null($gradevalue)) {
1358             return null;
1359         }
1361         if ($this->gradetype == GRADE_TYPE_SCALE) {
1362             // no >100% grades hack for scale grades!
1363             // 1.5 is rounded to 2 ;-)
1364             return (int)bounded_number($this->grademin, round($gradevalue+0.00001), $this->grademax);
1365         }
1367         $grademax = $this->grademax;
1369         // NOTE: if you change this value you must manually reset the needsupdate flag in all grade items
1370         $maxcoef = isset($CFG->gradeoverhundredprocentmax) ? $CFG->gradeoverhundredprocentmax : 10; // 1000% max by default
1372         if (!empty($CFG->unlimitedgrades)) {
1373             // NOTE: if you change this value you must manually reset the needsupdate flag in all grade items
1374             $grademax = $grademax * $maxcoef;
1375         } else if ($this->is_category_item() or $this->is_course_item()) {
1376             $category = $this->load_item_category();
1377             if ($category->aggregation >= 100) {
1378                 // grade >100% hack
1379                 $grademax = $grademax * $maxcoef;
1380             }
1381         }
1383         return (float)bounded_number($this->grademin, $gradevalue, $grademax);
1384     }
1386     /**
1387      * Finds out on which other items does this depend directly when doing calculation or category aggregation
1388      *
1389      * @param bool $reset_cache
1390      * @return array of grade_item IDs this one depends on
1391      */
1392     public function depends_on($reset_cache=false) {
1393         global $CFG, $DB;
1395         if ($reset_cache) {
1396             $this->dependson_cache = null;
1397         } else if (isset($this->dependson_cache)) {
1398             return $this->dependson_cache;
1399         }
1401         if ($this->is_locked()) {
1402             // locked items do not need to be regraded
1403             $this->dependson_cache = array();
1404             return $this->dependson_cache;
1405         }
1407         if ($this->is_calculated()) {
1408             if (preg_match_all('/##gi(\d+)##/', $this->calculation, $matches)) {
1409                 $this->dependson_cache = array_unique($matches[1]); // remove duplicates
1410                 return $this->dependson_cache;
1411             } else {
1412                 $this->dependson_cache = array();
1413                 return $this->dependson_cache;
1414             }
1416         } else if ($grade_category = $this->load_item_category()) {
1417             $params = array();
1419             //only items with numeric or scale values can be aggregated
1420             if ($this->gradetype != GRADE_TYPE_VALUE and $this->gradetype != GRADE_TYPE_SCALE) {
1421                 $this->dependson_cache = array();
1422                 return $this->dependson_cache;
1423             }
1425             $grade_category->apply_forced_settings();
1427             if (empty($CFG->enableoutcomes) or $grade_category->aggregateoutcomes) {
1428                 $outcomes_sql = "";
1429             } else {
1430                 $outcomes_sql = "AND gi.outcomeid IS NULL";
1431             }
1433             if (empty($CFG->grade_includescalesinaggregation)) {
1434                 $gtypes = "gi.gradetype = ?";
1435                 $params[] = GRADE_TYPE_VALUE;
1436             } else {
1437                 $gtypes = "(gi.gradetype = ? OR gi.gradetype = ?)";
1438                 $params[] = GRADE_TYPE_VALUE;
1439                 $params[] = GRADE_TYPE_SCALE;
1440             }
1442             if ($grade_category->aggregatesubcats) {
1443                 // return all children excluding category items
1444                 $params[] = $this->courseid;
1445                 $params[] = '%/' . $grade_category->id . '/%';
1446                 $sql = "SELECT gi.id
1447                           FROM {grade_items} gi
1448                           JOIN {grade_categories} gc ON gi.categoryid = gc.id
1449                          WHERE $gtypes
1450                                $outcomes_sql
1451                                AND gi.courseid = ?
1452                                AND gc.path LIKE ?";
1453             } else {
1454                 $params[] = $grade_category->id;
1455                 $params[] = $this->courseid;
1456                 $params[] = $grade_category->id;
1457                 $params[] = $this->courseid;
1458                 if (empty($CFG->grade_includescalesinaggregation)) {
1459                     $params[] = GRADE_TYPE_VALUE;
1460                 } else {
1461                     $params[] = GRADE_TYPE_VALUE;
1462                     $params[] = GRADE_TYPE_SCALE;
1463                 }
1464                 $sql = "SELECT gi.id
1465                           FROM {grade_items} gi
1466                          WHERE $gtypes
1467                                AND gi.categoryid = ?
1468                                AND gi.courseid = ?
1469                                $outcomes_sql
1470                         UNION
1472                         SELECT gi.id
1473                           FROM {grade_items} gi, {grade_categories} gc
1474                          WHERE (gi.itemtype = 'category' OR gi.itemtype = 'course') AND gi.iteminstance=gc.id
1475                                AND gc.parent = ?
1476                                AND gi.courseid = ?
1477                                AND $gtypes
1478                                $outcomes_sql";
1479             }
1481             if ($children = $DB->get_records_sql($sql, $params)) {
1482                 $this->dependson_cache = array_keys($children);
1483                 return $this->dependson_cache;
1484             } else {
1485                 $this->dependson_cache = array();
1486                 return $this->dependson_cache;
1487             }
1489         } else {
1490             $this->dependson_cache = array();
1491             return $this->dependson_cache;
1492         }
1493     }
1495     /**
1496      * Refetch grades from modules, plugins.
1497      *
1498      * @param int $userid optional, limit the refetch to a single user
1499      * @return bool Returns true on success or if there is nothing to do
1500      */
1501     public function refresh_grades($userid=0) {
1502         global $DB;
1503         if ($this->itemtype == 'mod') {
1504             if ($this->is_outcome_item()) {
1505                 //nothing to do
1506                 return true;
1507             }
1509             if (!$activity = $DB->get_record($this->itemmodule, array('id' => $this->iteminstance))) {
1510                 debugging("Can not find $this->itemmodule activity with id $this->iteminstance");
1511                 return false;
1512             }
1514             if (!$cm = get_coursemodule_from_instance($this->itemmodule, $activity->id, $this->courseid)) {
1515                 debugging('Can not find course module');
1516                 return false;
1517             }
1519             $activity->modname    = $this->itemmodule;
1520             $activity->cmidnumber = $cm->idnumber;
1522             return grade_update_mod_grades($activity, $userid);
1523         }
1525         return true;
1526     }
1528     /**
1529      * Updates final grade value for given user, this is a only way to update final
1530      * grades from gradebook and import because it logs the change in history table
1531      * and deals with overridden flag. This flag is set to prevent later overriding
1532      * from raw grades submitted from modules.
1533      *
1534      * @param int $userid The graded user
1535      * @param float|false $finalgrade The float value of final grade, false means do not change
1536      * @param string $source The modification source
1537      * @param string $feedback Optional teacher feedback
1538      * @param int $feedbackformat A format like FORMAT_PLAIN or FORMAT_HTML
1539      * @param int $usermodified The ID of the user making the modification
1540      * @return bool success
1541      */
1542     public function update_final_grade($userid, $finalgrade=false, $source=NULL, $feedback=false, $feedbackformat=FORMAT_MOODLE, $usermodified=null) {
1543         global $USER, $CFG;
1545         $result = true;
1547         // no grading used or locked
1548         if ($this->gradetype == GRADE_TYPE_NONE or $this->is_locked()) {
1549             return false;
1550         }
1552         $grade = new grade_grade(array('itemid'=>$this->id, 'userid'=>$userid));
1553         $grade->grade_item =& $this; // prevent db fetching of this grade_item
1555         if (empty($usermodified)) {
1556             $grade->usermodified = $USER->id;
1557         } else {
1558             $grade->usermodified = $usermodified;
1559         }
1561         if ($grade->is_locked()) {
1562             // do not update locked grades at all
1563             return false;
1564         }
1566         $locktime = $grade->get_locktime();
1567         if ($locktime and $locktime < time()) {
1568             // do not update grades that should be already locked, force regrade instead
1569             $this->force_regrading();
1570             return false;
1571         }
1573         $oldgrade = new stdClass();
1574         $oldgrade->finalgrade     = $grade->finalgrade;
1575         $oldgrade->overridden     = $grade->overridden;
1576         $oldgrade->feedback       = $grade->feedback;
1577         $oldgrade->feedbackformat = $grade->feedbackformat;
1579         // MDL-31713 rawgramemin and max must be up to date so conditional access %'s works properly.
1580         $grade->rawgrademin = $this->grademin;
1581         $grade->rawgrademax = $this->grademax;
1582         $grade->rawscaleid  = $this->scaleid;
1584         // changed grade?
1585         if ($finalgrade !== false) {
1586             if ($this->is_overridable_item()) {
1587                 $grade->overridden = time();
1588             }
1590             $grade->finalgrade = $this->bounded_grade($finalgrade);
1591         }
1593         // do we have comment from teacher?
1594         if ($feedback !== false) {
1595             if ($this->is_overridable_item_feedback()) {
1596                 // external items (modules, plugins) may have own feedback
1597                 $grade->overridden = time();
1598             }
1600             $grade->feedback       = $feedback;
1601             $grade->feedbackformat = $feedbackformat;
1602         }
1604         if (empty($grade->id)) {
1605             $grade->timecreated  = null;   // hack alert - date submitted - no submission yet
1606             $grade->timemodified = time(); // hack alert - date graded
1607             $result = (bool)$grade->insert($source);
1609         } else if (grade_floats_different($grade->finalgrade, $oldgrade->finalgrade)
1610                 or $grade->feedback       !== $oldgrade->feedback
1611                 or $grade->feedbackformat != $oldgrade->feedbackformat
1612                 or ($oldgrade->overridden == 0 and $grade->overridden > 0)) {
1613             $grade->timemodified = time(); // hack alert - date graded
1614             $result = $grade->update($source);
1615         } else {
1616             // no grade change
1617             return $result;
1618         }
1620         if (!$result) {
1621             // something went wrong - better force final grade recalculation
1622             $this->force_regrading();
1624         } else if ($this->is_course_item() and !$this->needsupdate) {
1625             if (grade_regrade_final_grades($this->courseid, $userid, $this) !== true) {
1626                 $this->force_regrading();
1627             }
1629         } else if (!$this->needsupdate) {
1630             $course_item = grade_item::fetch_course_item($this->courseid);
1631             if (!$course_item->needsupdate) {
1632                 if (grade_regrade_final_grades($this->courseid, $userid, $this) !== true) {
1633                     $this->force_regrading();
1634                 }
1635             } else {
1636                 $this->force_regrading();
1637             }
1638         }
1640         return $result;
1641     }
1644     /**
1645      * Updates raw grade value for given user, this is a only way to update raw
1646      * grades from external source (modules, etc.),
1647      * because it logs the change in history table and deals with final grade recalculation.
1648      *
1649      * @param int $userid the graded user
1650      * @param mixed $rawgrade float value of raw grade - false means do not change
1651      * @param string $source modification source
1652      * @param string $feedback optional teacher feedback
1653      * @param int $feedbackformat A format like FORMAT_PLAIN or FORMAT_HTML
1654      * @param int $usermodified the ID of the user who did the grading
1655      * @param int $dategraded A timestamp of when the student's work was graded
1656      * @param int $datesubmitted A timestamp of when the student's work was submitted
1657      * @param grade_grade $grade A grade object, useful for bulk upgrades
1658      * @return bool success
1659      */
1660     public function update_raw_grade($userid, $rawgrade=false, $source=NULL, $feedback=false, $feedbackformat=FORMAT_MOODLE, $usermodified=null, $dategraded=null, $datesubmitted=null, $grade=null) {
1661         global $USER;
1663         $result = true;
1665         // calculated grades can not be updated; course and category can not be updated  because they are aggregated
1666         if (!$this->is_raw_used() or $this->gradetype == GRADE_TYPE_NONE or $this->is_locked()) {
1667             return false;
1668         }
1670         if (is_null($grade)) {
1671             //fetch from db
1672             $grade = new grade_grade(array('itemid'=>$this->id, 'userid'=>$userid));
1673         }
1674         $grade->grade_item =& $this; // prevent db fetching of this grade_item
1676         if (empty($usermodified)) {
1677             $grade->usermodified = $USER->id;
1678         } else {
1679             $grade->usermodified = $usermodified;
1680         }
1682         if ($grade->is_locked()) {
1683             // do not update locked grades at all
1684             return false;
1685         }
1687         $locktime = $grade->get_locktime();
1688         if ($locktime and $locktime < time()) {
1689             // do not update grades that should be already locked and force regrade
1690             $this->force_regrading();
1691             return false;
1692         }
1694         $oldgrade = new stdClass();
1695         $oldgrade->finalgrade     = $grade->finalgrade;
1696         $oldgrade->rawgrade       = $grade->rawgrade;
1697         $oldgrade->rawgrademin    = $grade->rawgrademin;
1698         $oldgrade->rawgrademax    = $grade->rawgrademax;
1699         $oldgrade->rawscaleid     = $grade->rawscaleid;
1700         $oldgrade->feedback       = $grade->feedback;
1701         $oldgrade->feedbackformat = $grade->feedbackformat;
1703         // use new min and max
1704         $grade->rawgrade    = $grade->rawgrade;
1705         $grade->rawgrademin = $this->grademin;
1706         $grade->rawgrademax = $this->grademax;
1707         $grade->rawscaleid  = $this->scaleid;
1709         // change raw grade?
1710         if ($rawgrade !== false) {
1711             $grade->rawgrade = $rawgrade;
1712         }
1714         // empty feedback means no feedback at all
1715         if ($feedback === '') {
1716             $feedback = null;
1717         }
1719         // do we have comment from teacher?
1720         if ($feedback !== false and !$grade->is_overridden()) {
1721             $grade->feedback       = $feedback;
1722             $grade->feedbackformat = $feedbackformat;
1723         }
1725         // update final grade if possible
1726         if (!$grade->is_locked() and !$grade->is_overridden()) {
1727             $grade->finalgrade = $this->adjust_raw_grade($grade->rawgrade, $grade->rawgrademin, $grade->rawgrademax);
1728         }
1730         // TODO: hack alert - create new fields for these in 2.0
1731         $oldgrade->timecreated  = $grade->timecreated;
1732         $oldgrade->timemodified = $grade->timemodified;
1734         $grade->timecreated = $datesubmitted;
1736         if ($grade->is_overridden()) {
1737             // keep original graded date - update_final_grade() sets this for overridden grades
1739         } else if (is_null($grade->rawgrade) and is_null($grade->feedback)) {
1740             // no grade and feedback means no grading yet
1741             $grade->timemodified = null;
1743         } else if (!empty($dategraded)) {
1744             // fine - module sends info when graded (yay!)
1745             $grade->timemodified = $dategraded;
1747         } else if (grade_floats_different($grade->finalgrade, $oldgrade->finalgrade)
1748                    or $grade->feedback !== $oldgrade->feedback) {
1749             // guess - if either grade or feedback changed set new graded date
1750             $grade->timemodified = time();
1752         } else {
1753             //keep original graded date
1754         }
1755         // end of hack alert
1757         if (empty($grade->id)) {
1758             $result = (bool)$grade->insert($source);
1760         } else if (grade_floats_different($grade->finalgrade,  $oldgrade->finalgrade)
1761                 or grade_floats_different($grade->rawgrade,    $oldgrade->rawgrade)
1762                 or grade_floats_different($grade->rawgrademin, $oldgrade->rawgrademin)
1763                 or grade_floats_different($grade->rawgrademax, $oldgrade->rawgrademax)
1764                 or $grade->rawscaleid     != $oldgrade->rawscaleid
1765                 or $grade->feedback       !== $oldgrade->feedback
1766                 or $grade->feedbackformat != $oldgrade->feedbackformat
1767                 or $grade->timecreated    != $oldgrade->timecreated  // part of hack above
1768                 or $grade->timemodified   != $oldgrade->timemodified // part of hack above
1769                 ) {
1770             $result = $grade->update($source);
1771         } else {
1772             return $result;
1773         }
1775         if (!$result) {
1776             // something went wrong - better force final grade recalculation
1777             $this->force_regrading();
1779         } else if (!$this->needsupdate) {
1780             $course_item = grade_item::fetch_course_item($this->courseid);
1781             if (!$course_item->needsupdate) {
1782                 if (grade_regrade_final_grades($this->courseid, $userid, $this) !== true) {
1783                     $this->force_regrading();
1784                 }
1785             }
1786         }
1788         return $result;
1789     }
1791     /**
1792      * Calculates final grade values using the formula in the calculation property.
1793      * The parameters are taken from final grades of grade items in current course only.
1794      *
1795      * @param int $userid Supply a user ID to limit the calculations to the grades of a single user
1796      * @return bool false if error
1797      */
1798     public function compute($userid=null) {
1799         global $CFG, $DB;
1801         if (!$this->is_calculated()) {
1802             return false;
1803         }
1805         require_once($CFG->libdir.'/mathslib.php');
1807         if ($this->is_locked()) {
1808             return true; // no need to recalculate locked items
1809         }
1811         // Precreate grades - we need them to exist
1812         if ($userid) {
1813             $missing = array();
1814             if (!$DB->record_exists('grade_grades', array('itemid'=>$this->id, 'userid'=>$userid))) {
1815                 $m = new stdClass();
1816                 $m->userid = $userid;
1817                 $missing[] = $m;
1818             }
1819         } else {
1820             // Find any users who have grades for some but not all grade items in this course
1821             $params = array('gicourseid' => $this->courseid, 'ggitemid' => $this->id);
1822             $sql = "SELECT gg.userid
1823                       FROM {grade_grades} gg
1824                            JOIN {grade_items} gi
1825                            ON (gi.id = gg.itemid AND gi.courseid = :gicourseid)
1826                      GROUP BY gg.userid
1827                      HAVING SUM(CASE WHEN gg.itemid = :ggitemid THEN 1 ELSE 0 END) = 0";
1828             $missing = $DB->get_records_sql($sql, $params);
1829         }
1831         if ($missing) {
1832             foreach ($missing as $m) {
1833                 $grade = new grade_grade(array('itemid'=>$this->id, 'userid'=>$m->userid), false);
1834                 $grade->grade_item =& $this;
1835                 $grade->insert('system');
1836             }
1837         }
1839         // get used items
1840         $useditems = $this->depends_on();
1842         // prepare formula and init maths library
1843         $formula = preg_replace('/##(gi\d+)##/', '\1', $this->calculation);
1844         if (strpos($formula, '[[') !== false) {
1845             // missing item
1846             return false;
1847         }
1848         $this->formula = new calc_formula($formula);
1850         // where to look for final grades?
1851         // this itemid is added so that we use only one query for source and final grades
1852         $gis = array_merge($useditems, array($this->id));
1853         list($usql, $params) = $DB->get_in_or_equal($gis);
1855         if ($userid) {
1856             $usersql = "AND g.userid=?";
1857             $params[] = $userid;
1858         } else {
1859             $usersql = "";
1860         }
1862         $grade_inst = new grade_grade();
1863         $fields = 'g.'.implode(',g.', $grade_inst->required_fields);
1865         $params[] = $this->courseid;
1866         $sql = "SELECT $fields
1867                   FROM {grade_grades} g, {grade_items} gi
1868                  WHERE gi.id = g.itemid AND gi.id $usql $usersql AND gi.courseid=?
1869                  ORDER BY g.userid";
1871         $return = true;
1873         // group the grades by userid and use formula on the group
1874         $rs = $DB->get_recordset_sql($sql, $params);
1875         if ($rs->valid()) {
1876             $prevuser = 0;
1877             $grade_records   = array();
1878             $oldgrade    = null;
1879             foreach ($rs as $used) {
1880                 if ($used->userid != $prevuser) {
1881                     if (!$this->use_formula($prevuser, $grade_records, $useditems, $oldgrade)) {
1882                         $return = false;
1883                     }
1884                     $prevuser = $used->userid;
1885                     $grade_records   = array();
1886                     $oldgrade    = null;
1887                 }
1888                 if ($used->itemid == $this->id) {
1889                     $oldgrade = $used;
1890                 }
1891                 $grade_records['gi'.$used->itemid] = $used->finalgrade;
1892             }
1893             if (!$this->use_formula($prevuser, $grade_records, $useditems, $oldgrade)) {
1894                 $return = false;
1895             }
1896         }
1897         $rs->close();
1899         return $return;
1900     }
1902     /**
1903      * Internal function that does the final grade calculation
1904      *
1905      * @param int $userid The user ID
1906      * @param array $params An array of grade items of the form {'gi'.$itemid]} => $finalgrade
1907      * @param array $useditems An array of grade item IDs that this grade item depends on plus its own ID
1908      * @param grade_grade $oldgrade A grade_grade instance containing the old values from the database
1909      * @return bool False if an error occurred
1910      */
1911     public function use_formula($userid, $params, $useditems, $oldgrade) {
1912         if (empty($userid)) {
1913             return true;
1914         }
1916         // add missing final grade values
1917         // not graded (null) is counted as 0 - the spreadsheet way
1918         $allinputsnull = true;
1919         foreach($useditems as $gi) {
1920             if (!array_key_exists('gi'.$gi, $params) || is_null($params['gi'.$gi])) {
1921                 $params['gi'.$gi] = 0;
1922             } else {
1923                 $params['gi'.$gi] = (float)$params['gi'.$gi];
1924                 if ($gi != $this->id) {
1925                     $allinputsnull = false;
1926                 }
1927             }
1928         }
1930         // can not use own final grade during calculation
1931         unset($params['gi'.$this->id]);
1933         // insert final grade - will be needed later anyway
1934         if ($oldgrade) {
1935             $oldfinalgrade = $oldgrade->finalgrade;
1936             $grade = new grade_grade($oldgrade, false); // fetching from db is not needed
1937             $grade->grade_item =& $this;
1939         } else {
1940             $grade = new grade_grade(array('itemid'=>$this->id, 'userid'=>$userid), false);
1941             $grade->grade_item =& $this;
1942             $grade->insert('system');
1943             $oldfinalgrade = null;
1944         }
1946         // no need to recalculate locked or overridden grades
1947         if ($grade->is_locked() or $grade->is_overridden()) {
1948             return true;
1949         }
1951         if ($allinputsnull) {
1952             $grade->finalgrade = null;
1953             $result = true;
1955         } else {
1957             // do the calculation
1958             $this->formula->set_params($params);
1959             $result = $this->formula->evaluate();
1961             if ($result === false) {
1962                 $grade->finalgrade = null;
1964             } else {
1965                 // normalize
1966                 $grade->finalgrade = $this->bounded_grade($result);
1967             }
1969         }
1971         // update in db if changed
1972         if (grade_floats_different($grade->finalgrade, $oldfinalgrade)) {
1973             $grade->timemodified = time();
1974             $grade->update('compute');
1975         }
1977         if ($result !== false) {
1978             //lock grade if needed
1979         }
1981         if ($result === false) {
1982             return false;
1983         } else {
1984             return true;
1985         }
1987     }
1989     /**
1990      * Validate the formula.
1991      *
1992      * @param string $formulastr
1993      * @return bool true if calculation possible, false otherwise
1994      */
1995     public function validate_formula($formulastr) {
1996         global $CFG, $DB;
1997         require_once($CFG->libdir.'/mathslib.php');
1999         $formulastr = grade_item::normalize_formula($formulastr, $this->courseid);
2001         if (empty($formulastr)) {
2002             return true;
2003         }
2005         if (strpos($formulastr, '=') !== 0) {
2006             return get_string('errorcalculationnoequal', 'grades');
2007         }
2009         // get used items
2010         if (preg_match_all('/##gi(\d+)##/', $formulastr, $matches)) {
2011             $useditems = array_unique($matches[1]); // remove duplicates
2012         } else {
2013             $useditems = array();
2014         }
2016         // MDL-11902
2017         // unset the value if formula is trying to reference to itself
2018         // but array keys does not match itemid
2019         if (!empty($this->id)) {
2020             $useditems = array_diff($useditems, array($this->id));
2021             //unset($useditems[$this->id]);
2022         }
2024         // prepare formula and init maths library
2025         $formula = preg_replace('/##(gi\d+)##/', '\1', $formulastr);
2026         $formula = new calc_formula($formula);
2029         if (empty($useditems)) {
2030             $grade_items = array();
2032         } else {
2033             list($usql, $params) = $DB->get_in_or_equal($useditems);
2034             $params[] = $this->courseid;
2035             $sql = "SELECT gi.*
2036                       FROM {grade_items} gi
2037                      WHERE gi.id $usql and gi.courseid=?"; // from the same course only!
2039             if (!$grade_items = $DB->get_records_sql($sql, $params)) {
2040                 $grade_items = array();
2041             }
2042         }
2044         $params = array();
2045         foreach ($useditems as $itemid) {
2046             // make sure all grade items exist in this course
2047             if (!array_key_exists($itemid, $grade_items)) {
2048                 return false;
2049             }
2050             // use max grade when testing formula, this should be ok in 99.9%
2051             // division by 0 is one of possible problems
2052             $params['gi'.$grade_items[$itemid]->id] = $grade_items[$itemid]->grademax;
2053         }
2055         // do the calculation
2056         $formula->set_params($params);
2057         $result = $formula->evaluate();
2059         // false as result indicates some problem
2060         if ($result === false) {
2061             // TODO: add more error hints
2062             return get_string('errorcalculationunknown', 'grades');
2063         } else {
2064             return true;
2065         }
2066     }
2068     /**
2069      * Returns the value of the display type
2070      *
2071      * It can be set at 3 levels: grade_item, course setting and site. The lowest level overrides the higher ones.
2072      *
2073      * @return int Display type
2074      */
2075     public function get_displaytype() {
2076         global $CFG;
2078         if ($this->display == GRADE_DISPLAY_TYPE_DEFAULT) {
2079             return grade_get_setting($this->courseid, 'displaytype', $CFG->grade_displaytype);
2081         } else {
2082             return $this->display;
2083         }
2084     }
2086     /**
2087      * Returns the value of the decimals field
2088      *
2089      * It can be set at 3 levels: grade_item, course setting and site. The lowest level overrides the higher ones.
2090      *
2091      * @return int Decimals (0 - 5)
2092      */
2093     public function get_decimals() {
2094         global $CFG;
2096         if (is_null($this->decimals)) {
2097             return grade_get_setting($this->courseid, 'decimalpoints', $CFG->grade_decimalpoints);
2099         } else {
2100             return $this->decimals;
2101         }
2102     }
2104     /**
2105      * Returns a string representing the range of grademin - grademax for this grade item.
2106      *
2107      * @param int $rangesdisplaytype
2108      * @param int $rangesdecimalpoints
2109      * @return string
2110      */
2111     function get_formatted_range($rangesdisplaytype=null, $rangesdecimalpoints=null) {
2113         global $USER;
2115         // Determine which display type to use for this average
2116         if (isset($USER->gradeediting) && array_key_exists($this->courseid, $USER->gradeediting) && $USER->gradeediting[$this->courseid]) {
2117             $displaytype = GRADE_DISPLAY_TYPE_REAL;
2119         } else if ($rangesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // no ==0 here, please resave report and user prefs
2120             $displaytype = $this->get_displaytype();
2122         } else {
2123             $displaytype = $rangesdisplaytype;
2124         }
2126         // Override grade_item setting if a display preference (not default) was set for the averages
2127         if ($rangesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) {
2128             $decimalpoints = $this->get_decimals();
2130         } else {
2131             $decimalpoints = $rangesdecimalpoints;
2132         }
2134         if ($displaytype == GRADE_DISPLAY_TYPE_PERCENTAGE) {
2135             $grademin = "0 %";
2136             $grademax = "100 %";
2138         } else {
2139             $grademin = grade_format_gradevalue($this->grademin, $this, true, $displaytype, $decimalpoints);
2140             $grademax = grade_format_gradevalue($this->grademax, $this, true, $displaytype, $decimalpoints);
2141         }
2143         return $grademin.'&ndash;'. $grademax;
2144     }
2146     /**
2147      * Queries parent categories recursively to find the aggregationcoef type that applies to this grade item.
2148      *
2149      * @return string|false Returns the coefficient string of false is no coefficient is being used
2150      */
2151     public function get_coefstring() {
2152         $parent_category = $this->load_parent_category();
2153         if ($this->is_category_item()) {
2154             $parent_category = $parent_category->load_parent_category();
2155         }
2157         if ($parent_category->is_aggregationcoef_used()) {
2158             return $parent_category->get_coefstring();
2159         } else {
2160             return false;
2161         }
2162     }
2164     /**
2165      * Returns whether the grade item can control the visibility of the grades
2166      *
2167      * @return bool
2168      */
2169     public function can_control_visibility() {
2170         if (core_component::get_plugin_directory($this->itemtype, $this->itemmodule)) {
2171             return !plugin_supports($this->itemtype, $this->itemmodule, FEATURE_CONTROLS_GRADE_VISIBILITY, false);
2172         }
2173         return parent::can_control_visibility();
2174     }
2176     /**
2177      * Used to notify the completion system (if necessary) that a user's grade
2178      * has changed, and clear up a possible score cache.
2179      *
2180      * @param bool $deleted True if grade was actually deleted
2181      */
2182     protected function notify_changed($deleted) {
2183         global $CFG;
2185         // Condition code may cache the grades for conditional availability of
2186         // modules or sections. (This code should use a hook for communication
2187         // with plugin, but hooks are not implemented at time of writing.)
2188         if (!empty($CFG->enableavailability) && class_exists('\availability_grade\callbacks')) {
2189             \availability_grade\callbacks::grade_item_changed($this->courseid);
2190         }
2191     }