mirrored from git://git.moodle.org/moodle.git
/
grade_grade.php
813 lines (699 loc) · 26.9 KB
/
grade_grade.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Definitions of grade grade class
*
* @package core
* @subpackage grade
* @copyright 2006 Nicolas Connault
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
require_once('grade_object.php');
class grade_grade extends grade_object {
/**
* The DB table.
* @var string $table
*/
public $table = 'grade_grades';
/**
* Array of required table fields, must start with 'id'.
* @var array $required_fields
*/
public $required_fields = array('id', 'itemid', 'userid', 'rawgrade', 'rawgrademax', 'rawgrademin',
'rawscaleid', 'usermodified', 'finalgrade', 'hidden', 'locked',
'locktime', 'exported', 'overridden', 'excluded', 'timecreated', 'timemodified');
/**
* Array of optional fields with default values (these should match db defaults)
* @var array $optional_fields
*/
public $optional_fields = array('feedback'=>null, 'feedbackformat'=>0, 'information'=>null, 'informationformat'=>0);
/**
* The id of the grade_item this grade belongs to.
* @var int $itemid
*/
public $itemid;
/**
* The grade_item object referenced by $this->itemid.
* @var object $grade_item
*/
public $grade_item;
/**
* The id of the user this grade belongs to.
* @var int $userid
*/
public $userid;
/**
* The grade value of this raw grade, if such was provided by the module.
* @var float $rawgrade
*/
public $rawgrade;
/**
* The maximum allowable grade when this grade was created.
* @var float $rawgrademax
*/
public $rawgrademax = 100;
/**
* The minimum allowable grade when this grade was created.
* @var float $rawgrademin
*/
public $rawgrademin = 0;
/**
* id of the scale, if this grade is based on a scale.
* @var int $rawscaleid
*/
public $rawscaleid;
/**
* The userid of the person who last modified this grade.
* @var int $usermodified
*/
public $usermodified;
/**
* The final value of this grade.
* @var float $finalgrade
*/
public $finalgrade;
/**
* 0 if visible, 1 always hidden or date not visible until
* @var float $hidden
*/
public $hidden = 0;
/**
* 0 not locked, date when the item was locked
* @var float locked
*/
public $locked = 0;
/**
* 0 no automatic locking, date when to lock the grade automatically
* @var float $locktime
*/
public $locktime = 0;
/**
* Exported flag
* @var boolean $exported
*/
public $exported = 0;
/**
* Overridden flag
* @var boolean $overridden
*/
public $overridden = 0;
/**
* Grade excluded from aggregation functions
* @var boolean $excluded
*/
public $excluded = 0;
/**
* TODO: HACK: create a new field datesubmitted - the date of submission if any
* @var boolean $timecreated
*/
public $timecreated = null;
/**
* TODO: HACK: create a new field dategraded - the date of grading
* @var boolean $timemodified
*/
public $timemodified = null;
/**
* Returns array of grades for given grade_item+users.
* @param object $grade_item
* @param array $userids
* @param bool $include_missing include grades that do not exist yet
* @return array userid=>grade_grade array
*/
public static function fetch_users_grades($grade_item, $userids, $include_missing=true) {
global $DB;
// hmm, there might be a problem with length of sql query
// if there are too many users requested - we might run out of memory anyway
$limit = 2000;
$count = count($userids);
if ($count > $limit) {
$half = (int)($count/2);
$first = array_slice($userids, 0, $half);
$second = array_slice($userids, $half);
return grade_grade::fetch_users_grades($grade_item, $first, $include_missing) + grade_grade::fetch_users_grades($grade_item, $second, $include_missing);
}
list($user_ids_cvs, $params) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED, 'uid0');
$params['giid'] = $grade_item->id;
$result = array();
if ($grade_records = $DB->get_records_select('grade_grades', "itemid=:giid AND userid $user_ids_cvs", $params)) {
foreach ($grade_records as $record) {
$result[$record->userid] = new grade_grade($record, false);
}
}
if ($include_missing) {
foreach ($userids as $userid) {
if (!array_key_exists($userid, $result)) {
$grade_grade = new grade_grade();
$grade_grade->userid = $userid;
$grade_grade->itemid = $grade_item->id;
$result[$userid] = $grade_grade;
}
}
}
return $result;
}
/**
* Loads the grade_item object referenced by $this->itemid and saves it as $this->grade_item for easy access.
* @return object grade_item.
*/
public function load_grade_item() {
if (empty($this->itemid)) {
debugging('Missing itemid');
$this->grade_item = null;
return null;
}
if (empty($this->grade_item)) {
$this->grade_item = grade_item::fetch(array('id'=>$this->itemid));
} else if ($this->grade_item->id != $this->itemid) {
debugging('Itemid mismatch');
$this->grade_item = grade_item::fetch(array('id'=>$this->itemid));
}
return $this->grade_item;
}
/**
* Is grading object editable?
* @return boolean
*/
public function is_editable() {
if ($this->is_locked()) {
return false;
}
$grade_item = $this->load_grade_item();
if ($grade_item->gradetype == GRADE_TYPE_NONE) {
return false;
}
return true;
}
/**
* Check grade lock status. Uses both grade item lock and grade lock.
* Internally any date in locked field (including future ones) means locked,
* the date is stored for logging purposes only.
*
* @return boolean true if locked, false if not
*/
public function is_locked() {
$this->load_grade_item();
if (empty($this->grade_item)) {
return !empty($this->locked);
} else {
return !empty($this->locked) or $this->grade_item->is_locked();
}
}
/**
* Checks if grade overridden
* @return boolean
*/
public function is_overridden() {
return !empty($this->overridden);
}
/**
* Returns timestamp of submission related to this grade,
* might be null if not submitted.
* @return int
*/
public function get_datesubmitted() {
//TODO: HACK - create new fields in 2.0
return $this->timecreated;
}
/**
* Returns timestamp when last graded,
* might be null if no grade present.
* @return int
*/
public function get_dategraded() {
//TODO: HACK - create new fields in 2.0
if (is_null($this->finalgrade) and is_null($this->feedback)) {
return null; // no grade == no date
} else if ($this->overridden) {
return $this->overridden;
} else {
return $this->timemodified;
}
}
/**
* Set the overridden status of grade
* @param boolean $state requested overridden state
* @param boolean $refresh refresh grades from external activities if needed
* @return boolean true is db state changed
*/
public function set_overridden($state, $refresh = true) {
if (empty($this->overridden) and $state) {
$this->overridden = time();
$this->update();
return true;
} else if (!empty($this->overridden) and !$state) {
$this->overridden = 0;
$this->update();
if ($refresh) {
//refresh when unlocking
$this->grade_item->refresh_grades($this->userid);
}
return true;
}
return false;
}
/**
* Checks if grade excluded from aggregation functions
* @return boolean
*/
public function is_excluded() {
return !empty($this->excluded);
}
/**
* Set the excluded status of grade
* @param boolean $state requested excluded state
* @return boolean true is db state changed
*/
public function set_excluded($state) {
if (empty($this->excluded) and $state) {
$this->excluded = time();
$this->update();
return true;
} else if (!empty($this->excluded) and !$state) {
$this->excluded = 0;
$this->update();
return true;
}
return false;
}
/**
* Lock/unlock this grade.
*
* @param int $locked 0, 1 or a timestamp int(10) after which date the item will be locked.
* @param boolean $cascade ignored param
* @param boolean $refresh refresh grades when unlocking
* @return boolean true if successful, false if can not set new lock state for grade
*/
public function set_locked($lockedstate, $cascade=false, $refresh=true) {
$this->load_grade_item();
if ($lockedstate) {
if ($this->grade_item->needsupdate) {
//can not lock grade if final not calculated!
return false;
}
$this->locked = time();
$this->update();
return true;
} else {
if (!empty($this->locked) and $this->locktime < time()) {
//we have to reset locktime or else it would lock up again
$this->locktime = 0;
}
// remove the locked flag
$this->locked = 0;
$this->update();
if ($refresh and !$this->is_overridden()) {
//refresh when unlocking and not overridden
$this->grade_item->refresh_grades($this->userid);
}
return true;
}
}
/**
* Lock the grade if needed - make sure this is called only when final grades are valid
* @param array $items array of all grade item ids
* @return void
*/
public function check_locktime_all($items) {
global $CFG, $DB;
$now = time(); // no rounding needed, this is not supposed to be called every 10 seconds
list($usql, $params) = $DB->get_in_or_equal($items);
$params[] = $now;
$rs = $DB->get_recordset_select('grade_grades', "itemid $usql AND locked = 0 AND locktime > 0 AND locktime < ?", $params);
foreach ($rs as $grade) {
$grade_grade = new grade_grade($grade, false);
$grade_grade->locked = time();
$grade_grade->update('locktime');
}
$rs->close();
}
/**
* Set the locktime for this grade.
*
* @param int $locktime timestamp for lock to activate
* @return void
*/
public function set_locktime($locktime) {
$this->locktime = $locktime;
$this->update();
}
/**
* Set the locktime for this grade.
*
* @return int $locktime timestamp for lock to activate
*/
public function get_locktime() {
$this->load_grade_item();
$item_locktime = $this->grade_item->get_locktime();
if (empty($this->locktime) or ($item_locktime and $item_locktime < $this->locktime)) {
return $item_locktime;
} else {
return $this->locktime;
}
}
/**
* Check grade hidden status. Uses data from both grade item and grade.
* @return boolean true if hidden, false if not
*/
public function is_hidden() {
$this->load_grade_item();
if (empty($this->grade_item)) {
return $this->hidden == 1 or ($this->hidden != 0 and $this->hidden > time());
} else {
return $this->hidden == 1 or ($this->hidden != 0 and $this->hidden > time()) or $this->grade_item->is_hidden();
}
}
/**
* Check grade hidden status. Uses data from both grade item and grade.
* @return boolean true if hiddenuntil, false if not
*/
public function is_hiddenuntil() {
$this->load_grade_item();
if ($this->hidden == 1 or $this->grade_item->hidden == 1) {
return false; //always hidden
}
if ($this->hidden > 1 or $this->grade_item->hidden > 1) {
return true;
}
return false;
}
/**
* Check grade hidden status. Uses data from both grade item and grade.
* @return int 0 means visible, 1 hidden always, timestamp hidden until
*/
public function get_hidden() {
$this->load_grade_item();
$item_hidden = $this->grade_item->get_hidden();
if ($item_hidden == 1) {
return 1;
} else if ($item_hidden == 0) {
return $this->hidden;
} else {
if ($this->hidden == 0) {
return $item_hidden;
} else if ($this->hidden == 1) {
return 1;
} else if ($this->hidden > $item_hidden) {
return $this->hidden;
} else {
return $item_hidden;
}
}
}
/**
* Set the hidden status of grade, 0 mean visible, 1 always hidden, number means date to hide until.
* @param boolean $cascade ignored
* @param int $hidden new hidden status
*/
public function set_hidden($hidden, $cascade=false) {
$this->hidden = $hidden;
$this->update();
}
/**
* Finds and returns a grade_grade instance based on params.
* @static
*
* @param array $params associative arrays varname=>value
* @return object grade_grade instance or false if none found.
*/
public static function fetch($params) {
return grade_object::fetch_helper('grade_grades', 'grade_grade', $params);
}
/**
* Finds and returns all grade_grade instances based on params.
* @static
*
* @param array $params associative arrays varname=>value
* @return array array of grade_grade instances or false if none found.
*/
public static function fetch_all($params) {
return grade_object::fetch_all_helper('grade_grades', 'grade_grade', $params);
}
/**
* Given a float value situated between a source minimum and a source maximum, converts it to the
* corresponding value situated between a target minimum and a target maximum. Thanks to Darlene
* for the formula :-)
*
* @static
* @param float $rawgrade
* @param float $source_min
* @param float $source_max
* @param float $target_min
* @param float $target_max
* @return float Converted value
*/
public static function standardise_score($rawgrade, $source_min, $source_max, $target_min, $target_max) {
if (is_null($rawgrade)) {
return null;
}
if ($source_max == $source_min or $target_min == $target_max) {
// prevent division by 0
return $target_max;
}
$factor = ($rawgrade - $source_min) / ($source_max - $source_min);
$diff = $target_max - $target_min;
$standardised_value = $factor * $diff + $target_min;
return $standardised_value;
}
/**
* Return array of grade item ids that are either hidden or indirectly depend
* on hidden grades, excluded grades are not returned.
* THIS IS A REALLY BIG HACK! to be replaced by conditional aggregation of hidden grades in 2.0
*
* @static
* @param array $grades all course grades of one user, & used for better internal caching
* @param array $items $grade_items array of grade items, & used for better internal caching
* @return array
*/
public static function get_hiding_affected(&$grade_grades, &$grade_items) {
global $CFG;
if (count($grade_grades) !== count($grade_items)) {
print_error('invalidarraysize', 'debug', '', 'grade_grade::get_hiding_affected()!');
}
$dependson = array();
$todo = array();
$unknown = array(); // can not find altered
$altered = array(); // altered grades
$hiddenfound = false;
foreach($grade_grades as $itemid=>$unused) {
$grade_grade =& $grade_grades[$itemid];
if ($grade_grade->is_excluded()) {
//nothing to do, aggregation is ok
} else if ($grade_grade->is_hidden()) {
$hiddenfound = true;
$altered[$grade_grade->itemid] = null;
} else if ($grade_grade->is_locked() or $grade_grade->is_overridden()) {
// no need to recalculate locked or overridden grades
} else {
$dependson[$grade_grade->itemid] = $grade_items[$grade_grade->itemid]->depends_on();
if (!empty($dependson[$grade_grade->itemid])) {
$todo[] = $grade_grade->itemid;
}
}
}
if (!$hiddenfound) {
return array('unknown'=>array(), 'altered'=>array());
}
$max = count($todo);
$hidden_precursors = null;
for($i=0; $i<$max; $i++) {
$found = false;
foreach($todo as $key=>$do) {
$hidden_precursors = array_intersect($dependson[$do], $unknown);
if ($hidden_precursors) {
// this item depends on hidden grade indirectly
$unknown[$do] = $do;
unset($todo[$key]);
$found = true;
continue;
} else if (!array_intersect($dependson[$do], $todo)) {
$hidden_precursors = array_intersect($dependson[$do], array_keys($altered));
if (!$hidden_precursors) {
// hiding does not affect this grade
unset($todo[$key]);
$found = true;
continue;
} else {
// depends on altered grades - we should try to recalculate if possible
if ($grade_items[$do]->is_calculated() or
(!$grade_items[$do]->is_category_item() and !$grade_items[$do]->is_course_item())
) {
$unknown[$do] = $do;
unset($todo[$key]);
$found = true;
continue;
} else {
$grade_category = $grade_items[$do]->load_item_category();
$values = array();
foreach ($dependson[$do] as $itemid) {
if (array_key_exists($itemid, $altered)) {
//nulling an altered precursor
$values[$itemid] = $altered[$itemid];
} elseif (empty($values[$itemid])) {
$values[$itemid] = $grade_grades[$itemid]->finalgrade;
}
}
foreach ($values as $itemid=>$value) {
if ($grade_grades[$itemid]->is_excluded()) {
unset($values[$itemid]);
continue;
}
$values[$itemid] = grade_grade::standardise_score($value, $grade_items[$itemid]->grademin, $grade_items[$itemid]->grademax, 0, 1);
}
if ($grade_category->aggregateonlygraded) {
foreach ($values as $itemid=>$value) {
if (is_null($value)) {
unset($values[$itemid]);
}
}
} else {
foreach ($values as $itemid=>$value) {
if (is_null($value)) {
$values[$itemid] = 0;
}
}
}
// limit and sort
$grade_category->apply_limit_rules($values, $grade_items);
asort($values, SORT_NUMERIC);
// let's see we have still enough grades to do any statistics
if (count($values) == 0) {
// not enough attempts yet
$altered[$do] = null;
unset($todo[$key]);
$found = true;
continue;
}
$agg_grade = $grade_category->aggregate_values($values, $grade_items);
// recalculate the rawgrade back to requested range
$finalgrade = grade_grade::standardise_score($agg_grade, 0, 1, $grade_items[$do]->grademin, $grade_items[$do]->grademax);
$finalgrade = $grade_items[$do]->bounded_grade($finalgrade);
$altered[$do] = $finalgrade;
unset($todo[$key]);
$found = true;
continue;
}
}
}
}
if (!$found) {
break;
}
}
return array('unknown'=>$unknown, 'altered'=>$altered);
}
/**
* Returns true if the grade's value is superior or equal to the grade item's gradepass value, false otherwise.
* @param object $grade_item An optional grade_item of which gradepass value we can use, saves having to load the grade_grade's grade_item
* @return boolean
*/
public function is_passed($grade_item = null) {
if (empty($grade_item)) {
if (!isset($this->grade_item)) {
$this->load_grade_item();
}
} else {
$this->grade_item = $grade_item;
$this->itemid = $grade_item->id;
}
// Return null if finalgrade is null
if (is_null($this->finalgrade)) {
return null;
}
// Return null if gradepass == grademin or gradepass is null
if (is_null($this->grade_item->gradepass) || $this->grade_item->gradepass == $this->grade_item->grademin) {
return null;
}
return $this->finalgrade >= $this->grade_item->gradepass;
}
public function insert($source=null) {
// TODO: dategraded hack - do not update times, they are used for submission and grading
//$this->timecreated = $this->timemodified = time();
return parent::insert($source);
}
/**
* In addition to update() as defined in grade_object rounds the float numbers using php function,
* the reason is we need to compare the db value with computed number to skip updates if possible.
* @param string $source from where was the object inserted (mod/forum, manual, etc.)
* @return boolean success
*/
public function update($source=null) {
$this->rawgrade = grade_floatval($this->rawgrade);
$this->finalgrade = grade_floatval($this->finalgrade);
$this->rawgrademin = grade_floatval($this->rawgrademin);
$this->rawgrademax = grade_floatval($this->rawgrademax);
return parent::update($source);
}
/**
* Used to notify the completion system (if necessary) that a user's grade
* has changed, and clear up a possible score cache.
* @param bool deleted True if grade was actually deleted
*/
function notify_changed($deleted) {
global $USER, $SESSION, $CFG,$COURSE, $DB;
// Grades may be cached in user session
if ($USER->id == $this->userid) {
unset($SESSION->gradescorecache[$this->itemid]);
}
// Ignore during restore
// TODO There should be a proper way to determine when we are in restore
// so that this hack looking for a $restore global is not needed.
global $restore;
if (!empty($restore->backup_unique_code)) {
return;
}
require_once($CFG->libdir.'/completionlib.php');
// Bail out immediately if completion is not enabled for site (saves loading
// grade item below)
if (!completion_info::is_enabled_for_site()) {
return;
}
// Load information about grade item
$this->load_grade_item();
// Only course-modules have completion data
if ($this->grade_item->itemtype!='mod') {
return;
}
// Use $COURSE if available otherwise get it via item fields
if(!empty($COURSE) && $COURSE->id == $this->grade_item->courseid) {
$course = $COURSE;
} else {
$course = $DB->get_record('course', array('id'=>$this->grade_item->courseid));
}
// Bail out if completion is not enabled for course
$completion = new completion_info($course);
if (!$completion->is_enabled()) {
return;
}
// Get course-module
$cm = get_coursemodule_from_instance($this->grade_item->itemmodule,
$this->grade_item->iteminstance, $this->grade_item->courseid);
// If the course-module doesn't exist, display a warning...
if (!$cm) {
// ...unless the grade is being deleted in which case it's likely
// that the course-module was just deleted too, so that's okay.
if (!$deleted) {
debugging("Couldn't find course-module for module '" .
$this->grade_item->itemmodule . "', instance '" .
$this->grade_item->iteminstance . "', course '" .
$this->grade_item->courseid . "'");
}
return;
}
// Pass information on to completion system
$completion->inform_grade_changed($cm, $this->grade_item, $this, $deleted);
}
}