58444636765a06a333b23063fd1b0fa59e12eb0d
[moodle.git] / mod / assign / submission / comments / lib.php
1 <?PHP
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * This file contains the moodle hooks for the submission comments plugin
19  *
20  * @package   assignsubmission_comments
21  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
24 defined('MOODLE_INTERNAL') || die();
26 /**
27  *
28  * Callback method for data validation---- required method for AJAXmoodle based comment API
29  *
30  * @param stdClass $options
31  * @return bool
32  */
33 function assignsubmission_comments_comment_validate(stdClass $options) {
34     global $USER, $CFG, $DB;
36     if ($options->commentarea != 'submission_comments' &&
37             $options->commentarea != 'submission_comments_upgrade') {
38         throw new comment_exception('invalidcommentarea');
39     }
40     if (!$submission = $DB->get_record('assign_submission', array('id'=>$options->itemid))) {
41         throw new comment_exception('invalidcommentitemid');
42     }
43     $context = $options->context;
45     require_once($CFG->dirroot . '/mod/assign/locallib.php');
46     $assignment = new assign($context, null, null);
48     if ($assignment->get_instance()->id != $submission->assignment) {
49         throw new comment_exception('invalidcontext');
50     }
51     if (!has_capability('mod/assign:grade', $context)) {
52         if (!has_capability('mod/assign:submit', $context)) {
53             throw new comment_exception('nopermissiontocomment');
54         } else if ($assignment->get_instance()->teamsubmission) {
55             $group = $assignment->get_submission_group($USER->id);
56             $groupid = 0;
57             if ($group) {
58                 $groupid = $group->id;
59             }
60             if ($groupid != $submission->groupid) {
61                 throw new comment_exception('nopermissiontocomment');
62             }
63         } else if ($submission->userid != $USER->id) {
64             throw new comment_exception('nopermissiontocomment');
65         }
66     }
68     return true;
69 }
71 /**
72  * Permission control method for submission plugin ---- required method for AJAXmoodle based comment API
73  *
74  * @param stdClass $options
75  * @return array
76  */
77 function assignsubmission_comments_comment_permissions(stdClass $options) {
78     global $USER, $CFG, $DB;
80     if ($options->commentarea != 'submission_comments' &&
81             $options->commentarea != 'submission_comments_upgrade') {
82         throw new comment_exception('invalidcommentarea');
83     }
84     if (!$submission = $DB->get_record('assign_submission', array('id'=>$options->itemid))) {
85         throw new comment_exception('invalidcommentitemid');
86     }
87     $context = $options->context;
89     require_once($CFG->dirroot . '/mod/assign/locallib.php');
90     $assignment = new assign($context, null, null);
92     if ($assignment->get_instance()->id != $submission->assignment) {
93         throw new comment_exception('invalidcontext');
94     }
95     if (!has_capability('mod/assign:grade', $context)) {
96         if (!has_capability('mod/assign:submit', $context)) {
97             return array('post' => false, 'view' => false);
98         } else if ($assignment->get_instance()->teamsubmission) {
99             $group = $assignment->get_submission_group($USER->id);
100             $groupid = 0;
101             if ($group) {
102                 $groupid = $group->id;
103             }
104             if ($groupid != $submission->groupid) {
105                 return array('post' => false, 'view' => false);
106             }
107         } else if ($submission->userid != $USER->id) {
108             return array('post' => false, 'view' => false);
109         }
110     }
112     return array('post' => true, 'view' => true);
115 /**
116  * Callback to force the userid for all comments to be the userid of the submission and NOT the global $USER->id. This
117  * is required by the upgrade code. Note the comment area is used to identify upgrades.
118  *
119  * @param stdClass $comment
120  * @param stdClass $param
121  */
122 function assignsubmission_comments_comment_add(stdClass $comment, stdClass $param) {
124     global $DB;
125     if ($comment->commentarea == 'submission_comments_upgrade') {
126         $submissionid = $comment->itemid;
127         $submission = $DB->get_record('assign_submission', array('id' => $submissionid));
129         $comment->userid = $submission->userid;
130         $comment->commentarea = 'submission_comments';
131     }