MDL-62344 mod_label: ID number feature support
[moodle.git] / mod / label / lib.php
CommitLineData
44a87f63 1<?php
2
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/>.
2c5c3e62 17
44a87f63 18/**
19 * Library of functions and constants for module label
20 *
53945f38 21 * @package mod_label
9516942a
PS
22 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44a87f63 24 */
2c5c3e62 25
9516942a
PS
26defined('MOODLE_INTERNAL') || die;
27
44a87f63 28/** LABEL_MAX_NAME_LENGTH = 50 */
2c5c3e62 29define("LABEL_MAX_NAME_LENGTH", 50);
30
44a87f63 31/**
32 * @uses LABEL_MAX_NAME_LENGTH
33 * @param object $label
34 * @return string
35 */
376ca347 36function get_label_name($label) {
43b44d5e 37 $name = strip_tags(format_string($label->intro,true));
2f1e464a
PS
38 if (core_text::strlen($name) > LABEL_MAX_NAME_LENGTH) {
39 $name = core_text::substr($name, 0, LABEL_MAX_NAME_LENGTH)."...";
376ca347 40 }
41
42 if (empty($name)) {
43 // arbitrary name
c0a578c0 44 $name = get_string('modulename','label');
376ca347 45 }
46
47 return $name;
48}
44a87f63 49/**
50 * Given an object containing all the necessary data,
51 * (defined by the form in mod_form.php) this function
52 * will create a new instance and return the id number
53 * of the new instance.
54 *
55 * @global object
56 * @param object $label
57 * @return bool|int
58 */
2c5c3e62 59function label_add_instance($label) {
c18269c7 60 global $DB;
2c5c3e62 61
376ca347 62 $label->name = get_label_name($label);
2c5c3e62 63 $label->timemodified = time();
64
b3bd7a66
MN
65 $id = $DB->insert_record("label", $label);
66
67 $completiontimeexpected = !empty($label->completionexpected) ? $label->completionexpected : null;
68 \core_completion\api::update_completion_date_event($label->coursemodule, 'label', $id, $completiontimeexpected);
69
70 return $id;
2c5c3e62 71}
72
44a87f63 73/**
74 * Given an object containing all the necessary data,
75 * (defined by the form in mod_form.php) this function
76 * will update an existing instance with new data.
77 *
78 * @global object
79 * @param object $label
80 * @return bool
81 */
2c5c3e62 82function label_update_instance($label) {
c18269c7 83 global $DB;
2bf5b5d4 84
376ca347 85 $label->name = get_label_name($label);
2c5c3e62 86 $label->timemodified = time();
87 $label->id = $label->instance;
88
b3bd7a66
MN
89 $completiontimeexpected = !empty($label->completionexpected) ? $label->completionexpected : null;
90 \core_completion\api::update_completion_date_event($label->coursemodule, 'label', $label->id, $completiontimeexpected);
91
c18269c7 92 return $DB->update_record("label", $label);
2c5c3e62 93}
94
44a87f63 95/**
96 * Given an ID of an instance of this module,
97 * this function will permanently delete the instance
98 * and any data that depends on it.
99 *
100 * @global object
101 * @param int $id
102 * @return bool
103 */
2c5c3e62 104function label_delete_instance($id) {
c18269c7 105 global $DB;
2c5c3e62 106
c18269c7 107 if (! $label = $DB->get_record("label", array("id"=>$id))) {
2c5c3e62 108 return false;
109 }
110
111 $result = true;
112
b3bd7a66 113 $cm = get_coursemodule_from_instance('label', $id);
de036a2d 114 \core_completion\api::update_completion_date_event($cm->id, 'label', $label->id, null);
b3bd7a66 115
c18269c7 116 if (! $DB->delete_records("label", array("id"=>$label->id))) {
2c5c3e62 117 $result = false;
118 }
119
120 return $result;
121}
122
f36cbf1d 123/**
124 * Given a course_module object, this function returns any
125 * "extra" information that may be needed when printing
126 * this activity in a course listing.
127 * See get_array_of_activities() in course/lib.php
44a87f63 128 *
129 * @global object
130 * @param object $coursemodule
3c620d7f 131 * @return cached_cm_info|null
f36cbf1d 132 */
8dddba42 133function label_get_coursemodule_info($coursemodule) {
1b81b0a4 134 global $DB;
135
43b44d5e 136 if ($label = $DB->get_record('label', array('id'=>$coursemodule->instance), 'id, name, intro, introformat')) {
d02f1934 137 if (empty($label->name)) {
138 // label name missing, fix it
139 $label->name = "label{$label->id}";
140 $DB->set_field('label', 'name', $label->name, array('id'=>$label->id));
141 }
3008f86c 142 $info = new cached_cm_info();
43b44d5e 143 // no filtering hre because this info is cached and filtered later
3008f86c 144 $info->content = format_module_intro('label', $label, $coursemodule->id, false);
9a9012dc 145 $info->name = $label->name;
dd97c328 146 return $info;
147 } else {
148 return null;
149 }
8dddba42 150}
151
0b5a80a1 152/**
153 * This function is used by the reset_course_userdata function in moodlelib.
86342d63 154 *
44a87f63 155 * @param object $data the data submitted from the reset course.
0b5a80a1 156 * @return array status array
157 */
158function label_reset_userdata($data) {
0d14fcbc
AA
159
160 // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
161 // See MDL-9367.
162
0b5a80a1 163 return array();
164}
165
f432bebf 166/**
167 * Returns all other caps used in module
44a87f63 168 *
169 * @return array
f432bebf 170 */
e83a6a22 171function label_get_extra_capabilities() {
f432bebf 172 return array('moodle/site:accessallgroups');
173}
174
42f103be 175/**
44a87f63 176 * @uses FEATURE_IDNUMBER
177 * @uses FEATURE_GROUPS
178 * @uses FEATURE_GROUPINGS
44a87f63 179 * @uses FEATURE_MOD_INTRO
180 * @uses FEATURE_COMPLETION_TRACKS_VIEWS
181 * @uses FEATURE_GRADE_HAS_GRADE
182 * @uses FEATURE_GRADE_OUTCOMES
42f103be 183 * @param string $feature FEATURE_xx constant for requested feature
44a87f63 184 * @return bool|null True if module supports feature, false if not, null if doesn't know
42f103be 185 */
186function label_supports($feature) {
187 switch($feature) {
155bf1dd 188 case FEATURE_IDNUMBER: return true;
42f103be 189 case FEATURE_GROUPS: return false;
190 case FEATURE_GROUPINGS: return false;
43b44d5e 191 case FEATURE_MOD_INTRO: return true;
42f103be 192 case FEATURE_COMPLETION_TRACKS_VIEWS: return false;
193 case FEATURE_GRADE_HAS_GRADE: return false;
194 case FEATURE_GRADE_OUTCOMES: return false;
31dadc6f 195 case FEATURE_MOD_ARCHETYPE: return MOD_ARCHETYPE_RESOURCE;
f58a9e37 196 case FEATURE_BACKUP_MOODLE2: return true;
0d8b6a69 197 case FEATURE_NO_VIEW_LINK: return true;
42f103be 198
199 default: return null;
200 }
201}
202
785e09a7
DS
203/**
204 * Register the ability to handle drag and drop file uploads
205 * @return array containing details of the files / types the mod can handle
206 */
207function label_dndupload_register() {
5efae682 208 $strdnd = get_string('dnduploadlabel', 'mod_label');
785e09a7 209 if (get_config('label', 'dndmedia')) {
59e004cd 210 $mediaextensions = file_get_typegroup('extension', ['web_image', 'web_video', 'web_audio']);
785e09a7
DS
211 $files = array();
212 foreach ($mediaextensions as $extn) {
213 $extn = trim($extn, '.');
214 $files[] = array('extension' => $extn, 'message' => $strdnd);
215 }
5efae682 216 $ret = array('files' => $files);
785e09a7 217 } else {
5efae682 218 $ret = array();
785e09a7 219 }
5efae682
DS
220
221 $strdndtext = get_string('dnduploadlabeltext', 'mod_label');
222 return array_merge($ret, array('types' => array(
2748d8ef
DS
223 array('identifier' => 'text/html', 'message' => $strdndtext, 'noname' => true),
224 array('identifier' => 'text', 'message' => $strdndtext, 'noname' => true)
5efae682 225 )));
785e09a7
DS
226}
227
228/**
229 * Handle a file that has been uploaded
230 * @param object $uploadinfo details of the file / content that has been uploaded
231 * @return int instance id of the newly created mod
232 */
233function label_dndupload_handle($uploadinfo) {
234 global $USER;
235
236 // Gather the required info.
237 $data = new stdClass();
238 $data->course = $uploadinfo->course->id;
239 $data->name = $uploadinfo->displayname;
240 $data->intro = '';
241 $data->introformat = FORMAT_HTML;
242 $data->coursemodule = $uploadinfo->coursemodule;
243
fbe45792 244 // Extract the first (and only) file from the file area and add it to the label as an img tag.
785e09a7
DS
245 if (!empty($uploadinfo->draftitemid)) {
246 $fs = get_file_storage();
247 $draftcontext = context_user::instance($USER->id);
248 $context = context_module::instance($uploadinfo->coursemodule);
249 $files = $fs->get_area_files($draftcontext->id, 'user', 'draft', $uploadinfo->draftitemid, '', false);
250 if ($file = reset($files)) {
785e09a7 251 if (file_mimetype_in_typegroup($file->get_mimetype(), 'web_image')) {
fbe45792
DS
252 // It is an image - resize it, if too big, then insert the img tag.
253 $config = get_config('label');
254 $data->intro = label_generate_resized_image($file, $config->dndresizewidth, $config->dndresizeheight);
255 } else {
256 // We aren't supposed to be supporting non-image types here, but fallback to adding a link, just in case.
257 $url = moodle_url::make_draftfile_url($file->get_itemid(), $file->get_filepath(), $file->get_filename());
258 $data->intro = html_writer::link($url, $file->get_filename());
785e09a7 259 }
fbe45792
DS
260 $data->intro = file_save_draft_area_files($uploadinfo->draftitemid, $context->id, 'mod_label', 'intro', 0,
261 null, $data->intro);
785e09a7 262 }
5efae682
DS
263 } else if (!empty($uploadinfo->content)) {
264 $data->intro = $uploadinfo->content;
3d387773
DS
265 if ($uploadinfo->type != 'text/html') {
266 $data->introformat = FORMAT_PLAIN;
267 }
785e09a7
DS
268 }
269
270 return label_add_instance($data, null);
271}
fbe45792
DS
272
273/**
274 * Resize the image, if required, then generate an img tag and, if required, a link to the full-size image
275 * @param stored_file $file the image file to process
276 * @param int $maxwidth the maximum width allowed for the image
277 * @param int $maxheight the maximum height allowed for the image
278 * @return string HTML fragment to add to the label
279 */
280function label_generate_resized_image(stored_file $file, $maxwidth, $maxheight) {
281 global $CFG;
282
283 $fullurl = moodle_url::make_draftfile_url($file->get_itemid(), $file->get_filepath(), $file->get_filename());
284 $link = null;
285 $attrib = array('alt' => $file->get_filename(), 'src' => $fullurl);
286
287 if ($imginfo = $file->get_imageinfo()) {
288 // Work out the new width / height, bounded by maxwidth / maxheight
289 $width = $imginfo['width'];
290 $height = $imginfo['height'];
291 if (!empty($maxwidth) && $width > $maxwidth) {
292 $height *= (float)$maxwidth / $width;
293 $width = $maxwidth;
294 }
295 if (!empty($maxheight) && $height > $maxheight) {
296 $width *= (float)$maxheight / $height;
297 $height = $maxheight;
298 }
299
300 $attrib['width'] = $width;
301 $attrib['height'] = $height;
302
303 // If the size has changed and the image is of a suitable mime type, generate a smaller version
304 if ($width != $imginfo['width']) {
305 $mimetype = $file->get_mimetype();
306 if ($mimetype === 'image/gif' or $mimetype === 'image/jpeg' or $mimetype === 'image/png') {
307 require_once($CFG->libdir.'/gdlib.php');
2b53b13f 308 $data = $file->generate_image_thumbnail($width, $height);
fbe45792
DS
309
310 if (!empty($data)) {
311 $fs = get_file_storage();
312 $record = array(
313 'contextid' => $file->get_contextid(),
314 'component' => $file->get_component(),
315 'filearea' => $file->get_filearea(),
316 'itemid' => $file->get_itemid(),
317 'filepath' => '/',
318 'filename' => 's_'.$file->get_filename(),
319 );
320 $smallfile = $fs->create_file_from_string($record, $data);
321
322 // Replace the image 'src' with the resized file and link to the original
323 $attrib['src'] = moodle_url::make_draftfile_url($smallfile->get_itemid(), $smallfile->get_filepath(),
324 $smallfile->get_filename());
325 $link = $fullurl;
326 }
327 }
328 }
329
330 } else {
331 // Assume this is an image type that get_imageinfo cannot handle (e.g. SVG)
332 $attrib['width'] = $maxwidth;
333 }
334
335 $img = html_writer::empty_tag('img', $attrib);
336 if ($link) {
337 return html_writer::link($link, $img);
338 } else {
339 return $img;
340 }
5efae682 341}
02a73d76
JL
342
343/**
344 * Check if the module has any update that affects the current user since a given time.
345 *
346 * @param cm_info $cm course module data
347 * @param int $from the time to check updates from
348 * @param array $filter if we need to check only specific updates
349 * @return stdClass an object with the different type of areas indicating if they were updated or not
350 * @since Moodle 3.2
351 */
352function label_check_updates_since(cm_info $cm, $from, $filter = array()) {
353 $updates = course_check_module_updates_since($cm, $from, array(), $filter);
354 return $updates;
355}
b3bd7a66
MN
356
357/**
59391e80
MN
358 * This function receives a calendar event and returns the action associated with it, or null if there is none.
359 *
360 * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event
361 * is not displayed on the block.
b3bd7a66 362 *
e1cd93ce 363 * @param calendar_event $event
b3bd7a66 364 * @param \core_calendar\action_factory $factory
01f96180 365 * @return \core_calendar\local\event\entities\action_interface|null
b3bd7a66 366 */
e1cd93ce 367function mod_label_core_calendar_provide_event_action(calendar_event $event,
b3bd7a66
MN
368 \core_calendar\action_factory $factory) {
369 $cm = get_fast_modinfo($event->courseid)->instances['label'][$event->instance];
370
50d845e3 371 $completion = new \completion_info($cm->get_course());
b3bd7a66
MN
372
373 $completiondata = $completion->get_data($cm, false);
374
375 if ($completiondata->completionstate != COMPLETION_INCOMPLETE) {
376 return null;
377 }
378
379 return $factory->create_instance(
380 get_string('view'),
381 new \moodle_url('/mod/label/view.php', ['id' => $cm->id]),
382 1,
383 true
384 );
385}