MDL-35042 blocks: Allow HTML block advanced setting to be toggled
[moodle.git] / blocks / html / block_html.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  * Form for editing HTML block instances.
20  *
21  * @package   block_html
22  * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 class block_html extends block_base {
28     function init() {
29         $this->title = get_string('pluginname', 'block_html');
30     }
32     function has_config() {
33         return true;
34     }
36     function applicable_formats() {
37         return array('all' => true);
38     }
40     function specialization() {
41         $this->title = isset($this->config->title) ? format_string($this->config->title) : format_string(get_string('newhtmlblock', 'block_html'));
42     }
44     function instance_allow_multiple() {
45         return true;
46     }
48     function get_content() {
49         global $CFG;
51         require_once($CFG->libdir . '/filelib.php');
53         if ($this->content !== NULL) {
54             return $this->content;
55         }
57         $filteropt = new stdClass;
58         $filteropt->overflowdiv = true;
59         if ($this->content_is_trusted()) {
60             // fancy html allowed only on course, category and system blocks.
61             $filteropt->noclean = true;
62         }
64         $this->content = new stdClass;
65         $this->content->footer = '';
66         if (isset($this->config->text)) {
67             // rewrite url
68             $this->config->text = file_rewrite_pluginfile_urls($this->config->text, 'pluginfile.php', $this->context->id, 'block_html', 'content', NULL);
69             // Default to FORMAT_HTML which is what will have been used before the
70             // editor was properly implemented for the block.
71             $format = FORMAT_HTML;
72             // Check to see if the format has been properly set on the config
73             if (isset($this->config->format)) {
74                 $format = $this->config->format;
75             }
76             $this->content->text = format_text($this->config->text, $format, $filteropt);
77         } else {
78             $this->content->text = '';
79         }
81         unset($filteropt); // memory footprint
83         return $this->content;
84     }
87     /**
88      * Serialize and store config data
89      */
90     function instance_config_save($data, $nolongerused = false) {
91         global $DB;
93         $config = clone($data);
94         // Move embedded files into a proper filearea and adjust HTML links to match
95         $config->text = file_save_draft_area_files($data->text['itemid'], $this->context->id, 'block_html', 'content', 0, array('subdirs'=>true), $data->text['text']);
96         $config->format = $data->text['format'];
98         parent::instance_config_save($config, $nolongerused);
99     }
101     function instance_delete() {
102         global $DB;
103         $fs = get_file_storage();
104         $fs->delete_area_files($this->context->id, 'block_html');
105         return true;
106     }
108     function content_is_trusted() {
109         global $SCRIPT;
111         if (!$context = get_context_instance_by_id($this->instance->parentcontextid)) {
112             return false;
113         }
114         //find out if this block is on the profile page
115         if ($context->contextlevel == CONTEXT_USER) {
116             if ($SCRIPT === '/my/index.php') {
117                 // this is exception - page is completely private, nobody else may see content there
118                 // that is why we allow JS here
119                 return true;
120             } else {
121                 // no JS on public personal pages, it would be a big security issue
122                 return false;
123             }
124         }
126         return true;
127     }
129     /**
130      * The block should only be dockable when the title of the block is not empty
131      * and when parent allows docking.
132      *
133      * @return bool
134      */
135     public function instance_can_be_docked() {
136         return (!empty($this->config->title) && parent::instance_can_be_docked());
137     }
139     /*
140      * Add custom html attributes to aid with theming and styling
141      *
142      * @return array
143      */
144     function html_attributes() {
145         global $CFG;
147         $attributes = parent::html_attributes();
149         if (!empty($CFG->block_html_allowcssclasses)) {
150             if (!empty($this->config->classes)) {
151                 $attributes['class'] .= ' '.$this->config->classes;
152             }
153         }
155         return $attributes;
156     }