Merge branch 'MDL-55127_master-fix-everything' of git://github.com/dmonllao/moodle
[moodle.git] / mod / data / field / textarea / field.class.php
1 <?php
2 ///////////////////////////////////////////////////////////////////////////
3 //                                                                       //
4 // NOTICE OF COPYRIGHT                                                   //
5 //                                                                       //
6 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
7 //          http://moodle.org                                            //
8 //                                                                       //
9 // Copyright (C) 1999-onwards Moodle Pty Ltd  http://moodle.com          //
10 //                                                                       //
11 // This program is free software; you can redistribute it and/or modify  //
12 // it under the terms of the GNU General Public License as published by  //
13 // the Free Software Foundation; either version 2 of the License, or     //
14 // (at your option) any later version.                                   // //                                                                       //
15 // This program is distributed in the hope that it will be useful,       //
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
18 // GNU General Public License for more details:                          //
19 //                                                                       //
20 //          http://www.gnu.org/copyleft/gpl.html                         //
21 //                                                                       //
22 ///////////////////////////////////////////////////////////////////////////
24 require_once($CFG->dirroot.'/lib/filelib.php');
25 require_once($CFG->dirroot.'/repository/lib.php');
27 class data_field_textarea extends data_field_base {
29     var $type = 'textarea';
30     /**
31      * priority for globalsearch indexing
32      *
33      * @var int
34      */
35     protected static $priority = self::LOW_PRIORITY;
37     /**
38      * Returns options for embedded files
39      *
40      * @return array
41      */
42     private function get_options() {
43         if (!isset($this->field->param5)) {
44             $this->field->param5 = 0;
45         }
46         $options = array();
47         $options['trusttext'] = false;
48         $options['forcehttps'] = false;
49         $options['subdirs'] = false;
50         $options['maxfiles'] = -1;
51         $options['context'] = $this->context;
52         $options['maxbytes'] = $this->field->param5;
53         $options['changeformat'] = 0;
54         $options['noclean'] = false;
55         return $options;
56     }
58     function display_add_field($recordid = 0, $formdata = null) {
59         global $CFG, $DB, $OUTPUT, $PAGE;
61         $text   = '';
62         $format = 0;
63         $str = '<div title="' . s($this->field->description) . '">';
64         $str .= '<label for="field_' . $this->field->id . '">';
65         $str .= html_writer::span($this->field->name, "accesshide");
66         if ($this->field->required) {
67             $image = html_writer::img($OUTPUT->pix_url('req'), get_string('requiredelement', 'form'),
68                                      array('class' => 'req', 'title' => get_string('requiredelement', 'form')));
69             $str .= html_writer::div($image, 'inline-req');
70         }
71         $str .= '</label>';
73         editors_head_setup();
74         $options = $this->get_options();
76         $itemid = $this->field->id;
77         $field = 'field_'.$itemid;
79         if ($formdata) {
80             $fieldname = 'field_' . $this->field->id . '_content1';
81             if (isset($formdata->$fieldname)) {
82                 $format = $formdata->$fieldname;
83             } else {
84                 $format = file_get_unused_draft_itemid();
85             }
86             $fieldname = 'field_' . $this->field->id . '_itemid';
87             if (isset($formdata->$fieldname)) {
88                 $draftitemid = clean_param($formdata->$fieldname, PARAM_INT);
89             } else {
90                 $draftitemid = file_get_unused_draft_itemid();
91             }
92             $fieldname = 'field_' . $this->field->id;
93             if (isset($formdata->$fieldname)) {
94                 $text = $formdata->$fieldname;
95             }
96         } else if ($recordid &&
97                    $content = $DB->get_record('data_content', array('fieldid' => $this->field->id, 'recordid' => $recordid))) {
98             $format = $content->content1;
99             $text = clean_text($content->content, $format);
100             $text = file_prepare_draft_area($draftitemid, $this->context->id, 'mod_data', 'content', $content->id, $options, $text);
101         } else {
102             $draftitemid = file_get_unused_draft_itemid();
103             $format = FORMAT_HTML;
104         }
106         // get filepicker info
107         //
108         $fpoptions = array();
109         if ($options['maxfiles'] != 0 ) {
110             $args = new stdClass();
111             // need these three to filter repositories list
112             $args->accepted_types = array('web_image');
113             $args->return_types = (FILE_INTERNAL | FILE_EXTERNAL);
114             $args->context = $this->context;
115             $args->env = 'filepicker';
116             // advimage plugin
117             $image_options = initialise_filepicker($args);
118             $image_options->context = $this->context;
119             $image_options->client_id = uniqid();
120             $image_options->maxbytes = $options['maxbytes'];
121             $image_options->env = 'editor';
122             $image_options->itemid = $draftitemid;
124             // moodlemedia plugin
125             $args->accepted_types = array('video', 'audio');
126             $media_options = initialise_filepicker($args);
127             $media_options->context = $this->context;
128             $media_options->client_id = uniqid();
129             $media_options->maxbytes  = $options['maxbytes'];
130             $media_options->env = 'editor';
131             $media_options->itemid = $draftitemid;
133             // advlink plugin
134             $args->accepted_types = '*';
135             $link_options = initialise_filepicker($args);
136             $link_options->context = $this->context;
137             $link_options->client_id = uniqid();
138             $link_options->maxbytes  = $options['maxbytes'];
139             $link_options->env = 'editor';
140             $link_options->itemid = $draftitemid;
142             $fpoptions['image'] = $image_options;
143             $fpoptions['media'] = $media_options;
144             $fpoptions['link'] = $link_options;
145         }
147         $editor = editors_get_preferred_editor($format);
148         $strformats = format_text_menu();
149         $formats =  $editor->get_supported_formats();
150         foreach ($formats as $fid) {
151             $formats[$fid] = $strformats[$fid];
152         }
153         $editor->set_text($text);
154         $editor->use_editor($field, $options, $fpoptions);
155         $str .= '<input type="hidden" name="'.$field.'_itemid" value="'.s($draftitemid).'" />';
156         $str .= '<div class="mod-data-input">';
157         $str .= '<div><textarea id="'.$field.'" name="'.$field.'" rows="'.$this->field->param3.'" cols="'.$this->field->param2.'" spellcheck="true">'.s($text).'</textarea></div>';
158         $str .= '<div><label class="accesshide" for="' . $field . '_content1">' . get_string('format') . '</label>';
159         $str .= '<select id="' . $field . '_content1" name="'.$field.'_content1">';
160         foreach ($formats as $key=>$desc) {
161             $selected = ($format == $key) ? 'selected="selected"' : '';
162             $str .= '<option value="'.s($key).'" '.$selected.'>'.$desc.'</option>';
163         }
164         $str .= '</select>';
166         $str .= '</div>';
167         $str .= '</div>';
168         $str .= '</div>';
169         return $str;
170     }
173     function display_search_field($value = '') {
174         return '<label class="accesshide" for="f_' . $this->field->id . '">' . $this->field->name . '</label>' .
175                '<input type="text" size="16" id="f_'.$this->field->id.'" name="f_'.$this->field->id.'" value="'.s($value).'" />';
176     }
178     function parse_search_field() {
179         return optional_param('f_'.$this->field->id, '', PARAM_NOTAGS);
180     }
182     function generate_sql($tablealias, $value) {
183         global $DB;
185         static $i=0;
186         $i++;
187         $name = "df_textarea_$i";
188         return array(" ({$tablealias}.fieldid = {$this->field->id} AND ".$DB->sql_like("{$tablealias}.content", ":$name", false).") ", array($name=>"%$value%"));
189     }
191     function print_after_form() {
192     }
195     function update_content($recordid, $value, $name='') {
196         global $DB;
198         $content = new stdClass();
199         $content->fieldid = $this->field->id;
200         $content->recordid = $recordid;
202         $names = explode('_', $name);
203         if (!empty($names[2])) {
204             if ($names[2] == 'itemid') {
205                 // the value will be retrieved by file_get_submitted_draft_itemid, do not need to save in DB
206                 return true;
207             } else {
208                 $content->{$names[2]} = clean_param($value, PARAM_NOTAGS);  // content[1-4]
209             }
210         } else {
211             $content->content = clean_param($value, PARAM_CLEAN);
212         }
214         if ($oldcontent = $DB->get_record('data_content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid))) {
215             $content->id = $oldcontent->id;
216         } else {
217             $content->id = $DB->insert_record('data_content', $content);
218             if (!$content->id) {
219                 return false;
220             }
221         }
222         if (!empty($content->content)) {
223             $draftitemid = file_get_submitted_draft_itemid('field_'. $this->field->id. '_itemid');
224             $options = $this->get_options();
225             $content->content = file_save_draft_area_files($draftitemid, $this->context->id, 'mod_data', 'content', $content->id, $options, $content->content);
226         }
227         $rv = $DB->update_record('data_content', $content);
228         return $rv;
229     }
231     /**
232      * Display the content of the field in browse mode
233      *
234      * @param int $recordid
235      * @param object $template
236      * @return bool|string
237      */
238     function display_browse_field($recordid, $template) {
239         global $DB;
241         if ($content = $DB->get_record('data_content', array('fieldid' => $this->field->id, 'recordid' => $recordid))) {
242             if (isset($content->content)) {
243                 $options = new stdClass();
244                 if ($this->field->param1 == '1') {  // We are autolinking this field, so disable linking within us
245                     $options->filter = false;
246                 }
247                 $options->para = false;
248                 $str = file_rewrite_pluginfile_urls($content->content, 'pluginfile.php', $this->context->id, 'mod_data', 'content', $content->id, $this->get_options());
249                 $str = format_text($str, $content->content1, $options);
250             } else {
251                 $str = '';
252             }
253             return $str;
254         }
255         return false;
256     }
258     /**
259      * Whether this module support files
260      *
261      * @param string $relativepath
262      * @return bool
263      */
264     function file_ok($relativepath) {
265         return true;
266     }
268     /**
269      * Only look at the first item (second is format)
270      *
271      * @param string $value
272      * @param string $name
273      * @return bool
274      */
275     function notemptyfield($value, $name) {
276         $names = explode('_', $name);
277         // Clean first.
278         if (count($names) == 2) {
279             // Don't assume that this is coming from a text editor with tags.
280             return strval($value) !== '';
281         }
282         return false;
283     }
285     /**
286      * Returns the presentable string value for a field content.
287      *
288      * The returned string should be plain text.
289      *
290      * @param stdClass $content
291      * @return string
292      */
293     public static function get_content_value($content) {
294         return content_to_text($content->content, $content->content1);
295     }