MDL-34137 mod_label - resize images when uploaded via drag & drop
[moodle.git] / mod / label / lib.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 functions and constants for module label
20  *
21  * @package    mod
22  * @subpackage label
23  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die;
29 /** LABEL_MAX_NAME_LENGTH = 50 */
30 define("LABEL_MAX_NAME_LENGTH", 50);
32 /**
33  * @uses LABEL_MAX_NAME_LENGTH
34  * @param object $label
35  * @return string
36  */
37 function get_label_name($label) {
38     $name = strip_tags(format_string($label->intro,true));
39     if (textlib::strlen($name) > LABEL_MAX_NAME_LENGTH) {
40         $name = textlib::substr($name, 0, LABEL_MAX_NAME_LENGTH)."...";
41     }
43     if (empty($name)) {
44         // arbitrary name
45         $name = get_string('modulename','label');
46     }
48     return $name;
49 }
50 /**
51  * Given an object containing all the necessary data,
52  * (defined by the form in mod_form.php) this function
53  * will create a new instance and return the id number
54  * of the new instance.
55  *
56  * @global object
57  * @param object $label
58  * @return bool|int
59  */
60 function label_add_instance($label) {
61     global $DB;
63     $label->name = get_label_name($label);
64     $label->timemodified = time();
66     return $DB->insert_record("label", $label);
67 }
69 /**
70  * Given an object containing all the necessary data,
71  * (defined by the form in mod_form.php) this function
72  * will update an existing instance with new data.
73  *
74  * @global object
75  * @param object $label
76  * @return bool
77  */
78 function label_update_instance($label) {
79     global $DB;
81     $label->name = get_label_name($label);
82     $label->timemodified = time();
83     $label->id = $label->instance;
85     return $DB->update_record("label", $label);
86 }
88 /**
89  * Given an ID of an instance of this module,
90  * this function will permanently delete the instance
91  * and any data that depends on it.
92  *
93  * @global object
94  * @param int $id
95  * @return bool
96  */
97 function label_delete_instance($id) {
98     global $DB;
100     if (! $label = $DB->get_record("label", array("id"=>$id))) {
101         return false;
102     }
104     $result = true;
106     if (! $DB->delete_records("label", array("id"=>$label->id))) {
107         $result = false;
108     }
110     return $result;
113 /**
114  * Given a course_module object, this function returns any
115  * "extra" information that may be needed when printing
116  * this activity in a course listing.
117  * See get_array_of_activities() in course/lib.php
118  *
119  * @global object
120  * @param object $coursemodule
121  * @return object|null
122  */
123 function label_get_coursemodule_info($coursemodule) {
124     global $DB;
126     if ($label = $DB->get_record('label', array('id'=>$coursemodule->instance), 'id, name, intro, introformat')) {
127         if (empty($label->name)) {
128             // label name missing, fix it
129             $label->name = "label{$label->id}";
130             $DB->set_field('label', 'name', $label->name, array('id'=>$label->id));
131         }
132         $info = new stdClass();
133         // no filtering hre because this info is cached and filtered later
134         $info->extra = format_module_intro('label', $label, $coursemodule->id, false);
135         $info->name  = $label->name;
136         return $info;
137     } else {
138         return null;
139     }
142 /**
143  * @return array
144  */
145 function label_get_view_actions() {
146     return array();
149 /**
150  * @return array
151  */
152 function label_get_post_actions() {
153     return array();
156 /**
157  * This function is used by the reset_course_userdata function in moodlelib.
158  *
159  * @param object $data the data submitted from the reset course.
160  * @return array status array
161  */
162 function label_reset_userdata($data) {
163     return array();
166 /**
167  * Returns all other caps used in module
168  *
169  * @return array
170  */
171 function label_get_extra_capabilities() {
172     return array('moodle/site:accessallgroups');
175 /**
176  * @uses FEATURE_IDNUMBER
177  * @uses FEATURE_GROUPS
178  * @uses FEATURE_GROUPINGS
179  * @uses FEATURE_GROUPMEMBERSONLY
180  * @uses FEATURE_MOD_INTRO
181  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
182  * @uses FEATURE_GRADE_HAS_GRADE
183  * @uses FEATURE_GRADE_OUTCOMES
184  * @param string $feature FEATURE_xx constant for requested feature
185  * @return bool|null True if module supports feature, false if not, null if doesn't know
186  */
187 function label_supports($feature) {
188     switch($feature) {
189         case FEATURE_IDNUMBER:                return false;
190         case FEATURE_GROUPS:                  return false;
191         case FEATURE_GROUPINGS:               return false;
192         case FEATURE_GROUPMEMBERSONLY:        return true;
193         case FEATURE_MOD_INTRO:               return true;
194         case FEATURE_COMPLETION_TRACKS_VIEWS: return false;
195         case FEATURE_GRADE_HAS_GRADE:         return false;
196         case FEATURE_GRADE_OUTCOMES:          return false;
197         case FEATURE_MOD_ARCHETYPE:           return MOD_ARCHETYPE_RESOURCE;
198         case FEATURE_BACKUP_MOODLE2:          return true;
199         case FEATURE_NO_VIEW_LINK:            return true;
201         default: return null;
202     }
205 /**
206  * Register the ability to handle drag and drop file uploads
207  * @return array containing details of the files / types the mod can handle
208  */
209 function label_dndupload_register() {
210     if (get_config('label', 'dndmedia')) {
211         $mediaextensions = file_get_typegroup('extension', 'web_image');
212         $strdnd = get_string('dnduploadlabel', 'mod_label');
213         $files = array();
214         foreach ($mediaextensions as $extn) {
215             $extn = trim($extn, '.');
216             $files[] = array('extension' => $extn, 'message' => $strdnd);
217         }
218         return array('files' => $files);
219     } else {
220         return array();
221     }
224 /**
225  * Handle a file that has been uploaded
226  * @param object $uploadinfo details of the file / content that has been uploaded
227  * @return int instance id of the newly created mod
228  */
229 function label_dndupload_handle($uploadinfo) {
230     global $USER;
232     // Gather the required info.
233     $data = new stdClass();
234     $data->course = $uploadinfo->course->id;
235     $data->name = $uploadinfo->displayname;
236     $data->intro = '';
237     $data->introformat = FORMAT_HTML;
238     $data->coursemodule = $uploadinfo->coursemodule;
240     // Extract the first (and only) file from the file area and add it to the label as an img tag.
241     if (!empty($uploadinfo->draftitemid)) {
242         $fs = get_file_storage();
243         $draftcontext = context_user::instance($USER->id);
244         $context = context_module::instance($uploadinfo->coursemodule);
245         $files = $fs->get_area_files($draftcontext->id, 'user', 'draft', $uploadinfo->draftitemid, '', false);
246         if ($file = reset($files)) {
247             if (file_mimetype_in_typegroup($file->get_mimetype(), 'web_image')) {
248                 // It is an image - resize it, if too big, then insert the img tag.
249                 $config = get_config('label');
250                 $data->intro = label_generate_resized_image($file, $config->dndresizewidth, $config->dndresizeheight);
251             } else {
252                 // We aren't supposed to be supporting non-image types here, but fallback to adding a link, just in case.
253                 $url = moodle_url::make_draftfile_url($file->get_itemid(), $file->get_filepath(), $file->get_filename());
254                 $data->intro = html_writer::link($url, $file->get_filename());
255             }
256             $data->intro = file_save_draft_area_files($uploadinfo->draftitemid, $context->id, 'mod_label', 'intro', 0,
257                                                       null, $data->intro);
258         }
259     }
261     return label_add_instance($data, null);
264 /**
265  * Resize the image, if required, then generate an img tag and, if required, a link to the full-size image
266  * @param stored_file $file the image file to process
267  * @param int $maxwidth the maximum width allowed for the image
268  * @param int $maxheight the maximum height allowed for the image
269  * @return string HTML fragment to add to the label
270  */
271 function label_generate_resized_image(stored_file $file, $maxwidth, $maxheight) {
272     global $CFG;
274     $fullurl = moodle_url::make_draftfile_url($file->get_itemid(), $file->get_filepath(), $file->get_filename());
275     $link = null;
276     $attrib = array('alt' => $file->get_filename(), 'src' => $fullurl);
278     if ($imginfo = $file->get_imageinfo()) {
279         // Work out the new width / height, bounded by maxwidth / maxheight
280         $width = $imginfo['width'];
281         $height = $imginfo['height'];
282         if (!empty($maxwidth) && $width > $maxwidth) {
283             $height *= (float)$maxwidth / $width;
284             $width = $maxwidth;
285         }
286         if (!empty($maxheight) && $height > $maxheight) {
287             $width *= (float)$maxheight / $height;
288             $height = $maxheight;
289         }
291         $attrib['width'] = $width;
292         $attrib['height'] = $height;
294         // If the size has changed and the image is of a suitable mime type, generate a smaller version
295         if ($width != $imginfo['width']) {
296             $mimetype = $file->get_mimetype();
297             if ($mimetype === 'image/gif' or $mimetype === 'image/jpeg' or $mimetype === 'image/png') {
298                 require_once($CFG->libdir.'/gdlib.php');
299                 $tmproot = make_temp_directory('mod_label');
300                 $tmpfilepath = $tmproot.'/'.$file->get_contenthash();
301                 $file->copy_content_to($tmpfilepath);
302                 $data = generate_image_thumbnail($tmpfilepath, $width, $height);
303                 unlink($tmpfilepath);
305                 if (!empty($data)) {
306                     $fs = get_file_storage();
307                     $record = array(
308                         'contextid' => $file->get_contextid(),
309                         'component' => $file->get_component(),
310                         'filearea'  => $file->get_filearea(),
311                         'itemid'    => $file->get_itemid(),
312                         'filepath'  => '/',
313                         'filename'  => 's_'.$file->get_filename(),
314                     );
315                     $smallfile = $fs->create_file_from_string($record, $data);
317                     // Replace the image 'src' with the resized file and link to the original
318                     $attrib['src'] = moodle_url::make_draftfile_url($smallfile->get_itemid(), $smallfile->get_filepath(),
319                                                                     $smallfile->get_filename());
320                     $link = $fullurl;
321                 }
322             }
323         }
325     } else {
326         // Assume this is an image type that get_imageinfo cannot handle (e.g. SVG)
327         $attrib['width'] = $maxwidth;
328     }
330     $img = html_writer::empty_tag('img', $attrib);
331     if ($link) {
332         return html_writer::link($link, $img);
333     } else {
334         return $img;
335     }