ef576ba10d6bc6f6ae7ba8353f4f5cb676f344bf
[moodle.git] / lib / editorlib.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  * Utility classes and functions for text editor integration.
20  *
21  * @package    moodlecore
22  * @subpackage editor
23  * @copyright  2009 Petr Skoda {@link http://skodak.org}
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 /**
28  * Returns users preferred editor for given format
29  *
30  * @todo  implement user preferences for text editors
31  *
32  * @global object
33  * @global object
34  * @param int $format text format or null of none
35  * @return texteditor object
36  */
37 function get_preferred_texteditor($format=null) {
38     global $CFG, $USER;
40     if (empty($CFG->texteditors)) {
41         $CFG->texteditors = 'tinymce,textarea';
42     }
43     $active = explode(',', $CFG->texteditors);
45     // TODO: implement user preferences for text editors
47     // now find some plugin that supports format and is available
48     $editor = false;
49     foreach ($active as $editorname) {
50         if (!$e = get_texteditor($editorname)) {
51             continue;
52         }
53         if (!$e->supported_by_browser()) {
54             // bad luck, this editor is not compatible
55             continue;
56         }
57         if (!$supports = $e->get_supported_formats()) {
58             continue;
59         }
60         if (is_null($format)) {
61             // format does not matter
62             $editor = $e;
63             break;
64         }
65         if (in_array($format, $supports)) {
66             // editor supports this format, yay!
67             $editor = $e;
68             break;
69         }
70     }
72     if (!$editor) {
73         $editor = get_texteditor('textarea'); // must exist and can edit anything
74     }
76     return $editor;
77 }
79 /**
80  * Returns instance of text editor
81  *
82  * @global object
83  * @param string $editorname name of editor (textarea, tinymce, ...)
84  * @return object|bool texeditor instance or false if does not exist
85  */
86 function get_texteditor($editorname) {
87     global $CFG;
89     $libfile = "$CFG->libdir/editor/$editorname/lib.php";
90     if (!file_exists($libfile)) {
91         return false;
92     }
93     require_once($libfile);
94     $classname = $editorname.'_texteditor';
95     if (!class_exists($classname)) {
96         return false;
97     }
98     return new $classname();
99 }
101 /**
102  * Get the list of available editors
103  *
104  * @return array Array ('editorname'=>'localised editor name')
105  */
106 function get_available_editors() {
107     $editors = array();
108     foreach (get_plugin_list('editor') as $editorname => $dir) {
109         $editors[$editorname] = get_string('modulename', 'editor_'.$editorname);
110     }
111     return $editors;
114 /**
115  * Setup all JS and CSS needed for editors.
116  * @return void
117  */
118 function editors_head_setup() {
119     global $CFG;
121     if (empty($CFG->texteditors)) {
122         $CFG->texteditors = 'tinymce,textarea';
123     }
124     $active = explode(',', $CFG->texteditors);
126     foreach ($active as $editorname) {
127         if (!$editor = get_texteditor($editorname)) {
128             continue;
129         }
130         if (!$editor->supported_by_browser()) {
131             // bad luck, this editor is not compatible
132             continue;
133         }
134         $editor->head_setup();
135     }
138 /**
139  * Base abstract text editor class.
140  *
141  * @copyright  2009 Petr Skoda {@link http://skodak.org}
142  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
143  * @package moodlecore
144  */
145 abstract class texteditor {
146     /**
147      * Is editor supported in current browser?
148      * @return bool
149      */
150     public abstract function supported_by_browser();
152     /**
153      * Returns list of supported text formats
154      * @return array Array (FORMAT=>FORMAT)
155      */
156     public abstract function get_supported_formats();
158     /**
159      * Returns main preferred text format.
160      * @return int text format
161      */
162     public abstract function get_preferred_format();
164     /**
165      * Supports file picker and repos?
166      * @return object book object
167      */
168     public abstract function supports_repositories();
170     /**
171      * Add required JS needed for editor
172      * @param string $elementid id of text area to be converted to editor
173      * @param array $options
174      * @param obejct $fpoptions file picker options
175      * @return void
176      */
177     public abstract function use_editor($elementid, array $options=null, $fpoptions = null);
179     /**
180      * Setup all JS and CSS needed for editor.
181      * @return void
182      */
183     public function head_setup() {
184     }
187 //TODO: this is very wrong way to do admin settings - this has to be rewritten
188 require_once($CFG->libdir.'/formslib.php'); 
189 /**
190  * Editor settings moodle form class.
191  *
192  * @copyright  2010 Dongsheng Cai
193  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
194  * @package moodlecore
195  */
196 class editor_settings_form extends moodleform {
197     public function definition() {
198         $mform =& $this->_form;
200         $mform->addElement('hidden', 'action', 'edit');
201         $this->add_action_buttons(true, get_string('savechanges'));
202     }
205 //=== DEPRECATED =====================
206 /**
207  * can_use_html_editor is deprecated...
208  * @deprecated
209  * @todo Deprecated: eradicate completely, replace with something else
210  * @return bool
211  */
212 function can_use_html_editor() {
213     //TODO: eradicate completely, replace with something else
215     $tinymyce = get_texteditor('tinymce');
216     return $tinymyce ->supported_by_browser();