87d888dbbbd7636c893d47bc79f8dbe732da98d8
[moodle.git] / lib / form / editor.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/>.
18 /**
19  * Editor input element
20  *
21  * Contains class to create preffered editor form element
22  *
23  * @package   core_form
24  * @copyright 2009 Petr Skoda {@link http://skodak.org}
25  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 global $CFG;
30 require_once('HTML/QuickForm/element.php');
31 require_once($CFG->dirroot.'/lib/filelib.php');
32 require_once($CFG->dirroot.'/repository/lib.php');
34 /**
35  * Editor element
36  *
37  * It creates preffered editor (textbox/TinyMce) form element for the format (Text/HTML) selected.
38  *
39  * @package   core_form
40  * @category  form
41  * @copyright 2009 Petr Skoda {@link http://skodak.org}
42  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
43  * @todo      MDL-29421 element Freezing
44  * @todo      MDL-29426 ajax format conversion
45  */
46 class MoodleQuickForm_editor extends HTML_QuickForm_element {
47     /** @var string html for help button, if empty then no help will icon will be dispalyed. */
48     public $_helpbutton = '';
50     /** @var string defines the type of editor */
51     public $_type       = 'editor';
53     /** @var array options provided to initalize filepicker */
54     protected $_options = array('subdirs' => 0, 'maxbytes' => 0, 'maxfiles' => 0, 'changeformat' => 0,
55             'areamaxbytes' => FILE_AREA_MAX_BYTES_UNLIMITED, 'context' => null, 'noclean' => 0, 'trusttext' => 0,
56             'return_types' => 7);
57     // $_options['return_types'] = FILE_INTERNAL | FILE_EXTERNAL | FILE_REFERENCE
59     /** @var array values for editor */
60     protected $_values     = array('text'=>null, 'format'=>null, 'itemid'=>null);
62     /**
63      * Constructor
64      *
65      * @param string $elementName (optional) name of the editor
66      * @param string $elementLabel (optional) editor label
67      * @param array $attributes (optional) Either a typical HTML attribute string
68      *              or an associative array
69      * @param array $options set of options to initalize filepicker
70      */
71     function MoodleQuickForm_editor($elementName=null, $elementLabel=null, $attributes=null, $options=null) {
72         global $CFG, $PAGE;
74         $options = (array)$options;
75         foreach ($options as $name=>$value) {
76             if (array_key_exists($name, $this->_options)) {
77                 $this->_options[$name] = $value;
78             }
79         }
80         if (!empty($options['maxbytes'])) {
81             $this->_options['maxbytes'] = get_max_upload_file_size($CFG->maxbytes, $options['maxbytes']);
82         }
83         if (!$this->_options['context']) {
84             // trying to set context to the current page context to make legacy files show in filepicker (e.g. forum post)
85             if (!empty($PAGE->context->id)) {
86                 $this->_options['context'] = $PAGE->context;
87             } else {
88                 $this->_options['context'] = context_system::instance();
89             }
90         }
91         $this->_options['trusted'] = trusttext_trusted($this->_options['context']);
92         parent::HTML_QuickForm_element($elementName, $elementLabel, $attributes);
94         // Note: for some reason the code using this setting does not like bools.
95         $this->_options['subdirs'] = (int)($this->_options['subdirs'] == 1);
97         editors_head_setup();
98     }
100     /**
101      * Sets name of editor
102      *
103      * @param string $name name of the editor
104      */
105     function setName($name) {
106         $this->updateAttributes(array('name'=>$name));
107     }
109     /**
110      * Returns name of element
111      *
112      * @return string
113      */
114     function getName() {
115         return $this->getAttribute('name');
116     }
118     /**
119      * Updates editor values, if part of $_values
120      *
121      * @param array $values associative array of values to set
122      */
123     function setValue($values) {
124         $values = (array)$values;
125         foreach ($values as $name=>$value) {
126             if (array_key_exists($name, $this->_values)) {
127                 $this->_values[$name] = $value;
128             }
129         }
130     }
132     /**
133      * Returns editor values
134      *
135      * @return array
136      */
137     function getValue() {
138         return $this->_values;
139     }
141     /**
142      * Returns maximum file size which can be uploaded
143      *
144      * @return int
145      */
146     function getMaxbytes() {
147         return $this->_options['maxbytes'];
148     }
150     /**
151      * Sets maximum file size which can be uploaded
152      *
153      * @param int $maxbytes file size
154      */
155     function setMaxbytes($maxbytes) {
156         global $CFG;
157         $this->_options['maxbytes'] = get_max_upload_file_size($CFG->maxbytes, $maxbytes);
158     }
160      /**
161      * Returns the maximum size of the area.
162      *
163      * @return int
164      */
165     function getAreamaxbytes() {
166         return $this->_options['areamaxbytes'];
167     }
169     /**
170      * Sets the maximum size of the area.
171      *
172      * @param int $areamaxbytes size limit
173      */
174     function setAreamaxbytes($areamaxbytes) {
175         $this->_options['areamaxbytes'] = $areamaxbytes;
176     }
178     /**
179      * Returns maximum number of files which can be uploaded
180      *
181      * @return int
182      */
183     function getMaxfiles() {
184         return $this->_options['maxfiles'];
185     }
187     /**
188      * Sets maximum number of files which can be uploaded.
189      *
190      * @param int $num number of files
191      */
192     function setMaxfiles($num) {
193         $this->_options['maxfiles'] = $num;
194     }
196     /**
197      * Returns true if subdirectoy can be created, else false
198      *
199      * @return bool
200      */
201     function getSubdirs() {
202         return $this->_options['subdirs'];
203     }
205     /**
206      * Set option to create sub directory, while uploading  file
207      *
208      * @param bool $allow true if sub directory can be created.
209      */
210     function setSubdirs($allow) {
211         $this->_options['subdirs'] = (int)($allow == 1);
212     }
214     /**
215      * Returns editor format
216      *
217      * @return int.
218      */
219     function getFormat() {
220         return $this->_values['format'];
221     }
223     /**
224      * Checks if editor used is a required field
225      *
226      * @return bool true if required field.
227      */
228     function isRequired() {
229         return (isset($this->_options['required']) && $this->_options['required']);
230     }
232     /**
233      * @deprecated since Moodle 2.0
234      */
235     function setHelpButton($_helpbuttonargs, $function='_helpbutton') {
236         throw new coding_exception('setHelpButton() can not be used any more, please see MoodleQuickForm::addHelpButton().');
237     }
239     /**
240      * Returns html for help button.
241      *
242      * @return string html for help button
243      */
244     function getHelpButton() {
245         return $this->_helpbutton;
246     }
248     /**
249      * Returns type of editor element
250      *
251      * @return string
252      */
253     function getElementTemplateType() {
254         if ($this->_flagFrozen){
255             return 'nodisplay';
256         } else {
257             return 'default';
258         }
259     }
261     /**
262      * Returns HTML for editor form element.
263      *
264      * @return string
265      */
266     function toHtml() {
267         global $CFG, $PAGE;
268         require_once($CFG->dirroot.'/repository/lib.php');
270         if ($this->_flagFrozen) {
271             return $this->getFrozenHtml();
272         }
274         $ctx = $this->_options['context'];
276         $id           = $this->_attributes['id'];
277         $elname       = $this->_attributes['name'];
279         $subdirs      = $this->_options['subdirs'];
280         $maxbytes     = $this->_options['maxbytes'];
281         $areamaxbytes = $this->_options['areamaxbytes'];
282         $maxfiles     = $this->_options['maxfiles'];
283         $changeformat = $this->_options['changeformat']; // TO DO: implement as ajax calls
285         $text         = $this->_values['text'];
286         $format       = $this->_values['format'];
287         $draftitemid  = $this->_values['itemid'];
289         // security - never ever allow guest/not logged in user to upload anything
290         if (isguestuser() or !isloggedin()) {
291             $maxfiles = 0;
292         }
294         $str = $this->_getTabs();
295         $str .= '<div>';
297         $editor = editors_get_preferred_editor($format);
298         $strformats = format_text_menu();
299         $formats =  $editor->get_supported_formats();
300         foreach ($formats as $fid) {
301             $formats[$fid] = $strformats[$fid];
302         }
304         // get filepicker info
305         //
306         $fpoptions = array();
307         if ($maxfiles != 0 ) {
308             if (empty($draftitemid)) {
309                 // no existing area info provided - let's use fresh new draft area
310                 require_once("$CFG->libdir/filelib.php");
311                 $this->setValue(array('itemid'=>file_get_unused_draft_itemid()));
312                 $draftitemid = $this->_values['itemid'];
313             }
315             $args = new stdClass();
316             // need these three to filter repositories list
317             $args->accepted_types = array('web_image');
318             $args->return_types = $this->_options['return_types'];
319             $args->context = $ctx;
320             $args->env = 'filepicker';
321             // advimage plugin
322             $image_options = initialise_filepicker($args);
323             $image_options->context = $ctx;
324             $image_options->client_id = uniqid();
325             $image_options->maxbytes = $this->_options['maxbytes'];
326             $image_options->areamaxbytes = $this->_options['areamaxbytes'];
327             $image_options->env = 'editor';
328             $image_options->itemid = $draftitemid;
330             // moodlemedia plugin
331             $args->accepted_types = array('video', 'audio');
332             $media_options = initialise_filepicker($args);
333             $media_options->context = $ctx;
334             $media_options->client_id = uniqid();
335             $media_options->maxbytes  = $this->_options['maxbytes'];
336             $media_options->areamaxbytes  = $this->_options['areamaxbytes'];
337             $media_options->env = 'editor';
338             $media_options->itemid = $draftitemid;
340             // advlink plugin
341             $args->accepted_types = '*';
342             $link_options = initialise_filepicker($args);
343             $link_options->context = $ctx;
344             $link_options->client_id = uniqid();
345             $link_options->maxbytes  = $this->_options['maxbytes'];
346             $link_options->areamaxbytes  = $this->_options['areamaxbytes'];
347             $link_options->env = 'editor';
348             $link_options->itemid = $draftitemid;
350             $fpoptions['image'] = $image_options;
351             $fpoptions['media'] = $media_options;
352             $fpoptions['link'] = $link_options;
353         }
355         //If editor is required and tinymce, then set required_tinymce option to initalize tinymce validation.
356         if (($editor instanceof tinymce_texteditor)  && !is_null($this->getAttribute('onchange'))) {
357             $this->_options['required'] = true;
358         }
360         // print text area - TODO: add on-the-fly switching, size configuration, etc.
361         $editor->use_editor($id, $this->_options, $fpoptions);
363         $rows = empty($this->_attributes['rows']) ? 15 : $this->_attributes['rows'];
364         $cols = empty($this->_attributes['cols']) ? 80 : $this->_attributes['cols'];
366         //Apply editor validation if required field
367         $editorrules = '';
368         if (!is_null($this->getAttribute('onblur')) && !is_null($this->getAttribute('onchange'))) {
369             $editorrules = ' onblur="'.htmlspecialchars($this->getAttribute('onblur')).'" onchange="'.htmlspecialchars($this->getAttribute('onchange')).'"';
370         }
371         $str .= '<div><textarea id="'.$id.'" name="'.$elname.'[text]" rows="'.$rows.'" cols="'.$cols.'" spellcheck="true"'.$editorrules.'>';
372         $str .= s($text);
373         $str .= '</textarea></div>';
375         $str .= '<div>';
376         if (count($formats)>1) {
377             $str .= html_writer::label(get_string('format'), 'menu'. $elname. 'format', false, array('class' => 'accesshide'));
378             $str .= html_writer::select($formats, $elname.'[format]', $format, false, array('id' => 'menu'. $elname. 'format'));
379         } else {
380             $keys = array_keys($formats);
381             $str .= html_writer::empty_tag('input',
382                     array('name'=>$elname.'[format]', 'type'=> 'hidden', 'value' => array_pop($keys)));
383         }
384         $str .= '</div>';
386         // during moodle installation, user area doesn't exist
387         // so we need to disable filepicker here.
388         if (!during_initial_install() && empty($CFG->adminsetuppending)) {
389             // 0 means no files, -1 unlimited
390             if ($maxfiles != 0 ) {
391                 $str .= '<input type="hidden" name="'.$elname.'[itemid]" value="'.$draftitemid.'" />';
393                 // used by non js editor only
394                 $editorurl = new moodle_url("$CFG->wwwroot/repository/draftfiles_manager.php", array(
395                     'action'=>'browse',
396                     'env'=>'editor',
397                     'itemid'=>$draftitemid,
398                     'subdirs'=>$subdirs,
399                     'maxbytes'=>$maxbytes,
400                     'areamaxbytes' => $areamaxbytes,
401                     'maxfiles'=>$maxfiles,
402                     'ctx_id'=>$ctx->id,
403                     'course'=>$PAGE->course->id,
404                     'sesskey'=>sesskey(),
405                     ));
406                 $str .= '<noscript>';
407                 $str .= "<div><object type='text/html' data='$editorurl' height='160' width='600' style='border:1px solid #000'></object></div>";
408                 $str .= '</noscript>';
409             }
410         }
413         $str .= '</div>';
415         return $str;
416     }
418     /**
419      * What to display when element is frozen.
420      *
421      * @return empty string
422      */
423     function getFrozenHtml() {
425         return '';
426     }