9cc6d755f067d83a9d165260c8f7999d737f1f49
[moodle.git] / lib / editor / atto / lib.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/>.
17 /**
18  * YUI text editor integration.
19  *
20  * @package    editor_atto
21  * @copyright  2013 Damyon Wiese  <damyon@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 /**
28  * This is the texteditor implementation.
29  * @copyright  2013 Damyon Wiese  <damyon@moodle.com>
30  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
31  */
32 class atto_texteditor extends texteditor {
34     /**
35      * Is the current browser supported by this editor?
36      *
37      * Of course!
38      * @return bool
39      */
40     public function supported_by_browser() {
41         return true;
42     }
44     /**
45      * Returns array of supported text formats.
46      * @return array
47      */
48     public function get_supported_formats() {
49         // FORMAT_MOODLE is not supported here, sorry.
50         return array(FORMAT_HTML => FORMAT_HTML);
51     }
53     /**
54      * Returns text format preferred by this editor.
55      * @return int
56      */
57     public function get_preferred_format() {
58         return FORMAT_HTML;
59     }
61     /**
62      * Does this editor support picking from repositories?
63      * @return bool
64      */
65     public function supports_repositories() {
66         return true;
67     }
69     /**
70      * Use this editor for given element.
71      *
72      * @param string $elementid
73      * @param array $options
74      * @param null $fpoptions
75      */
76     public function use_editor($elementid, array $options=null, $fpoptions=null) {
77         global $PAGE;
79         $configstr = get_config('editor_atto', 'toolbar');
81         $grouplines = explode("\n", $configstr);
83         $groups = array();
85         foreach ($grouplines as $groupline) {
86             $line = explode('=', $groupline);
87             if (count($line) > 1) {
88                 $group = trim(array_shift($line));
89                 $plugins = array_map('trim', explode(',', array_shift($line)));
90                 $groups[$group] = $plugins;
91             }
92         }
94         $modules = array('moodle-editor_atto-editor');
95         $options['context'] = empty($options['context']) ? context_system::instance() : $options['context'];
97         $jsplugins = array();
98         foreach ($groups as $group => $plugins) {
99             $groupplugins = array();
100             foreach ($plugins as $plugin) {
101                 // Do not die on missing plugin.
102                 if (!core_component::get_component_directory('atto_' . $plugin))  {
103                     continue;
104                 }
106                 // Remove manage files if requested.
107                 if ($plugin == 'managefiles' && isset($options['enable_filemanagement']) && !$options['enable_filemanagement']) {
108                     continue;
109                 }
111                 $jsplugin = array();
112                 $jsplugin['name'] = $plugin;
113                 $jsplugin['params'] = array();
114                 $modules[] = 'moodle-atto_' . $plugin . '-button';
116                 component_callback('atto_' . $plugin, 'strings_for_js');
117                 $extra = component_callback('atto_' . $plugin, 'params_for_js', array($elementid, $options, $fpoptions));
119                 if ($extra) {
120                     $jsplugin = array_merge($jsplugin, $extra);
121                 }
122                 // We always need the plugin name.
123                 $PAGE->requires->string_for_js('pluginname', 'atto_' . $plugin);
124                 $groupplugins[] = $jsplugin;
125             }
126             $jsplugins[] = array('group'=>$group, 'plugins'=>$groupplugins);
127         }
129         $PAGE->requires->strings_for_js(array(
130                 'editor_command_keycode',
131                 'editor_control_keycode',
132                 'plugin_title_shortcut',
133                 'textrecovered',
134                 'autosavefailed',
135                 'autosavesucceeded',
136                 'errortextrecovery'
137             ), 'editor_atto');
138         $PAGE->requires->strings_for_js(array(
139                 'warning',
140                 'info'
141             ), 'moodle');
142         $PAGE->requires->yui_module($modules,
143                                     'Y.M.editor_atto.Editor.init',
144                                     array($this->get_init_params($elementid, $options, $fpoptions, $jsplugins)));
146     }
148     /**
149      * Create a params array to init the editor.
150      *
151      * @param string $elementid
152      * @param array $options
153      * @param array $fpoptions
154      */
155     protected function get_init_params($elementid, array $options = null, array $fpoptions = null, $plugins = null) {
156         global $PAGE;
158         $directionality = get_string('thisdirection', 'langconfig');
159         $strtime        = get_string('strftimetime');
160         $strdate        = get_string('strftimedaydate');
161         $lang           = current_language();
162         $autosave       = true;
163         $autosavefrequency = get_config('editor_atto', 'autosavefrequency');
164         if (isset($options['autosave'])) {
165             $autosave       = $options['autosave'];
166         }
167         $contentcss     = $PAGE->theme->editor_css_url()->out(false);
169         // Autosave disabled for guests.
170         if (isguestuser()) {
171             $autosave = false;
172         }
173         // Note <> is a safe separator, because it will not appear in the output of s().
174         $pagehash = sha1($PAGE->url . '<>' . s($this->get_text()));
175         $params = array(
176             'elementid' => $elementid,
177             'content_css' => $contentcss,
178             'contextid' => $options['context']->id,
179             'autosaveEnabled' => $autosave,
180             'autosaveFrequency' => $autosavefrequency,
181             'language' => $lang,
182             'directionality' => $directionality,
183             'filepickeroptions' => array(),
184             'plugins' => $plugins,
185             'pageHash' => $pagehash,
186         );
187         if ($fpoptions) {
188             $params['filepickeroptions'] = $fpoptions;
189         }
190         return $params;
191     }