forked from moodle-an-hochschulen/moodle-theme_boost_campus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
externallib.php
238 lines (186 loc) · 7.35 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
226
227
228
229
230
231
232
233
234
235
236
237
<?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/>.
/**
* Webservices for Boost Campus.
*
* @package theme_urcourses_default
* @author John Lane
*
*/
defined('MOODLE_INTERNAL') || die();
require_once($CFG->libdir . "/externallib.php");
require_once($CFG->dirroot . "/course/lib.php");
class theme_urcourses_default_external extends external_api {
/**
* Describes upload_course_image parameters.
* @return external_function_parameters
*/
public static function upload_course_image_parameters() {
return new external_function_parameters(
array(
'courseid' => new external_value(PARAM_INT),
'imagedata' => new external_value(PARAM_TEXT),
'imagename' => new external_value(PARAM_TEXT),
)
);
}
public static function choose_header_style_parameters() {
return new external_function_parameters(
array(
'courseid' => new external_value(PARAM_INT),
'headerstyle' => new external_value(PARAM_INT),
)
);
}
public static function toggle_course_availability_parameters() {
return new external_function_parameters(
array(
'courseid' => new external_value(PARAM_INT),
'availability' => new external_value(PARAM_INT),
)
);
}
/**
* Describes upload_couse_image return value.
* @return external_single_structure
*/
public static function upload_course_image_returns() {
return new external_single_structure(array('success' => new external_value(PARAM_BOOL)));
}
/**
* Describes choose_header_style return value.
* @return external_single_structure
*/
public static function choose_header_style_returns() {
return new external_single_structure(array('success' => new external_value(PARAM_BOOL)));
}
/**
* Describes choose_header_style return value.
* @return external_single_structure
*/
public static function toggle_course_availability_returns() {
return new external_single_structure(array('success' => new external_value(PARAM_BOOL)));
}
/**
* Changes course header image.
* @param int $courseid - ID of course.
* @param string $imagedata - Raw image data.
* @param string $imagename - Name of image.
* @return bool $success - Whether or not the image was uploaded properly.
*/
public static function upload_course_image($courseid, $imagedata, $imagename) {
global $CFG;
// get params
$params = self::validate_parameters(
self::upload_course_image_parameters(),
array(
'courseid' => $courseid,
'imagedata' => $imagedata,
'imagename' => $imagename,
)
);
// ensure user has permissions to change image
$context = \context_course::instance($params['courseid']);
self::validate_context($context);
require_capability('moodle/course:changesummary', $context);
$filestorage = get_file_storage();
$filetype = strtolower(pathinfo($params['imagename'], PATHINFO_EXTENSION));
$filetype === 'jpeg' ? 'jpg' : $filetype;
$new_filename = 'courseimage_'.time().'.' . $filetype;
$binary_data = base64_decode($params['imagedata']);
// verify size
if (strlen($binary_data) > get_max_upload_file_size($CFG->maxbytes)) {
throw new \moodle_exception('error:courseimageexceedsmaxbytes', 'theme_urcourses_default', $CFG->maxbytes);
}
// verify filetype
if ($filetype !== 'jpg' && $filetype !== 'png' && $filetype !== 'gif') {
throw new \moodle_exception('error:courseimageinvalidfiletype', 'theme_urcourses_default');
}
if ($context->contextlevel === CONTEXT_COURSE) {
$fileinfo = array(
'contextid' => $context->id,
'component' => 'course',
'filearea' => 'overviewfiles',
'itemid' => 0,
'filepath' => '/',
'filename' => $new_filename
);
// Remove any old course summary image files for this context.
$filestorage->delete_area_files($context->id, $fileinfo['component'], $fileinfo['filearea']);
// Create and set new image.
$storedfile = $filestorage->create_file_from_string($fileinfo, $binary_data);
$success = $storedfile instanceof \stored_file;
}
// return
return array('success' => $success);
}
public static function choose_header_style($courseid, $headerstyle) {
global $CFG, $DB;
// get params
$params = self::validate_parameters(
self::choose_header_style_parameters(),
array(
'courseid' => $courseid,
'headerstyle' => $headerstyle,
)
);
// ensure user has permissions to change image
$context = \context_course::instance($params['courseid']);
self::validate_context($context);
require_capability('moodle/course:changesummary', $context);
//update the db
$table = 'theme_urcourses_hdrstyle';
$newrecord = new stdClass();
$newrecord->courseid = $courseid;
$newrecord->hdrstyle = $headerstyle;
//database check if user has a record, insert if not
if ($record = $DB->get_record($table, array('courseid'=>$courseid))) {
//if has a record, update record to $setdarkmode
$newrecord->id = $record->id;
$success = $DB->update_record($table, $newrecord);
} else {
//create a record
$success = $DB->insert_record($table, $newrecord);
}
return array('success' => $success);
}
public static function toggle_course_availability($courseid, $availability) {
global $CFG, $DB;
// get params
$params = self::validate_parameters(
self::toggle_course_availability_parameters(),
array(
'courseid' => $courseid,
'availability' => $availability,
)
);
// ensure user has permissions to change image
$context = \context_course::instance($params['courseid']);
self::validate_context($context);
require_capability('moodle/course:changesummary', $context);
$table = 'course';
$newrecord = new stdClass();
$newrecord->courseid = $courseid;
$newrecord->visible = $availability==1?0:1;
if ($record = $DB->get_record($table, array('id'=>$courseid))) {
$newrecord->id = $record->id;
$success = $DB->update_record($table, $newrecord);
return array('success' => $success);
} else {
return array('error' => 'Record not found');
}
}
}