MDL-27550 workshop: assessments are now displayed via proper rendering subsystem
[moodle.git] / mod / workshop / locallib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library of internal classes and functions for module workshop
20  *
21  * All the workshop specific functions, needed to implement the module
22  * logic, should go to here. Instead of having bunch of function named
23  * workshop_something() taking the workshop instance as the first
24  * parameter, we use a class workshop that provides all methods.
25  *
26  * @package    mod
27  * @subpackage workshop
28  * @copyright  2009 David Mudrak <david.mudrak@gmail.com>
29  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30  */
32 defined('MOODLE_INTERNAL') || die();
34 require_once(dirname(__FILE__).'/lib.php');     // we extend this library here
35 require_once($CFG->libdir . '/gradelib.php');   // we use some rounding and comparing routines here
36 require_once($CFG->libdir . '/filelib.php');
38 /**
39  * Full-featured workshop API
40  *
41  * This wraps the workshop database record with a set of methods that are called
42  * from the module itself. The class should be initialized right after you get
43  * $workshop, $cm and $course records at the begining of the script.
44  */
45 class workshop {
47     /** return statuses of {@link add_allocation} to be passed to a workshop renderer method */
48     const ALLOCATION_EXISTS             = -9999;
49     const ALLOCATION_ERROR              = -9998;
51     /** the internal code of the workshop phases as are stored in the database */
52     const PHASE_SETUP                   = 10;
53     const PHASE_SUBMISSION              = 20;
54     const PHASE_ASSESSMENT              = 30;
55     const PHASE_EVALUATION              = 40;
56     const PHASE_CLOSED                  = 50;
58     /** the internal code of the examples modes as are stored in the database */
59     const EXAMPLES_VOLUNTARY            = 0;
60     const EXAMPLES_BEFORE_SUBMISSION    = 1;
61     const EXAMPLES_BEFORE_ASSESSMENT    = 2;
63     /** @var stdclass course module record */
64     public $cm;
66     /** @var stdclass course record */
67     public $course;
69     /** @var stdclass context object */
70     public $context;
72     /** @var int workshop instance identifier */
73     public $id;
75     /** @var string workshop activity name */
76     public $name;
78     /** @var string introduction or description of the activity */
79     public $intro;
81     /** @var int format of the {@link $intro} */
82     public $introformat;
84     /** @var string instructions for the submission phase */
85     public $instructauthors;
87     /** @var int format of the {@link $instructauthors} */
88     public $instructauthorsformat;
90     /** @var string instructions for the assessment phase */
91     public $instructreviewers;
93     /** @var int format of the {@link $instructreviewers} */
94     public $instructreviewersformat;
96     /** @var int timestamp of when the module was modified */
97     public $timemodified;
99     /** @var int current phase of workshop, for example {@link workshop::PHASE_SETUP} */
100     public $phase;
102     /** @var bool optional feature: students practise evaluating on example submissions from teacher */
103     public $useexamples;
105     /** @var bool optional feature: students perform peer assessment of others' work */
106     public $usepeerassessment;
108     /** @var bool optional feature: students perform self assessment of their own work */
109     public $useselfassessment;
111     /** @var float number (10, 5) unsigned, the maximum grade for submission */
112     public $grade;
114     /** @var float number (10, 5) unsigned, the maximum grade for assessment */
115     public $gradinggrade;
117     /** @var string type of the current grading strategy used in this workshop, for example 'accumulative' */
118     public $strategy;
120     /** @var string the name of the evaluation plugin to use for grading grades calculation */
121     public $evaluation;
123     /** @var int number of digits that should be shown after the decimal point when displaying grades */
124     public $gradedecimals;
126     /** @var int number of allowed submission attachments and the files embedded into submission */
127     public $nattachments;
129     /** @var bool allow submitting the work after the deadline */
130     public $latesubmissions;
132     /** @var int maximum size of the one attached file in bytes */
133     public $maxbytes;
135     /** @var int mode of example submissions support, for example {@link workshop::EXAMPLES_VOLUNTARY} */
136     public $examplesmode;
138     /** @var int if greater than 0 then the submission is not allowed before this timestamp */
139     public $submissionstart;
141     /** @var int if greater than 0 then the submission is not allowed after this timestamp */
142     public $submissionend;
144     /** @var int if greater than 0 then the peer assessment is not allowed before this timestamp */
145     public $assessmentstart;
147     /** @var int if greater than 0 then the peer assessment is not allowed after this timestamp */
148     public $assessmentend;
150     /**
151      * @var workshop_strategy grading strategy instance
152      * Do not use directly, get the instance using {@link workshop::grading_strategy_instance()}
153      */
154     protected $strategyinstance = null;
156     /**
157      * @var workshop_evaluation grading evaluation instance
158      * Do not use directly, get the instance using {@link workshop::grading_evaluation_instance()}
159      */
160     protected $evaluationinstance = null;
162     /**
163      * Initializes the workshop API instance using the data from DB
164      *
165      * Makes deep copy of all passed records properties. Replaces integer $course attribute
166      * with a full database record (course should not be stored in instances table anyway).
167      *
168      * @param stdClass $dbrecord Workshop instance data from {workshop} table
169      * @param stdClass $cm       Course module record as returned by {@link get_coursemodule_from_id()}
170      * @param stdClass $course   Course record from {course} table
171      * @param stdClass $context  The context of the workshop instance
172      */
173     public function __construct(stdclass $dbrecord, stdclass $cm, stdclass $course, stdclass $context=null) {
174         foreach ($dbrecord as $field => $value) {
175             if (property_exists('workshop', $field)) {
176                 $this->{$field} = $value;
177             }
178         }
179         $this->cm           = $cm;
180         $this->course       = $course;
181         if (is_null($context)) {
182             $this->context = get_context_instance(CONTEXT_MODULE, $this->cm->id);
183         } else {
184             $this->context = $context;
185         }
186         $this->evaluation   = 'best';   // todo make this configurable although we have no alternatives yet
187     }
189     ////////////////////////////////////////////////////////////////////////////////
190     // Static methods                                                             //
191     ////////////////////////////////////////////////////////////////////////////////
193     /**
194      * Return list of available allocation methods
195      *
196      * @return array Array ['string' => 'string'] of localized allocation method names
197      */
198     public static function installed_allocators() {
199         $installed = get_plugin_list('workshopallocation');
200         $forms = array();
201         foreach ($installed as $allocation => $allocationpath) {
202             if (file_exists($allocationpath . '/lib.php')) {
203                 $forms[$allocation] = get_string('pluginname', 'workshopallocation_' . $allocation);
204             }
205         }
206         // usability - make sure that manual allocation appears the first
207         if (isset($forms['manual'])) {
208             $m = array('manual' => $forms['manual']);
209             unset($forms['manual']);
210             $forms = array_merge($m, $forms);
211         }
212         return $forms;
213     }
215     /**
216      * Returns an array of options for the editors that are used for submitting and assessing instructions
217      *
218      * @param stdClass $context
219      * @uses EDITOR_UNLIMITED_FILES hard-coded value for the 'maxfiles' option
220      * @return array
221      */
222     public static function instruction_editors_options(stdclass $context) {
223         return array('subdirs' => 1, 'maxbytes' => 0, 'maxfiles' => -1,
224                      'changeformat' => 1, 'context' => $context, 'noclean' => 1, 'trusttext' => 0);
225     }
227     /**
228      * Given the percent and the total, returns the number
229      *
230      * @param float $percent from 0 to 100
231      * @param float $total   the 100% value
232      * @return float
233      */
234     public static function percent_to_value($percent, $total) {
235         if ($percent < 0 or $percent > 100) {
236             throw new coding_exception('The percent can not be less than 0 or higher than 100');
237         }
239         return $total * $percent / 100;
240     }
242     /**
243      * Returns an array of numeric values that can be used as maximum grades
244      *
245      * @return array Array of integers
246      */
247     public static function available_maxgrades_list() {
248         $grades = array();
249         for ($i=100; $i>=0; $i--) {
250             $grades[$i] = $i;
251         }
252         return $grades;
253     }
255     /**
256      * Returns the localized list of supported examples modes
257      *
258      * @return array
259      */
260     public static function available_example_modes_list() {
261         $options = array();
262         $options[self::EXAMPLES_VOLUNTARY]         = get_string('examplesvoluntary', 'workshop');
263         $options[self::EXAMPLES_BEFORE_SUBMISSION] = get_string('examplesbeforesubmission', 'workshop');
264         $options[self::EXAMPLES_BEFORE_ASSESSMENT] = get_string('examplesbeforeassessment', 'workshop');
265         return $options;
266     }
268     /**
269      * Returns the list of available grading strategy methods
270      *
271      * @return array ['string' => 'string']
272      */
273     public static function available_strategies_list() {
274         $installed = get_plugin_list('workshopform');
275         $forms = array();
276         foreach ($installed as $strategy => $strategypath) {
277             if (file_exists($strategypath . '/lib.php')) {
278                 $forms[$strategy] = get_string('pluginname', 'workshopform_' . $strategy);
279             }
280         }
281         return $forms;
282     }
284     /**
285      * Return an array of possible values of assessment dimension weight
286      *
287      * @return array of integers 0, 1, 2, ..., 16
288      */
289     public static function available_dimension_weights_list() {
290         $weights = array();
291         for ($i=16; $i>=0; $i--) {
292             $weights[$i] = $i;
293         }
294         return $weights;
295     }
297     /**
298      * Return an array of possible values of assessment weight
299      *
300      * Note there is no real reason why the maximum value here is 16. It used to be 10 in
301      * workshop 1.x and I just decided to use the same number as in the maximum weight of
302      * a single assessment dimension.
303      * The value looks reasonable, though. Teachers who would want to assign themselves
304      * higher weight probably do not want peer assessment really...
305      *
306      * @return array of integers 0, 1, 2, ..., 16
307      */
308     public static function available_assessment_weights_list() {
309         $weights = array();
310         for ($i=16; $i>=0; $i--) {
311             $weights[$i] = $i;
312         }
313         return $weights;
314     }
316     /**
317      * Helper function returning the greatest common divisor
318      *
319      * @param int $a
320      * @param int $b
321      * @return int
322      */
323     public static function gcd($a, $b) {
324         return ($b == 0) ? ($a):(self::gcd($b, $a % $b));
325     }
327     /**
328      * Helper function returning the least common multiple
329      *
330      * @param int $a
331      * @param int $b
332      * @return int
333      */
334     public static function lcm($a, $b) {
335         return ($a / self::gcd($a,$b)) * $b;
336     }
338     /**
339      * Returns an object suitable for strings containing dates/times
340      *
341      * The returned object contains properties date, datefullshort, datetime, ... containing the given
342      * timestamp formatted using strftimedate, strftimedatefullshort, strftimedatetime, ... from the
343      * current lang's langconfig.php
344      * This allows translators and administrators customize the date/time format.
345      *
346      * @param int $timestamp the timestamp in UTC
347      * @return stdclass
348      */
349     public static function timestamp_formats($timestamp) {
350         $formats = array('date', 'datefullshort', 'dateshort', 'datetime',
351                 'datetimeshort', 'daydate', 'daydatetime', 'dayshort', 'daytime',
352                 'monthyear', 'recent', 'recentfull', 'time');
353         $a = new stdclass();
354         foreach ($formats as $format) {
355             $a->{$format} = userdate($timestamp, get_string('strftime'.$format, 'langconfig'));
356         }
357         $day = userdate($timestamp, '%Y%m%d', 99, false);
358         $today = userdate(time(), '%Y%m%d', 99, false);
359         $tomorrow = userdate(time() + DAYSECS, '%Y%m%d', 99, false);
360         $yesterday = userdate(time() - DAYSECS, '%Y%m%d', 99, false);
361         $distance = (int)round(abs(time() - $timestamp) / DAYSECS);
362         if ($day == $today) {
363             $a->distanceday = get_string('daystoday', 'workshop');
364         } elseif ($day == $yesterday) {
365             $a->distanceday = get_string('daysyesterday', 'workshop');
366         } elseif ($day < $today) {
367             $a->distanceday = get_string('daysago', 'workshop', $distance);
368         } elseif ($day == $tomorrow) {
369             $a->distanceday = get_string('daystomorrow', 'workshop');
370         } elseif ($day > $today) {
371             $a->distanceday = get_string('daysleft', 'workshop', $distance);
372         }
373         return $a;
374     }
376     ////////////////////////////////////////////////////////////////////////////////
377     // Workshop API                                                               //
378     ////////////////////////////////////////////////////////////////////////////////
380     /**
381      * Fetches all users with the capability mod/workshop:submit in the current context
382      *
383      * The returned objects contain id, lastname and firstname properties and are ordered by lastname,firstname
384      *
385      * @todo handle with limits and groups
386      * @param bool $musthavesubmission If true, return only users who have already submitted. All possible authors otherwise.
387      * @return array array[userid] => stdclass{->id ->lastname ->firstname}
388      */
389     public function get_potential_authors($musthavesubmission=true) {
390         $users = get_users_by_capability($this->context, 'mod/workshop:submit',
391                     'u.id,u.lastname,u.firstname', 'u.lastname,u.firstname,u.id', '', '', '', '', false, false, true);
392         if ($musthavesubmission) {
393             $users = array_intersect_key($users, $this->users_with_submission(array_keys($users)));
394         }
395         return $users;
396     }
398     /**
399      * Fetches all users with the capability mod/workshop:peerassess in the current context
400      *
401      * The returned objects contain id, lastname and firstname properties and are ordered by lastname,firstname
402      *
403      * @todo handle with limits and groups
404      * @param bool $musthavesubmission If true, return only users who have already submitted. All possible users otherwise.
405      * @return array array[userid] => stdclass{->id ->lastname ->firstname}
406      */
407     public function get_potential_reviewers($musthavesubmission=false) {
408         $users = get_users_by_capability($this->context, 'mod/workshop:peerassess',
409                     'u.id, u.lastname, u.firstname', 'u.lastname,u.firstname,u.id', '', '', '', '', false, false, true);
410         if ($musthavesubmission) {
411             // users without their own submission can not be reviewers
412             $users = array_intersect_key($users, $this->users_with_submission(array_keys($users)));
413         }
414         return $users;
415     }
417     /**
418      * Groups the given users by the group membership
419      *
420      * This takes the module grouping settings into account. If "Available for group members only"
421      * is set, returns only groups withing the course module grouping. Always returns group [0] with
422      * all the given users.
423      *
424      * @param array $users array[userid] => stdclass{->id ->lastname ->firstname}
425      * @return array array[groupid][userid] => stdclass{->id ->lastname ->firstname}
426      */
427     public function get_grouped($users) {
428         global $DB;
429         global $CFG;
431         $grouped = array();  // grouped users to be returned
432         if (empty($users)) {
433             return $grouped;
434         }
435         if (!empty($CFG->enablegroupmembersonly) and $this->cm->groupmembersonly) {
436             // Available for group members only - the workshop is available only
437             // to users assigned to groups within the selected grouping, or to
438             // any group if no grouping is selected.
439             $groupingid = $this->cm->groupingid;
440             // All users that are members of at least one group will be
441             // added into a virtual group id 0
442             $grouped[0] = array();
443         } else {
444             $groupingid = 0;
445             // there is no need to be member of a group so $grouped[0] will contain
446             // all users
447             $grouped[0] = $users;
448         }
449         $gmemberships = groups_get_all_groups($this->cm->course, array_keys($users), $groupingid,
450                             'gm.id,gm.groupid,gm.userid');
451         foreach ($gmemberships as $gmembership) {
452             if (!isset($grouped[$gmembership->groupid])) {
453                 $grouped[$gmembership->groupid] = array();
454             }
455             $grouped[$gmembership->groupid][$gmembership->userid] = $users[$gmembership->userid];
456             $grouped[0][$gmembership->userid] = $users[$gmembership->userid];
457         }
458         return $grouped;
459     }
461     /**
462      * Returns the list of all allocations (i.e. assigned assessments) in the workshop
463      *
464      * Assessments of example submissions are ignored
465      *
466      * @return array
467      */
468     public function get_allocations() {
469         global $DB;
471         $sql = 'SELECT a.id, a.submissionid, a.reviewerid, s.authorid
472                   FROM {workshop_assessments} a
473             INNER JOIN {workshop_submissions} s ON (a.submissionid = s.id)
474                  WHERE s.example = 0 AND s.workshopid = :workshopid';
475         $params = array('workshopid' => $this->id);
477         return $DB->get_records_sql($sql, $params);
478     }
480     /**
481      * Returns submissions from this workshop
482      *
483      * Fetches data from {workshop_submissions} and adds some useful information from other
484      * tables. Does not return textual fields to prevent possible memory lack issues.
485      *
486      * @param mixed $authorid int|array|'all' If set to [array of] integer, return submission[s] of the given user[s] only
487      * @return array of records or an empty array
488      */
489     public function get_submissions($authorid='all') {
490         global $DB;
492         $authorfields      = user_picture::fields('u', null, 'authoridx', 'author');
493         $gradeoverbyfields = user_picture::fields('t', null, 'gradeoverbyx', 'over');
494         $sql = "SELECT s.id, s.workshopid, s.example, s.authorid, s.timecreated, s.timemodified,
495                        s.title, s.grade, s.gradeover, s.gradeoverby, s.published,
496                        $authorfields, $gradeoverbyfields
497                   FROM {workshop_submissions} s
498             INNER JOIN {user} u ON (s.authorid = u.id)
499              LEFT JOIN {user} t ON (s.gradeoverby = t.id)
500                  WHERE s.example = 0 AND s.workshopid = :workshopid";
501         $params = array('workshopid' => $this->id);
503         if ('all' === $authorid) {
504             // no additional conditions
505         } elseif (!empty($authorid)) {
506             list($usql, $uparams) = $DB->get_in_or_equal($authorid, SQL_PARAMS_NAMED);
507             $sql .= " AND authorid $usql";
508             $params = array_merge($params, $uparams);
509         } else {
510             // $authorid is empty
511             return array();
512         }
513         $sql .= " ORDER BY u.lastname, u.firstname";
515         return $DB->get_records_sql($sql, $params);
516     }
518     /**
519      * Returns a submission record with the author's data
520      *
521      * @param int $id submission id
522      * @return stdclass
523      */
524     public function get_submission_by_id($id) {
525         global $DB;
527         // we intentionally check the workshopid here, too, so the workshop can't touch submissions
528         // from other instances
529         $authorfields      = user_picture::fields('u', null, 'authoridx', 'author');
530         $gradeoverbyfields = user_picture::fields('g', null, 'gradeoverbyx', 'gradeoverby');
531         $sql = "SELECT s.*, $authorfields, $gradeoverbyfields
532                   FROM {workshop_submissions} s
533             INNER JOIN {user} u ON (s.authorid = u.id)
534              LEFT JOIN {user} g ON (s.gradeoverby = g.id)
535                  WHERE s.example = 0 AND s.workshopid = :workshopid AND s.id = :id";
536         $params = array('workshopid' => $this->id, 'id' => $id);
537         return $DB->get_record_sql($sql, $params, MUST_EXIST);
538     }
540     /**
541      * Returns a submission submitted by the given author
542      *
543      * @param int $id author id
544      * @return stdclass|false
545      */
546     public function get_submission_by_author($authorid) {
547         global $DB;
549         if (empty($authorid)) {
550             return false;
551         }
552         $authorfields      = user_picture::fields('u', null, 'authoridx', 'author');
553         $gradeoverbyfields = user_picture::fields('g', null, 'gradeoverbyx', 'gradeoverby');
554         $sql = "SELECT s.*, $authorfields, $gradeoverbyfields
555                   FROM {workshop_submissions} s
556             INNER JOIN {user} u ON (s.authorid = u.id)
557              LEFT JOIN {user} g ON (s.gradeoverby = g.id)
558                  WHERE s.example = 0 AND s.workshopid = :workshopid AND s.authorid = :authorid";
559         $params = array('workshopid' => $this->id, 'authorid' => $authorid);
560         return $DB->get_record_sql($sql, $params);
561     }
563     /**
564      * Returns published submissions with their authors data
565      *
566      * @return array of stdclass
567      */
568     public function get_published_submissions($orderby='finalgrade DESC') {
569         global $DB;
571         $authorfields = user_picture::fields('u', null, 'authoridx', 'author');
572         $sql = "SELECT s.id, s.authorid, s.timecreated, s.timemodified,
573                        s.title, s.grade, s.gradeover, COALESCE(s.gradeover,s.grade) AS finalgrade,
574                        $authorfields
575                   FROM {workshop_submissions} s
576             INNER JOIN {user} u ON (s.authorid = u.id)
577                  WHERE s.example = 0 AND s.workshopid = :workshopid AND s.published = 1
578               ORDER BY $orderby";
579         $params = array('workshopid' => $this->id);
580         return $DB->get_records_sql($sql, $params);
581     }
583     /**
584      * Returns full record of the given example submission
585      *
586      * @param int $id example submission od
587      * @return object
588      */
589     public function get_example_by_id($id) {
590         global $DB;
591         return $DB->get_record('workshop_submissions',
592                 array('id' => $id, 'workshopid' => $this->id, 'example' => 1), '*', MUST_EXIST);
593     }
595     /**
596      * Returns the list of example submissions in this workshop with reference assessments attached
597      *
598      * @return array of objects or an empty array
599      * @see workshop::prepare_example_summary()
600      */
601     public function get_examples_for_manager() {
602         global $DB;
604         $sql = 'SELECT s.id, s.title,
605                        a.id AS assessmentid, a.grade, a.gradinggrade
606                   FROM {workshop_submissions} s
607              LEFT JOIN {workshop_assessments} a ON (a.submissionid = s.id AND a.weight = 1)
608                  WHERE s.example = 1 AND s.workshopid = :workshopid
609               ORDER BY s.title';
610         return $DB->get_records_sql($sql, array('workshopid' => $this->id));
611     }
613     /**
614      * Returns the list of all example submissions in this workshop with the information of assessments done by the given user
615      *
616      * @param int $reviewerid user id
617      * @return array of objects, indexed by example submission id
618      * @see workshop::prepare_example_summary()
619      */
620     public function get_examples_for_reviewer($reviewerid) {
621         global $DB;
623         if (empty($reviewerid)) {
624             return false;
625         }
626         $sql = 'SELECT s.id, s.title,
627                        a.id AS assessmentid, a.grade, a.gradinggrade
628                   FROM {workshop_submissions} s
629              LEFT JOIN {workshop_assessments} a ON (a.submissionid = s.id AND a.reviewerid = :reviewerid AND a.weight = 0)
630                  WHERE s.example = 1 AND s.workshopid = :workshopid
631               ORDER BY s.title';
632         return $DB->get_records_sql($sql, array('workshopid' => $this->id, 'reviewerid' => $reviewerid));
633     }
635     /**
636      * Prepares renderable submission component
637      *
638      * @param stdClass $record required by {@see workshop_submission}
639      * @param bool $showauthor show the author-related information
640      * @return workshop_submission
641      */
642     public function prepare_submission(stdClass $record, $showauthor = false) {
644         $submission         = new workshop_submission($record, $showauthor);
645         $submission->url    = $this->submission_url($record->id);
647         return $submission;
648     }
650     /**
651      * Prepares renderable submission summary component
652      *
653      * @param stdClass $record required by {@see workshop_submission_summary}
654      * @param bool $showauthor show the author-related information
655      * @return workshop_submission_summary
656      */
657     public function prepare_submission_summary(stdClass $record, $showauthor = false) {
659         $summary        = new workshop_submission_summary($record, $showauthor);
660         $summary->url   = $this->submission_url($record->id);
662         return $summary;
663     }
665     /**
666      * Prepares renderable example submission component
667      *
668      * @param stdClass $record required by {@see workshop_example_submission}
669      * @return workshop_example_submission
670      */
671     public function prepare_example_submission(stdClass $record) {
673         $example = new workshop_example_submission($record);
675         return $example;
676     }
678     /**
679      * Prepares renderable example submission summary component
680      *
681      * If the example is editable, the caller must set the 'editable' flag explicitly.
682      *
683      * @param stdClass $example as returned by {@link workshop::get_examples_for_manager()} or {@link workshop::get_examples_for_reviewer()}
684      * @return workshop_example_submission_summary to be rendered
685      */
686     public function prepare_example_summary(stdClass $example) {
688         $summary = new workshop_example_submission_summary($example);
690         if (is_null($example->grade)) {
691             $summary->status = 'notgraded';
692             $summary->assesslabel = get_string('assess', 'workshop');
693         } else {
694             $summary->status = 'graded';
695             $summary->assesslabel = get_string('reassess', 'workshop');
696         }
698         $summary->gradeinfo           = new stdclass();
699         $summary->gradeinfo->received = $this->real_grade($example->grade);
700         $summary->gradeinfo->max      = $this->real_grade(100);
702         $summary->url       = new moodle_url($this->exsubmission_url($example->id));
703         $summary->editurl   = new moodle_url($this->exsubmission_url($example->id), array('edit' => 'on'));
704         $summary->assessurl = new moodle_url($this->exsubmission_url($example->id), array('assess' => 'on', 'sesskey' => sesskey()));
706         return $summary;
707     }
709     /**
710      * Prepares renderable assessment component
711      *
712      * The $options array supports the following keys:
713      * showauthor - should the author user info be available for the renderer
714      * showreviewer - should the reviewer user info be available for the renderer
715      * showform - show the assessment form if it is available
716      *
717      * @param stdClass $record as returned by eg {@link self::get_assessment_by_id()}
718      * @param workshop_assessment_form|null $form as returned by {@link workshop_strategy::get_assessment_form()}
719      * @param array $options
720      * @return workshop_assessment
721      */
722     public function prepare_assessment(stdClass $record, $form, array $options = array()) {
724         $assessment             = new workshop_assessment($record, $options);
725         $assessment->url        = $this->assess_url($record->id);
726         $assessment->maxgrade   = $this->real_grade(100);
728         if (!empty($options['showform']) and !($form instanceof workshop_assessment_form)) {
729             debugging('Not a valid instance of workshop_assessment_form supplied', DEBUG_DEVELOPER);
730         }
732         if (!empty($options['showform']) and ($form instanceof workshop_assessment_form)) {
733             $assessment->form = $form;
734         }
736         if (empty($options['showweight'])) {
737             $assessment->weight = null;
738         }
740         if (!is_null($record->grade)) {
741             $assessment->realgrade = $this->real_grade($record->grade);
742         }
744         return $assessment;
745     }
747     /**
748      * Removes the submission and all relevant data
749      *
750      * @param stdClass $submission record to delete
751      * @return void
752      */
753     public function delete_submission(stdclass $submission) {
754         global $DB;
755         $assessments = $DB->get_records('workshop_assessments', array('submissionid' => $submission->id), '', 'id');
756         $this->delete_assessment(array_keys($assessments));
757         $DB->delete_records('workshop_submissions', array('id' => $submission->id));
758     }
760     /**
761      * Returns the list of all assessments in the workshop with some data added
762      *
763      * Fetches data from {workshop_assessments} and adds some useful information from other
764      * tables. The returned object does not contain textual fields (i.e. comments) to prevent memory
765      * lack issues.
766      *
767      * @return array [assessmentid] => assessment stdclass
768      */
769     public function get_all_assessments() {
770         global $DB;
772         $reviewerfields = user_picture::fields('reviewer', null, 'revieweridx', 'reviewer');
773         $authorfields   = user_picture::fields('author', null, 'authorid', 'author');
774         $sql = "SELECT a.id, a.submissionid, a.reviewerid, a.timecreated, a.timemodified,
775                        a.grade, a.gradinggrade, a.gradinggradeover, a.gradinggradeoverby,
776                        $reviewerfields, $authorfields,
777                        s.title
778                   FROM {workshop_assessments} a
779             INNER JOIN {user} reviewer ON (a.reviewerid = reviewer.id)
780             INNER JOIN {workshop_submissions} s ON (a.submissionid = s.id)
781             INNER JOIN {user} author ON (s.authorid = author.id)
782                  WHERE s.workshopid = :workshopid AND s.example = 0
783               ORDER BY reviewer.lastname, reviewer.firstname";
784         $params = array('workshopid' => $this->id);
786         return $DB->get_records_sql($sql, $params);
787     }
789     /**
790      * Get the complete information about the given assessment
791      *
792      * @param int $id Assessment ID
793      * @return stdclass
794      */
795     public function get_assessment_by_id($id) {
796         global $DB;
798         $reviewerfields = user_picture::fields('reviewer', null, 'revieweridx', 'reviewer');
799         $authorfields   = user_picture::fields('author', null, 'authorid', 'author');
800         $sql = "SELECT a.*, s.title, $reviewerfields, $authorfields
801                   FROM {workshop_assessments} a
802             INNER JOIN {user} reviewer ON (a.reviewerid = reviewer.id)
803             INNER JOIN {workshop_submissions} s ON (a.submissionid = s.id)
804             INNER JOIN {user} author ON (s.authorid = author.id)
805                  WHERE a.id = :id AND s.workshopid = :workshopid";
806         $params = array('id' => $id, 'workshopid' => $this->id);
808         return $DB->get_record_sql($sql, $params, MUST_EXIST);
809     }
811     /**
812      * Get the complete information about the user's assessment of the given submission
813      *
814      * @param int $sid submission ID
815      * @param int $uid user ID of the reviewer
816      * @return false|stdclass false if not found, stdclass otherwise
817      */
818     public function get_assessment_of_submission_by_user($submissionid, $reviewerid) {
819         global $DB;
821         $reviewerfields = user_picture::fields('reviewer', null, 'revieweridx', 'reviewer');
822         $authorfields   = user_picture::fields('author', null, 'authorid', 'author');
823         $sql = "SELECT a.*, s.title, $reviewerfields, $authorfields
824                   FROM {workshop_assessments} a
825             INNER JOIN {user} reviewer ON (a.reviewerid = reviewer.id)
826             INNER JOIN {workshop_submissions} s ON (a.submissionid = s.id AND s.example = 0)
827             INNER JOIN {user} author ON (s.authorid = author.id)
828                  WHERE s.id = :sid AND reviewer.id = :rid AND s.workshopid = :workshopid";
829         $params = array('sid' => $submissionid, 'rid' => $reviewerid, 'workshopid' => $this->id);
831         return $DB->get_record_sql($sql, $params, IGNORE_MISSING);
832     }
834     /**
835      * Get the complete information about all assessments of the given submission
836      *
837      * @param int $submissionid
838      * @return array
839      */
840     public function get_assessments_of_submission($submissionid) {
841         global $DB;
843         $reviewerfields = user_picture::fields('reviewer', null, 'revieweridx', 'reviewer');
844         $sql = "SELECT a.*, s.title, $reviewerfields
845                   FROM {workshop_assessments} a
846             INNER JOIN {user} reviewer ON (a.reviewerid = reviewer.id)
847             INNER JOIN {workshop_submissions} s ON (a.submissionid = s.id)
848                  WHERE s.example = 0 AND s.id = :submissionid AND s.workshopid = :workshopid
849               ORDER BY reviewer.lastname, reviewer.firstname, reviewer.id";
850         $params = array('submissionid' => $submissionid, 'workshopid' => $this->id);
852         return $DB->get_records_sql($sql, $params);
853     }
855     /**
856      * Get the complete information about all assessments allocated to the given reviewer
857      *
858      * @param int $reviewerid
859      * @return array
860      */
861     public function get_assessments_by_reviewer($reviewerid) {
862         global $DB;
864         $reviewerfields = user_picture::fields('reviewer', null, 'revieweridx', 'reviewer');
865         $authorfields   = user_picture::fields('author', null, 'authorid', 'author');
866         $sql = "SELECT a.*, $reviewerfields, $authorfields,
867                        s.id AS submissionid, s.title AS submissiontitle, s.timecreated AS submissioncreated,
868                        s.timemodified AS submissionmodified
869                   FROM {workshop_assessments} a
870             INNER JOIN {user} reviewer ON (a.reviewerid = reviewer.id)
871             INNER JOIN {workshop_submissions} s ON (a.submissionid = s.id)
872             INNER JOIN {user} author ON (s.authorid = author.id)
873                  WHERE s.example = 0 AND reviewer.id = :reviewerid AND s.workshopid = :workshopid";
874         $params = array('reviewerid' => $reviewerid, 'workshopid' => $this->id);
876         return $DB->get_records_sql($sql, $params);
877     }
879     /**
880      * Allocate a submission to a user for review
881      *
882      * @param stdClass $submission Submission object with at least id property
883      * @param int $reviewerid User ID
884      * @param int $weight of the new assessment, from 0 to 16
885      * @param bool $bulk repeated inserts into DB expected
886      * @return int ID of the new assessment or an error code
887      */
888     public function add_allocation(stdclass $submission, $reviewerid, $weight=1, $bulk=false) {
889         global $DB;
891         if ($DB->record_exists('workshop_assessments', array('submissionid' => $submission->id, 'reviewerid' => $reviewerid))) {
892             return self::ALLOCATION_EXISTS;
893         }
895         $weight = (int)$weight;
896         if ($weight < 0) {
897             $weight = 0;
898         }
899         if ($weight > 16) {
900             $weight = 16;
901         }
903         $now = time();
904         $assessment = new stdclass();
905         $assessment->submissionid           = $submission->id;
906         $assessment->reviewerid             = $reviewerid;
907         $assessment->timecreated            = $now;         // do not set timemodified here
908         $assessment->weight                 = $weight;
909         $assessment->generalcommentformat   = editors_get_preferred_format();
910         $assessment->feedbackreviewerformat = editors_get_preferred_format();
912         return $DB->insert_record('workshop_assessments', $assessment, true, $bulk);
913     }
915     /**
916      * Delete assessment record or records
917      *
918      * @param mixed $id int|array assessment id or array of assessments ids
919      * @return bool false if $id not a valid parameter, true otherwise
920      */
921     public function delete_assessment($id) {
922         global $DB;
924         // todo remove all given grades from workshop_grades;
926         if (is_array($id)) {
927             return $DB->delete_records_list('workshop_assessments', 'id', $id);
928         } else {
929             return $DB->delete_records('workshop_assessments', array('id' => $id));
930         }
931     }
933     /**
934      * Returns instance of grading strategy class
935      *
936      * @return stdclass Instance of a grading strategy
937      */
938     public function grading_strategy_instance() {
939         global $CFG;    // because we require other libs here
941         if (is_null($this->strategyinstance)) {
942             $strategylib = dirname(__FILE__) . '/form/' . $this->strategy . '/lib.php';
943             if (is_readable($strategylib)) {
944                 require_once($strategylib);
945             } else {
946                 throw new coding_exception('the grading forms subplugin must contain library ' . $strategylib);
947             }
948             $classname = 'workshop_' . $this->strategy . '_strategy';
949             $this->strategyinstance = new $classname($this);
950             if (!in_array('workshop_strategy', class_implements($this->strategyinstance))) {
951                 throw new coding_exception($classname . ' does not implement workshop_strategy interface');
952             }
953         }
954         return $this->strategyinstance;
955     }
957     /**
958      * Returns instance of grading evaluation class
959      *
960      * @return stdclass Instance of a grading evaluation
961      */
962     public function grading_evaluation_instance() {
963         global $CFG;    // because we require other libs here
965         if (is_null($this->evaluationinstance)) {
966             $evaluationlib = dirname(__FILE__) . '/eval/' . $this->evaluation . '/lib.php';
967             if (is_readable($evaluationlib)) {
968                 require_once($evaluationlib);
969             } else {
970                 throw new coding_exception('the grading evaluation subplugin must contain library ' . $evaluationlib);
971             }
972             $classname = 'workshop_' . $this->evaluation . '_evaluation';
973             $this->evaluationinstance = new $classname($this);
974             if (!in_array('workshop_evaluation', class_implements($this->evaluationinstance))) {
975                 throw new coding_exception($classname . ' does not implement workshop_evaluation interface');
976             }
977         }
978         return $this->evaluationinstance;
979     }
981     /**
982      * Returns instance of submissions allocator
983      *
984      * @param string $method The name of the allocation method, must be PARAM_ALPHA
985      * @return stdclass Instance of submissions allocator
986      */
987     public function allocator_instance($method) {
988         global $CFG;    // because we require other libs here
990         $allocationlib = dirname(__FILE__) . '/allocation/' . $method . '/lib.php';
991         if (is_readable($allocationlib)) {
992             require_once($allocationlib);
993         } else {
994             throw new coding_exception('Unable to find the allocation library ' . $allocationlib);
995         }
996         $classname = 'workshop_' . $method . '_allocator';
997         return new $classname($this);
998     }
1000     /**
1001      * @return moodle_url of this workshop's view page
1002      */
1003     public function view_url() {
1004         global $CFG;
1005         return new moodle_url('/mod/workshop/view.php', array('id' => $this->cm->id));
1006     }
1008     /**
1009      * @return moodle_url of the page for editing this workshop's grading form
1010      */
1011     public function editform_url() {
1012         global $CFG;
1013         return new moodle_url('/mod/workshop/editform.php', array('cmid' => $this->cm->id));
1014     }
1016     /**
1017      * @return moodle_url of the page for previewing this workshop's grading form
1018      */
1019     public function previewform_url() {
1020         global $CFG;
1021         return new moodle_url('/mod/workshop/editformpreview.php', array('cmid' => $this->cm->id));
1022     }
1024     /**
1025      * @param int $assessmentid The ID of assessment record
1026      * @return moodle_url of the assessment page
1027      */
1028     public function assess_url($assessmentid) {
1029         global $CFG;
1030         $assessmentid = clean_param($assessmentid, PARAM_INT);
1031         return new moodle_url('/mod/workshop/assessment.php', array('asid' => $assessmentid));
1032     }
1034     /**
1035      * @param int $assessmentid The ID of assessment record
1036      * @return moodle_url of the example assessment page
1037      */
1038     public function exassess_url($assessmentid) {
1039         global $CFG;
1040         $assessmentid = clean_param($assessmentid, PARAM_INT);
1041         return new moodle_url('/mod/workshop/exassessment.php', array('asid' => $assessmentid));
1042     }
1044     /**
1045      * @return moodle_url of the page to view a submission, defaults to the own one
1046      */
1047     public function submission_url($id=null) {
1048         global $CFG;
1049         return new moodle_url('/mod/workshop/submission.php', array('cmid' => $this->cm->id, 'id' => $id));
1050     }
1052     /**
1053      * @param int $id example submission id
1054      * @return moodle_url of the page to view an example submission
1055      */
1056     public function exsubmission_url($id) {
1057         global $CFG;
1058         return new moodle_url('/mod/workshop/exsubmission.php', array('cmid' => $this->cm->id, 'id' => $id));
1059     }
1061     /**
1062      * @param int $sid submission id
1063      * @param array $aid of int assessment ids
1064      * @return moodle_url of the page to compare assessments of the given submission
1065      */
1066     public function compare_url($sid, array $aids) {
1067         global $CFG;
1069         $url = new moodle_url('/mod/workshop/compare.php', array('cmid' => $this->cm->id, 'sid' => $sid));
1070         $i = 0;
1071         foreach ($aids as $aid) {
1072             $url->param("aid{$i}", $aid);
1073             $i++;
1074         }
1075         return $url;
1076     }
1078     /**
1079      * @param int $sid submission id
1080      * @param int $aid assessment id
1081      * @return moodle_url of the page to compare the reference assessments of the given example submission
1082      */
1083     public function excompare_url($sid, $aid) {
1084         global $CFG;
1085         return new moodle_url('/mod/workshop/excompare.php', array('cmid' => $this->cm->id, 'sid' => $sid, 'aid' => $aid));
1086     }
1088     /**
1089      * @return moodle_url of the mod_edit form
1090      */
1091     public function updatemod_url() {
1092         global $CFG;
1093         return new moodle_url('/course/modedit.php', array('update' => $this->cm->id, 'return' => 1));
1094     }
1096     /**
1097      * @param string $method allocation method
1098      * @return moodle_url to the allocation page
1099      */
1100     public function allocation_url($method=null) {
1101         global $CFG;
1102         $params = array('cmid' => $this->cm->id);
1103         if (!empty($method)) {
1104             $params['method'] = $method;
1105         }
1106         return new moodle_url('/mod/workshop/allocation.php', $params);
1107     }
1109     /**
1110      * @param int $phasecode The internal phase code
1111      * @return moodle_url of the script to change the current phase to $phasecode
1112      */
1113     public function switchphase_url($phasecode) {
1114         global $CFG;
1115         $phasecode = clean_param($phasecode, PARAM_INT);
1116         return new moodle_url('/mod/workshop/switchphase.php', array('cmid' => $this->cm->id, 'phase' => $phasecode));
1117     }
1119     /**
1120      * @return moodle_url to the aggregation page
1121      */
1122     public function aggregate_url() {
1123         global $CFG;
1124         return new moodle_url('/mod/workshop/aggregate.php', array('cmid' => $this->cm->id));
1125     }
1127     /**
1128      * @return moodle_url of this workshop's toolbox page
1129      */
1130     public function toolbox_url($tool) {
1131         global $CFG;
1132         return new moodle_url('/mod/workshop/toolbox.php', array('id' => $this->cm->id, 'tool' => $tool));
1133     }
1135     /**
1136      * Workshop wrapper around {@see add_to_log()}
1137      *
1138      * @param string $action to be logged
1139      * @param moodle_url $url absolute url as returned by {@see workshop::submission_url()} and friends
1140      * @param mixed $info additional info, usually id in a table
1141      */
1142     public function log($action, moodle_url $url = null, $info = null) {
1144         if (is_null($url)) {
1145             $url = $this->view_url();
1146         }
1148         if (is_null($info)) {
1149             $info = $this->id;
1150         }
1152         $logurl = $this->log_convert_url($url);
1153         add_to_log($this->course->id, 'workshop', $action, $logurl, $info, $this->cm->id);
1154     }
1156     /**
1157      * Is the given user allowed to create their submission?
1158      *
1159      * @param int $userid
1160      * @return bool
1161      */
1162     public function creating_submission_allowed($userid) {
1164         $now = time();
1165         $ignoredeadlines = has_capability('mod/workshop:ignoredeadlines', $this->context, $userid);
1167         if ($this->latesubmissions) {
1168             if ($this->phase != self::PHASE_SUBMISSION and $this->phase != self::PHASE_ASSESSMENT) {
1169                 // late submissions are allowed in the submission and assessment phase only
1170                 return false;
1171             }
1172             if (!$ignoredeadlines and !empty($this->submissionstart) and $this->submissionstart > $now) {
1173                 // late submissions are not allowed before the submission start
1174                 return false;
1175             }
1176             return true;
1178         } else {
1179             if ($this->phase != self::PHASE_SUBMISSION) {
1180                 // submissions are allowed during the submission phase only
1181                 return false;
1182             }
1183             if (!$ignoredeadlines and !empty($this->submissionstart) and $this->submissionstart > $now) {
1184                 // if enabled, submitting is not allowed before the date/time defined in the mod_form
1185                 return false;
1186             }
1187             if (!$ignoredeadlines and !empty($this->submissionend) and $now > $this->submissionend ) {
1188                 // if enabled, submitting is not allowed after the date/time defined in the mod_form unless late submission is allowed
1189                 return false;
1190             }
1191             return true;
1192         }
1193     }
1195     /**
1196      * Is the given user allowed to modify their existing submission?
1197      *
1198      * @param int $userid
1199      * @return bool
1200      */
1201     public function modifying_submission_allowed($userid) {
1203         $now = time();
1204         $ignoredeadlines = has_capability('mod/workshop:ignoredeadlines', $this->context, $userid);
1206         if ($this->phase != self::PHASE_SUBMISSION) {
1207             // submissions can be edited during the submission phase only
1208             return false;
1209         }
1210         if (!$ignoredeadlines and !empty($this->submissionstart) and $this->submissionstart > $now) {
1211             // if enabled, re-submitting is not allowed before the date/time defined in the mod_form
1212             return false;
1213         }
1214         if (!$ignoredeadlines and !empty($this->submissionend) and $now > $this->submissionend) {
1215             // if enabled, re-submitting is not allowed after the date/time defined in the mod_form even if late submission is allowed
1216             return false;
1217         }
1218         return true;
1219     }
1221     /**
1222      * Is the given reviewer allowed to create/edit their assessments?
1223      *
1224      * @param int $userid
1225      * @return bool
1226      */
1227     public function assessing_allowed($userid) {
1229         if ($this->phase != self::PHASE_ASSESSMENT) {
1230             // assessing is not allowed but in the assessment phase
1231             return false;
1232         }
1234         $now = time();
1235         $ignoredeadlines = has_capability('mod/workshop:ignoredeadlines', $this->context, $userid);
1237         if (!$ignoredeadlines and !empty($this->assessmentstart) and $this->assessmentstart > $now) {
1238             // if enabled, assessing is not allowed before the date/time defined in the mod_form
1239             return false;
1240         }
1241         if (!$ignoredeadlines and !empty($this->assessmentend) and $now > $this->assessmentend) {
1242             // if enabled, assessing is not allowed after the date/time defined in the mod_form
1243             return false;
1244         }
1245         // here we go, assessing is allowed
1246         return true;
1247     }
1249     /**
1250      * Are reviewers allowed to create/edit their assessments of the example submissions?
1251      *
1252      * Returns null if example submissions are not enabled in this workshop. Otherwise returns
1253      * true or false. Note this does not check other conditions like the number of already
1254      * assessed examples, examples mode etc.
1255      *
1256      * @return null|bool
1257      */
1258     public function assessing_examples_allowed() {
1259         if (empty($this->useexamples)) {
1260             return null;
1261         }
1262         if (self::EXAMPLES_VOLUNTARY == $this->examplesmode) {
1263             return true;
1264         }
1265         if (self::EXAMPLES_BEFORE_SUBMISSION == $this->examplesmode and self::PHASE_SUBMISSION == $this->phase) {
1266             return true;
1267         }
1268         if (self::EXAMPLES_BEFORE_ASSESSMENT == $this->examplesmode and self::PHASE_ASSESSMENT == $this->phase) {
1269             return true;
1270         }
1271         return false;
1272     }
1274     /**
1275      * Are the peer-reviews available to the authors?
1276      *
1277      * @return bool
1278      */
1279     public function assessments_available() {
1280         return $this->phase == self::PHASE_CLOSED;
1281     }
1283     /**
1284      * Switch to a new workshop phase
1285      *
1286      * Modifies the underlying database record. You should terminate the script shortly after calling this.
1287      *
1288      * @param int $newphase new phase code
1289      * @return bool true if success, false otherwise
1290      */
1291     public function switch_phase($newphase) {
1292         global $DB;
1294         $known = $this->available_phases_list();
1295         if (!isset($known[$newphase])) {
1296             return false;
1297         }
1299         if (self::PHASE_CLOSED == $newphase) {
1300             // push the grades into the gradebook
1301             $workshop = new stdclass();
1302             foreach ($this as $property => $value) {
1303                 $workshop->{$property} = $value;
1304             }
1305             $workshop->course     = $this->course->id;
1306             $workshop->cmidnumber = $this->cm->id;
1307             $workshop->modname    = 'workshop';
1308             workshop_update_grades($workshop);
1309         }
1311         $DB->set_field('workshop', 'phase', $newphase, array('id' => $this->id));
1312         return true;
1313     }
1315     /**
1316      * Saves a raw grade for submission as calculated from the assessment form fields
1317      *
1318      * @param array $assessmentid assessment record id, must exists
1319      * @param mixed $grade        raw percentual grade from 0.00000 to 100.00000
1320      * @return false|float        the saved grade
1321      */
1322     public function set_peer_grade($assessmentid, $grade) {
1323         global $DB;
1325         if (is_null($grade)) {
1326             return false;
1327         }
1328         $data = new stdclass();
1329         $data->id = $assessmentid;
1330         $data->grade = $grade;
1331         $data->timemodified = time();
1332         $DB->update_record('workshop_assessments', $data);
1333         return $grade;
1334     }
1336     /**
1337      * Prepares data object with all workshop grades to be rendered
1338      *
1339      * @param int $userid the user we are preparing the report for
1340      * @param mixed $groups single group or array of groups - only show users who are in one of these group(s). Defaults to all
1341      * @param int $page the current page (for the pagination)
1342      * @param int $perpage participants per page (for the pagination)
1343      * @param string $sortby lastname|firstname|submissiontitle|submissiongrade|gradinggrade
1344      * @param string $sorthow ASC|DESC
1345      * @return stdclass data for the renderer
1346      */
1347     public function prepare_grading_report_data($userid, $groups, $page, $perpage, $sortby, $sorthow) {
1348         global $DB;
1350         $canviewall     = has_capability('mod/workshop:viewallassessments', $this->context, $userid);
1351         $isparticipant  = has_any_capability(array('mod/workshop:submit', 'mod/workshop:peerassess'), $this->context, $userid);
1353         if (!$canviewall and !$isparticipant) {
1354             // who the hell is this?
1355             return array();
1356         }
1358         if (!in_array($sortby, array('lastname','firstname','submissiontitle','submissiongrade','gradinggrade'))) {
1359             $sortby = 'lastname';
1360         }
1362         if (!($sorthow === 'ASC' or $sorthow === 'DESC')) {
1363             $sorthow = 'ASC';
1364         }
1366         // get the list of user ids to be displayed
1367         if ($canviewall) {
1368             // fetch the list of ids of all workshop participants - this may get really long so fetch just id
1369             $participants = get_users_by_capability($this->context, array('mod/workshop:submit', 'mod/workshop:peerassess'),
1370                     'u.id', '', '', '', $groups, '', false, false, true);
1371         } else {
1372             // this is an ordinary workshop participant (aka student) - display the report just for him/her
1373             $participants = array($userid => (object)array('id' => $userid));
1374         }
1376         // we will need to know the number of all records later for the pagination purposes
1377         $numofparticipants = count($participants);
1379         if ($numofparticipants > 0) {
1380             // load all fields which can be used for sorting and paginate the records
1381             list($participantids, $params) = $DB->get_in_or_equal(array_keys($participants), SQL_PARAMS_NAMED);
1382             $params['workshopid1'] = $this->id;
1383             $params['workshopid2'] = $this->id;
1384             $sqlsort = array();
1385             $sqlsortfields = array($sortby => $sorthow) + array('lastname' => 'ASC', 'firstname' => 'ASC', 'u.id' => 'ASC');
1386             foreach ($sqlsortfields as $sqlsortfieldname => $sqlsortfieldhow) {
1387                 $sqlsort[] = $sqlsortfieldname . ' ' . $sqlsortfieldhow;
1388             }
1389             $sqlsort = implode(',', $sqlsort);
1390             $sql = "SELECT u.id AS userid,u.firstname,u.lastname,u.picture,u.imagealt,u.email,
1391                            s.title AS submissiontitle, s.grade AS submissiongrade, ag.gradinggrade
1392                       FROM {user} u
1393                  LEFT JOIN {workshop_submissions} s ON (s.authorid = u.id AND s.workshopid = :workshopid1 AND s.example = 0)
1394                  LEFT JOIN {workshop_aggregations} ag ON (ag.userid = u.id AND ag.workshopid = :workshopid2)
1395                      WHERE u.id $participantids
1396                   ORDER BY $sqlsort";
1397             $participants = $DB->get_records_sql($sql, $params, $page * $perpage, $perpage);
1398         } else {
1399             $participants = array();
1400         }
1402         // this will hold the information needed to display user names and pictures
1403         $userinfo = array();
1405         // get the user details for all participants to display
1406         foreach ($participants as $participant) {
1407             if (!isset($userinfo[$participant->userid])) {
1408                 $userinfo[$participant->userid]            = new stdclass();
1409                 $userinfo[$participant->userid]->id        = $participant->userid;
1410                 $userinfo[$participant->userid]->firstname = $participant->firstname;
1411                 $userinfo[$participant->userid]->lastname  = $participant->lastname;
1412                 $userinfo[$participant->userid]->picture   = $participant->picture;
1413                 $userinfo[$participant->userid]->imagealt  = $participant->imagealt;
1414                 $userinfo[$participant->userid]->email     = $participant->email;
1415             }
1416         }
1418         // load the submissions details
1419         $submissions = $this->get_submissions(array_keys($participants));
1421         // get the user details for all moderators (teachers) that have overridden a submission grade
1422         foreach ($submissions as $submission) {
1423             if (!isset($userinfo[$submission->gradeoverby])) {
1424                 $userinfo[$submission->gradeoverby]            = new stdclass();
1425                 $userinfo[$submission->gradeoverby]->id        = $submission->gradeoverby;
1426                 $userinfo[$submission->gradeoverby]->firstname = $submission->overfirstname;
1427                 $userinfo[$submission->gradeoverby]->lastname  = $submission->overlastname;
1428                 $userinfo[$submission->gradeoverby]->picture   = $submission->overpicture;
1429                 $userinfo[$submission->gradeoverby]->imagealt  = $submission->overimagealt;
1430                 $userinfo[$submission->gradeoverby]->email     = $submission->overemail;
1431             }
1432         }
1434         // get the user details for all reviewers of the displayed participants
1435         $reviewers = array();
1436         if ($submissions) {
1437             list($submissionids, $params) = $DB->get_in_or_equal(array_keys($submissions), SQL_PARAMS_NAMED);
1438             $sql = "SELECT a.id AS assessmentid, a.submissionid, a.grade, a.gradinggrade, a.gradinggradeover, a.weight,
1439                            r.id AS reviewerid, r.lastname, r.firstname, r.picture, r.imagealt, r.email,
1440                            s.id AS submissionid, s.authorid
1441                       FROM {workshop_assessments} a
1442                       JOIN {user} r ON (a.reviewerid = r.id)
1443                       JOIN {workshop_submissions} s ON (a.submissionid = s.id AND s.example = 0)
1444                      WHERE a.submissionid $submissionids
1445                   ORDER BY a.weight DESC, r.lastname, r.firstname";
1446             $reviewers = $DB->get_records_sql($sql, $params);
1447             foreach ($reviewers as $reviewer) {
1448                 if (!isset($userinfo[$reviewer->reviewerid])) {
1449                     $userinfo[$reviewer->reviewerid]            = new stdclass();
1450                     $userinfo[$reviewer->reviewerid]->id        = $reviewer->reviewerid;
1451                     $userinfo[$reviewer->reviewerid]->firstname = $reviewer->firstname;
1452                     $userinfo[$reviewer->reviewerid]->lastname  = $reviewer->lastname;
1453                     $userinfo[$reviewer->reviewerid]->picture   = $reviewer->picture;
1454                     $userinfo[$reviewer->reviewerid]->imagealt  = $reviewer->imagealt;
1455                     $userinfo[$reviewer->reviewerid]->email     = $reviewer->email;
1456                 }
1457             }
1458         }
1460         // get the user details for all reviewees of the displayed participants
1461         $reviewees = array();
1462         if ($participants) {
1463             list($participantids, $params) = $DB->get_in_or_equal(array_keys($participants), SQL_PARAMS_NAMED);
1464             $params['workshopid'] = $this->id;
1465             $sql = "SELECT a.id AS assessmentid, a.submissionid, a.grade, a.gradinggrade, a.gradinggradeover, a.reviewerid, a.weight,
1466                            s.id AS submissionid,
1467                            e.id AS authorid, e.lastname, e.firstname, e.picture, e.imagealt, e.email
1468                       FROM {user} u
1469                       JOIN {workshop_assessments} a ON (a.reviewerid = u.id)
1470                       JOIN {workshop_submissions} s ON (a.submissionid = s.id AND s.example = 0)
1471                       JOIN {user} e ON (s.authorid = e.id)
1472                      WHERE u.id $participantids AND s.workshopid = :workshopid
1473                   ORDER BY a.weight DESC, e.lastname, e.firstname";
1474             $reviewees = $DB->get_records_sql($sql, $params);
1475             foreach ($reviewees as $reviewee) {
1476                 if (!isset($userinfo[$reviewee->authorid])) {
1477                     $userinfo[$reviewee->authorid]            = new stdclass();
1478                     $userinfo[$reviewee->authorid]->id        = $reviewee->authorid;
1479                     $userinfo[$reviewee->authorid]->firstname = $reviewee->firstname;
1480                     $userinfo[$reviewee->authorid]->lastname  = $reviewee->lastname;
1481                     $userinfo[$reviewee->authorid]->picture   = $reviewee->picture;
1482                     $userinfo[$reviewee->authorid]->imagealt  = $reviewee->imagealt;
1483                     $userinfo[$reviewee->authorid]->email     = $reviewee->email;
1484                 }
1485             }
1486         }
1488         // finally populate the object to be rendered
1489         $grades = $participants;
1491         foreach ($participants as $participant) {
1492             // set up default (null) values
1493             $grades[$participant->userid]->submissionid = null;
1494             $grades[$participant->userid]->submissiontitle = null;
1495             $grades[$participant->userid]->submissiongrade = null;
1496             $grades[$participant->userid]->submissiongradeover = null;
1497             $grades[$participant->userid]->submissiongradeoverby = null;
1498             $grades[$participant->userid]->submissionpublished = null;
1499             $grades[$participant->userid]->reviewedby = array();
1500             $grades[$participant->userid]->reviewerof = array();
1501         }
1502         unset($participants);
1503         unset($participant);
1505         foreach ($submissions as $submission) {
1506             $grades[$submission->authorid]->submissionid = $submission->id;
1507             $grades[$submission->authorid]->submissiontitle = $submission->title;
1508             $grades[$submission->authorid]->submissiongrade = $this->real_grade($submission->grade);
1509             $grades[$submission->authorid]->submissiongradeover = $this->real_grade($submission->gradeover);
1510             $grades[$submission->authorid]->submissiongradeoverby = $submission->gradeoverby;
1511             $grades[$submission->authorid]->submissionpublished = $submission->published;
1512         }
1513         unset($submissions);
1514         unset($submission);
1516         foreach($reviewers as $reviewer) {
1517             $info = new stdclass();
1518             $info->userid = $reviewer->reviewerid;
1519             $info->assessmentid = $reviewer->assessmentid;
1520             $info->submissionid = $reviewer->submissionid;
1521             $info->grade = $this->real_grade($reviewer->grade);
1522             $info->gradinggrade = $this->real_grading_grade($reviewer->gradinggrade);
1523             $info->gradinggradeover = $this->real_grading_grade($reviewer->gradinggradeover);
1524             $info->weight = $reviewer->weight;
1525             $grades[$reviewer->authorid]->reviewedby[$reviewer->reviewerid] = $info;
1526         }
1527         unset($reviewers);
1528         unset($reviewer);
1530         foreach($reviewees as $reviewee) {
1531             $info = new stdclass();
1532             $info->userid = $reviewee->authorid;
1533             $info->assessmentid = $reviewee->assessmentid;
1534             $info->submissionid = $reviewee->submissionid;
1535             $info->grade = $this->real_grade($reviewee->grade);
1536             $info->gradinggrade = $this->real_grading_grade($reviewee->gradinggrade);
1537             $info->gradinggradeover = $this->real_grading_grade($reviewee->gradinggradeover);
1538             $info->weight = $reviewee->weight;
1539             $grades[$reviewee->reviewerid]->reviewerof[$reviewee->authorid] = $info;
1540         }
1541         unset($reviewees);
1542         unset($reviewee);
1544         foreach ($grades as $grade) {
1545             $grade->gradinggrade = $this->real_grading_grade($grade->gradinggrade);
1546         }
1548         $data = new stdclass();
1549         $data->grades = $grades;
1550         $data->userinfo = $userinfo;
1551         $data->totalcount = $numofparticipants;
1552         $data->maxgrade = $this->real_grade(100);
1553         $data->maxgradinggrade = $this->real_grading_grade(100);
1554         return $data;
1555     }
1557     /**
1558      * Calculates the real value of a grade
1559      *
1560      * @param float $value percentual value from 0 to 100
1561      * @param float $max   the maximal grade
1562      * @return string
1563      */
1564     public function real_grade_value($value, $max) {
1565         $localized = true;
1566         if (is_null($value) or $value === '') {
1567             return null;
1568         } elseif ($max == 0) {
1569             return 0;
1570         } else {
1571             return format_float($max * $value / 100, $this->gradedecimals, $localized);
1572         }
1573     }
1575     /**
1576      * Calculates the raw (percentual) value from a real grade
1577      *
1578      * This is used in cases when a user wants to give a grade such as 12 of 20 and we need to save
1579      * this value in a raw percentual form into DB
1580      * @param float $value given grade
1581      * @param float $max   the maximal grade
1582      * @return float       suitable to be stored as numeric(10,5)
1583      */
1584     public function raw_grade_value($value, $max) {
1585         if (is_null($value) or $value === '') {
1586             return null;
1587         }
1588         if ($max == 0 or $value < 0) {
1589             return 0;
1590         }
1591         $p = $value / $max * 100;
1592         if ($p > 100) {
1593             return $max;
1594         }
1595         return grade_floatval($p);
1596     }
1598     /**
1599      * Calculates the real value of grade for submission
1600      *
1601      * @param float $value percentual value from 0 to 100
1602      * @return string
1603      */
1604     public function real_grade($value) {
1605         return $this->real_grade_value($value, $this->grade);
1606     }
1608     /**
1609      * Calculates the real value of grade for assessment
1610      *
1611      * @param float $value percentual value from 0 to 100
1612      * @return string
1613      */
1614     public function real_grading_grade($value) {
1615         return $this->real_grade_value($value, $this->gradinggrade);
1616     }
1618     /**
1619      * Sets the given grades and received grading grades to null
1620      *
1621      * This does not clear the information about how the peers filled the assessment forms, but
1622      * clears the calculated grades in workshop_assessments. Therefore reviewers have to re-assess
1623      * the allocated submissions.
1624      *
1625      * @return void
1626      */
1627     public function clear_assessments() {
1628         global $DB;
1630         $submissions = $this->get_submissions();
1631         if (empty($submissions)) {
1632             // no money, no love
1633             return;
1634         }
1635         $submissions = array_keys($submissions);
1636         list($sql, $params) = $DB->get_in_or_equal($submissions, SQL_PARAMS_NAMED);
1637         $sql = "submissionid $sql";
1638         $DB->set_field_select('workshop_assessments', 'grade', null, $sql, $params);
1639         $DB->set_field_select('workshop_assessments', 'gradinggrade', null, $sql, $params);
1640     }
1642     /**
1643      * Sets the grades for submission to null
1644      *
1645      * @param null|int|array $restrict If null, update all authors, otherwise update just grades for the given author(s)
1646      * @return void
1647      */
1648     public function clear_submission_grades($restrict=null) {
1649         global $DB;
1651         $sql = "workshopid = :workshopid AND example = 0";
1652         $params = array('workshopid' => $this->id);
1654         if (is_null($restrict)) {
1655             // update all users - no more conditions
1656         } elseif (!empty($restrict)) {
1657             list($usql, $uparams) = $DB->get_in_or_equal($restrict, SQL_PARAMS_NAMED);
1658             $sql .= " AND authorid $usql";
1659             $params = array_merge($params, $uparams);
1660         } else {
1661             throw new coding_exception('Empty value is not a valid parameter here');
1662         }
1664         $DB->set_field_select('workshop_submissions', 'grade', null, $sql, $params);
1665     }
1667     /**
1668      * Calculates grades for submission for the given participant(s) and updates it in the database
1669      *
1670      * @param null|int|array $restrict If null, update all authors, otherwise update just grades for the given author(s)
1671      * @return void
1672      */
1673     public function aggregate_submission_grades($restrict=null) {
1674         global $DB;
1676         // fetch a recordset with all assessments to process
1677         $sql = 'SELECT s.id AS submissionid, s.grade AS submissiongrade,
1678                        a.weight, a.grade
1679                   FROM {workshop_submissions} s
1680              LEFT JOIN {workshop_assessments} a ON (a.submissionid = s.id)
1681                  WHERE s.example=0 AND s.workshopid=:workshopid'; // to be cont.
1682         $params = array('workshopid' => $this->id);
1684         if (is_null($restrict)) {
1685             // update all users - no more conditions
1686         } elseif (!empty($restrict)) {
1687             list($usql, $uparams) = $DB->get_in_or_equal($restrict, SQL_PARAMS_NAMED);
1688             $sql .= " AND s.authorid $usql";
1689             $params = array_merge($params, $uparams);
1690         } else {
1691             throw new coding_exception('Empty value is not a valid parameter here');
1692         }
1694         $sql .= ' ORDER BY s.id'; // this is important for bulk processing
1696         $rs         = $DB->get_recordset_sql($sql, $params);
1697         $batch      = array();    // will contain a set of all assessments of a single submission
1698         $previous   = null;       // a previous record in the recordset
1700         foreach ($rs as $current) {
1701             if (is_null($previous)) {
1702                 // we are processing the very first record in the recordset
1703                 $previous   = $current;
1704             }
1705             if ($current->submissionid == $previous->submissionid) {
1706                 // we are still processing the current submission
1707                 $batch[] = $current;
1708             } else {
1709                 // process all the assessments of a sigle submission
1710                 $this->aggregate_submission_grades_process($batch);
1711                 // and then start to process another submission
1712                 $batch      = array($current);
1713                 $previous   = $current;
1714             }
1715         }
1716         // do not forget to process the last batch!
1717         $this->aggregate_submission_grades_process($batch);
1718         $rs->close();
1719     }
1721     /**
1722      * Sets the aggregated grades for assessment to null
1723      *
1724      * @param null|int|array $restrict If null, update all reviewers, otherwise update just grades for the given reviewer(s)
1725      * @return void
1726      */
1727     public function clear_grading_grades($restrict=null) {
1728         global $DB;
1730         $sql = "workshopid = :workshopid";
1731         $params = array('workshopid' => $this->id);
1733         if (is_null($restrict)) {
1734             // update all users - no more conditions
1735         } elseif (!empty($restrict)) {
1736             list($usql, $uparams) = $DB->get_in_or_equal($restrict, SQL_PARAMS_NAMED);
1737             $sql .= " AND userid $usql";
1738             $params = array_merge($params, $uparams);
1739         } else {
1740             throw new coding_exception('Empty value is not a valid parameter here');
1741         }
1743         $DB->set_field_select('workshop_aggregations', 'gradinggrade', null, $sql, $params);
1744     }
1746     /**
1747      * Calculates grades for assessment for the given participant(s)
1748      *
1749      * Grade for assessment is calculated as a simple mean of all grading grades calculated by the grading evaluator.
1750      * The assessment weight is not taken into account here.
1751      *
1752      * @param null|int|array $restrict If null, update all reviewers, otherwise update just grades for the given reviewer(s)
1753      * @return void
1754      */
1755     public function aggregate_grading_grades($restrict=null) {
1756         global $DB;
1758         // fetch a recordset with all assessments to process
1759         $sql = 'SELECT a.reviewerid, a.gradinggrade, a.gradinggradeover,
1760                        ag.id AS aggregationid, ag.gradinggrade AS aggregatedgrade
1761                   FROM {workshop_assessments} a
1762             INNER JOIN {workshop_submissions} s ON (a.submissionid = s.id)
1763              LEFT JOIN {workshop_aggregations} ag ON (ag.userid = a.reviewerid AND ag.workshopid = s.workshopid)
1764                  WHERE s.example=0 AND s.workshopid=:workshopid'; // to be cont.
1765         $params = array('workshopid' => $this->id);
1767         if (is_null($restrict)) {
1768             // update all users - no more conditions
1769         } elseif (!empty($restrict)) {
1770             list($usql, $uparams) = $DB->get_in_or_equal($restrict, SQL_PARAMS_NAMED);
1771             $sql .= " AND a.reviewerid $usql";
1772             $params = array_merge($params, $uparams);
1773         } else {
1774             throw new coding_exception('Empty value is not a valid parameter here');
1775         }
1777         $sql .= ' ORDER BY a.reviewerid'; // this is important for bulk processing
1779         $rs         = $DB->get_recordset_sql($sql, $params);
1780         $batch      = array();    // will contain a set of all assessments of a single submission
1781         $previous   = null;       // a previous record in the recordset
1783         foreach ($rs as $current) {
1784             if (is_null($previous)) {
1785                 // we are processing the very first record in the recordset
1786                 $previous   = $current;
1787             }
1788             if ($current->reviewerid == $previous->reviewerid) {
1789                 // we are still processing the current reviewer
1790                 $batch[] = $current;
1791             } else {
1792                 // process all the assessments of a sigle submission
1793                 $this->aggregate_grading_grades_process($batch);
1794                 // and then start to process another reviewer
1795                 $batch      = array($current);
1796                 $previous   = $current;
1797             }
1798         }
1799         // do not forget to process the last batch!
1800         $this->aggregate_grading_grades_process($batch);
1801         $rs->close();
1802     }
1804     /**
1805      * Returns the mform the teachers use to put a feedback for the reviewer
1806      *
1807      * @param moodle_url $actionurl
1808      * @param stdClass $assessment
1809      * @param array $options editable, editableweight, overridablegradinggrade
1810      * @return workshop_feedbackreviewer_form
1811      */
1812     public function get_feedbackreviewer_form(moodle_url $actionurl, stdclass $assessment, $options=array()) {
1813         global $CFG;
1814         require_once(dirname(__FILE__) . '/feedbackreviewer_form.php');
1816         $current = new stdclass();
1817         $current->asid                      = $assessment->id;
1818         $current->weight                    = $assessment->weight;
1819         $current->gradinggrade              = $this->real_grading_grade($assessment->gradinggrade);
1820         $current->gradinggradeover          = $this->real_grading_grade($assessment->gradinggradeover);
1821         $current->feedbackreviewer          = $assessment->feedbackreviewer;
1822         $current->feedbackreviewerformat    = $assessment->feedbackreviewerformat;
1823         if (is_null($current->gradinggrade)) {
1824             $current->gradinggrade = get_string('nullgrade', 'workshop');
1825         }
1826         if (!isset($options['editable'])) {
1827             $editable = true;   // by default
1828         } else {
1829             $editable = (bool)$options['editable'];
1830         }
1832         // prepare wysiwyg editor
1833         $current = file_prepare_standard_editor($current, 'feedbackreviewer', array());
1835         return new workshop_feedbackreviewer_form($actionurl,
1836                 array('workshop' => $this, 'current' => $current, 'editoropts' => array(), 'options' => $options),
1837                 'post', '', null, $editable);
1838     }
1840     /**
1841      * Returns the mform the teachers use to put a feedback for the author on their submission
1842      *
1843      * @param moodle_url $actionurl
1844      * @param stdClass $submission
1845      * @param array $options editable
1846      * @return workshop_feedbackauthor_form
1847      */
1848     public function get_feedbackauthor_form(moodle_url $actionurl, stdclass $submission, $options=array()) {
1849         global $CFG;
1850         require_once(dirname(__FILE__) . '/feedbackauthor_form.php');
1852         $current = new stdclass();
1853         $current->submissionid          = $submission->id;
1854         $current->published             = $submission->published;
1855         $current->grade                 = $this->real_grade($submission->grade);
1856         $current->gradeover             = $this->real_grade($submission->gradeover);
1857         $current->feedbackauthor        = $submission->feedbackauthor;
1858         $current->feedbackauthorformat  = $submission->feedbackauthorformat;
1859         if (is_null($current->grade)) {
1860             $current->grade = get_string('nullgrade', 'workshop');
1861         }
1862         if (!isset($options['editable'])) {
1863             $editable = true;   // by default
1864         } else {
1865             $editable = (bool)$options['editable'];
1866         }
1868         // prepare wysiwyg editor
1869         $current = file_prepare_standard_editor($current, 'feedbackauthor', array());
1871         return new workshop_feedbackauthor_form($actionurl,
1872                 array('workshop' => $this, 'current' => $current, 'editoropts' => array(), 'options' => $options),
1873                 'post', '', null, $editable);
1874     }
1876     ////////////////////////////////////////////////////////////////////////////////
1877     // Internal methods (implementation details)                                  //
1878     ////////////////////////////////////////////////////////////////////////////////
1880     /**
1881      * Given an array of all assessments of a single submission, calculates the final grade for this submission
1882      *
1883      * This calculates the weighted mean of the passed assessment grades. If, however, the submission grade
1884      * was overridden by a teacher, the gradeover value is returned and the rest of grades are ignored.
1885      *
1886      * @param array $assessments of stdclass(->submissionid ->submissiongrade ->gradeover ->weight ->grade)
1887      * @return void
1888      */
1889     protected function aggregate_submission_grades_process(array $assessments) {
1890         global $DB;
1892         $submissionid   = null; // the id of the submission being processed
1893         $current        = null; // the grade currently saved in database
1894         $finalgrade     = null; // the new grade to be calculated
1895         $sumgrades      = 0;
1896         $sumweights     = 0;
1898         foreach ($assessments as $assessment) {
1899             if (is_null($submissionid)) {
1900                 // the id is the same in all records, fetch it during the first loop cycle
1901                 $submissionid = $assessment->submissionid;
1902             }
1903             if (is_null($current)) {
1904                 // the currently saved grade is the same in all records, fetch it during the first loop cycle
1905                 $current = $assessment->submissiongrade;
1906             }
1907             if (is_null($assessment->grade)) {
1908                 // this was not assessed yet
1909                 continue;
1910             }
1911             if ($assessment->weight == 0) {
1912                 // this does not influence the calculation
1913                 continue;
1914             }
1915             $sumgrades  += $assessment->grade * $assessment->weight;
1916             $sumweights += $assessment->weight;
1917         }
1918         if ($sumweights > 0 and is_null($finalgrade)) {
1919             $finalgrade = grade_floatval($sumgrades / $sumweights);
1920         }
1921         // check if the new final grade differs from the one stored in the database
1922         if (grade_floats_different($finalgrade, $current)) {
1923             // we need to save new calculation into the database
1924             $record = new stdclass();
1925             $record->id = $submissionid;
1926             $record->grade = $finalgrade;
1927             $record->timegraded = time();
1928             $DB->update_record('workshop_submissions', $record);
1929         }
1930     }
1932     /**
1933      * Given an array of all assessments done by a single reviewer, calculates the final grading grade
1934      *
1935      * This calculates the simple mean of the passed grading grades. If, however, the grading grade
1936      * was overridden by a teacher, the gradinggradeover value is returned and the rest of grades are ignored.
1937      *
1938      * @param array $assessments of stdclass(->reviewerid ->gradinggrade ->gradinggradeover ->aggregationid ->aggregatedgrade)
1939      * @return void
1940      */
1941     protected function aggregate_grading_grades_process(array $assessments) {
1942         global $DB;
1944         $reviewerid = null; // the id of the reviewer being processed
1945         $current    = null; // the gradinggrade currently saved in database
1946         $finalgrade = null; // the new grade to be calculated
1947         $agid       = null; // aggregation id
1948         $sumgrades  = 0;
1949         $count      = 0;
1951         foreach ($assessments as $assessment) {
1952             if (is_null($reviewerid)) {
1953                 // the id is the same in all records, fetch it during the first loop cycle
1954                 $reviewerid = $assessment->reviewerid;
1955             }
1956             if (is_null($agid)) {
1957                 // the id is the same in all records, fetch it during the first loop cycle
1958                 $agid = $assessment->aggregationid;
1959             }
1960             if (is_null($current)) {
1961                 // the currently saved grade is the same in all records, fetch it during the first loop cycle
1962                 $current = $assessment->aggregatedgrade;
1963             }
1964             if (!is_null($assessment->gradinggradeover)) {
1965                 // the grading grade for this assessment is overridden by a teacher
1966                 $sumgrades += $assessment->gradinggradeover;
1967                 $count++;
1968             } else {
1969                 if (!is_null($assessment->gradinggrade)) {
1970                     $sumgrades += $assessment->gradinggrade;
1971                     $count++;
1972                 }
1973             }
1974         }
1975         if ($count > 0) {
1976             $finalgrade = grade_floatval($sumgrades / $count);
1977         }
1978         // check if the new final grade differs from the one stored in the database
1979         if (grade_floats_different($finalgrade, $current)) {
1980             // we need to save new calculation into the database
1981             if (is_null($agid)) {
1982                 // no aggregation record yet
1983                 $record = new stdclass();
1984                 $record->workshopid = $this->id;
1985                 $record->userid = $reviewerid;
1986                 $record->gradinggrade = $finalgrade;
1987                 $record->timegraded = time();
1988                 $DB->insert_record('workshop_aggregations', $record);
1989             } else {
1990                 $record = new stdclass();
1991                 $record->id = $agid;
1992                 $record->gradinggrade = $finalgrade;
1993                 $record->timegraded = time();
1994                 $DB->update_record('workshop_aggregations', $record);
1995             }
1996         }
1997     }
1999     /**
2000      * Given a list of user ids, returns the filtered one containing just ids of users with own submission
2001      *
2002      * Example submissions are ignored.
2003      *
2004      * @param array $userids
2005      * @return array
2006      */
2007     protected function users_with_submission(array $userids) {
2008         global $DB;
2010         if (empty($userids)) {
2011             return array();
2012         }
2013         $userswithsubmission = array();
2014         list($usql, $uparams) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
2015         $sql = "SELECT id,authorid
2016                   FROM {workshop_submissions}
2017                  WHERE example = 0 AND workshopid = :workshopid AND authorid $usql";
2018         $params = array('workshopid' => $this->id);
2019         $params = array_merge($params, $uparams);
2020         $submissions = $DB->get_records_sql($sql, $params);
2021         foreach ($submissions as $submission) {
2022             $userswithsubmission[$submission->authorid] = true;
2023         }
2025         return $userswithsubmission;
2026     }
2028     /**
2029      * @return array of available workshop phases
2030      */
2031     protected function available_phases_list() {
2032         return array(
2033             self::PHASE_SETUP       => true,
2034             self::PHASE_SUBMISSION  => true,
2035             self::PHASE_ASSESSMENT  => true,
2036             self::PHASE_EVALUATION  => true,
2037             self::PHASE_CLOSED      => true,
2038         );
2039     }
2041     /**
2042      * Converts absolute URL to relative URL needed by {@see add_to_log()}
2043      *
2044      * @param moodle_url $url absolute URL
2045      * @return string
2046      */
2047     protected function log_convert_url(moodle_url $fullurl) {
2048         static $baseurl;
2050         if (!isset($baseurl)) {
2051             $baseurl = new moodle_url('/mod/workshop/');
2052             $baseurl = $baseurl->out();
2053         }
2055         return substr($fullurl->out(), strlen($baseurl));
2056     }
2059 ////////////////////////////////////////////////////////////////////////////////
2060 // Renderable components
2061 ////////////////////////////////////////////////////////////////////////////////
2063 /**
2064  * Represents the user planner tool
2065  *
2066  * Planner contains list of phases. Each phase contains list of tasks. Task is a simple object with
2067  * title, link and completed (true/false/null logic).
2068  */
2069 class workshop_user_plan implements renderable {
2071     /** @var int id of the user this plan is for */
2072     public $userid;
2073     /** @var workshop */
2074     public $workshop;
2075     /** @var array of (stdclass)tasks */
2076     public $phases = array();
2077     /** @var null|array of example submissions to be assessed by the planner owner */
2078     protected $examples = null;
2080     /**
2081      * Prepare an individual workshop plan for the given user.
2082      *
2083      * @param workshop $workshop instance
2084      * @param int $userid whom the plan is prepared for
2085      */
2086     public function __construct(workshop $workshop, $userid) {
2087         global $DB;
2089         $this->workshop = $workshop;
2090         $this->userid   = $userid;
2092         //---------------------------------------------------------
2093         // * SETUP | submission | assessment | evaluation | closed
2094         //---------------------------------------------------------
2095         $phase = new stdclass();
2096         $phase->title = get_string('phasesetup', 'workshop');
2097         $phase->tasks = array();
2098         if (has_capability('moodle/course:manageactivities', $workshop->context, $userid)) {
2099             $task = new stdclass();
2100             $task->title = get_string('taskintro', 'workshop');
2101             $task->link = $workshop->updatemod_url();
2102             $task->completed = !(trim($workshop->intro) == '');
2103             $phase->tasks['intro'] = $task;
2104         }
2105         if (has_capability('moodle/course:manageactivities', $workshop->context, $userid)) {
2106             $task = new stdclass();
2107             $task->title = get_string('taskinstructauthors', 'workshop');
2108             $task->link = $workshop->updatemod_url();
2109             $task->completed = !(trim($workshop->instructauthors) == '');
2110             $phase->tasks['instructauthors'] = $task;
2111         }
2112         if (has_capability('mod/workshop:editdimensions', $workshop->context, $userid)) {
2113             $task = new stdclass();
2114             $task->title = get_string('editassessmentform', 'workshop');
2115             $task->link = $workshop->editform_url();
2116             if ($workshop->grading_strategy_instance()->form_ready()) {
2117                 $task->completed = true;
2118             } elseif ($workshop->phase > workshop::PHASE_SETUP) {
2119                 $task->completed = false;
2120             }
2121             $phase->tasks['editform'] = $task;
2122         }
2123         if ($workshop->useexamples and has_capability('mod/workshop:manageexamples', $workshop->context, $userid)) {
2124             $task = new stdclass();
2125             $task->title = get_string('prepareexamples', 'workshop');
2126             if ($DB->count_records('workshop_submissions', array('example' => 1, 'workshopid' => $workshop->id)) > 0) {
2127                 $task->completed = true;
2128             } elseif ($workshop->phase > workshop::PHASE_SETUP) {
2129                 $task->completed = false;
2130             }
2131             $phase->tasks['prepareexamples'] = $task;
2132         }
2133         if (empty($phase->tasks) and $workshop->phase == workshop::PHASE_SETUP) {
2134             // if we are in the setup phase and there is no task (typical for students), let us
2135             // display some explanation what is going on
2136             $task = new stdclass();
2137             $task->title = get_string('undersetup', 'workshop');
2138             $task->completed = 'info';
2139             $phase->tasks['setupinfo'] = $task;
2140         }
2141         $this->phases[workshop::PHASE_SETUP] = $phase;
2143         //---------------------------------------------------------
2144         // setup | * SUBMISSION | assessment | evaluation | closed
2145         //---------------------------------------------------------
2146         $phase = new stdclass();
2147         $phase->title = get_string('phasesubmission', 'workshop');
2148         $phase->tasks = array();
2149         if (($workshop->usepeerassessment or $workshop->useselfassessment)
2150              and has_capability('moodle/course:manageactivities', $workshop->context, $userid)) {
2151             $task = new stdclass();
2152             $task->title = get_string('taskinstructreviewers', 'workshop');
2153             $task->link = $workshop->updatemod_url();
2154             if (trim($workshop->instructreviewers)) {
2155                 $task->completed = true;
2156             } elseif ($workshop->phase >= workshop::PHASE_ASSESSMENT) {
2157                 $task->completed = false;
2158             }
2159             $phase->tasks['instructreviewers'] = $task;
2160         }
2161         if ($workshop->useexamples and $workshop->examplesmode == workshop::EXAMPLES_BEFORE_SUBMISSION
2162                 and has_capability('mod/workshop:submit', $workshop->context, $userid, false)
2163                     and !has_capability('mod/workshop:manageexamples', $workshop->context, $userid)) {
2164             $task = new stdclass();
2165             $task->title = get_string('exampleassesstask', 'workshop');
2166             $examples = $this->get_examples();
2167             $a = new stdclass();
2168             $a->expected = count($examples);
2169             $a->assessed = 0;
2170             foreach ($examples as $exampleid => $example) {
2171                 if (!is_null($example->grade)) {
2172                     $a->assessed++;
2173                 }
2174             }
2175             $task->details = get_string('exampleassesstaskdetails', 'workshop', $a);
2176             if ($a->assessed == $a->expected) {
2177                 $task->completed = true;
2178             } elseif ($workshop->phase >= workshop::PHASE_ASSESSMENT) {
2179                 $task->completed = false;
2180             }
2181             $phase->tasks['examples'] = $task;
2182         }
2183         if (has_capability('mod/workshop:submit', $workshop->context, $userid, false)) {
2184             $task = new stdclass();
2185             $task->title = get_string('tasksubmit', 'workshop');
2186             $task->link = $workshop->submission_url();
2187             if ($DB->record_exists('workshop_submissions', array('workshopid'=>$workshop->id, 'example'=>0, 'authorid'=>$userid))) {
2188                 $task->completed = true;
2189             } elseif ($workshop->phase >= workshop::PHASE_ASSESSMENT) {
2190                 $task->completed = false;
2191             } else {
2192                 $task->completed = null;    // still has a chance to submit
2193             }
2194             $phase->tasks['submit'] = $task;
2195         }
2196         if (has_capability('mod/workshop:allocate', $workshop->context, $userid)) {
2197             $task = new stdclass();
2198             $task->title = get_string('allocate', 'workshop');
2199             $task->link = $workshop->allocation_url();
2200             $numofauthors = count(get_users_by_capability($workshop->context, 'mod/workshop:submit', 'u.id', '', '', '',
2201                     '', '', false, true));
2202             $numofsubmissions = $DB->count_records('workshop_submissions', array('workshopid'=>$workshop->id, 'example'=>0));
2203             $sql = 'SELECT COUNT(s.id) AS nonallocated
2204                       FROM {workshop_submissions} s
2205                  LEFT JOIN {workshop_assessments} a ON (a.submissionid=s.id)
2206                      WHERE s.workshopid = :workshopid AND s.example=0 AND a.submissionid IS NULL';
2207             $params['workshopid'] = $workshop->id;
2208             $numnonallocated = $DB->count_records_sql($sql, $params);
2209             if ($numofsubmissions == 0) {
2210                 $task->completed = null;
2211             } elseif ($numnonallocated == 0) {
2212                 $task->completed = true;
2213             } elseif ($workshop->phase > workshop::PHASE_SUBMISSION) {
2214                 $task->completed = false;
2215             } else {
2216                 $task->completed = null;    // still has a chance to allocate
2217             }
2218             $a = new stdclass();
2219             $a->expected    = $numofauthors;
2220             $a->submitted   = $numofsubmissions;
2221             $a->allocate    = $numnonallocated;
2222             $task->details  = get_string('allocatedetails', 'workshop', $a);
2223             unset($a);
2224             $phase->tasks['allocate'] = $task;
2226             if ($numofsubmissions < $numofauthors and $workshop->phase >= workshop::PHASE_SUBMISSION) {
2227                 $task = new stdclass();
2228                 $task->title = get_string('someuserswosubmission', 'workshop');
2229                 $task->completed = 'info';
2230                 $phase->tasks['allocateinfo'] = $task;
2231             }
2232         }
2233         if ($workshop->submissionstart) {
2234             $task = new stdclass();
2235             $task->title = get_string('submissionstartdatetime', 'workshop', workshop::timestamp_formats($workshop->submissionstart));
2236             $task->completed = 'info';
2237             $phase->tasks['submissionstartdatetime'] = $task;
2238         }
2239         if ($workshop->submissionend) {
2240             $task = new stdclass();
2241             $task->title = get_string('submissionenddatetime', 'workshop', workshop::timestamp_formats($workshop->submissionend));
2242             $task->completed = 'info';
2243             $phase->tasks['submissionenddatetime'] = $task;
2244         }
2245         if (($workshop->submissionstart < time()) and $workshop->latesubmissions) {
2246             $task = new stdclass();
2247             $task->title = get_string('latesubmissionsallowed', 'workshop');
2248             $task->completed = 'info';
2249             $phase->tasks['latesubmissionsallowed'] = $task;
2250         }
2251         if (isset($phase->tasks['submissionstartdatetime']) or isset($phase->tasks['submissionenddatetime'])) {
2252             if (has_capability('mod/workshop:ignoredeadlines', $workshop->context, $userid)) {
2253                 $task = new stdclass();
2254                 $task->title = get_string('deadlinesignored', 'workshop');
2255                 $task->completed = 'info';
2256                 $phase->tasks['deadlinesignored'] = $task;
2257             }
2258         }
2259         $this->phases[workshop::PHASE_SUBMISSION] = $phase;
2261         //---------------------------------------------------------
2262         // setup | submission | * ASSESSMENT | evaluation | closed
2263         //---------------------------------------------------------
2264         $phase = new stdclass();
2265         $phase->title = get_string('phaseassessment', 'workshop');
2266         $phase->tasks = array();
2267         $phase->isreviewer = has_capability('mod/workshop:peerassess', $workshop->context, $userid);
2268         if ($workshop->useexamples and $workshop->examplesmode == workshop::EXAMPLES_BEFORE_ASSESSMENT
2269                 and $phase->isreviewer and !has_capability('mod/workshop:manageexamples', $workshop->context, $userid)) {
2270             $task = new stdclass();
2271             $task->title = get_string('exampleassesstask', 'workshop');
2272             $examples = $workshop->get_examples_for_reviewer($userid);
2273             $a = new stdclass();
2274             $a->expected = count($examples);
2275             $a->assessed = 0;
2276             foreach ($examples as $exampleid => $example) {
2277                 if (!is_null($example->grade)) {
2278                     $a->assessed++;
2279                 }
2280             }
2281             $task->details = get_string('exampleassesstaskdetails', 'workshop', $a);
2282             if ($a->assessed == $a->expected) {
2283                 $task->completed = true;
2284             } elseif ($workshop->phase > workshop::PHASE_ASSESSMENT) {
2285                 $task->completed = false;
2286             }
2287             $phase->tasks['examples'] = $task;
2288         }
2289         if (empty($phase->tasks['examples']) or !empty($phase->tasks['examples']->completed)) {
2290             $phase->assessments = $workshop->get_assessments_by_reviewer($userid);
2291             $numofpeers     = 0;    // number of allocated peer-assessments
2292             $numofpeerstodo = 0;    // number of peer-assessments to do
2293             $numofself      = 0;    // number of allocated self-assessments - should be 0 or 1
2294             $numofselftodo  = 0;    // number of self-assessments to do - should be 0 or 1
2295             foreach ($phase->assessments as $a) {
2296                 if ($a->authorid == $userid) {
2297                     $numofself++;
2298                     if (is_null($a->grade)) {
2299                         $numofselftodo++;
2300                     }
2301                 } else {
2302                     $numofpeers++;
2303                     if (is_null($a->grade)) {
2304                         $numofpeerstodo++;
2305                     }
2306                 }
2307             }
2308             unset($a);
2309             if ($workshop->usepeerassessment and $numofpeers) {
2310                 $task = new stdclass();
2311                 if ($numofpeerstodo == 0) {
2312                     $task->completed = true;
2313                 } elseif ($workshop->phase > workshop::PHASE_ASSESSMENT) {
2314                     $task->completed = false;
2315                 }
2316                 $a = new stdclass();
2317                 $a->total = $numofpeers;
2318                 $a->todo  = $numofpeerstodo;
2319                 $task->title = get_string('taskassesspeers', 'workshop');
2320                 $task->details = get_string('taskassesspeersdetails', 'workshop', $a);
2321                 unset($a);
2322                 $phase->tasks['assesspeers'] = $task;
2323             }
2324             if ($workshop->useselfassessment and $numofself) {
2325                 $task = new stdclass();
2326                 if ($numofselftodo == 0) {
2327                     $task->completed = true;
2328                 } elseif ($workshop->phase > workshop::PHASE_ASSESSMENT) {
2329                     $task->completed = false;
2330                 }
2331                 $task->title = get_string('taskassessself', 'workshop');
2332                 $phase->tasks['assessself'] = $task;
2333             }
2334         }
2335         if ($workshop->assessmentstart) {
2336             $task = new stdclass();
2337             $task->title = get_string('assessmentstartdatetime', 'workshop', workshop::timestamp_formats($workshop->assessmentstart));
2338             $task->completed = 'info';
2339             $phase->tasks['assessmentstartdatetime'] = $task;
2340         }
2341         if ($workshop->assessmentend) {
2342             $task = new stdclass();
2343             $task->title = get_string('assessmentenddatetime', 'workshop', workshop::timestamp_formats($workshop->assessmentend));
2344             $task->completed = 'info';
2345             $phase->tasks['assessmentenddatetime'] = $task;
2346         }
2347         if (isset($phase->tasks['assessmentstartdatetime']) or isset($phase->tasks['assessmentenddatetime'])) {
2348             if (has_capability('mod/workshop:ignoredeadlines', $workshop->context, $userid)) {
2349                 $task = new stdclass();
2350                 $task->title = get_string('deadlinesignored', 'workshop');
2351                 $task->completed = 'info';
2352                 $phase->tasks['deadlinesignored'] = $task;
2353             }
2354         }
2355         $this->phases[workshop::PHASE_ASSESSMENT] = $phase;
2357         //---------------------------------------------------------
2358         // setup | submission | assessment | * EVALUATION | closed
2359         //---------------------------------------------------------
2360         $phase = new stdclass();
2361         $phase->title = get_string('phaseevaluation', 'workshop');
2362         $phase->tasks = array();
2363         if (has_capability('mod/workshop:overridegrades', $workshop->context)) {
2364             $expected = count($workshop->get_potential_authors(false));
2365             $calculated = $DB->count_records_select('workshop_submissions',
2366                     'workshopid = ? AND (grade IS NOT NULL OR gradeover IS NOT NULL)', array($workshop->id));
2367             $task = new stdclass();
2368             $task->title = get_string('calculatesubmissiongrades', 'workshop');
2369             $a = new stdclass();
2370             $a->expected    = $expected;
2371             $a->calculated  = $calculated;
2372             $task->details  = get_string('calculatesubmissiongradesdetails', 'workshop', $a);
2373             if ($calculated >= $expected) {
2374                 $task->completed = true;
2375             } elseif ($workshop->phase > workshop::PHASE_EVALUATION) {
2376                 $task->completed = false;
2377             }
2378             $phase->tasks['calculatesubmissiongrade'] = $task;
2380             $expected = count($workshop->get_potential_reviewers(false));
2381             $calculated = $DB->count_records_select('workshop_aggregations',
2382                     'workshopid = ? AND gradinggrade IS NOT NULL', array($workshop->id));
2383             $task = new stdclass();
2384             $task->title = get_string('calculategradinggrades', 'workshop');
2385             $a = new stdclass();
2386             $a->expected    = $expected;
2387             $a->calculated  = $calculated;
2388             $task->details  = get_string('calculategradinggradesdetails', 'workshop', $a);
2389             if ($calculated >= $expected) {
2390                 $task->completed = true;
2391             } elseif ($workshop->phase > workshop::PHASE_EVALUATION) {
2392                 $task->completed = false;
2393             }
2394             $phase->tasks['calculategradinggrade'] = $task;
2396         } elseif ($workshop->phase == workshop::PHASE_EVALUATION) {
2397             $task = new stdclass();
2398             $task->title = get_string('evaluategradeswait', 'workshop');
2399             $task->completed = 'info';
2400             $phase->tasks['evaluateinfo'] = $task;
2401         }
2402         $this->phases[workshop::PHASE_EVALUATION] = $phase;
2404         //---------------------------------------------------------
2405         // setup | submission | assessment | evaluation | * CLOSED
2406         //---------------------------------------------------------
2407         $phase = new stdclass();
2408         $phase->title = get_string('phaseclosed', 'workshop');
2409         $phase->tasks = array();
2410         $this->phases[workshop::PHASE_CLOSED] = $phase;
2412         // Polish data, set default values if not done explicitly
2413         foreach ($this->phases as $phasecode => $phase) {
2414             $phase->title       = isset($phase->title)      ? $phase->title     : '';
2415             $phase->tasks       = isset($phase->tasks)      ? $phase->tasks     : array();
2416             if ($phasecode == $workshop->phase) {
2417                 $phase->active = true;
2418             } else {
2419                 $phase->active = false;
2420             }
2421             if (!isset($phase->actions)) {
2422                 $phase->actions = array();
2423             }
2425             foreach ($phase->tasks as $taskcode => $task) {
2426                 $task->title        = isset($task->title)       ? $task->title      : '';
2427                 $task->link         = isset($task->link)        ? $task->link       : null;
2428                 $task->details      = isset($task->details)     ? $task->details    : '';
2429                 $task->completed    = isset($task->completed)   ? $task->completed  : null;
2430             }
2431         }
2433         // Add phase switching actions
2434         if (has_capability('mod/workshop:switchphase', $workshop->context, $userid)) {
2435             foreach ($this->phases as $phasecode => $phase) {
2436                 if (! $phase->active) {
2437                     $action = new stdclass();
2438                     $action->type = 'switchphase';
2439                     $action->url  = $workshop->switchphase_url($phasecode);
2440                     $phase->actions[] = $action;
2441                 }
2442             }
2443         }
2444     }
2446     /**
2447      * Returns example submissions to be assessed by the owner of the planner
2448      *
2449      * This is here to cache the DB query because the same list is needed later in view.php
2450      *
2451      * @see workshop::get_examples_for_reviewer() for the format of returned value
2452      * @return array
2453      */
2454     public function get_examples() {
2455         if (is_null($this->examples)) {
2456             $this->examples = $this->workshop->get_examples_for_reviewer($this->userid);
2457         }
2458         return $this->examples;
2459     }
2462 /**
2463  * Common base class for submissions and example submissions rendering
2464  *
2465  * Subclasses of this class convert raw submission record from
2466  * workshop_submissions table (as returned by {@see workshop::get_submission_by_id()}
2467  * for example) into renderable objects.
2468  */
2469 abstract class workshop_submission_base {
2471     /** @var bool is the submission anonymous (i.e. contains author information) */
2472     protected $anonymous;
2474     /* @var array of columns from workshop_submissions that are assigned as properties */
2475     protected $fields = array();
2477     /**
2478      * Copies the properties of the given database record into properties of $this instance
2479      *
2480      * @param stdClass $submission full record
2481      * @param bool $showauthor show the author-related information
2482      * @param array $options additional properties
2483      */
2484     public function __construct(stdClass $submission, $showauthor = false) {
2486         foreach ($this->fields as $field) {
2487             if (!property_exists($submission, $field)) {
2488                 throw new coding_exception('Submission record must provide public property ' . $field);
2489             }
2490             if (!property_exists($this, $field)) {
2491                 throw new coding_exception('Renderable component must accept public property ' . $field);
2492             }
2493             $this->{$field} = $submission->{$field};
2494         }
2496         if ($showauthor) {
2497             $this->anonymous = false;
2498         } else {
2499             $this->anonymize();
2500         }
2501     }
2503     /**
2504      * Unsets all author-related properties so that the renderer does not have access to them
2505      *
2506      * Usually this is called by the contructor but can be called explicitely, too.
2507      */
2508     public function anonymize() {
2509         foreach (array('authorid', 'authorfirstname', 'authorlastname',
2510                'authorpicture', 'authorimagealt', 'authoremail') as $field) {
2511             unset($this->{$field});
2512         }
2513         $this->anonymous = true;
2514     }
2516     /**
2517      * Does the submission object contain author-related information?
2518      *
2519      * @return null|boolean
2520      */
2521     public function is_anonymous() {
2522         return $this->anonymous;
2523     }
2526 /**
2527  * Renderable object containing a basic set of information needed to display the submission summary
2528  *
2529  * @see workshop_renderer::render_workshop_submission_summary
2530  */
2531 class workshop_submission_summary extends workshop_submission_base implements renderable {
2533     /** @var int */
2534     public $id;
2535     /** @var string */
2536     public $title;
2537     /** @var string graded|notgraded */
2538     public $status;
2539     /** @var int */
2540     public $timecreated;
2541     /** @var int */
2542     public $timemodified;
2543     /** @var int */
2544     public $authorid;
2545     /** @var string */
2546     public $authorfirstname;
2547     /** @var string */
2548     public $authorlastname;
2549     /** @var int */
2550     public $authorpicture;
2551     /** @var string */
2552     public $authorimagealt;
2553     /** @var string */
2554     public $authoremail;
2555     /** @var moodle_url to display submission */
2556     public $url;
2558     /**
2559      * @var array of columns from workshop_submissions that are assigned as properties
2560      * of instances of this class
2561      */
2562     protected $fields = array(
2563         'id', 'title', 'timecreated', 'timemodified',
2564         'authorid', 'authorfirstname', 'authorlastname', 'authorpicture',
2565         'authorimagealt', 'authoremail');
2568 /**
2569  * Renderable object containing all the information needed to display the submission
2570  *
2571  * @see workshop_renderer::render_workshop_submission()
2572  */
2573 class workshop_submission extends workshop_submission_summary implements renderable {
2575     /** @var string */
2576     public $content;
2577     /** @var int */
2578     public $contentformat;
2579     /** @var bool */
2580     public $contenttrust;
2581     /** @var array */
2582     public $attachment;
2584     /**
2585      * @var array of columns from workshop_submissions that are assigned as properties
2586      * of instances of this class
2587      */
2588     protected $fields = array(
2589         'id', 'title', 'timecreated', 'timemodified', 'content', 'contentformat', 'contenttrust',
2590         'attachment', 'authorid', 'authorfirstname', 'authorlastname', 'authorpicture',
2591         'authorimagealt', 'authoremail');
2594 /**
2595  * Renderable object containing a basic set of information needed to display the example submission summary
2596  *
2597  * @see workshop::prepare_example_summary()
2598  * @see workshop_renderer::render_workshop_example_submission_summary()
2599  */
2600 class workshop_example_submission_summary extends workshop_submission_base implements renderable {
2602     /** @var int */
2603     public $id;
2604     /** @var string */
2605     public $title;
2606     /** @var string graded|notgraded */
2607     public $status;
2608     /** @var stdClass */
2609     public $gradeinfo;
2610     /** @var moodle_url */
2611     public $url;
2612     /** @var moodle_url */
2613     public $editurl;
2614     /** @var string */
2615     public $assesslabel;
2616     /** @var moodle_url */
2617     public $assessurl;
2618     /** @var bool must be set explicitly by the caller */
2619     public $editable = false;
2621     /**
2622      * @var array of columns from workshop_submissions that are assigned as properties
2623      * of instances of this class
2624      */
2625     protected $fields = array('id', 'title');
2627     /**
2628      * Example submissions are always anonymous
2629      *
2630      * @return true
2631      */
2632     public function is_anonymous() {
2633         return true;
2634     }
2637 /**
2638  * Renderable object containing all the information needed to display the example submission
2639  *
2640  * @see workshop_renderer::render_workshop_example_submission()
2641  */
2642 class workshop_example_submission extends workshop_example_submission_summary implements renderable {
2644     /** @var string */
2645     public $content;
2646     /** @var int */
2647     public $contentformat;
2648     /** @var bool */
2649     public $contenttrust;
2650     /** @var array */
2651     public $attachment;
2653     /**
2654      * @var array of columns from workshop_submissions that are assigned as properties
2655      * of instances of this class
2656      */
2657     protected $fields = array('id', 'title', 'content', 'contentformat', 'contenttrust', 'attachment');
2661 /**
2662  * Common base class for assessments rendering
2663  *
2664  * Subclasses of this class convert raw assessment record from
2665  * workshop_assessments table (as returned by {@see workshop::get_assessment_by_id()}
2666  * for example) into renderable objects.
2667  */
2668 abstract class workshop_assessment_base {
2670     /** @var string the optional title of the assessment */
2671     public $title = '';
2673     /** @var workshop_assessment_form $form as returned by {@link workshop_strategy::get_assessment_form()} */
2674     public $form;
2676     /** @var moodle_url */
2677     public $url;
2679     /** @var float|null the real received grade */
2680     public $realgrade = null;
2682     /** @var float the real maximum grade */
2683     public $maxgrade;
2685     /** @var stdClass|null reviewer user info */
2686     public $reviewer = null;
2688     /** @var stdClass|null assessed submission's author user info */
2689     public $author = null;
2691     /** @var array of actions */
2692     public $actions = array();
2694     /* @var array of columns that are assigned as properties */
2695     protected $fields = array();
2697     /**
2698      * Copies the properties of the given database record into properties of $this instance
2699      *
2700      * The $options keys are: showreviewer, showauthor
2701      * @param stdClass $assessment full record
2702      * @param array $options additional properties
2703      */
2704     public function __construct(stdClass $record, array $options = array()) {
2706         foreach ($this->fields as $field) {
2707             if (!property_exists($record, $field)) {
2708                 throw new coding_exception('Assessment record must provide public property ' . $field);
2709             }
2710             if (!property_exists($this, $field)) {
2711                 throw new coding_exception('Renderable component must accept public property ' . $field);
2712             }
2713             $this->{$field} = $record->{$field};
2714         }
2716         if (!empty($options['showreviewer'])) {
2717             $this->reviewer = user_picture::unalias($record, null, 'revieweridx', 'reviewer');
2718         }
2720         if (!empty($options['showauthor'])) {
2721             $this->author = user_picture::unalias($record, null, 'authorid', 'author');
2722         }
2723     }
2725     /**
2726      * Adds a new action
2727      *
2728      * @param moodle_url $url action URL
2729      * @param string $label action label
2730      * @param string $method get|post
2731      */
2732     public function add_action(moodle_url $url, $label, $method = 'get') {
2734         $action = new stdClass();
2735         $action->url = $url;
2736         $action->label = $label;
2737         $action->method = $method;
2739         $this->actions[] = $action;
2740     }
2744 /**
2745  * Represents a rendarable full assessment
2746  */
2747 class workshop_assessment extends workshop_assessment_base implements renderable {
2749     /** @var int */
2750     public $id;
2752     /** @var int */
2753     public $submissionid;
2755     /** @var int */
2756     public $weight;
2758     /** @var int */
2759     public $timecreated;
2761     /** @var int */
2762     public $timemodified;
2764     /** @var float */
2765     public $grade;
2767     /** @var float */
2768     public $gradinggrade;
2770     /** @var float */
2771     public $gradinggradeover;
2773     /** @var array */
2774     protected $fields = array('id', 'submissionid', 'weight', 'timecreated',
2775         'timemodified', 'grade', 'gradinggrade', 'gradinggradeover');
2778 /**
2779  * Renderable message to be displayed to the user
2780  *
2781  * Message can contain an optional action link with a label that is supposed to be rendered
2782  * as a button or a link.
2783  *
2784  * @see workshop::renderer::render_workshop_message()
2785  */
2786 class workshop_message implements renderable {
2788     const TYPE_INFO     = 10;
2789     const TYPE_OK       = 20;
2790     const TYPE_ERROR    = 30;
2792     /** @var string */
2793     protected $text = '';
2794     /** @var int */
2795     protected $type = self::TYPE_INFO;
2796     /** @var moodle_url */
2797     protected $actionurl = null;
2798     /** @var string */
2799     protected $actionlabel = '';
2801     /**
2802      * @param string $text short text to be displayed
2803      * @param string $type optional message type info|ok|error
2804      */
2805     public function __construct($text = null, $type = self::TYPE_INFO) {
2806         $this->set_text($text);
2807         $this->set_type($type);
2808     }
2810     /**
2811      * Sets the message text
2812      *
2813      * @param string $text short text to be displayed
2814      */
2815     public function set_text($text) {
2816         $this->text = $text;
2817     }
2819     /**
2820      * Sets the message type
2821      *
2822      * @param int $type
2823      */
2824     public function set_type($type = self::TYPE_INFO) {
2825         if (in_array($type, array(self::TYPE_OK, self::TYPE_ERROR, self::TYPE_INFO))) {
2826             $this->type = $type;
2827         } else {
2828             throw new coding_exception('Unknown message type.');
2829         }
2830     }
2832     /**
2833      * Sets the optional message action
2834      *
2835      * @param moodle_url $url to follow on action
2836      * @param string $label action label
2837      */
2838     public function set_action(moodle_url $url, $label) {
2839         $this->actionurl    = $url;
2840         $this->actionlabel  = $label;
2841     }
2843     /**
2844      * Returns message text with HTML tags quoted
2845      *
2846      * @return string
2847      */
2848     public function get_message() {
2849         return s($this->text);
2850     }
2852     /**
2853      * Returns message type
2854      *
2855      * @return int
2856      */
2857     public function get_type() {
2858         return $this->type;
2859     }
2861     /**
2862      * Returns action URL
2863      *
2864      * @return moodle_url|null
2865      */
2866     public function get_action_url() {
2867         return $this->actionurl;
2868     }
2870     /**
2871      * Returns action label
2872      *
2873      * @return string
2874      */
2875     public function get_action_label() {
2876         return $this->actionlabel;
2877     }
2880 /**
2881  * Renderable output of submissions allocation process
2882  */
2883 class workshop_allocation_init_result implements renderable {
2885     /** @var workshop_message */
2886     protected $message;
2887     /** @var array of steps */
2888     protected $info = array();
2889     /** @var moodle_url */
2890     protected $continue;
2892     /**
2893      * Supplied argument can be either integer status code or an array of string messages. Messages
2894      * in a array can have optional prefix or prefixes, using '::' as delimiter. Prefixes determine
2895      * the type of the message and may influence its visualisation.
2896      *
2897      * @param mixed $result int|array returned by {@see workshop_allocator::init()}
2898      * @param moodle_url to continue
2899      */
2900     public function __construct($result, moodle_url $continue) {
2902         if ($result === workshop::ALLOCATION_ERROR) {
2903             $this->message = new workshop_message(get_string('allocationerror', 'workshop'), workshop_message::TYPE_ERROR);
2904         } else {
2905             $this->message = new workshop_message(get_string('allocationdone', 'workshop'), workshop_message::TYPE_OK);
2906             if (is_array($result)) {
2907                 $this->info = $result;
2908             }
2909         }
2911         $this->continue = $continue;
2912     }
2914     /**
2915      * @return workshop_message instance to render
2916      */
2917     public function get_message() {
2918         return $this->message;
2919     }
2921     /**
2922      * @return array of strings with allocation process details
2923      */
2924     public function get_info() {
2925         return $this->info;
2926     }
2928     /**
2929      * @return moodle_url where the user shoudl continue
2930      */
2931     public function get_continue_url() {
2932         return $this->continue;
2933     }
2936 /**
2937  * Renderable component containing all the data needed to display the grading report
2938  */
2939 class workshop_grading_report implements renderable {
2941     /** @var stdClass returned by {@see workshop::prepare_grading_report_data()} */
2942     protected $data;
2943     /** @var stdClass rendering options */
2944     protected $options;
2946     /**
2947      * Grades in $data must be already rounded to the set number of decimals or must be null
2948      * (in which later case, the [mod_workshop,nullgrade] string shall be displayed)
2949      *
2950      * @param stdClass $data prepared by {@link workshop::prepare_grading_report_data()}
2951      * @param stdClass $options display options (showauthornames, showreviewernames, sortby, sorthow, showsubmissiongrade, showgradinggrade)
2952      */
2953     public function __construct(stdClass $data, stdClass $options) {
2954         $this->data     = $data;
2955         $this->options  = $options;
2956     }
2958     /**
2959      * @return stdClass grading report data
2960      */
2961     public function get_data() {
2962         return $this->data;
2963     }
2965     /**
2966      * @return stdClass rendering options
2967      */
2968     public function get_options() {
2969         return $this->options;
2970     }
2974 /**
2975  * Base class for renderable feedback for author and feedback for reviewer
2976  */
2977 abstract class workshop_feedback {
2979     /** @var stdClass the user info */
2980     protected $provider = null;
2982     /** @var string the feedback text */
2983     protected $content = null;
2985     /** @var int format of the feedback text */
2986     protected $format = null;
2988     /**
2989      * @return stdClass the user info
2990      */
2991     public function get_provider() {
2993         if (is_null($this->provider)) {
2994             throw new coding_exception('Feedback provider not set');
2995         }
2997         return $this->provider;
2998     }
3000     /**
3001      * @return string the feedback text
3002      */
3003     public function get_content() {
3005         if (is_null($this->content)) {
3006             throw new coding_exception('Feedback content not set');
3007         }
3009         return $this->content;
3010     }
3012     /**
3013      * @return int format of the feedback text
3014      */
3015     public function get_format() {
3017         if (is_null($this->format)) {
3018             throw new coding_exception('Feedback text format not set');
3019         }
3021         return $this->format;
3022     }
3026 /**
3027  * Renderable feedback for the author of submission
3028  */
3029 class workshop_feedback_author extends workshop_feedback implements renderable {
3031     /**
3032      * Extracts feedback from the given submission record
3033      *
3034      * @param stdClass $submission record as returned by {@see self::get_submission_by_id()}
3035      */
3036     public function __construct(stdClass $submission) {
3038         $this->provider = user_picture::unalias($submission, null, 'gradeoverbyx', 'gradeoverby');
3039         $this->content  = $submission->feedbackauthor;
3040         $this->format   = $submission->feedbackauthorformat;
3041     }