forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
externallib.php
225 lines (198 loc) · 8.79 KB
/
externallib.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* External notes API
*
* @package moodlecore
* @subpackage notes
* @copyright 2011 Moodle Pty Ltd (http://moodle.com)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
require_once("$CFG->libdir/externallib.php");
/**
* Notes functions
*/
class core_notes_external extends external_api {
/**
* Returns description of method parameters
* @return external_function_parameters
*/
public static function create_notes_parameters() {
return new external_function_parameters(
array(
'notes' => new external_multiple_structure(
new external_single_structure(
array(
'userid' => new external_value(PARAM_INT, 'id of the user the note is about'),
'publishstate' => new external_value(PARAM_ALPHA, '\'personal\', \'course\' or \'site\''),
'courseid' => new external_value(PARAM_INT, 'course id of the note (in Moodle a note can only be created into a course, even for site and personal notes)'),
'text' => new external_value(PARAM_RAW, 'the text of the message - text or HTML'),
'format' => new external_value(PARAM_ALPHA, '\'text\' or \'html\'', VALUE_DEFAULT, 'text'),
'clientnoteid' => new external_value(PARAM_ALPHANUMEXT, 'your own client id for the note. If this id is provided, the fail message id will be returned to you', VALUE_OPTIONAL),
)
)
)
)
);
}
/**
* Create notes about some users
* Note: code should be matching the /notes/edit.php checks
* and the /user/addnote.php checks. (they are similar cheks)
* @param array $notes An array of notes to create.
* @return array (success infos and fail infos)
*/
public static function create_notes($notes = array()) {
global $CFG, $DB;
require_once($CFG->dirroot . "/notes/lib.php");
$params = self::validate_parameters(self::create_notes_parameters(), array('notes' => $notes));
//check if note system is enabled
if (!$CFG->enablenotes) {
throw new moodle_exception('notesdisabled', 'notes');
}
//retrieve all courses
$courseids = array();
foreach($params['notes'] as $note) {
$courseids[] = $note['courseid'];
}
$courses = $DB->get_records_list("course", "id", $courseids);
//retrieve all users of the notes
$userids = array();
foreach($params['notes'] as $note) {
$userids[] = $note['userid'];
}
list($sqluserids, $sqlparams) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED, 'userid_');
$users = $DB->get_records_select("user", "id " . $sqluserids . " AND deleted = 0", $sqlparams);
$resultnotes = array();
foreach ($params['notes'] as $note) {
$success = true;
$resultnote = array(); //the infos about the success of the operation
//check the course exists
if (empty($courses[$note['courseid']])) {
$success = false;
$errormessage = get_string('invalidcourseid', 'notes', $note['courseid']);
} else {
// Ensure the current user is allowed to run this function
$context = get_context_instance(CONTEXT_COURSE, $note['courseid']);
self::validate_context($context);
require_capability('moodle/notes:manage', $context);
}
//check the user exists
if (empty($users[$note['userid']])) {
$success = false;
$errormessage = get_string('invaliduserid', 'notes', $note['userid']);
}
//build the resultnote
if (isset($note['clientnoteid'])) {
$resultnote['clientnoteid'] = $note['clientnoteid'];
}
if ($success) {
//now we can create the note
$dbnote = new stdClass;
$dbnote->courseid = $note['courseid'];
$dbnote->userid = $note['userid'];
//clean param text and set format accordingly
switch (strtolower($note['format'])) {
case 'html':
$dbnote->content = clean_param($note['text'], PARAM_CLEANHTML);
$dbnote->format = FORMAT_HTML;
break;
case 'text':
default:
$dbnote->content = clean_param($note['text'], PARAM_TEXT);
$dbnote->format = FORMAT_PLAIN;
break;
}
//get the state ('personal', 'course', 'site')
switch ($note['publishstate']) {
case 'personal':
$dbnote->publishstate = NOTES_STATE_DRAFT;
break;
case 'course':
$dbnote->publishstate = NOTES_STATE_PUBLIC;
break;
case 'site':
$dbnote->publishstate = NOTES_STATE_SITE;
$dbnote->courseid = SITEID;
break;
default:
break;
}
//TODO: performance improvement - if possible create a bulk functions for saving multiple notes at once
if (note_save($dbnote)) { //note_save attribut an id in case of success
add_to_log($dbnote->courseid, 'notes', 'add',
'index.php?course='.$dbnote->courseid.'&user='.$dbnote->userid
. '#note-' . $dbnote->id , 'add note');
$success = $dbnote->id;
}
$resultnote['noteid'] = $success;
} else {
$resultnote['noteid'] = -1;
$resultnote['errormessage'] = $errormessage;
}
$resultnotes[] = $resultnote;
}
return $resultnotes;
}
/**
* Returns description of method result value
* @return external_description
*/
public static function create_notes_returns() {
return new external_multiple_structure(
new external_single_structure(
array(
'clientnoteid' => new external_value(PARAM_ALPHANUMEXT, 'your own id for the note', VALUE_OPTIONAL),
'noteid' => new external_value(PARAM_INT, 'test this to know if it success: id of the created note when successed, -1 when failed'),
'errormessage' => new external_value(PARAM_TEXT, 'error message - if failed', VALUE_OPTIONAL)
)
)
);
}
}
/**
* Deprecated notes functions
* @deprecated since Moodle 2.2 please use core_notes_external instead
*/
class moodle_notes_external extends external_api {
/**
* Returns description of method parameters
* @deprecated since Moodle 2.2 please use core_notes_external::create_notes_parameters instead
* @return external_function_parameters
*/
public static function create_notes_parameters() {
return core_notes_external::create_notes_parameters();
}
/**
* Create notes about some users
* Note: code should be matching the /notes/edit.php checks
* and the /user/addnote.php checks. (they are similar cheks)
* @deprecated since Moodle 2.2 please use core_notes_external::create_notes instead
* @param array $notes An array of notes to create.
* @return array (success infos and fail infos)
*/
public static function create_notes($notes = array()) {
return core_notes_external::create_notes($notes);
}
/**
* Returns description of method result value
* @deprecated since Moodle 2.2 please use core_notes_external::create_notes_returns instead
* @return external_description
*/
public static function create_notes_returns() {
return core_notes_external::create_notes_returns();
}
}