MDL-65788 tool_policy: Prevent two modals rendering for guests.
[moodle.git] / blocks / moodleblock.class.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  * This file contains the parent class for moodle blocks, block_base.
19  *
20  * @package    core_block
21  * @license    http://www.gnu.org/copyleft/gpl.html GNU Public License
22  */
24 /// Constants
26 /**
27  * Block type of list. Contents of block should be set as an associative array in the content object as items ($this->content->items). Optionally include footer text in $this->content->footer.
28  */
29 define('BLOCK_TYPE_LIST',    1);
31 /**
32  * Block type of text. Contents of block should be set to standard html text in the content object as items ($this->content->text). Optionally include footer text in $this->content->footer.
33  */
34 define('BLOCK_TYPE_TEXT',    2);
35 /**
36  * Block type of tree. $this->content->items is a list of tree_item objects and $this->content->footer is a string.
37  */
38 define('BLOCK_TYPE_TREE',    3);
40 /**
41  * Class for describing a moodle block, all Moodle blocks derive from this class
42  *
43  * @author Jon Papaioannou
44  * @package core_block
45  */
46 class block_base {
48     /**
49      * Internal var for storing/caching translated strings
50      * @var string $str
51      */
52     var $str;
54     /**
55      * The title of the block to be displayed in the block title area.
56      * @var string $title
57      */
58     var $title         = NULL;
60     /**
61      * The name of the block to be displayed in the block title area if the title is empty.
62      * @var string arialabel
63      */
64     var $arialabel         = NULL;
66     /**
67      * The type of content that this block creates. Currently support options - BLOCK_TYPE_LIST, BLOCK_TYPE_TEXT
68      * @var int $content_type
69      */
70     var $content_type  = BLOCK_TYPE_TEXT;
72     /**
73      * An object to contain the information to be displayed in the block.
74      * @var stdObject $content
75      */
76     var $content       = NULL;
78     /**
79      * The initialized instance of this block object.
80      * @var block $instance
81      */
82     var $instance      = NULL;
84     /**
85      * The page that this block is appearing on.
86      * @var moodle_page
87      */
88     public $page       = NULL;
90     /**
91      * This blocks's context.
92      * @var stdClass
93      */
94     public $context    = NULL;
96     /**
97      * An object containing the instance configuration information for the current instance of this block.
98      * @var stdObject $config
99      */
100     var $config        = NULL;
102     /**
103      * How often the cronjob should run, 0 if not at all.
104      * @var int $cron
105      */
107     var $cron          = NULL;
109 /// Class Functions
111     /**
112      * Fake constructor to keep PHP5 happy
113      *
114      */
115     function __construct() {
116         $this->init();
117     }
119     /**
120      * Function that can be overridden to do extra cleanup before
121      * the database tables are deleted. (Called once per block, not per instance!)
122      */
123     function before_delete() {
124     }
126     /**
127      * Returns the block name, as present in the class name,
128      * the database, the block directory, etc etc.
129      *
130      * @return string
131      */
132     function name() {
133         // Returns the block name, as present in the class name,
134         // the database, the block directory, etc etc.
135         static $myname;
136         if ($myname === NULL) {
137             $myname = strtolower(get_class($this));
138             $myname = substr($myname, strpos($myname, '_') + 1);
139         }
140         return $myname;
141     }
143     /**
144      * Parent class version of this function simply returns NULL
145      * This should be implemented by the derived class to return
146      * the content object.
147      *
148      * @return stdObject
149      */
150     function get_content() {
151         // This should be implemented by the derived class.
152         return NULL;
153     }
155     /**
156      * Returns the class $title var value.
157      *
158      * Intentionally doesn't check if a title is set.
159      * This is already done in {@link _self_test()}
160      *
161      * @return string $this->title
162      */
163     function get_title() {
164         // Intentionally doesn't check if a title is set. This is already done in _self_test()
165         return $this->title;
166     }
168     /**
169      * Returns the class $content_type var value.
170      *
171      * Intentionally doesn't check if content_type is set.
172      * This is already done in {@link _self_test()}
173      *
174      * @return string $this->content_type
175      */
176     function get_content_type() {
177         // Intentionally doesn't check if a content_type is set. This is already done in _self_test()
178         return $this->content_type;
179     }
181     /**
182      * Returns true or false, depending on whether this block has any content to display
183      * and whether the user has permission to view the block
184      *
185      * @return boolean
186      */
187     function is_empty() {
188         if ( !has_capability('moodle/block:view', $this->context) ) {
189             return true;
190         }
192         $this->get_content();
193         return(empty($this->content->text) && empty($this->content->footer));
194     }
196     /**
197      * First sets the current value of $this->content to NULL
198      * then calls the block's {@link get_content()} function
199      * to set its value back.
200      *
201      * @return stdObject
202      */
203     function refresh_content() {
204         // Nothing special here, depends on content()
205         $this->content = NULL;
206         return $this->get_content();
207     }
209     /**
210      * Return a block_contents object representing the full contents of this block.
211      *
212      * This internally calls ->get_content(), and then adds the editing controls etc.
213      *
214      * You probably should not override this method, but instead override
215      * {@link html_attributes()}, {@link formatted_contents()} or {@link get_content()},
216      * {@link hide_header()}, {@link (get_edit_controls)}, etc.
217      *
218      * @return block_contents a representation of the block, for rendering.
219      * @since Moodle 2.0.
220      */
221     public function get_content_for_output($output) {
222         global $CFG;
224         $bc = new block_contents($this->html_attributes());
225         $bc->attributes['data-block'] = $this->name();
226         $bc->blockinstanceid = $this->instance->id;
227         $bc->blockpositionid = $this->instance->blockpositionid;
229         if ($this->instance->visible) {
230             $bc->content = $this->formatted_contents($output);
231             if (!empty($this->content->footer)) {
232                 $bc->footer = $this->content->footer;
233             }
234         } else {
235             $bc->add_class('invisibleblock');
236         }
238         if (!$this->hide_header()) {
239             $bc->title = $this->title;
240         }
242         if (empty($bc->title)) {
243             $bc->arialabel = new lang_string('pluginname', get_class($this));
244             $this->arialabel = $bc->arialabel;
245         }
247         if ($this->page->user_is_editing()) {
248             $bc->controls = $this->page->blocks->edit_controls($this);
249         } else {
250             // we must not use is_empty on hidden blocks
251             if ($this->is_empty() && !$bc->controls) {
252                 return null;
253             }
254         }
256         if (empty($CFG->allowuserblockhiding)
257                 || (empty($bc->content) && empty($bc->footer))
258                 || !$this->instance_can_be_collapsed()) {
259             $bc->collapsible = block_contents::NOT_HIDEABLE;
260         } else if (get_user_preferences('block' . $bc->blockinstanceid . 'hidden', false)) {
261             $bc->collapsible = block_contents::HIDDEN;
262         } else {
263             $bc->collapsible = block_contents::VISIBLE;
264         }
266         if ($this->instance_can_be_docked() && !$this->hide_header()) {
267             $bc->dockable = true;
268         }
270         $bc->annotation = ''; // TODO MDL-19398 need to work out what to say here.
272         return $bc;
273     }
276     /**
277      * Return an object containing all the block content to be returned by external functions.
278      *
279      * If your block is returning formatted content or provide files for download, you should override this method to use the
280      * external_format_text, external_format_string functions for formatting or external_util::get_area_files for files.
281      *
282      * @param  core_renderer $output the rendered used for output
283      * @return stdClass      object containing the block title, central content, footer and linked files (if any).
284      * @since  Moodle 3.6
285      */
286     public function get_content_for_external($output) {
287         $bc = new stdClass;
288         $bc->title = null;
289         $bc->content = null;
290         $bc->contentformat = FORMAT_HTML;
291         $bc->footer = null;
292         $bc->files = [];
294         if ($this->instance->visible) {
295             $bc->content = $this->formatted_contents($output);
296             if (!empty($this->content->footer)) {
297                 $bc->footer = $this->content->footer;
298             }
299         }
301         if (!$this->hide_header()) {
302             $bc->title = $this->title;
303         }
305         return $bc;
306     }
308     /**
309      * Convert the contents of the block to HTML.
310      *
311      * This is used by block base classes like block_list to convert the structured
312      * $this->content->list and $this->content->icons arrays to HTML. So, in most
313      * blocks, you probaby want to override the {@link get_contents()} method,
314      * which generates that structured representation of the contents.
315      *
316      * @param $output The core_renderer to use when generating the output.
317      * @return string the HTML that should appearn in the body of the block.
318      * @since Moodle 2.0.
319      */
320     protected function formatted_contents($output) {
321         $this->get_content();
322         $this->get_required_javascript();
323         if (!empty($this->content->text)) {
324             return $this->content->text;
325         } else {
326             return '';
327         }
328     }
330     /**
331      * Tests if this block has been implemented correctly.
332      * Also, $errors isn't used right now
333      *
334      * @return boolean
335      */
337     function _self_test() {
338         // Tests if this block has been implemented correctly.
339         // Also, $errors isn't used right now
340         $errors = array();
342         $correct = true;
343         if ($this->get_title() === NULL) {
344             $errors[] = 'title_not_set';
345             $correct = false;
346         }
347         if (!in_array($this->get_content_type(), array(BLOCK_TYPE_LIST, BLOCK_TYPE_TEXT, BLOCK_TYPE_TREE))) {
348             $errors[] = 'invalid_content_type';
349             $correct = false;
350         }
351         //following selftest was not working when roles&capabilities were used from block
352 /*        if ($this->get_content() === NULL) {
353             $errors[] = 'content_not_set';
354             $correct = false;
355         }*/
356         $formats = $this->applicable_formats();
357         if (empty($formats) || array_sum($formats) === 0) {
358             $errors[] = 'no_formats';
359             $correct = false;
360         }
362         return $correct;
363     }
365     /**
366      * Subclasses should override this and return true if the
367      * subclass block has a settings.php file.
368      *
369      * @return boolean
370      */
371     function has_config() {
372         return false;
373     }
375     /**
376      * Default behavior: save all variables as $CFG properties
377      * You don't need to override this if you 're satisfied with the above
378      *
379      * @deprecated since Moodle 2.9 MDL-49385 - Please use Admin Settings functionality to save block configuration.
380      */
381     function config_save($data) {
382         throw new coding_exception('config_save() can not be used any more, use Admin Settings functionality to save block configuration.');
383     }
385     /**
386      * Which page types this block may appear on.
387      *
388      * The information returned here is processed by the
389      * {@link blocks_name_allowed_in_format()} function. Look there if you need
390      * to know exactly how this works.
391      *
392      * Default case: everything except mod and tag.
393      *
394      * @return array page-type prefix => true/false.
395      */
396     function applicable_formats() {
397         // Default case: the block can be used in courses and site index, but not in activities
398         return array('all' => true, 'mod' => false, 'tag' => false);
399     }
402     /**
403      * Default return is false - header will be shown
404      * @return boolean
405      */
406     function hide_header() {
407         return false;
408     }
410     /**
411      * Return any HTML attributes that you want added to the outer <div> that
412      * of the block when it is output.
413      *
414      * Because of the way certain JS events are wired it is a good idea to ensure
415      * that the default values here still get set.
416      * I found the easiest way to do this and still set anything you want is to
417      * override it within your block in the following way
418      *
419      * <code php>
420      * function html_attributes() {
421      *    $attributes = parent::html_attributes();
422      *    $attributes['class'] .= ' mynewclass';
423      *    return $attributes;
424      * }
425      * </code>
426      *
427      * @return array attribute name => value.
428      */
429     function html_attributes() {
430         $attributes = array(
431             'id' => 'inst' . $this->instance->id,
432             'class' => 'block_' . $this->name() . ' block',
433             'role' => $this->get_aria_role()
434         );
435         if ($this->hide_header()) {
436             $attributes['class'] .= ' no-header';
437         }
438         if ($this->instance_can_be_docked() && get_user_preferences('docked_block_instance_' . $this->instance->id, 0)) {
439             $attributes['class'] .= ' dock_on_load';
440         }
441         return $attributes;
442     }
444     /**
445      * Set up a particular instance of this class given data from the block_insances
446      * table and the current page. (See {@link block_manager::load_blocks()}.)
447      *
448      * @param stdClass $instance data from block_insances, block_positions, etc.
449      * @param moodle_page $the page this block is on.
450      */
451     function _load_instance($instance, $page) {
452         if (!empty($instance->configdata)) {
453             $this->config = unserialize(base64_decode($instance->configdata));
454         }
455         $this->instance = $instance;
456         $this->context = context_block::instance($instance->id);
457         $this->page = $page;
458         $this->specialization();
459     }
461     /**
462      * Allows the block to load any JS it requires into the page.
463      *
464      * By default this function simply permits the user to dock the block if it is dockable.
465      *
466      * Left null as of MDL-64506.
467      */
468     function get_required_javascript() {
469     }
471     /**
472      * This function is called on your subclass right after an instance is loaded
473      * Use this function to act on instance data just after it's loaded and before anything else is done
474      * For instance: if your block will have different title's depending on location (site, course, blog, etc)
475      */
476     function specialization() {
477         // Just to make sure that this method exists.
478     }
480     /**
481      * Is each block of this type going to have instance-specific configuration?
482      * Normally, this setting is controlled by {@link instance_allow_multiple()}: if multiple
483      * instances are allowed, then each will surely need its own configuration. However, in some
484      * cases it may be necessary to provide instance configuration to blocks that do not want to
485      * allow multiple instances. In that case, make this function return true.
486      * I stress again that this makes a difference ONLY if {@link instance_allow_multiple()} returns false.
487      * @return boolean
488      */
489     function instance_allow_config() {
490         return false;
491     }
493     /**
494      * Are you going to allow multiple instances of each block?
495      * If yes, then it is assumed that the block WILL USE per-instance configuration
496      * @return boolean
497      */
498     function instance_allow_multiple() {
499         // Are you going to allow multiple instances of each block?
500         // If yes, then it is assumed that the block WILL USE per-instance configuration
501         return false;
502     }
504     /**
505      * Serialize and store config data
506      */
507     function instance_config_save($data, $nolongerused = false) {
508         global $DB;
509         $DB->update_record('block_instances', ['id' => $this->instance->id,
510                 'configdata' => base64_encode(serialize($data)), 'timemodified' => time()]);
511     }
513     /**
514      * Replace the instance's configuration data with those currently in $this->config;
515      */
516     function instance_config_commit($nolongerused = false) {
517         global $DB;
518         $this->instance_config_save($this->config);
519     }
521     /**
522      * Do any additional initialization you may need at the time a new block instance is created
523      * @return boolean
524      */
525     function instance_create() {
526         return true;
527     }
529     /**
530      * Copy any block-specific data when copying to a new block instance.
531      * @param int $fromid the id number of the block instance to copy from
532      * @return boolean
533      */
534     public function instance_copy($fromid) {
535         return true;
536     }
538     /**
539      * Delete everything related to this instance if you have been using persistent storage other than the configdata field.
540      * @return boolean
541      */
542     function instance_delete() {
543         return true;
544     }
546     /**
547      * Allows the block class to have a say in the user's ability to edit (i.e., configure) blocks of this type.
548      * The framework has first say in whether this will be allowed (e.g., no editing allowed unless in edit mode)
549      * but if the framework does allow it, the block can still decide to refuse.
550      * @return boolean
551      */
552     function user_can_edit() {
553         global $USER;
555         if (has_capability('moodle/block:edit', $this->context)) {
556             return true;
557         }
559         // The blocks in My Moodle are a special case.  We want them to inherit from the user context.
560         if (!empty($USER->id)
561             && $this->instance->parentcontextid == $this->page->context->id   // Block belongs to this page
562             && $this->page->context->contextlevel == CONTEXT_USER             // Page belongs to a user
563             && $this->page->context->instanceid == $USER->id) {               // Page belongs to this user
564             return has_capability('moodle/my:manageblocks', $this->page->context);
565         }
567         return false;
568     }
570     /**
571      * Allows the block class to have a say in the user's ability to create new instances of this block.
572      * The framework has first say in whether this will be allowed (e.g., no adding allowed unless in edit mode)
573      * but if the framework does allow it, the block can still decide to refuse.
574      * This function has access to the complete page object, the creation related to which is being determined.
575      *
576      * @param moodle_page $page
577      * @return boolean
578      */
579     function user_can_addto($page) {
580         // List of formats this block supports.
581         $formats = $this->applicable_formats();
583         // The blocks in My Moodle are a special case and use a different capability.
584         $mypagetypes = my_page_type_list($page->pagetype); // Get list of possible my page types.
586         if (array_key_exists($page->pagetype, $mypagetypes)) { // Ensure we are on a page with a my page type.
587             // If the block cannot be displayed on /my it is ok if the myaddinstance capability is not defined.
588             // Is 'my' explicitly forbidden?
589             // If 'all' has not been allowed, has 'my' been explicitly allowed?
590             if ((isset($formats['my']) && $formats['my'] == false)
591                 || (empty($formats['all']) && empty($formats['my']))) {
593                 // Block cannot be added to /my regardless of capabilities.
594                 return false;
595             } else {
596                 $capability = 'block/' . $this->name() . ':myaddinstance';
597                 return $this->has_add_block_capability($page, $capability)
598                        && has_capability('moodle/my:manageblocks', $page->context);
599             }
600         }
601         // Check if this is a block only used on /my.
602         unset($formats['my']);
603         if (empty($formats)) {
604             // Block can only be added to /my - return false.
605             return false;
606         }
608         $capability = 'block/' . $this->name() . ':addinstance';
609         if ($this->has_add_block_capability($page, $capability)
610                 && has_capability('moodle/block:edit', $page->context)) {
611             return true;
612         }
614         return false;
615     }
617     /**
618      * Returns true if the user can add a block to a page.
619      *
620      * @param moodle_page $page
621      * @param string $capability the capability to check
622      * @return boolean true if user can add a block, false otherwise.
623      */
624     private function has_add_block_capability($page, $capability) {
625         // Check if the capability exists.
626         if (!get_capability_info($capability)) {
627             // Debug warning that the capability does not exist, but no more than once per page.
628             static $warned = array();
629             if (!isset($warned[$this->name()])) {
630                 debugging('The block ' .$this->name() . ' does not define the standard capability ' .
631                         $capability , DEBUG_DEVELOPER);
632                 $warned[$this->name()] = 1;
633             }
634             // If the capability does not exist, the block can always be added.
635             return true;
636         } else {
637             return has_capability($capability, $page->context);
638         }
639     }
641     static function get_extra_capabilities() {
642         return array('moodle/block:view', 'moodle/block:edit');
643     }
645     /**
646      * Can be overridden by the block to prevent the block from being dockable.
647      *
648      * @return bool
649      *
650      * Return false as per MDL-64506
651      */
652     public function instance_can_be_docked() {
653         return false;
654     }
656     /**
657      * If overridden and set to false by the block it will not be hidable when
658      * editing is turned on.
659      *
660      * @return bool
661      */
662     public function instance_can_be_hidden() {
663         return true;
664     }
666     /**
667      * If overridden and set to false by the block it will not be collapsible.
668      *
669      * @return bool
670      */
671     public function instance_can_be_collapsed() {
672         return true;
673     }
675     /** @callback callback functions for comments api */
676     public static function comment_template($options) {
677         $ret = <<<EOD
678 <div class="comment-userpicture">___picture___</div>
679 <div class="comment-content">
680     ___name___ - <span>___time___</span>
681     <div>___content___</div>
682 </div>
683 EOD;
684         return $ret;
685     }
686     public static function comment_permissions($options) {
687         return array('view'=>true, 'post'=>true);
688     }
689     public static function comment_url($options) {
690         return null;
691     }
692     public static function comment_display($comments, $options) {
693         return $comments;
694     }
695     public static function comment_add(&$comments, $options) {
696         return true;
697     }
699     /**
700      * Returns the aria role attribute that best describes this block.
701      *
702      * Region is the default, but this should be overridden by a block is there is a region child, or even better
703      * a landmark child.
704      *
705      * Options are as follows:
706      *    - landmark
707      *      - application
708      *      - banner
709      *      - complementary
710      *      - contentinfo
711      *      - form
712      *      - main
713      *      - navigation
714      *      - search
715      *
716      * @return string
717      */
718     public function get_aria_role() {
719         return 'complementary';
720     }
723 /**
724  * Specialized class for displaying a block with a list of icons/text labels
725  *
726  * The get_content method should set $this->content->items and (optionally)
727  * $this->content->icons, instead of $this->content->text.
728  *
729  * @author Jon Papaioannou
730  * @package core_block
731  */
733 class block_list extends block_base {
734     var $content_type  = BLOCK_TYPE_LIST;
736     function is_empty() {
737         if ( !has_capability('moodle/block:view', $this->context) ) {
738             return true;
739         }
741         $this->get_content();
742         return (empty($this->content->items) && empty($this->content->footer));
743     }
745     protected function formatted_contents($output) {
746         $this->get_content();
747         $this->get_required_javascript();
748         if (!empty($this->content->items)) {
749             return $output->list_block_contents($this->content->icons, $this->content->items);
750         } else {
751             return '';
752         }
753     }
755     function html_attributes() {
756         $attributes = parent::html_attributes();
757         $attributes['class'] .= ' list_block';
758         return $attributes;
759     }
763 /**
764  * Specialized class for displaying a tree menu.
765  *
766  * The {@link get_content()} method involves setting the content of
767  * <code>$this->content->items</code> with an array of {@link tree_item}
768  * objects (these are the top-level nodes). The {@link tree_item::children}
769  * property may contain more tree_item objects, and so on. The tree_item class
770  * itself is abstract and not intended for use, use one of it's subclasses.
771  *
772  * Unlike {@link block_list}, the icons are specified as part of the items,
773  * not in a separate array.
774  *
775  * @author Alan Trick
776  * @package core_block
777  * @internal this extends block_list so we get is_empty() for free
778  */
779 class block_tree extends block_list {
781     /**
782      * @var int specifies the manner in which contents should be added to this
783      * block type. In this case <code>$this->content->items</code> is used with
784      * {@link tree_item}s.
785      */
786     public $content_type = BLOCK_TYPE_TREE;
788     /**
789      * Make the formatted HTML ouput.
790      *
791      * Also adds the required javascript call to the page output.
792      *
793      * @param core_renderer $output
794      * @return string HTML
795      */
796     protected function formatted_contents($output) {
797         // based of code in admin_tree
798         global $PAGE; // TODO change this when there is a proper way for blocks to get stuff into head.
799         static $eventattached;
800         if ($eventattached===null) {
801             $eventattached = true;
802         }
803         if (!$this->content) {
804             $this->content = new stdClass;
805             $this->content->items = array();
806         }
807         $this->get_required_javascript();
808         $this->get_content();
809         $content = $output->tree_block_contents($this->content->items,array('class'=>'block_tree list'));
810         if (isset($this->id) && !is_numeric($this->id)) {
811             $content = $output->box($content, 'block_tree_box', $this->id);
812         }
813         return $content;
814     }