lib/form/editor.php

   1 <?php
   2
   3 global $CFG;
   4
   5 require_once('HTML/QuickForm/element.php');
   6 require_once($CFG->dirroot.'/lib/filelib.php');
   7 require_once($CFG->dirroot.'/repository/lib.php');
   8
   9 //TODO:
  10 //  * locking
  11 //  * freezing
  12 //  * ajax format conversion
  13
  14 class MoodleQuickForm_editor extends HTML_QuickForm_element {
  15     public $_helpbutton = '';
  16
  17     public $_type       = 'editor';
  18     protected $_options    = array('subdirs'=>0, 'maxbytes'=>0, 'maxfiles'=>0, 'changeformat'=>0,
  19                                    'context'=>null, 'noclean'=>0, 'trusttext'=>0);
  20     protected $_values     = array('text'=>null, 'format'=>null, 'itemid'=>null);
  21
  22     function MoodleQuickForm_editor($elementName=null, $elementLabel=null, $attributes=null, $options=null) {
  23         global $CFG, $PAGE;
  24
  25         $options = (array)$options;
  26         foreach ($options as $name=>$value) {
  27             if (array_key_exists($name, $this->_options)) {
  28                 $this->_options[$name] = $value;
  29             }
  30         }
  31         if (!empty($options['maxbytes'])) {
  32             $this->_options['maxbytes'] = get_max_upload_file_size($CFG->maxbytes, $options['maxbytes']);
  33         }
  34         if (!$this->_options['context']) {
  35             $this->_options['context'] = get_context_instance(CONTEXT_SYSTEM);
  36         }
  37         $this->_options['trusted'] = trusttext_trusted($this->_options['context']);
  38         parent::HTML_QuickForm_element($elementName, $elementLabel, $attributes);
  39
  40         editors_head_setup();
  41     }
  42
  43     function setName($name) {
  44         $this->updateAttributes(array('name'=>$name));
  45     }
  46
  47     function getName() {
  48         return $this->getAttribute('name');
  49     }
  50
  51     function setValue($values) {
  52         $values = (array)$values;
  53         foreach ($values as $name=>$value) {
  54             if (array_key_exists($name, $this->_values)) {
  55                 $this->_values[$name] = $value;
  56             }
  57         }
  58     }
  59
  60     function getValue() {
  61         return $this->getAttribute('value');
  62     }
  63
  64     function getMaxbytes() {
  65         return $this->_options['maxbytes'];
  66     }
  67
  68     function setMaxbytes($maxbytes) {
  69         global $CFG;
  70         $this->_options['maxbytes'] = get_max_upload_file_size($CFG->maxbytes, $maxbytes);
  71     }
  72
  73     function getMaxfiles() {
  74         return $this->_options['maxfiles'];
  75     }
  76
  77     function setMaxfiles($num) {
  78         $this->_options['maxfiles'] = $num;
  79     }
  80
  81     function getSubdirs() {
  82         return $this->_options['subdirs'];
  83     }
  84
  85     function setSubdirs($allow) {
  86         $this->_options['subdirs'] = $allow;
  87     }
  88
  89     /**
  90      * Returns editor format
  91      *
  92      * @return int.
  93      */
  94     function getFormat() {
  95         return $this->_values['format'];
  96     }
  97
  98     /**
  99      * Checks if editor used is tinymce and is required field
 100      *
 101      * @return true if required field.
 102      */
 103     function isRequired() {
 104         return (isset($this->_options['required']) && $this->_options['required']);
 105     }
 106
 107     function setHelpButton($_helpbuttonargs, $function='_helpbutton') {
 108         if (!is_array($_helpbuttonargs)) {
 109             $_helpbuttonargs = array($_helpbuttonargs);
 110         } else {
 111             $_helpbuttonargs = $_helpbuttonargs;
 112         }
 113         //we do this to to return html instead of printing it
 114         //without having to specify it in every call to make a button.
 115         if ('_helpbutton' == $function){
 116             $defaultargs = array('', '', 'moodle', true, false, '', true);
 117             $_helpbuttonargs = $_helpbuttonargs + $defaultargs ;
 118         }
 119         $this->_helpbutton=call_user_func_array($function, $_helpbuttonargs);
 120     }
 121
 122     function getHelpButton() {
 123         return $this->_helpbutton;
 124     }
 125
 126     function getElementTemplateType() {
 127         if ($this->_flagFrozen){
 128             return 'nodisplay';
 129         } else {
 130             return 'default';
 131         }
 132     }
 133
 134     function toHtml() {
 135         global $CFG, $PAGE;
 136         require_once($CFG->dirroot.'/repository/lib.php');
 137
 138         if ($this->_flagFrozen) {
 139             return $this->getFrozenHtml();
 140         }
 141
 142         $ctx = $this->_options['context'];
 143
 144         $id           = $this->_attributes['id'];
 145         $elname       = $this->_attributes['name'];
 146
 147         $subdirs      = $this->_options['subdirs'];
 148         $maxbytes     = $this->_options['maxbytes'];
 149         $maxfiles     = $this->_options['maxfiles'];
 150         $changeformat = $this->_options['changeformat']; // TO DO: implement as ajax calls
 151
 152         $text         = $this->_values['text'];
 153         $format       = $this->_values['format'];
 154         $draftitemid  = $this->_values['itemid'];
 155
 156         // security - never ever allow guest/not logged in user to upload anything
 157         if (isguestuser() or !isloggedin()) {
 158             $maxfiles = 0;
 159         }
 160
 161         $str = $this->_getTabs();
 162         $str .= '<div>';
 163
 164         $editor = editors_get_preferred_editor($format);
 165         $strformats = format_text_menu();
 166         $formats =  $editor->get_supported_formats();
 167         foreach ($formats as $fid) {
 168             $formats[$fid] = $strformats[$fid];
 169         }
 170
 171         // get filepicker info
 172         //
 173         $fpoptions = array();
 174         if ($maxfiles != 0 ) {
 175             if (empty($draftitemid)) {
 176                 // no existing area info provided - let's use fresh new draft area
 177                 require_once("$CFG->libdir/filelib.php");
 178                 $this->setValue(array('itemid'=>file_get_unused_draft_itemid()));
 179                 $draftitemid = $this->_values['itemid'];
 180             }
 181
 182             $args = new stdClass();
 183             // need these three to filter repositories list
 184             $args->accepted_types = array('image');
 185             $args->return_types = (FILE_INTERNAL | FILE_EXTERNAL);
 186             $args->context = $ctx;
 187             $args->env = 'filepicker';
 188             // advimage plugin
 189             $image_options = initialise_filepicker($args);
 190             $image_options->context = $ctx;
 191             $image_options->client_id = uniqid();
 192             $image_options->maxbytes = $this->_options['maxbytes'];
 193             $image_options->env = 'editor';
 194             $image_options->itemid = $draftitemid;
 195
 196             // moodlemedia plugin
 197             $args->accepted_types = array('video', 'audio');
 198             $media_options = initialise_filepicker($args);
 199             $media_options->context = $ctx;
 200             $media_options->client_id = uniqid();
 201             $media_options->maxbytes  = $this->_options['maxbytes'];
 202             $media_options->env = 'editor';
 203             $media_options->itemid = $draftitemid;
 204
 205             // advlink plugin
 206             $args->accepted_types = '*';
 207             $link_options = initialise_filepicker($args);
 208             $link_options->context = $ctx;
 209             $link_options->client_id = uniqid();
 210             $link_options->maxbytes  = $this->_options['maxbytes'];
 211             $link_options->env = 'editor';
 212             $link_options->itemid = $draftitemid;
 213
 214             $fpoptions['image'] = $image_options;
 215             $fpoptions['media'] = $media_options;
 216             $fpoptions['link'] = $link_options;
 217         }
 218
 219         //If editor is required and tinymce, then set required_tinymce option to initalize tinymce validation.
 220         if (($editor instanceof tinymce_texteditor)  && !is_null($this->getAttribute('onchange'))) {
 221             $this->_options['required'] = true;
 222         }
 223
 224     /// print text area - TODO: add on-the-fly switching, size configuration, etc.
 225         $editor->use_editor($id, $this->_options, $fpoptions);
 226
 227         $rows = empty($this->_attributes['rows']) ? 15 : $this->_attributes['rows'];
 228         $cols = empty($this->_attributes['cols']) ? 80 : $this->_attributes['cols'];
 229
 230         //Apply editor validation if required field
 231         $editorrules = '';
 232         if (!is_null($this->getAttribute('onblur')) && !is_null($this->getAttribute('onchange'))) {
 233             $editorrules = 'onblur="'.htmlspecialchars($this->getAttribute('onblur')).'" onchange="'.htmlspecialchars($this->getAttribute('onchange')).'"';
 234         }
 235         $str .= '<div><textarea id="'.$id.'" name="'.$elname.'[text]" rows="'.$rows.'" cols="'.$cols.'"'.$editorrules.'>';
 236         $str .= s($text);
 237         $str .= '</textarea></div>';
 238
 239         $str .= '<div>';
 240         if (count($formats)>1) {
 241             $str.= html_writer::select($formats, $elname.'[format]', $format, false);
 242         } else {
 243             $str.= html_writer::empty_tag('input',
 244                     array('name'=>$elname.'[format]', 'type'=> 'hidden', 'value' => array_pop(array_keys($formats))));
 245         }
 246         $str .= '</div>';
 247
 248         // during moodle installation, user area doesn't exist
 249         // so we need to disable filepicker here.
 250         if (!during_initial_install() && empty($CFG->adminsetuppending)) {
 251             // 0 means no files, -1 unlimited
 252             if ($maxfiles != 0 ) {
 253                 $str .= '<input type="hidden" name="'.$elname.'[itemid]" value="'.$draftitemid.'" />';
 254
 255                 // used by non js editor only
 256                 $editorurl = new moodle_url("$CFG->wwwroot/repository/draftfiles_manager.php", array(
 257                     'action'=>'browse',
 258                     'env'=>'editor',
 259                     'itemid'=>$draftitemid,
 260                     'subdirs'=>$subdirs,
 261                     'maxbytes'=>$maxbytes,
 262                     'maxfiles'=>$maxfiles,
 263                     'ctx_id'=>$ctx->id,
 264                     'course'=>$PAGE->course->id,
 265                     'sesskey'=>sesskey(),
 266                     ));
 267                 $str .= '<noscript>';
 268                 $str .= "<div><object type='text/html' data='$editorurl' height='160' width='600' style='border:1px solid #000'></object></div>";
 269                 $str .= '</noscript>';
 270             }
 271         }
 272
 273
 274         $str .= '</div>';
 275
 276         return $str;
 277     }
 278
 279 }