MDL-27500 HTML Editor - updating tinymce version used by moodle to 3.4.2
[moodle.git] / lib / editor / tinymce / 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  * TinyMCE text editor integration.
20  *
21  * @package    editor
22  * @subpackage tinymce
23  * @copyright  2009 Petr Skoda (http://skodak.org)
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 class tinymce_texteditor extends texteditor {
30     /** @var string active version - directory name */
31     public $version = '3.4.2';
33     public function supported_by_browser() {
34         if (check_browser_version('MSIE', 6)) {
35             return true;
36         }
37         if (check_browser_version('Gecko', 20030516)) {
38             return true;
39         }
40         if (check_browser_version('Safari', 412)) {
41             return true;
42         }
43         if (check_browser_version('Chrome', 6)) {
44             return true;
45         }
46         if (check_browser_version('Opera', 9)) {
47             return true;
48         }
50         return false;
51     }
53     public function get_supported_formats() {
54         return array(FORMAT_HTML => FORMAT_HTML);
55     }
57     public function get_preferred_format() {
58         return FORMAT_HTML;
59     }
61     public function supports_repositories() {
62         return true;
63     }
65     public function head_setup() {
66     }
68     public function use_editor($elementid, array $options=null, $fpoptions=null) {
69         global $PAGE;
70         $PAGE->requires->js('/lib/editor/tinymce/tiny_mce/'.$this->version.'/tiny_mce.js');
71         $PAGE->requires->js_init_call('M.editor_tinymce.init_editor', array($elementid, $this->get_init_params($elementid, $options)), true);
72         if ($fpoptions) {
73             $PAGE->requires->js_init_call('M.editor_tinymce.init_filepicker', array($elementid, $fpoptions), true);
74         }
75     }
77     protected function get_init_params($elementid, array $options=null) {
78         global $CFG, $PAGE, $OUTPUT;
80         //TODO: we need to implement user preferences that affect the editor setup too
82         $directionality = get_string('thisdirection', 'langconfig');
83         $strtime        = get_string('strftimetime');
84         $strdate        = get_string('strftimedaydate');
85         $lang           = current_language();
86         $contentcss     = $PAGE->theme->editor_css_url()->out(false);
88         $context = empty($options['context']) ? get_context_instance(CONTEXT_SYSTEM) : $options['context'];
90         $xmedia = 'moodlemedia,'; // HQ thinks it should be always on, so it is no matter if it will actually work or not
91         /*
92         if (!empty($options['legacy'])) {
93             $xmedia = 'moodlemedia,';
94         } else {
95             if (!empty($options['noclean']) or !empty($options['trusted'])) {
96             }
97         }*/
99         $filters = filter_get_active_in_context($context);
100         if (array_key_exists('filter/tex', $filters)) {
101             $xdragmath = 'dragmath,';
102         } else {
103             $xdragmath = '';
104         }
105         if (array_key_exists('filter/emoticon', $filters)) {
106             $xemoticon = 'moodleemoticon,';
107         } else {
108             $xemoticon = '';
109         }
111         $params = array(
112                     'mode' => "exact",
113                     'elements' => $elementid,
114                     'relative_urls' => false,
115                     'document_base_url' => $CFG->httpswwwroot,
116                     'content_css' => $contentcss,
117                     'language' => $lang,
118                     'directionality' => $directionality,
119                     'plugin_insertdate_dateFormat ' => $strdate,
120                     'plugin_insertdate_timeFormat ' => $strtime,
121                     'theme' => "advanced",
122                     'skin' => "o2k7",
123                     'skin_variant' => "silver",
124                     'apply_source_formatting' => true,
125                     'remove_script_host' => false,
126                     'entity_encoding' => "raw",
127                     'plugins' => "{$xmedia}advimage,safari,table,style,layer,advhr,advlink,emotions,inlinepopups,searchreplace,paste,directionality,fullscreen,moodlenolink,{$xemoticon}{$xdragmath}nonbreaking,contextmenu,insertdatetime,save,iespell,preview,print,noneditable,visualchars,xhtmlxtras,template,pagebreak,spellchecker",
128                     'theme_advanced_font_sizes' => "1,2,3,4,5,6,7",
129                     'theme_advanced_layout_manager' => "SimpleLayout",
130                     'theme_advanced_toolbar_align' => "left",
131                     'theme_advanced_buttons1' => "fontselect,fontsizeselect,formatselect",
132                     'theme_advanced_buttons1_add' => "|,undo,redo,|,search,replace,|,fullscreen",
133                     'theme_advanced_buttons2' => "bold,italic,underline,strikethrough,sub,sup,|,justifyleft,justifycenter,justifyright",
134                     'theme_advanced_buttons2_add' => "|,cleanup,removeformat,pastetext,pasteword,|,forecolor,backcolor,|,ltr,rtl",
135                     'theme_advanced_buttons3' => "bullist,numlist,outdent,indent,|,link,unlink,moodlenolink,|,image,{$xemoticon}{$xmedia}{$xdragmath}nonbreaking,charmap",
136                     'theme_advanced_buttons3_add' => "table,|,code,spellchecker",
137                     'theme_advanced_fonts' => "Trebuchet=Trebuchet MS,Verdana,Arial,Helvetica,sans-serif;Arial=arial,helvetica,sans-serif;Courier New=courier new,courier,monospace;Georgia=georgia,times new roman,times,serif;Tahoma=tahoma,arial,helvetica,sans-serif;Times New Roman=times new roman,times,serif;Verdana=verdana,arial,helvetica,sans-serif;Impact=impact;Wingdings=wingdings",
138                     'theme_advanced_resize_horizontal' => true,
139                     'theme_advanced_resizing' => true,
140                     'theme_advanced_toolbar_location' => "top",
141                     'theme_advanced_statusbar_location' => "bottom",
142                     'spellchecker_rpc_url' => $CFG->wwwroot."/lib/editor/tinymce/tiny_mce/$this->version/plugins/spellchecker/rpc.php"
143                   );
145         if ($xemoticon) {
146             $manager = get_emoticon_manager();
147             $emoticons = $manager->get_emoticons();
148             $imgs = array();
149             // see the TinyMCE plugin moodleemoticon for how the emoticon index is (ab)used :-S
150             $index = 0;
151             foreach ($emoticons as $emoticon) {
152                 $imgs[$emoticon->text] = $OUTPUT->render(
153                     $manager->prepare_renderable_emoticon($emoticon, array('class' => 'emoticon emoticon-index-'.$index++)));
154             }
155             $params['moodleemoticon_emoticons'] = json_encode($imgs);
156         }
158         if (empty($CFG->xmlstrictheaders) and (!empty($options['legacy']) or !empty($options['noclean']) or !empty($options['trusted']))) {
159             // now deal somehow with non-standard tags, people scream when we do not make moodle code xtml strict,
160             // but they scream even more when we strip all tags that are not strict :-(
161             $params['valid_elements'] = 'script[src|type],*[*]'; // for some reason the *[*] does not inlcude javascript src attribute MDL-25836
162             $params['invalid_elements'] = '';
163         }
165         if (empty($options['legacy'])) {
166             if (isset($options['maxfiles']) and $options['maxfiles'] != 0) {
167                 $params['file_browser_callback'] = "M.editor_tinymce.filepicker";
168             }
169         }
171         return $params;
172     }