MDL-61621 blocks: New API function
[moodle.git] / lib / blocklib.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  * Block Class and Functions
20  *
21  * This file defines the {@link block_manager} class,
22  *
23  * @package    core
24  * @subpackage block
25  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 defined('MOODLE_INTERNAL') || die();
31 /**#@+
32  * Default names for the block regions in the standard theme.
33  */
34 define('BLOCK_POS_LEFT',  'side-pre');
35 define('BLOCK_POS_RIGHT', 'side-post');
36 /**#@-*/
38 define('BUI_CONTEXTS_FRONTPAGE_ONLY', 0);
39 define('BUI_CONTEXTS_FRONTPAGE_SUBS', 1);
40 define('BUI_CONTEXTS_ENTIRE_SITE', 2);
42 define('BUI_CONTEXTS_CURRENT', 0);
43 define('BUI_CONTEXTS_CURRENT_SUBS', 1);
45 // Position of "Add block" control, to be used in theme config as a value for $THEME->addblockposition:
46 // - default: as a fake block that is displayed in editing mode
47 // - flatnav: "Add block" item in the flat navigation drawer in editing mode
48 // - custom: none of the above, theme will take care of displaying the control.
49 define('BLOCK_ADDBLOCK_POSITION_DEFAULT', 0);
50 define('BLOCK_ADDBLOCK_POSITION_FLATNAV', 1);
51 define('BLOCK_ADDBLOCK_POSITION_CUSTOM', -1);
53 /**
54  * Exception thrown when someone tried to do something with a block that does
55  * not exist on a page.
56  *
57  * @copyright 2009 Tim Hunt
58  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
59  * @since     Moodle 2.0
60  */
61 class block_not_on_page_exception extends moodle_exception {
62     /**
63      * Constructor
64      * @param int $instanceid the block instance id of the block that was looked for.
65      * @param object $page the current page.
66      */
67     public function __construct($instanceid, $page) {
68         $a = new stdClass;
69         $a->instanceid = $instanceid;
70         $a->url = $page->url->out();
71         parent::__construct('blockdoesnotexistonpage', '', $page->url->out(), $a);
72     }
73 }
75 /**
76  * This class keeps track of the block that should appear on a moodle_page.
77  *
78  * The page to work with as passed to the constructor.
79  *
80  * @copyright 2009 Tim Hunt
81  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
82  * @since     Moodle 2.0
83  */
84 class block_manager {
85     /**
86      * The UI normally only shows block weights between -MAX_WEIGHT and MAX_WEIGHT,
87      * although other weights are valid.
88      */
89     const MAX_WEIGHT = 10;
91 /// Field declarations =========================================================
93     /**
94      * the moodle_page we are managing blocks for.
95      * @var moodle_page
96      */
97     protected $page;
99     /** @var array region name => 1.*/
100     protected $regions = array();
102     /** @var string the region where new blocks are added.*/
103     protected $defaultregion = null;
105     /** @var array will be $DB->get_records('blocks') */
106     protected $allblocks = null;
108     /**
109      * @var array blocks that this user can add to this page. Will be a subset
110      * of $allblocks, but with array keys block->name. Access this via the
111      * {@link get_addable_blocks()} method to ensure it is lazy-loaded.
112      */
113     protected $addableblocks = null;
115     /**
116      * Will be an array region-name => array(db rows loaded in load_blocks);
117      * @var array
118      */
119     protected $birecordsbyregion = null;
121     /**
122      * array region-name => array(block objects); populated as necessary by
123      * the ensure_instances_exist method.
124      * @var array
125      */
126     protected $blockinstances = array();
128     /**
129      * array region-name => array(block_contents objects) what actually needs to
130      * be displayed in each region.
131      * @var array
132      */
133     protected $visibleblockcontent = array();
135     /**
136      * array region-name => array(block_contents objects) extra block-like things
137      * to be displayed in each region, before the real blocks.
138      * @var array
139      */
140     protected $extracontent = array();
142     /**
143      * Used by the block move id, to track whether a block is currently being moved.
144      *
145      * When you click on the move icon of a block, first the page needs to reload with
146      * extra UI for choosing a new position for a particular block. In that situation
147      * this field holds the id of the block being moved.
148      *
149      * @var integer|null
150      */
151     protected $movingblock = null;
153     /**
154      * Show only fake blocks
155      */
156     protected $fakeblocksonly = false;
158 /// Constructor ================================================================
160     /**
161      * Constructor.
162      * @param object $page the moodle_page object object we are managing the blocks for,
163      * or a reasonable faxilimily. (See the comment at the top of this class
164      * and {@link http://en.wikipedia.org/wiki/Duck_typing})
165      */
166     public function __construct($page) {
167         $this->page = $page;
168     }
170 /// Getter methods =============================================================
172     /**
173      * Get an array of all region names on this page where a block may appear
174      *
175      * @return array the internal names of the regions on this page where block may appear.
176      */
177     public function get_regions() {
178         if (is_null($this->defaultregion)) {
179             $this->page->initialise_theme_and_output();
180         }
181         return array_keys($this->regions);
182     }
184     /**
185      * Get the region name of the region blocks are added to by default
186      *
187      * @return string the internal names of the region where new blocks are added
188      * by default, and where any blocks from an unrecognised region are shown.
189      * (Imagine that blocks were added with one theme selected, then you switched
190      * to a theme with different block positions.)
191      */
192     public function get_default_region() {
193         $this->page->initialise_theme_and_output();
194         return $this->defaultregion;
195     }
197     /**
198      * The list of block types that may be added to this page.
199      *
200      * @return array block name => record from block table.
201      */
202     public function get_addable_blocks() {
203         $this->check_is_loaded();
205         if (!is_null($this->addableblocks)) {
206             return $this->addableblocks;
207         }
209         // Lazy load.
210         $this->addableblocks = array();
212         $allblocks = blocks_get_record();
213         if (empty($allblocks)) {
214             return $this->addableblocks;
215         }
217         $unaddableblocks = self::get_undeletable_block_types();
218         $requiredbythemeblocks = $this->get_required_by_theme_block_types();
219         $pageformat = $this->page->pagetype;
220         foreach($allblocks as $block) {
221             if (!$bi = block_instance($block->name)) {
222                 continue;
223             }
224             if ($block->visible && !in_array($block->name, $unaddableblocks) &&
225                     !in_array($block->name, $requiredbythemeblocks) &&
226                     ($bi->instance_allow_multiple() || !$this->is_block_present($block->name)) &&
227                     blocks_name_allowed_in_format($block->name, $pageformat) &&
228                     $bi->user_can_addto($this->page)) {
229                 $block->title = $bi->get_title();
230                 $this->addableblocks[$block->name] = $block;
231             }
232         }
234         core_collator::asort_objects_by_property($this->addableblocks, 'title');
235         return $this->addableblocks;
236     }
238     /**
239      * Given a block name, find out of any of them are currently present in the page
241      * @param string $blockname - the basic name of a block (eg "navigation")
242      * @return boolean - is there one of these blocks in the current page?
243      */
244     public function is_block_present($blockname) {
245         if (empty($this->blockinstances)) {
246             return false;
247         }
249         $requiredbythemeblocks = $this->get_required_by_theme_block_types();
250         foreach ($this->blockinstances as $region) {
251             foreach ($region as $instance) {
252                 if (empty($instance->instance->blockname)) {
253                     continue;
254                 }
255                 if ($instance->instance->blockname == $blockname) {
256                     if ($instance->instance->requiredbytheme) {
257                         if (!in_array($blockname, $requiredbythemeblocks)) {
258                             continue;
259                         }
260                     }
261                     return true;
262                 }
263             }
264         }
265         return false;
266     }
268     /**
269      * Find out if a block type is known by the system
270      *
271      * @param string $blockname the name of the type of block.
272      * @param boolean $includeinvisible if false (default) only check 'visible' blocks, that is, blocks enabled by the admin.
273      * @return boolean true if this block in installed.
274      */
275     public function is_known_block_type($blockname, $includeinvisible = false) {
276         $blocks = $this->get_installed_blocks();
277         foreach ($blocks as $block) {
278             if ($block->name == $blockname && ($includeinvisible || $block->visible)) {
279                 return true;
280             }
281         }
282         return false;
283     }
285     /**
286      * Find out if a region exists on a page
287      *
288      * @param string $region a region name
289      * @return boolean true if this region exists on this page.
290      */
291     public function is_known_region($region) {
292         if (empty($region)) {
293             return false;
294         }
295         return array_key_exists($region, $this->regions);
296     }
298     /**
299      * Get an array of all blocks within a given region
300      *
301      * @param string $region a block region that exists on this page.
302      * @return array of block instances.
303      */
304     public function get_blocks_for_region($region) {
305         $this->check_is_loaded();
306         $this->ensure_instances_exist($region);
307         return $this->blockinstances[$region];
308     }
310     /**
311      * Returns an array of block content objects that exist in a region
312      *
313      * @param string $region a block region that exists on this page.
314      * @return array of block block_contents objects for all the blocks in a region.
315      */
316     public function get_content_for_region($region, $output) {
317         $this->check_is_loaded();
318         $this->ensure_content_created($region, $output);
319         return $this->visibleblockcontent[$region];
320     }
322     /**
323      * Returns an array of block content objects for all the existings regions
324      *
325      * @param renderer_base $output the rendered to use
326      * @return array of block block_contents objects for all the blocks in all regions.
327      * @since  Moodle 3.3
328      */
329     public function get_content_for_all_regions($output) {
330         $contents = array();
331         $this->check_is_loaded();
333         foreach ($this->regions as $region => $val) {
334             $this->ensure_content_created($region, $output);
335             $contents[$region] = $this->visibleblockcontent[$region];
336         }
337         return $contents;
338     }
340     /**
341      * Helper method used by get_content_for_region.
342      * @param string $region region name
343      * @param float $weight weight. May be fractional, since you may want to move a block
344      * between ones with weight 2 and 3, say ($weight would be 2.5).
345      * @return string URL for moving block $this->movingblock to this position.
346      */
347     protected function get_move_target_url($region, $weight) {
348         return new moodle_url($this->page->url, array('bui_moveid' => $this->movingblock,
349                 'bui_newregion' => $region, 'bui_newweight' => $weight, 'sesskey' => sesskey()));
350     }
352     /**
353      * Determine whether a region contains anything. (Either any real blocks, or
354      * the add new block UI.)
355      *
356      * (You may wonder why the $output parameter is required. Unfortunately,
357      * because of the way that blocks work, the only reliable way to find out
358      * if a block will be visible is to get the content for output, and to
359      * get the content, you need a renderer. Fortunately, this is not a
360      * performance problem, because we cache the output that is generated, and
361      * in almost every case where we call region_has_content, we are about to
362      * output the blocks anyway, so we are not doing wasted effort.)
363      *
364      * @param string $region a block region that exists on this page.
365      * @param core_renderer $output a core_renderer. normally the global $OUTPUT.
366      * @return boolean Whether there is anything in this region.
367      */
368     public function region_has_content($region, $output) {
370         if (!$this->is_known_region($region)) {
371             return false;
372         }
373         $this->check_is_loaded();
374         $this->ensure_content_created($region, $output);
375         // if ($this->page->user_is_editing() && $this->page->user_can_edit_blocks()) {
376         // Mark Nielsen's patch - part 1
377         if ($this->page->user_is_editing() && $this->page->user_can_edit_blocks() && $this->movingblock) {
378             // If editing is on, we need all the block regions visible, for the
379             // move blocks UI.
380             return true;
381         }
382         return !empty($this->visibleblockcontent[$region]) || !empty($this->extracontent[$region]);
383     }
385     /**
386      * Get an array of all of the installed blocks.
387      *
388      * @return array contents of the block table.
389      */
390     public function get_installed_blocks() {
391         global $DB;
392         if (is_null($this->allblocks)) {
393             $this->allblocks = $DB->get_records('block');
394         }
395         return $this->allblocks;
396     }
398     /**
399      * @return array names of block types that must exist on every page with this theme.
400      */
401     public function get_required_by_theme_block_types() {
402         $requiredbythemeblocks = false;
403         if (isset($this->page->theme->requiredblocks)) {
404             $requiredbythemeblocks = $this->page->theme->requiredblocks;
405         }
407         if ($requiredbythemeblocks === false) {
408             return array('navigation', 'settings');
409         } else if ($requiredbythemeblocks === '') {
410             return array();
411         } else if (is_string($requiredbythemeblocks)) {
412             return explode(',', $requiredbythemeblocks);
413         } else {
414             return $requiredbythemeblocks;
415         }
416     }
418     /**
419      * Make this block type undeletable and unaddable.
420      *
421      * @param mixed $blockidorname string or int
422      */
423     public static function protect_block($blockidorname) {
424         global $DB;
426         $syscontext = context_system::instance();
428         require_capability('moodle/site:config', $syscontext);
430         $block = false;
431         if (is_int($blockidorname)) {
432             $block = $DB->get_record('block', array('id' => $blockidorname), 'id, name', MUST_EXIST);
433         } else {
434             $block = $DB->get_record('block', array('name' => $blockidorname), 'id, name', MUST_EXIST);
435         }
436         $undeletableblocktypes = self::get_undeletable_block_types();
437         if (!in_array($block->name, $undeletableblocktypes)) {
438             $undeletableblocktypes[] = $block->name;
439             set_config('undeletableblocktypes', implode(',', $undeletableblocktypes));
440             add_to_config_log('block_protect', "0", "1", $block->name);
441         }
442     }
444     /**
445      * Make this block type deletable and addable.
446      *
447      * @param mixed $blockidorname string or int
448      */
449     public static function unprotect_block($blockidorname) {
450         global $DB;
452         $syscontext = context_system::instance();
454         require_capability('moodle/site:config', $syscontext);
456         $block = false;
457         if (is_int($blockidorname)) {
458             $block = $DB->get_record('block', array('id' => $blockidorname), 'id, name', MUST_EXIST);
459         } else {
460             $block = $DB->get_record('block', array('name' => $blockidorname), 'id, name', MUST_EXIST);
461         }
462         $undeletableblocktypes = self::get_undeletable_block_types();
463         if (in_array($block->name, $undeletableblocktypes)) {
464             $undeletableblocktypes = array_diff($undeletableblocktypes, array($block->name));
465             set_config('undeletableblocktypes', implode(',', $undeletableblocktypes));
466             add_to_config_log('block_protect', "1", "0", $block->name);
467         }
469     }
471     /**
472      * Get the list of "protected" blocks via admin block manager ui.
473      *
474      * @return array names of block types that cannot be added or deleted. E.g. array('navigation','settings').
475      */
476     public static function get_undeletable_block_types() {
477         global $CFG;
478         $undeletableblocks = false;
479         if (isset($CFG->undeletableblocktypes)) {
480             $undeletableblocks = $CFG->undeletableblocktypes;
481         }
483         if (empty($undeletableblocks)) {
484             return array();
485         } else if (is_string($undeletableblocks)) {
486             return explode(',', $undeletableblocks);
487         } else {
488             return $undeletableblocks;
489         }
490     }
492 /// Setter methods =============================================================
494     /**
495      * Add a region to a page
496      *
497      * @param string $region add a named region where blocks may appear on the current page.
498      *      This is an internal name, like 'side-pre', not a string to display in the UI.
499      * @param bool $custom True if this is a custom block region, being added by the page rather than the theme layout.
500      */
501     public function add_region($region, $custom = true) {
502         global $SESSION;
503         $this->check_not_yet_loaded();
504         if ($custom) {
505             if (array_key_exists($region, $this->regions)) {
506                 // This here is EXACTLY why we should not be adding block regions into a page. It should
507                 // ALWAYS be done in a theme layout.
508                 debugging('A custom region conflicts with a block region in the theme.', DEBUG_DEVELOPER);
509             }
510             // We need to register this custom region against the page type being used.
511             // This allows us to check, when performing block actions, that unrecognised regions can be worked with.
512             $type = $this->page->pagetype;
513             if (!isset($SESSION->custom_block_regions)) {
514                 $SESSION->custom_block_regions = array($type => array($region));
515             } else if (!isset($SESSION->custom_block_regions[$type])) {
516                 $SESSION->custom_block_regions[$type] = array($region);
517             } else if (!in_array($region, $SESSION->custom_block_regions[$type])) {
518                 $SESSION->custom_block_regions[$type][] = $region;
519             }
520         }
521         $this->regions[$region] = 1;
522     }
524     /**
525      * Add an array of regions
526      * @see add_region()
527      *
528      * @param array $regions this utility method calls add_region for each array element.
529      */
530     public function add_regions($regions, $custom = true) {
531         foreach ($regions as $region) {
532             $this->add_region($region, $custom);
533         }
534     }
536     /**
537      * Finds custom block regions associated with a page type and registers them with this block manager.
538      *
539      * @param string $pagetype
540      */
541     public function add_custom_regions_for_pagetype($pagetype) {
542         global $SESSION;
543         if (isset($SESSION->custom_block_regions[$pagetype])) {
544             foreach ($SESSION->custom_block_regions[$pagetype] as $customregion) {
545                 $this->add_region($customregion, false);
546             }
547         }
548     }
550     /**
551      * Set the default region for new blocks on the page
552      *
553      * @param string $defaultregion the internal names of the region where new
554      * blocks should be added by default, and where any blocks from an
555      * unrecognised region are shown.
556      */
557     public function set_default_region($defaultregion) {
558         $this->check_not_yet_loaded();
559         if ($defaultregion) {
560             $this->check_region_is_known($defaultregion);
561         }
562         $this->defaultregion = $defaultregion;
563     }
565     /**
566      * Add something that looks like a block, but which isn't an actual block_instance,
567      * to this page.
568      *
569      * @param block_contents $bc the content of the block-like thing.
570      * @param string $region a block region that exists on this page.
571      */
572     public function add_fake_block($bc, $region) {
573         $this->page->initialise_theme_and_output();
574         if (!$this->is_known_region($region)) {
575             $region = $this->get_default_region();
576         }
577         if (array_key_exists($region, $this->visibleblockcontent)) {
578             throw new coding_exception('block_manager has already prepared the blocks in region ' .
579                     $region . 'for output. It is too late to add a fake block.');
580         }
581         if (!isset($bc->attributes['data-block'])) {
582             $bc->attributes['data-block'] = '_fake';
583         }
584         $bc->attributes['class'] .= ' block_fake';
585         $this->extracontent[$region][] = $bc;
586     }
588     /**
589      * Checks to see whether all of the blocks within the given region are docked
590      *
591      * @see region_uses_dock
592      * @param string $region
593      * @return bool True if all of the blocks within that region are docked
594      */
595     public function region_completely_docked($region, $output) {
596         global $CFG;
597         // If theme doesn't allow docking or allowblockstodock is not set, then return.
598         if (!$this->page->theme->enable_dock || empty($CFG->allowblockstodock)) {
599             return false;
600         }
602         // Do not dock the region when the user attemps to move a block.
603         if ($this->movingblock) {
604             return false;
605         }
607         // Block regions should not be docked during editing when all the blocks are hidden.
608         if ($this->page->user_is_editing() && $this->page->user_can_edit_blocks()) {
609             return false;
610         }
612         $this->check_is_loaded();
613         $this->ensure_content_created($region, $output);
614         if (!$this->region_has_content($region, $output)) {
615             // If the region has no content then nothing is docked at all of course.
616             return false;
617         }
618         foreach ($this->visibleblockcontent[$region] as $instance) {
619             if (!get_user_preferences('docked_block_instance_'.$instance->blockinstanceid, 0)) {
620                 return false;
621             }
622         }
623         return true;
624     }
626     /**
627      * Checks to see whether any of the blocks within the given regions are docked
628      *
629      * @see region_completely_docked
630      * @param array|string $regions array of regions (or single region)
631      * @return bool True if any of the blocks within that region are docked
632      */
633     public function region_uses_dock($regions, $output) {
634         if (!$this->page->theme->enable_dock) {
635             return false;
636         }
637         $this->check_is_loaded();
638         foreach((array)$regions as $region) {
639             $this->ensure_content_created($region, $output);
640             foreach($this->visibleblockcontent[$region] as $instance) {
641                 if(!empty($instance->content) && get_user_preferences('docked_block_instance_'.$instance->blockinstanceid, 0)) {
642                     return true;
643                 }
644             }
645         }
646         return false;
647     }
649 /// Actions ====================================================================
651     /**
652      * This method actually loads the blocks for our page from the database.
653      *
654      * @param boolean|null $includeinvisible
655      *      null (default) - load hidden blocks if $this->page->user_is_editing();
656      *      true - load hidden blocks.
657      *      false - don't load hidden blocks.
658      */
659     public function load_blocks($includeinvisible = null) {
660         global $DB, $CFG;
662         if (!is_null($this->birecordsbyregion)) {
663             // Already done.
664             return;
665         }
667         if ($CFG->version < 2009050619) {
668             // Upgrade/install not complete. Don't try too show any blocks.
669             $this->birecordsbyregion = array();
670             return;
671         }
673         // Ensure we have been initialised.
674         if (is_null($this->defaultregion)) {
675             $this->page->initialise_theme_and_output();
676             // If there are still no block regions, then there are no blocks on this page.
677             if (empty($this->regions)) {
678                 $this->birecordsbyregion = array();
679                 return;
680             }
681         }
683         // Check if we need to load normal blocks
684         if ($this->fakeblocksonly) {
685             $this->birecordsbyregion = $this->prepare_per_region_arrays();
686             return;
687         }
689         // Exclude auto created blocks if they are not undeletable in this theme.
690         $requiredbytheme = $this->get_required_by_theme_block_types();
691         $requiredbythemecheck = '';
692         $requiredbythemeparams = array();
693         $requiredbythemenotparams = array();
694         if (!empty($requiredbytheme)) {
695             list($testsql, $requiredbythemeparams) = $DB->get_in_or_equal($requiredbytheme, SQL_PARAMS_NAMED, 'requiredbytheme');
696             list($testnotsql, $requiredbythemenotparams) = $DB->get_in_or_equal($requiredbytheme, SQL_PARAMS_NAMED,
697                                                                                 'notrequiredbytheme', false);
698             $requiredbythemecheck = 'AND ((bi.blockname ' . $testsql . ' AND bi.requiredbytheme = 1) OR ' .
699                                 ' (bi.blockname ' . $testnotsql . ' AND bi.requiredbytheme = 0))';
700         } else {
701             $requiredbythemecheck = 'AND (bi.requiredbytheme = 0)';
702         }
704         if (is_null($includeinvisible)) {
705             $includeinvisible = $this->page->user_is_editing();
706         }
707         if ($includeinvisible) {
708             $visiblecheck = '';
709         } else {
710             $visiblecheck = 'AND (bp.visible = 1 OR bp.visible IS NULL) AND (bs.visible = 1 OR bs.visible IS NULL)';
711         }
713         $context = $this->page->context;
714         $contexttest = 'bi.parentcontextid IN (:contextid2, :contextid3)';
715         $parentcontextparams = array();
716         $parentcontextids = $context->get_parent_context_ids();
717         if ($parentcontextids) {
718             list($parentcontexttest, $parentcontextparams) =
719                     $DB->get_in_or_equal($parentcontextids, SQL_PARAMS_NAMED, 'parentcontext');
720             $contexttest = "($contexttest OR (bi.showinsubcontexts = 1 AND bi.parentcontextid $parentcontexttest))";
721         }
723         $pagetypepatterns = matching_page_type_patterns($this->page->pagetype);
724         list($pagetypepatterntest, $pagetypepatternparams) =
725                 $DB->get_in_or_equal($pagetypepatterns, SQL_PARAMS_NAMED, 'pagetypepatterntest');
727         $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
728         $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = bi.id AND ctx.contextlevel = :contextlevel)";
730         $systemcontext = context_system::instance();
731         $params = array(
732             'contextlevel' => CONTEXT_BLOCK,
733             'subpage1' => $this->page->subpage,
734             'subpage2' => $this->page->subpage,
735             'subpage3' => $this->page->subpage,
736             'contextid1' => $context->id,
737             'contextid2' => $context->id,
738             'contextid3' => $systemcontext->id,
739             'contextid4' => $systemcontext->id,
740             'pagetype' => $this->page->pagetype,
741             'pagetype2' => $this->page->pagetype,
742         );
743         if ($this->page->subpage === '') {
744             $params['subpage1'] = '';
745             $params['subpage2'] = '';
746             $params['subpage3'] = '';
747         }
748         $sql = "SELECT
749                     bi.id,
750                     COALESCE(bp.id, bs.id) AS blockpositionid,
751                     bi.blockname,
752                     bi.parentcontextid,
753                     bi.showinsubcontexts,
754                     bi.pagetypepattern,
755                     bi.requiredbytheme,
756                     bi.subpagepattern,
757                     bi.defaultregion,
758                     bi.defaultweight,
759                     COALESCE(bp.visible, bs.visible, 1) AS visible,
760                     COALESCE(bp.region, bs.region, bi.defaultregion) AS region,
761                     COALESCE(bp.weight, bs.weight, bi.defaultweight) AS weight,
762                     bi.configdata
763                     $ccselect
765                 FROM {block_instances} bi
766                 JOIN {block} b ON bi.blockname = b.name
767                 LEFT JOIN {block_positions} bp ON bp.blockinstanceid = bi.id
768                                                   AND bp.contextid = :contextid1
769                                                   AND bp.pagetype = :pagetype
770                                                   AND bp.subpage = :subpage1
771                 LEFT JOIN {block_positions} bs ON bs.blockinstanceid = bi.id
772                                                   AND bs.contextid = :contextid4
773                                                   AND bs.pagetype = :pagetype2
774                                                   AND bs.subpage = :subpage3
775                 $ccjoin
777                 WHERE
778                 $contexttest
779                 AND bi.pagetypepattern $pagetypepatterntest
780                 AND (bi.subpagepattern IS NULL OR bi.subpagepattern = :subpage2)
781                 $visiblecheck
782                 AND b.visible = 1
783                 $requiredbythemecheck
785                 ORDER BY
786                     COALESCE(bp.region, bs.region, bi.defaultregion),
787                     COALESCE(bp.weight, bs.weight, bi.defaultweight),
788                     bi.id";
790         $allparams = $params + $parentcontextparams + $pagetypepatternparams + $requiredbythemeparams + $requiredbythemenotparams;
791         $blockinstances = $DB->get_recordset_sql($sql, $allparams);
793         $this->birecordsbyregion = $this->prepare_per_region_arrays();
794         $unknown = array();
795         foreach ($blockinstances as $bi) {
796             context_helper::preload_from_record($bi);
797             if ($this->is_known_region($bi->region)) {
798                 $this->birecordsbyregion[$bi->region][] = $bi;
799             } else {
800                 $unknown[] = $bi;
801             }
802         }
803         $blockinstances->close();
805         // Pages don't necessarily have a defaultregion. The  one time this can
806         // happen is when there are no theme block regions, but the script itself
807         // has a block region in the main content area.
808         if (!empty($this->defaultregion)) {
809             $this->birecordsbyregion[$this->defaultregion] =
810                     array_merge($this->birecordsbyregion[$this->defaultregion], $unknown);
811         }
812     }
814     /**
815      * Add a block to the current page, or related pages. The block is added to
816      * context $this->page->contextid. If $pagetypepattern $subpagepattern
817      *
818      * @param string $blockname The type of block to add.
819      * @param string $region the block region on this page to add the block to.
820      * @param integer $weight determines the order where this block appears in the region.
821      * @param boolean $showinsubcontexts whether this block appears in subcontexts, or just the current context.
822      * @param string|null $pagetypepattern which page types this block should appear on. Defaults to just the current page type.
823      * @param string|null $subpagepattern which subpage this block should appear on. NULL = any (the default), otherwise only the specified subpage.
824      */
825     public function add_block($blockname, $region, $weight, $showinsubcontexts, $pagetypepattern = NULL, $subpagepattern = NULL) {
826         global $DB;
827         // Allow invisible blocks because this is used when adding default page blocks, which
828         // might include invisible ones if the user makes some default blocks invisible
829         $this->check_known_block_type($blockname, true);
830         $this->check_region_is_known($region);
832         if (empty($pagetypepattern)) {
833             $pagetypepattern = $this->page->pagetype;
834         }
836         $blockinstance = new stdClass;
837         $blockinstance->blockname = $blockname;
838         $blockinstance->parentcontextid = $this->page->context->id;
839         $blockinstance->showinsubcontexts = !empty($showinsubcontexts);
840         $blockinstance->pagetypepattern = $pagetypepattern;
841         $blockinstance->subpagepattern = $subpagepattern;
842         $blockinstance->defaultregion = $region;
843         $blockinstance->defaultweight = $weight;
844         $blockinstance->configdata = '';
845         $blockinstance->timecreated = time();
846         $blockinstance->timemodified = $blockinstance->timecreated;
847         $blockinstance->id = $DB->insert_record('block_instances', $blockinstance);
849         // Ensure the block context is created.
850         context_block::instance($blockinstance->id);
852         // If the new instance was created, allow it to do additional setup
853         if ($block = block_instance($blockname, $blockinstance)) {
854             $block->instance_create();
855         }
856     }
858     public function add_block_at_end_of_default_region($blockname) {
859         if (empty($this->birecordsbyregion)) {
860             // No blocks or block regions exist yet.
861             return;
862         }
863         $defaulregion = $this->get_default_region();
865         $lastcurrentblock = end($this->birecordsbyregion[$defaulregion]);
866         if ($lastcurrentblock) {
867             $weight = $lastcurrentblock->weight + 1;
868         } else {
869             $weight = 0;
870         }
872         if ($this->page->subpage) {
873             $subpage = $this->page->subpage;
874         } else {
875             $subpage = null;
876         }
878         // Special case. Course view page type include the course format, but we
879         // want to add the block non-format-specifically.
880         $pagetypepattern = $this->page->pagetype;
881         if (strpos($pagetypepattern, 'course-view') === 0) {
882             $pagetypepattern = 'course-view-*';
883         }
885         // We should end using this for ALL the blocks, making always the 1st option
886         // the default one to be used. Until then, this is one hack to avoid the
887         // 'pagetypewarning' message on blocks initial edition (MDL-27829) caused by
888         // non-existing $pagetypepattern set. This way at least we guarantee one "valid"
889         // (the FIRST $pagetypepattern will be set)
891         // We are applying it to all blocks created in mod pages for now and only if the
892         // default pagetype is not one of the available options
893         if (preg_match('/^mod-.*-/', $pagetypepattern)) {
894             $pagetypelist = generate_page_type_patterns($this->page->pagetype, null, $this->page->context);
895             // Only go for the first if the pagetype is not a valid option
896             if (is_array($pagetypelist) && !array_key_exists($pagetypepattern, $pagetypelist)) {
897                 $pagetypepattern = key($pagetypelist);
898             }
899         }
900         // Surely other pages like course-report will need this too, they just are not important
901         // enough now. This will be decided in the coming days. (MDL-27829, MDL-28150)
903         $this->add_block($blockname, $defaulregion, $weight, false, $pagetypepattern, $subpage);
904     }
906     /**
907      * Convenience method, calls add_block repeatedly for all the blocks in $blocks. Optionally, a starting weight
908      * can be used to decide the starting point that blocks are added in the region, the weight is passed to {@link add_block}
909      * and incremented by the position of the block in the $blocks array
910      *
911      * @param array $blocks array with array keys the region names, and values an array of block names.
912      * @param string $pagetypepattern optional. Passed to {@link add_block()}
913      * @param string $subpagepattern optional. Passed to {@link add_block()}
914      * @param boolean $showinsubcontexts optional. Passed to {@link add_block()}
915      * @param integer $weight optional. Determines the starting point that the blocks are added in the region.
916      */
917     public function add_blocks($blocks, $pagetypepattern = NULL, $subpagepattern = NULL, $showinsubcontexts=false, $weight=0) {
918         $initialweight = $weight;
919         $this->add_regions(array_keys($blocks), false);
920         foreach ($blocks as $region => $regionblocks) {
921             foreach ($regionblocks as $offset => $blockname) {
922                 $weight = $initialweight + $offset;
923                 $this->add_block($blockname, $region, $weight, $showinsubcontexts, $pagetypepattern, $subpagepattern);
924             }
925         }
926     }
928     /**
929      * Move a block to a new position on this page.
930      *
931      * If this block cannot appear on any other pages, then we change defaultposition/weight
932      * in the block_instances table. Otherwise we just set the position on this page.
933      *
934      * @param $blockinstanceid the block instance id.
935      * @param $newregion the new region name.
936      * @param $newweight the new weight.
937      */
938     public function reposition_block($blockinstanceid, $newregion, $newweight) {
939         global $DB;
941         $this->check_region_is_known($newregion);
942         $inst = $this->find_instance($blockinstanceid);
944         $bi = $inst->instance;
945         if ($bi->weight == $bi->defaultweight && $bi->region == $bi->defaultregion &&
946                 !$bi->showinsubcontexts && strpos($bi->pagetypepattern, '*') === false &&
947                 (!$this->page->subpage || $bi->subpagepattern)) {
949             // Set default position
950             $newbi = new stdClass;
951             $newbi->id = $bi->id;
952             $newbi->defaultregion = $newregion;
953             $newbi->defaultweight = $newweight;
954             $newbi->timemodified = time();
955             $DB->update_record('block_instances', $newbi);
957             if ($bi->blockpositionid) {
958                 $bp = new stdClass;
959                 $bp->id = $bi->blockpositionid;
960                 $bp->region = $newregion;
961                 $bp->weight = $newweight;
962                 $DB->update_record('block_positions', $bp);
963             }
965         } else {
966             // Just set position on this page.
967             $bp = new stdClass;
968             $bp->region = $newregion;
969             $bp->weight = $newweight;
971             if ($bi->blockpositionid) {
972                 $bp->id = $bi->blockpositionid;
973                 $DB->update_record('block_positions', $bp);
975             } else {
976                 $bp->blockinstanceid = $bi->id;
977                 $bp->contextid = $this->page->context->id;
978                 $bp->pagetype = $this->page->pagetype;
979                 if ($this->page->subpage) {
980                     $bp->subpage = $this->page->subpage;
981                 } else {
982                     $bp->subpage = '';
983                 }
984                 $bp->visible = $bi->visible;
985                 $DB->insert_record('block_positions', $bp);
986             }
987         }
988     }
990     /**
991      * Find a given block by its instance id
992      *
993      * @param integer $instanceid
994      * @return block_base
995      */
996     public function find_instance($instanceid) {
997         foreach ($this->regions as $region => $notused) {
998             $this->ensure_instances_exist($region);
999             foreach($this->blockinstances[$region] as $instance) {
1000                 if ($instance->instance->id == $instanceid) {
1001                     return $instance;
1002                 }
1003             }
1004         }
1005         throw new block_not_on_page_exception($instanceid, $this->page);
1006     }
1008 /// Inner workings =============================================================
1010     /**
1011      * Check whether the page blocks have been loaded yet
1012      *
1013      * @return void Throws coding exception if already loaded
1014      */
1015     protected function check_not_yet_loaded() {
1016         if (!is_null($this->birecordsbyregion)) {
1017             throw new coding_exception('block_manager has already loaded the blocks, to it is too late to change things that might affect which blocks are visible.');
1018         }
1019     }
1021     /**
1022      * Check whether the page blocks have been loaded yet
1023      *
1024      * Nearly identical to the above function {@link check_not_yet_loaded()} except different message
1025      *
1026      * @return void Throws coding exception if already loaded
1027      */
1028     protected function check_is_loaded() {
1029         if (is_null($this->birecordsbyregion)) {
1030             throw new coding_exception('block_manager has not yet loaded the blocks, to it is too soon to request the information you asked for.');
1031         }
1032     }
1034     /**
1035      * Check if a block type is known and usable
1036      *
1037      * @param string $blockname The block type name to search for
1038      * @param bool $includeinvisible Include disabled block types in the initial pass
1039      * @return void Coding Exception thrown if unknown or not enabled
1040      */
1041     protected function check_known_block_type($blockname, $includeinvisible = false) {
1042         if (!$this->is_known_block_type($blockname, $includeinvisible)) {
1043             if ($this->is_known_block_type($blockname, true)) {
1044                 throw new coding_exception('Unknown block type ' . $blockname);
1045             } else {
1046                 throw new coding_exception('Block type ' . $blockname . ' has been disabled by the administrator.');
1047             }
1048         }
1049     }
1051     /**
1052      * Check if a region is known by its name
1053      *
1054      * @param string $region
1055      * @return void Coding Exception thrown if the region is not known
1056      */
1057     protected function check_region_is_known($region) {
1058         if (!$this->is_known_region($region)) {
1059             throw new coding_exception('Trying to reference an unknown block region ' . $region);
1060         }
1061     }
1063     /**
1064      * Returns an array of region names as keys and nested arrays for values
1065      *
1066      * @return array an array where the array keys are the region names, and the array
1067      * values are empty arrays.
1068      */
1069     protected function prepare_per_region_arrays() {
1070         $result = array();
1071         foreach ($this->regions as $region => $notused) {
1072             $result[$region] = array();
1073         }
1074         return $result;
1075     }
1077     /**
1078      * Create a set of new block instance from a record array
1079      *
1080      * @param array $birecords An array of block instance records
1081      * @return array An array of instantiated block_instance objects
1082      */
1083     protected function create_block_instances($birecords) {
1084         $results = array();
1085         foreach ($birecords as $record) {
1086             if ($blockobject = block_instance($record->blockname, $record, $this->page)) {
1087                 $results[] = $blockobject;
1088             }
1089         }
1090         return $results;
1091     }
1093     /**
1094      * Create all the block instances for all the blocks that were loaded by
1095      * load_blocks. This is used, for example, to ensure that all blocks get a
1096      * chance to initialise themselves via the {@link block_base::specialize()}
1097      * method, before any output is done.
1098      *
1099      * It is also used to create any blocks that are "requiredbytheme" by the current theme.
1100      * These blocks that are auto-created have requiredbytheme set on the block instance
1101      * so they are only visible on themes that require them.
1102      */
1103     public function create_all_block_instances() {
1104         $missing = false;
1106         // If there are any un-removable blocks that were not created - force them.
1107         $requiredbytheme = $this->get_required_by_theme_block_types();
1108         if (!$this->fakeblocksonly) {
1109             foreach ($requiredbytheme as $forced) {
1110                 if (empty($forced)) {
1111                     continue;
1112                 }
1113                 $found = false;
1114                 foreach ($this->get_regions() as $region) {
1115                     foreach($this->birecordsbyregion[$region] as $instance) {
1116                         if ($instance->blockname == $forced) {
1117                             $found = true;
1118                         }
1119                     }
1120                 }
1121                 if (!$found) {
1122                     $this->add_block_required_by_theme($forced);
1123                     $missing = true;
1124                 }
1125             }
1126         }
1128         if ($missing) {
1129             // Some blocks were missing. Lets do it again.
1130             $this->birecordsbyregion = null;
1131             $this->load_blocks();
1132         }
1133         foreach ($this->get_regions() as $region) {
1134             $this->ensure_instances_exist($region);
1135         }
1137     }
1139     /**
1140      * Add a block that is required by the current theme but has not been
1141      * created yet. This is a special type of block that only shows in themes that
1142      * require it (by listing it in undeletable_block_types).
1143      *
1144      * @param string $blockname the name of the block type.
1145      */
1146     protected function add_block_required_by_theme($blockname) {
1147         global $DB;
1149         if (empty($this->birecordsbyregion)) {
1150             // No blocks or block regions exist yet.
1151             return;
1152         }
1154         // Never auto create blocks when we are showing fake blocks only.
1155         if ($this->fakeblocksonly) {
1156             return;
1157         }
1159         // Never add a duplicate block required by theme.
1160         if ($DB->record_exists('block_instances', array('blockname' => $blockname, 'requiredbytheme' => 1))) {
1161             return;
1162         }
1164         $systemcontext = context_system::instance();
1165         $defaultregion = $this->get_default_region();
1166         // Add a special system wide block instance only for themes that require it.
1167         $blockinstance = new stdClass;
1168         $blockinstance->blockname = $blockname;
1169         $blockinstance->parentcontextid = $systemcontext->id;
1170         $blockinstance->showinsubcontexts = true;
1171         $blockinstance->requiredbytheme = true;
1172         $blockinstance->pagetypepattern = '*';
1173         $blockinstance->subpagepattern = null;
1174         $blockinstance->defaultregion = $defaultregion;
1175         $blockinstance->defaultweight = 0;
1176         $blockinstance->configdata = '';
1177         $blockinstance->timecreated = time();
1178         $blockinstance->timemodified = $blockinstance->timecreated;
1179         $blockinstance->id = $DB->insert_record('block_instances', $blockinstance);
1181         // Ensure the block context is created.
1182         context_block::instance($blockinstance->id);
1184         // If the new instance was created, allow it to do additional setup.
1185         if ($block = block_instance($blockname, $blockinstance)) {
1186             $block->instance_create();
1187         }
1188     }
1190     /**
1191      * Return an array of content objects from a set of block instances
1192      *
1193      * @param array $instances An array of block instances
1194      * @param renderer_base The renderer to use.
1195      * @param string $region the region name.
1196      * @return array An array of block_content (and possibly block_move_target) objects.
1197      */
1198     protected function create_block_contents($instances, $output, $region) {
1199         $results = array();
1201         $lastweight = 0;
1202         $lastblock = 0;
1203         if ($this->movingblock) {
1204             $first = reset($instances);
1205             if ($first) {
1206                 $lastweight = $first->instance->weight - 2;
1207             }
1208         }
1210         foreach ($instances as $instance) {
1211             $content = $instance->get_content_for_output($output);
1212             if (empty($content)) {
1213                 continue;
1214             }
1216             if ($this->movingblock && $lastweight != $instance->instance->weight &&
1217                     $content->blockinstanceid != $this->movingblock && $lastblock != $this->movingblock) {
1218                 $results[] = new block_move_target($this->get_move_target_url($region, ($lastweight + $instance->instance->weight)/2));
1219             }
1221             if ($content->blockinstanceid == $this->movingblock) {
1222                 $content->add_class('beingmoved');
1223                 $content->annotation .= get_string('movingthisblockcancel', 'block',
1224                         html_writer::link($this->page->url, get_string('cancel')));
1225             }
1227             $results[] = $content;
1228             $lastweight = $instance->instance->weight;
1229             $lastblock = $instance->instance->id;
1230         }
1232         if ($this->movingblock && $lastblock != $this->movingblock) {
1233             $results[] = new block_move_target($this->get_move_target_url($region, $lastweight + 1));
1234         }
1235         return $results;
1236     }
1238     /**
1239      * Ensure block instances exist for a given region
1240      *
1241      * @param string $region Check for bi's with the instance with this name
1242      */
1243     protected function ensure_instances_exist($region) {
1244         $this->check_region_is_known($region);
1245         if (!array_key_exists($region, $this->blockinstances)) {
1246             $this->blockinstances[$region] =
1247                     $this->create_block_instances($this->birecordsbyregion[$region]);
1248         }
1249     }
1251     /**
1252      * Ensure that there is some content within the given region
1253      *
1254      * @param string $region The name of the region to check
1255      */
1256     public function ensure_content_created($region, $output) {
1257         $this->ensure_instances_exist($region);
1258         if (!array_key_exists($region, $this->visibleblockcontent)) {
1259             $contents = array();
1260             if (array_key_exists($region, $this->extracontent)) {
1261                 $contents = $this->extracontent[$region];
1262             }
1263             $contents = array_merge($contents, $this->create_block_contents($this->blockinstances[$region], $output, $region));
1264             if (($region == $this->defaultregion) && (!isset($this->page->theme->addblockposition) ||
1265                     $this->page->theme->addblockposition == BLOCK_ADDBLOCK_POSITION_DEFAULT)) {
1266                 $addblockui = block_add_block_ui($this->page, $output);
1267                 if ($addblockui) {
1268                     $contents[] = $addblockui;
1269                 }
1270             }
1271             $this->visibleblockcontent[$region] = $contents;
1272         }
1273     }
1275 /// Process actions from the URL ===============================================
1277     /**
1278      * Get the appropriate list of editing icons for a block. This is used
1279      * to set {@link block_contents::$controls} in {@link block_base::get_contents_for_output()}.
1280      *
1281      * @param $output The core_renderer to use when generating the output. (Need to get icon paths.)
1282      * @return an array in the format for {@link block_contents::$controls}
1283      */
1284     public function edit_controls($block) {
1285         global $CFG;
1287         $controls = array();
1288         $actionurl = $this->page->url->out(false, array('sesskey'=> sesskey()));
1289         $blocktitle = $block->title;
1290         if (empty($blocktitle)) {
1291             $blocktitle = $block->arialabel;
1292         }
1294         if ($this->page->user_can_edit_blocks()) {
1295             // Move icon.
1296             $str = new lang_string('moveblock', 'block', $blocktitle);
1297             $controls[] = new action_menu_link_primary(
1298                 new moodle_url($actionurl, array('bui_moveid' => $block->instance->id)),
1299                 new pix_icon('t/move', $str, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1300                 $str,
1301                 array('class' => 'editing_move')
1302             );
1304         }
1306         if ($this->page->user_can_edit_blocks() || $block->user_can_edit()) {
1307             // Edit config icon - always show - needed for positioning UI.
1308             $str = new lang_string('configureblock', 'block', $blocktitle);
1309             $controls[] = new action_menu_link_secondary(
1310                 new moodle_url($actionurl, array('bui_editid' => $block->instance->id)),
1311                 new pix_icon('t/edit', $str, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1312                 $str,
1313                 array('class' => 'editing_edit')
1314             );
1316         }
1318         if ($this->page->user_can_edit_blocks() && $block->instance_can_be_hidden()) {
1319             // Show/hide icon.
1320             if ($block->instance->visible) {
1321                 $str = new lang_string('hideblock', 'block', $blocktitle);
1322                 $url = new moodle_url($actionurl, array('bui_hideid' => $block->instance->id));
1323                 $icon = new pix_icon('t/hide', $str, 'moodle', array('class' => 'iconsmall', 'title' => ''));
1324                 $attributes = array('class' => 'editing_hide');
1325             } else {
1326                 $str = new lang_string('showblock', 'block', $blocktitle);
1327                 $url = new moodle_url($actionurl, array('bui_showid' => $block->instance->id));
1328                 $icon = new pix_icon('t/show', $str, 'moodle', array('class' => 'iconsmall', 'title' => ''));
1329                 $attributes = array('class' => 'editing_show');
1330             }
1331             $controls[] = new action_menu_link_secondary($url, $icon, $str, $attributes);
1332         }
1334         // Assign roles.
1335         if (get_assignable_roles($block->context, ROLENAME_SHORT)) {
1336             $rolesurl = new moodle_url('/admin/roles/assign.php', array('contextid' => $block->context->id,
1337                 'returnurl' => $this->page->url->out_as_local_url()));
1338             $str = new lang_string('assignrolesinblock', 'block', $blocktitle);
1339             $controls[] = new action_menu_link_secondary(
1340                 $rolesurl,
1341                 new pix_icon('i/assignroles', $str, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1342                 $str, array('class' => 'editing_assignroles')
1343             );
1344         }
1346         // Permissions.
1347         if (has_capability('moodle/role:review', $block->context) or get_overridable_roles($block->context)) {
1348             $rolesurl = new moodle_url('/admin/roles/permissions.php', array('contextid' => $block->context->id,
1349                 'returnurl' => $this->page->url->out_as_local_url()));
1350             $str = get_string('permissions', 'role');
1351             $controls[] = new action_menu_link_secondary(
1352                 $rolesurl,
1353                 new pix_icon('i/permissions', $str, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1354                 $str, array('class' => 'editing_permissions')
1355             );
1356         }
1358         // Change permissions.
1359         if (has_any_capability(array('moodle/role:safeoverride', 'moodle/role:override', 'moodle/role:assign'), $block->context)) {
1360             $rolesurl = new moodle_url('/admin/roles/check.php', array('contextid' => $block->context->id,
1361                 'returnurl' => $this->page->url->out_as_local_url()));
1362             $str = get_string('checkpermissions', 'role');
1363             $controls[] = new action_menu_link_secondary(
1364                 $rolesurl,
1365                 new pix_icon('i/checkpermissions', $str, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1366                 $str, array('class' => 'editing_checkroles')
1367             );
1368         }
1370         if ($this->user_can_delete_block($block)) {
1371             // Delete icon.
1372             $str = new lang_string('deleteblock', 'block', $blocktitle);
1373             $controls[] = new action_menu_link_secondary(
1374                 new moodle_url($actionurl, array('bui_deleteid' => $block->instance->id)),
1375                 new pix_icon('t/delete', $str, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1376                 $str,
1377                 array('class' => 'editing_delete')
1378             );
1379         }
1381         return $controls;
1382     }
1384     /**
1385      * @param block_base $block a block that appears on this page.
1386      * @return boolean boolean whether the currently logged in user is allowed to delete this block.
1387      */
1388     protected function user_can_delete_block($block) {
1389         return $this->page->user_can_edit_blocks() && $block->user_can_edit() &&
1390                 $block->user_can_addto($this->page) &&
1391                 !in_array($block->instance->blockname, self::get_undeletable_block_types()) &&
1392                 !in_array($block->instance->blockname, $this->get_required_by_theme_block_types());
1393     }
1395     /**
1396      * Process any block actions that were specified in the URL.
1397      *
1398      * @return boolean true if anything was done. False if not.
1399      */
1400     public function process_url_actions() {
1401         if (!$this->page->user_is_editing()) {
1402             return false;
1403         }
1404         return $this->process_url_add() || $this->process_url_delete() ||
1405             $this->process_url_show_hide() || $this->process_url_edit() ||
1406             $this->process_url_move();
1407     }
1409     /**
1410      * Handle adding a block.
1411      * @return boolean true if anything was done. False if not.
1412      */
1413     public function process_url_add() {
1414         global $CFG, $PAGE, $OUTPUT;
1416         $blocktype = optional_param('bui_addblock', null, PARAM_PLUGIN);
1417         if ($blocktype === null) {
1418             return false;
1419         }
1421         require_sesskey();
1423         if (!$this->page->user_can_edit_blocks()) {
1424             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('addblock'));
1425         }
1427         $addableblocks = $this->get_addable_blocks();
1429         if ($blocktype === '') {
1430             // Display add block selection.
1431             $addpage = new moodle_page();
1432             $addpage->set_pagelayout('admin');
1433             $addpage->blocks->show_only_fake_blocks(true);
1434             $addpage->set_course($this->page->course);
1435             $addpage->set_context($this->page->context);
1436             if ($this->page->cm) {
1437                 $addpage->set_cm($this->page->cm);
1438             }
1440             $addpagebase = str_replace($CFG->wwwroot . '/', '/', $this->page->url->out_omit_querystring());
1441             $addpageparams = $this->page->url->params();
1442             $addpage->set_url($addpagebase, $addpageparams);
1443             $addpage->set_block_actions_done();
1444             // At this point we are going to display the block selector, overwrite global $PAGE ready for this.
1445             $PAGE = $addpage;
1446             // Some functions use $OUTPUT so we need to replace that too.
1447             $OUTPUT = $addpage->get_renderer('core');
1449             $site = get_site();
1450             $straddblock = get_string('addblock');
1452             $PAGE->navbar->add($straddblock);
1453             $PAGE->set_title($straddblock);
1454             $PAGE->set_heading($site->fullname);
1455             echo $OUTPUT->header();
1456             echo $OUTPUT->heading($straddblock);
1458             if (!$addableblocks) {
1459                 echo $OUTPUT->box(get_string('noblockstoaddhere'));
1460                 echo $OUTPUT->container($OUTPUT->action_link($addpage->url, get_string('back')), 'm-x-3 m-b-1');
1461             } else {
1462                 $url = new moodle_url($addpage->url, array('sesskey' => sesskey()));
1463                 echo $OUTPUT->render_from_template('core/add_block_body',
1464                     ['blocks' => array_values($addableblocks),
1465                      'url' => '?' . $url->get_query_string(false)]);
1466                 echo $OUTPUT->container($OUTPUT->action_link($addpage->url, get_string('cancel')), 'm-x-3 m-b-1');
1467             }
1469             echo $OUTPUT->footer();
1470             // Make sure that nothing else happens after we have displayed this form.
1471             exit;
1472         }
1474         if (!array_key_exists($blocktype, $addableblocks)) {
1475             throw new moodle_exception('cannotaddthisblocktype', '', $this->page->url->out(), $blocktype);
1476         }
1478         $this->add_block_at_end_of_default_region($blocktype);
1480         // If the page URL was a guess, it will contain the bui_... param, so we must make sure it is not there.
1481         $this->page->ensure_param_not_in_url('bui_addblock');
1483         return true;
1484     }
1486     /**
1487      * Handle deleting a block.
1488      * @return boolean true if anything was done. False if not.
1489      */
1490     public function process_url_delete() {
1491         global $CFG, $PAGE, $OUTPUT;
1493         $blockid = optional_param('bui_deleteid', null, PARAM_INT);
1494         $confirmdelete = optional_param('bui_confirm', null, PARAM_INT);
1496         if (!$blockid) {
1497             return false;
1498         }
1500         require_sesskey();
1501         $block = $this->page->blocks->find_instance($blockid);
1502         if (!$this->user_can_delete_block($block)) {
1503             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('deleteablock'));
1504         }
1506         if (!$confirmdelete) {
1507             $deletepage = new moodle_page();
1508             $deletepage->set_pagelayout('admin');
1509             $deletepage->blocks->show_only_fake_blocks(true);
1510             $deletepage->set_course($this->page->course);
1511             $deletepage->set_context($this->page->context);
1512             if ($this->page->cm) {
1513                 $deletepage->set_cm($this->page->cm);
1514             }
1516             $deleteurlbase = str_replace($CFG->wwwroot . '/', '/', $this->page->url->out_omit_querystring());
1517             $deleteurlparams = $this->page->url->params();
1518             $deletepage->set_url($deleteurlbase, $deleteurlparams);
1519             $deletepage->set_block_actions_done();
1520             // At this point we are either going to redirect, or display the form, so
1521             // overwrite global $PAGE ready for this. (Formslib refers to it.)
1522             $PAGE = $deletepage;
1523             //some functions like MoodleQuickForm::addHelpButton use $OUTPUT so we need to replace that too
1524             $output = $deletepage->get_renderer('core');
1525             $OUTPUT = $output;
1527             $site = get_site();
1528             $blocktitle = $block->get_title();
1529             $strdeletecheck = get_string('deletecheck', 'block', $blocktitle);
1530             $message = get_string('deleteblockcheck', 'block', $blocktitle);
1532             // If the block is being shown in sub contexts display a warning.
1533             if ($block->instance->showinsubcontexts == 1) {
1534                 $parentcontext = context::instance_by_id($block->instance->parentcontextid);
1535                 $systemcontext = context_system::instance();
1536                 $messagestring = new stdClass();
1537                 $messagestring->location = $parentcontext->get_context_name();
1539                 // Checking for blocks that may have visibility on the front page and pages added on that.
1540                 if ($parentcontext->id != $systemcontext->id && is_inside_frontpage($parentcontext)) {
1541                     $messagestring->pagetype = get_string('showonfrontpageandsubs', 'block');
1542                 } else {
1543                     $pagetypes = generate_page_type_patterns($this->page->pagetype, $parentcontext);
1544                     $messagestring->pagetype = $block->instance->pagetypepattern;
1545                     if (isset($pagetypes[$block->instance->pagetypepattern])) {
1546                         $messagestring->pagetype = $pagetypes[$block->instance->pagetypepattern];
1547                     }
1548                 }
1550                 $message = get_string('deleteblockwarning', 'block', $messagestring);
1551             }
1553             $PAGE->navbar->add($strdeletecheck);
1554             $PAGE->set_title($blocktitle . ': ' . $strdeletecheck);
1555             $PAGE->set_heading($site->fullname);
1556             echo $OUTPUT->header();
1557             $confirmurl = new moodle_url($deletepage->url, array('sesskey' => sesskey(), 'bui_deleteid' => $block->instance->id, 'bui_confirm' => 1));
1558             $cancelurl = new moodle_url($deletepage->url);
1559             $yesbutton = new single_button($confirmurl, get_string('yes'));
1560             $nobutton = new single_button($cancelurl, get_string('no'));
1561             echo $OUTPUT->confirm($message, $yesbutton, $nobutton);
1562             echo $OUTPUT->footer();
1563             // Make sure that nothing else happens after we have displayed this form.
1564             exit;
1565         } else {
1566             blocks_delete_instance($block->instance);
1567             // bui_deleteid and bui_confirm should not be in the PAGE url.
1568             $this->page->ensure_param_not_in_url('bui_deleteid');
1569             $this->page->ensure_param_not_in_url('bui_confirm');
1570             return true;
1571         }
1572     }
1574     /**
1575      * Handle showing or hiding a block.
1576      * @return boolean true if anything was done. False if not.
1577      */
1578     public function process_url_show_hide() {
1579         if ($blockid = optional_param('bui_hideid', null, PARAM_INT)) {
1580             $newvisibility = 0;
1581         } else if ($blockid = optional_param('bui_showid', null, PARAM_INT)) {
1582             $newvisibility = 1;
1583         } else {
1584             return false;
1585         }
1587         require_sesskey();
1589         $block = $this->page->blocks->find_instance($blockid);
1591         if (!$this->page->user_can_edit_blocks()) {
1592             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('hideshowblocks'));
1593         } else if (!$block->instance_can_be_hidden()) {
1594             return false;
1595         }
1597         blocks_set_visibility($block->instance, $this->page, $newvisibility);
1599         // If the page URL was a guses, it will contain the bui_... param, so we must make sure it is not there.
1600         $this->page->ensure_param_not_in_url('bui_hideid');
1601         $this->page->ensure_param_not_in_url('bui_showid');
1603         return true;
1604     }
1606     /**
1607      * Handle showing/processing the submission from the block editing form.
1608      * @return boolean true if the form was submitted and the new config saved. Does not
1609      *      return if the editing form was displayed. False otherwise.
1610      */
1611     public function process_url_edit() {
1612         global $CFG, $DB, $PAGE, $OUTPUT;
1614         $blockid = optional_param('bui_editid', null, PARAM_INT);
1615         if (!$blockid) {
1616             return false;
1617         }
1619         require_sesskey();
1620         require_once($CFG->dirroot . '/blocks/edit_form.php');
1622         $block = $this->find_instance($blockid);
1624         if (!$block->user_can_edit() && !$this->page->user_can_edit_blocks()) {
1625             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('editblock'));
1626         }
1628         $editpage = new moodle_page();
1629         $editpage->set_pagelayout('admin');
1630         $editpage->blocks->show_only_fake_blocks(true);
1631         $editpage->set_course($this->page->course);
1632         //$editpage->set_context($block->context);
1633         $editpage->set_context($this->page->context);
1634         if ($this->page->cm) {
1635             $editpage->set_cm($this->page->cm);
1636         }
1637         $editurlbase = str_replace($CFG->wwwroot . '/', '/', $this->page->url->out_omit_querystring());
1638         $editurlparams = $this->page->url->params();
1639         $editurlparams['bui_editid'] = $blockid;
1640         $editpage->set_url($editurlbase, $editurlparams);
1641         $editpage->set_block_actions_done();
1642         // At this point we are either going to redirect, or display the form, so
1643         // overwrite global $PAGE ready for this. (Formslib refers to it.)
1644         $PAGE = $editpage;
1645         //some functions like MoodleQuickForm::addHelpButton use $OUTPUT so we need to replace that to
1646         $output = $editpage->get_renderer('core');
1647         $OUTPUT = $output;
1649         $formfile = $CFG->dirroot . '/blocks/' . $block->name() . '/edit_form.php';
1650         if (is_readable($formfile)) {
1651             require_once($formfile);
1652             $classname = 'block_' . $block->name() . '_edit_form';
1653             if (!class_exists($classname)) {
1654                 $classname = 'block_edit_form';
1655             }
1656         } else {
1657             $classname = 'block_edit_form';
1658         }
1660         $mform = new $classname($editpage->url, $block, $this->page);
1661         $mform->set_data($block->instance);
1663         if ($mform->is_cancelled()) {
1664             redirect($this->page->url);
1666         } else if ($data = $mform->get_data()) {
1667             $bi = new stdClass;
1668             $bi->id = $block->instance->id;
1670             // This may get overwritten by the special case handling below.
1671             $bi->pagetypepattern = $data->bui_pagetypepattern;
1672             $bi->showinsubcontexts = (bool) $data->bui_contexts;
1673             if (empty($data->bui_subpagepattern) || $data->bui_subpagepattern == '%@NULL@%') {
1674                 $bi->subpagepattern = null;
1675             } else {
1676                 $bi->subpagepattern = $data->bui_subpagepattern;
1677             }
1679             $systemcontext = context_system::instance();
1680             $frontpagecontext = context_course::instance(SITEID);
1681             $parentcontext = context::instance_by_id($data->bui_parentcontextid);
1683             // Updating stickiness and contexts.  See MDL-21375 for details.
1684             if (has_capability('moodle/site:manageblocks', $parentcontext)) { // Check permissions in destination
1686                 // Explicitly set the default context
1687                 $bi->parentcontextid = $parentcontext->id;
1689                 if ($data->bui_editingatfrontpage) {   // The block is being edited on the front page
1691                     // The interface here is a special case because the pagetype pattern is
1692                     // totally derived from the context menu.  Here are the excpetions.   MDL-30340
1694                     switch ($data->bui_contexts) {
1695                         case BUI_CONTEXTS_ENTIRE_SITE:
1696                             // The user wants to show the block across the entire site
1697                             $bi->parentcontextid = $systemcontext->id;
1698                             $bi->showinsubcontexts = true;
1699                             $bi->pagetypepattern  = '*';
1700                             break;
1701                         case BUI_CONTEXTS_FRONTPAGE_SUBS:
1702                             // The user wants the block shown on the front page and all subcontexts
1703                             $bi->parentcontextid = $frontpagecontext->id;
1704                             $bi->showinsubcontexts = true;
1705                             $bi->pagetypepattern  = '*';
1706                             break;
1707                         case BUI_CONTEXTS_FRONTPAGE_ONLY:
1708                             // The user want to show the front page on the frontpage only
1709                             $bi->parentcontextid = $frontpagecontext->id;
1710                             $bi->showinsubcontexts = false;
1711                             $bi->pagetypepattern  = 'site-index';
1712                             // This is the only relevant page type anyway but we'll set it explicitly just
1713                             // in case the front page grows site-index-* subpages of its own later
1714                             break;
1715                     }
1716                 }
1717             }
1719             $bits = explode('-', $bi->pagetypepattern);
1720             // hacks for some contexts
1721             if (($parentcontext->contextlevel == CONTEXT_COURSE) && ($parentcontext->instanceid != SITEID)) {
1722                 // For course context
1723                 // is page type pattern is mod-*, change showinsubcontext to 1
1724                 if ($bits[0] == 'mod' || $bi->pagetypepattern == '*') {
1725                     $bi->showinsubcontexts = 1;
1726                 } else {
1727                     $bi->showinsubcontexts = 0;
1728                 }
1729             } else  if ($parentcontext->contextlevel == CONTEXT_USER) {
1730                 // for user context
1731                 // subpagepattern should be null
1732                 if ($bits[0] == 'user' or $bits[0] == 'my') {
1733                     // we don't need subpagepattern in usercontext
1734                     $bi->subpagepattern = null;
1735                 }
1736             }
1738             $bi->defaultregion = $data->bui_defaultregion;
1739             $bi->defaultweight = $data->bui_defaultweight;
1740             $bi->timemodified = time();
1741             $DB->update_record('block_instances', $bi);
1743             if (!empty($block->config)) {
1744                 $config = clone($block->config);
1745             } else {
1746                 $config = new stdClass;
1747             }
1748             foreach ($data as $configfield => $value) {
1749                 if (strpos($configfield, 'config_') !== 0) {
1750                     continue;
1751                 }
1752                 $field = substr($configfield, 7);
1753                 $config->$field = $value;
1754             }
1755             $block->instance_config_save($config);
1757             $bp = new stdClass;
1758             $bp->visible = $data->bui_visible;
1759             $bp->region = $data->bui_region;
1760             $bp->weight = $data->bui_weight;
1761             $needbprecord = !$data->bui_visible || $data->bui_region != $data->bui_defaultregion ||
1762                     $data->bui_weight != $data->bui_defaultweight;
1764             if ($block->instance->blockpositionid && !$needbprecord) {
1765                 $DB->delete_records('block_positions', array('id' => $block->instance->blockpositionid));
1767             } else if ($block->instance->blockpositionid && $needbprecord) {
1768                 $bp->id = $block->instance->blockpositionid;
1769                 $DB->update_record('block_positions', $bp);
1771             } else if ($needbprecord) {
1772                 $bp->blockinstanceid = $block->instance->id;
1773                 $bp->contextid = $this->page->context->id;
1774                 $bp->pagetype = $this->page->pagetype;
1775                 if ($this->page->subpage) {
1776                     $bp->subpage = $this->page->subpage;
1777                 } else {
1778                     $bp->subpage = '';
1779                 }
1780                 $DB->insert_record('block_positions', $bp);
1781             }
1783             redirect($this->page->url);
1785         } else {
1786             $strheading = get_string('blockconfiga', 'moodle', $block->get_title());
1787             $editpage->set_title($strheading);
1788             $editpage->set_heading($strheading);
1789             $bits = explode('-', $this->page->pagetype);
1790             if ($bits[0] == 'tag' && !empty($this->page->subpage)) {
1791                 // better navbar for tag pages
1792                 $editpage->navbar->add(get_string('tags'), new moodle_url('/tag/'));
1793                 $tag = core_tag_tag::get($this->page->subpage);
1794                 // tag search page doesn't have subpageid
1795                 if ($tag) {
1796                     $editpage->navbar->add($tag->get_display_name(), $tag->get_view_url());
1797                 }
1798             }
1799             $editpage->navbar->add($block->get_title());
1800             $editpage->navbar->add(get_string('configuration'));
1801             echo $output->header();
1802             echo $output->heading($strheading, 2);
1803             $mform->display();
1804             echo $output->footer();
1805             exit;
1806         }
1807     }
1809     /**
1810      * Handle showing/processing the submission from the block editing form.
1811      * @return boolean true if the form was submitted and the new config saved. Does not
1812      *      return if the editing form was displayed. False otherwise.
1813      */
1814     public function process_url_move() {
1815         global $CFG, $DB, $PAGE;
1817         $blockid = optional_param('bui_moveid', null, PARAM_INT);
1818         if (!$blockid) {
1819             return false;
1820         }
1822         require_sesskey();
1824         $block = $this->find_instance($blockid);
1826         if (!$this->page->user_can_edit_blocks()) {
1827             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('editblock'));
1828         }
1830         $newregion = optional_param('bui_newregion', '', PARAM_ALPHANUMEXT);
1831         $newweight = optional_param('bui_newweight', null, PARAM_FLOAT);
1832         if (!$newregion || is_null($newweight)) {
1833             // Don't have a valid target position yet, must be just starting the move.
1834             $this->movingblock = $blockid;
1835             $this->page->ensure_param_not_in_url('bui_moveid');
1836             return false;
1837         }
1839         if (!$this->is_known_region($newregion)) {
1840             throw new moodle_exception('unknownblockregion', '', $this->page->url, $newregion);
1841         }
1843         // Move this block. This may involve moving other nearby blocks.
1844         $blocks = $this->birecordsbyregion[$newregion];
1846         $maxweight = self::MAX_WEIGHT;
1847         $minweight = -self::MAX_WEIGHT;
1849         // Initialise the used weights and spareweights array with the default values
1850         $spareweights = array();
1851         $usedweights = array();
1852         for ($i = $minweight; $i <= $maxweight; $i++) {
1853             $spareweights[$i] = $i;
1854             $usedweights[$i] = array();
1855         }
1857         // Check each block and sort out where we have used weights
1858         foreach ($blocks as $bi) {
1859             if ($bi->weight > $maxweight) {
1860                 // If this statement is true then the blocks weight is more than the
1861                 // current maximum. To ensure that we can get the best block position
1862                 // we will initialise elements within the usedweights and spareweights
1863                 // arrays between the blocks weight (which will then be the new max) and
1864                 // the current max
1865                 $parseweight = $bi->weight;
1866                 while (!array_key_exists($parseweight, $usedweights)) {
1867                     $usedweights[$parseweight] = array();
1868                     $spareweights[$parseweight] = $parseweight;
1869                     $parseweight--;
1870                 }
1871                 $maxweight = $bi->weight;
1872             } else if ($bi->weight < $minweight) {
1873                 // As above except this time the blocks weight is LESS than the
1874                 // the current minimum, so we will initialise the array from the
1875                 // blocks weight (new minimum) to the current minimum
1876                 $parseweight = $bi->weight;
1877                 while (!array_key_exists($parseweight, $usedweights)) {
1878                     $usedweights[$parseweight] = array();
1879                     $spareweights[$parseweight] = $parseweight;
1880                     $parseweight++;
1881                 }
1882                 $minweight = $bi->weight;
1883             }
1884             if ($bi->id != $block->instance->id) {
1885                 unset($spareweights[$bi->weight]);
1886                 $usedweights[$bi->weight][] = $bi->id;
1887             }
1888         }
1890         // First we find the nearest gap in the list of weights.
1891         $bestdistance = max(abs($newweight - self::MAX_WEIGHT), abs($newweight + self::MAX_WEIGHT)) + 1;
1892         $bestgap = null;
1893         foreach ($spareweights as $spareweight) {
1894             if (abs($newweight - $spareweight) < $bestdistance) {
1895                 $bestdistance = abs($newweight - $spareweight);
1896                 $bestgap = $spareweight;
1897             }
1898         }
1900         // If there is no gap, we have to go outside -self::MAX_WEIGHT .. self::MAX_WEIGHT.
1901         if (is_null($bestgap)) {
1902             $bestgap = self::MAX_WEIGHT + 1;
1903             while (!empty($usedweights[$bestgap])) {
1904                 $bestgap++;
1905             }
1906         }
1908         // Now we know the gap we are aiming for, so move all the blocks along.
1909         if ($bestgap < $newweight) {
1910             $newweight = floor($newweight);
1911             for ($weight = $bestgap + 1; $weight <= $newweight; $weight++) {
1912                 if (array_key_exists($weight, $usedweights)) {
1913                     foreach ($usedweights[$weight] as $biid) {
1914                         $this->reposition_block($biid, $newregion, $weight - 1);
1915                     }
1916                 }
1917             }
1918             $this->reposition_block($block->instance->id, $newregion, $newweight);
1919         } else {
1920             $newweight = ceil($newweight);
1921             for ($weight = $bestgap - 1; $weight >= $newweight; $weight--) {
1922                 if (array_key_exists($weight, $usedweights)) {
1923                     foreach ($usedweights[$weight] as $biid) {
1924                         $this->reposition_block($biid, $newregion, $weight + 1);
1925                     }
1926                 }
1927             }
1928             $this->reposition_block($block->instance->id, $newregion, $newweight);
1929         }
1931         $this->page->ensure_param_not_in_url('bui_moveid');
1932         $this->page->ensure_param_not_in_url('bui_newregion');
1933         $this->page->ensure_param_not_in_url('bui_newweight');
1934         return true;
1935     }
1937     /**
1938      * Turns the display of normal blocks either on or off.
1939      *
1940      * @param bool $setting
1941      */
1942     public function show_only_fake_blocks($setting = true) {
1943         $this->fakeblocksonly = $setting;
1944     }
1947 /// Helper functions for working with block classes ============================
1949 /**
1950  * Call a class method (one that does not require a block instance) on a block class.
1951  *
1952  * @param string $blockname the name of the block.
1953  * @param string $method the method name.
1954  * @param array $param parameters to pass to the method.
1955  * @return mixed whatever the method returns.
1956  */
1957 function block_method_result($blockname, $method, $param = NULL) {
1958     if(!block_load_class($blockname)) {
1959         return NULL;
1960     }
1961     return call_user_func(array('block_'.$blockname, $method), $param);
1964 /**
1965  * Returns a new instance of the specified block instance id.
1966  *
1967  * @param int $blockinstanceid
1968  * @return block_base the requested block instance.
1969  */
1970 function block_instance_by_id($blockinstanceid) {
1971     global $DB;
1973     $blockinstance = $DB->get_record('block_instances', ['id' => $blockinstanceid]);
1974     $instance = block_instance($blockinstance->blockname, $blockinstance);
1975     return $instance;
1978 /**
1979  * Creates a new instance of the specified block class.
1980  *
1981  * @param string $blockname the name of the block.
1982  * @param $instance block_instances DB table row (optional).
1983  * @param moodle_page $page the page this block is appearing on.
1984  * @return block_base the requested block instance.
1985  */
1986 function block_instance($blockname, $instance = NULL, $page = NULL) {
1987     if(!block_load_class($blockname)) {
1988         return false;
1989     }
1990     $classname = 'block_'.$blockname;
1991     $retval = new $classname;
1992     if($instance !== NULL) {
1993         if (is_null($page)) {
1994             global $PAGE;
1995             $page = $PAGE;
1996         }
1997         $retval->_load_instance($instance, $page);
1998     }
1999     return $retval;
2002 /**
2003  * Load the block class for a particular type of block.
2004  *
2005  * @param string $blockname the name of the block.
2006  * @return boolean success or failure.
2007  */
2008 function block_load_class($blockname) {
2009     global $CFG;
2011     if(empty($blockname)) {
2012         return false;
2013     }
2015     $classname = 'block_'.$blockname;
2017     if(class_exists($classname)) {
2018         return true;
2019     }
2021     $blockpath = $CFG->dirroot.'/blocks/'.$blockname.'/block_'.$blockname.'.php';
2023     if (file_exists($blockpath)) {
2024         require_once($CFG->dirroot.'/blocks/moodleblock.class.php');
2025         include_once($blockpath);
2026     }else{
2027         //debugging("$blockname code does not exist in $blockpath", DEBUG_DEVELOPER);
2028         return false;
2029     }
2031     return class_exists($classname);
2034 /**
2035  * Given a specific page type, return all the page type patterns that might
2036  * match it.
2037  *
2038  * @param string $pagetype for example 'course-view-weeks' or 'mod-quiz-view'.
2039  * @return array an array of all the page type patterns that might match this page type.
2040  */
2041 function matching_page_type_patterns($pagetype) {
2042     $patterns = array($pagetype);
2043     $bits = explode('-', $pagetype);
2044     if (count($bits) == 3 && $bits[0] == 'mod') {
2045         if ($bits[2] == 'view') {
2046             $patterns[] = 'mod-*-view';
2047         } else if ($bits[2] == 'index') {
2048             $patterns[] = 'mod-*-index';
2049         }
2050     }
2051     while (count($bits) > 0) {
2052         $patterns[] = implode('-', $bits) . '-*';
2053         array_pop($bits);
2054     }
2055     $patterns[] = '*';
2056     return $patterns;
2059 /**
2060  * Give an specific pattern, return all the page type patterns that would also match it.
2061  *
2062  * @param  string $pattern the pattern, e.g. 'mod-forum-*' or 'mod-quiz-view'.
2063  * @return array of all the page type patterns matching.
2064  */
2065 function matching_page_type_patterns_from_pattern($pattern) {
2066     $patterns = array($pattern);
2067     if ($pattern === '*') {
2068         return $patterns;
2069     }
2071     // Only keep the part before the star because we will append -* to all the bits.
2072     $star = strpos($pattern, '-*');
2073     if ($star !== false) {
2074         $pattern = substr($pattern, 0, $star);
2075     }
2077     $patterns = array_merge($patterns, matching_page_type_patterns($pattern));
2078     $patterns = array_unique($patterns);
2080     return $patterns;
2083 /**
2084  * Given a specific page type, parent context and currect context, return all the page type patterns
2085  * that might be used by this block.
2086  *
2087  * @param string $pagetype for example 'course-view-weeks' or 'mod-quiz-view'.
2088  * @param stdClass $parentcontext Block's parent context
2089  * @param stdClass $currentcontext Current context of block
2090  * @return array an array of all the page type patterns that might match this page type.
2091  */
2092 function generate_page_type_patterns($pagetype, $parentcontext = null, $currentcontext = null) {
2093     global $CFG; // Required for includes bellow.
2095     $bits = explode('-', $pagetype);
2097     $core = core_component::get_core_subsystems();
2098     $plugins = core_component::get_plugin_types();
2100     //progressively strip pieces off the page type looking for a match
2101     $componentarray = null;
2102     for ($i = count($bits); $i > 0; $i--) {
2103         $possiblecomponentarray = array_slice($bits, 0, $i);
2104         $possiblecomponent = implode('', $possiblecomponentarray);
2106         // Check to see if the component is a core component
2107         if (array_key_exists($possiblecomponent, $core) && !empty($core[$possiblecomponent])) {
2108             $libfile = $core[$possiblecomponent].'/lib.php';
2109             if (file_exists($libfile)) {
2110                 require_once($libfile);
2111                 $function = $possiblecomponent.'_page_type_list';
2112                 if (function_exists($function)) {
2113                     if ($patterns = $function($pagetype, $parentcontext, $currentcontext)) {
2114                         break;
2115                     }
2116                 }
2117             }
2118         }
2120         //check the plugin directory and look for a callback
2121         if (array_key_exists($possiblecomponent, $plugins) && !empty($plugins[$possiblecomponent])) {
2123             //We've found a plugin type. Look for a plugin name by getting the next section of page type
2124             if (count($bits) > $i) {
2125                 $pluginname = $bits[$i];
2126                 $directory = core_component::get_plugin_directory($possiblecomponent, $pluginname);
2127                 if (!empty($directory)){
2128                     $libfile = $directory.'/lib.php';
2129                     if (file_exists($libfile)) {
2130                         require_once($libfile);
2131                         $function = $possiblecomponent.'_'.$pluginname.'_page_type_list';
2132                         if (!function_exists($function)) {
2133                             $function = $pluginname.'_page_type_list';
2134                         }
2135                         if (function_exists($function)) {
2136                             if ($patterns = $function($pagetype, $parentcontext, $currentcontext)) {
2137                                 break;
2138                             }
2139                         }
2140                     }
2141                 }
2142             }
2144             //we'll only get to here if we still don't have any patterns
2145             //the plugin type may have a callback
2146             $directory = $plugins[$possiblecomponent];
2147             $libfile = $directory.'/lib.php';
2148             if (file_exists($libfile)) {
2149                 require_once($libfile);
2150                 $function = $possiblecomponent.'_page_type_list';
2151                 if (function_exists($function)) {
2152                     if ($patterns = $function($pagetype, $parentcontext, $currentcontext)) {
2153                         break;
2154                     }
2155                 }
2156             }
2157         }
2158     }
2160     if (empty($patterns)) {
2161         $patterns = default_page_type_list($pagetype, $parentcontext, $currentcontext);
2162     }
2164     // Ensure that the * pattern is always available if editing block 'at distance', so
2165     // we always can 'bring back' it to the original context. MDL-30340
2166     if ((!isset($currentcontext) or !isset($parentcontext) or $currentcontext->id != $parentcontext->id) && !isset($patterns['*'])) {
2167         // TODO: We could change the string here, showing its 'bring back' meaning
2168         $patterns['*'] = get_string('page-x', 'pagetype');
2169     }
2171     return $patterns;
2174 /**
2175  * Generates a default page type list when a more appropriate callback cannot be decided upon.
2176  *
2177  * @param string $pagetype
2178  * @param stdClass $parentcontext
2179  * @param stdClass $currentcontext
2180  * @return array
2181  */
2182 function default_page_type_list($pagetype, $parentcontext = null, $currentcontext = null) {
2183     // Generate page type patterns based on current page type if
2184     // callbacks haven't been defined
2185     $patterns = array($pagetype => $pagetype);
2186     $bits = explode('-', $pagetype);
2187     while (count($bits) > 0) {
2188         $pattern = implode('-', $bits) . '-*';
2189         $pagetypestringname = 'page-'.str_replace('*', 'x', $pattern);
2190         // guessing page type description
2191         if (get_string_manager()->string_exists($pagetypestringname, 'pagetype')) {
2192             $patterns[$pattern] = get_string($pagetypestringname, 'pagetype');
2193         } else {
2194             $patterns[$pattern] = $pattern;
2195         }
2196         array_pop($bits);
2197     }
2198     $patterns['*'] = get_string('page-x', 'pagetype');
2199     return $patterns;
2202 /**
2203  * Generates the page type list for the my moodle page
2204  *
2205  * @param string $pagetype
2206  * @param stdClass $parentcontext
2207  * @param stdClass $currentcontext
2208  * @return array
2209  */
2210 function my_page_type_list($pagetype, $parentcontext = null, $currentcontext = null) {
2211     return array('my-index' => get_string('page-my-index', 'pagetype'));
2214 /**
2215  * Generates the page type list for a module by either locating and using the modules callback
2216  * or by generating a default list.
2217  *
2218  * @param string $pagetype
2219  * @param stdClass $parentcontext
2220  * @param stdClass $currentcontext
2221  * @return array
2222  */
2223 function mod_page_type_list($pagetype, $parentcontext = null, $currentcontext = null) {
2224     $patterns = plugin_page_type_list($pagetype, $parentcontext, $currentcontext);
2225     if (empty($patterns)) {
2226         // if modules don't have callbacks
2227         // generate two default page type patterns for modules only
2228         $bits = explode('-', $pagetype);
2229         $patterns = array($pagetype => $pagetype);
2230         if ($bits[2] == 'view') {
2231             $patterns['mod-*-view'] = get_string('page-mod-x-view', 'pagetype');
2232         } else if ($bits[2] == 'index') {
2233             $patterns['mod-*-index'] = get_string('page-mod-x-index', 'pagetype');
2234         }
2235     }
2236     return $patterns;
2238 /// Functions update the blocks if required by the request parameters ==========
2240 /**
2241  * Return a {@link block_contents} representing the add a new block UI, if
2242  * this user is allowed to see it.
2243  *
2244  * @return block_contents an appropriate block_contents, or null if the user
2245  * cannot add any blocks here.
2246  */
2247 function block_add_block_ui($page, $output) {
2248     global $CFG, $OUTPUT;
2249     if (!$page->user_is_editing() || !$page->user_can_edit_blocks()) {
2250         return null;
2251     }
2253     $bc = new block_contents();
2254     $bc->title = get_string('addblock');
2255     $bc->add_class('block_adminblock');
2256     $bc->attributes['data-block'] = 'adminblock';
2258     $missingblocks = $page->blocks->get_addable_blocks();
2259     if (empty($missingblocks)) {
2260         $bc->content = get_string('noblockstoaddhere');
2261         return $bc;
2262     }
2264     $menu = array();
2265     foreach ($missingblocks as $block) {
2266         $menu[$block->name] = $block->title;
2267     }
2269     $actionurl = new moodle_url($page->url, array('sesskey'=>sesskey()));
2270     $select = new single_select($actionurl, 'bui_addblock', $menu, null, array(''=>get_string('adddots')), 'add_block');
2271     $select->set_label(get_string('addblock'), array('class'=>'accesshide'));
2272     $bc->content = $OUTPUT->render($select);
2273     return $bc;
2276 /**
2277  * Actually delete from the database any blocks that are currently on this page,
2278  * but which should not be there according to blocks_name_allowed_in_format.
2279  *
2280  * @todo Write/Fix this function. Currently returns immediately
2281  * @param $course
2282  */
2283 function blocks_remove_inappropriate($course) {
2284     // TODO
2285     return;
2286     /*
2287     $blockmanager = blocks_get_by_page($page);
2289     if (empty($blockmanager)) {
2290         return;
2291     }
2293     if (($pageformat = $page->pagetype) == NULL) {
2294         return;
2295     }
2297     foreach($blockmanager as $region) {
2298         foreach($region as $instance) {
2299             $block = blocks_get_record($instance->blockid);
2300             if(!blocks_name_allowed_in_format($block->name, $pageformat)) {
2301                blocks_delete_instance($instance->instance);
2302             }
2303         }
2304     }*/
2307 /**
2308  * Check that a given name is in a permittable format
2309  *
2310  * @param string $name
2311  * @param string $pageformat
2312  * @return bool
2313  */
2314 function blocks_name_allowed_in_format($name, $pageformat) {
2315     $accept = NULL;
2316     $maxdepth = -1;
2317     if (!$bi = block_instance($name)) {
2318         return false;
2319     }
2321     $formats = $bi->applicable_formats();
2322     if (!$formats) {
2323         $formats = array();
2324     }
2325     foreach ($formats as $format => $allowed) {
2326         $formatregex = '/^'.str_replace('*', '[^-]*', $format).'.*$/';
2327         $depth = substr_count($format, '-');
2328         if (preg_match($formatregex, $pageformat) && $depth > $maxdepth) {
2329             $maxdepth = $depth;
2330             $accept = $allowed;
2331         }
2332     }
2333     if ($accept === NULL) {
2334         $accept = !empty($formats['all']);
2335     }
2336     return $accept;
2339 /**
2340  * Delete a block, and associated data.
2341  *
2342  * @param object $instance a row from the block_instances table
2343  * @param bool $nolongerused legacy parameter. Not used, but kept for backwards compatibility.
2344  * @param bool $skipblockstables for internal use only. Makes @see blocks_delete_all_for_context() more efficient.
2345  */
2346 function blocks_delete_instance($instance, $nolongerused = false, $skipblockstables = false) {
2347     global $DB;
2349     // Allow plugins to use this block before we completely delete it.
2350     if ($pluginsfunction = get_plugins_with_function('pre_block_delete')) {
2351         foreach ($pluginsfunction as $plugintype => $plugins) {
2352             foreach ($plugins as $pluginfunction) {
2353                 $pluginfunction($instance);
2354             }
2355         }
2356     }
2358     if ($block = block_instance($instance->blockname, $instance)) {
2359         $block->instance_delete();
2360     }
2361     context_helper::delete_instance(CONTEXT_BLOCK, $instance->id);
2363     if (!$skipblockstables) {
2364         $DB->delete_records('block_positions', array('blockinstanceid' => $instance->id));
2365         $DB->delete_records('block_instances', array('id' => $instance->id));
2366         $DB->delete_records_list('user_preferences', 'name', array('block'.$instance->id.'hidden','docked_block_instance_'.$instance->id));
2367     }
2370 /**
2371  * Delete multiple blocks at once.
2372  *
2373  * @param array $instanceids A list of block instance ID.
2374  */
2375 function blocks_delete_instances($instanceids) {
2376     global $DB;
2378     $limit = 1000;
2379     $count = count($instanceids);
2380     $chunks = [$instanceids];
2381     if ($count > $limit) {
2382         $chunks = array_chunk($instanceids, $limit);
2383     }
2385     // Perform deletion for each chunk.
2386     foreach ($chunks as $chunk) {
2387         $instances = $DB->get_recordset_list('block_instances', 'id', $chunk);
2388         foreach ($instances as $instance) {
2389             blocks_delete_instance($instance, false, true);
2390         }
2391         $instances->close();
2393         $DB->delete_records_list('block_positions', 'blockinstanceid', $chunk);
2394         $DB->delete_records_list('block_instances', 'id', $chunk);
2396         $preferences = array();
2397         foreach ($chunk as $instanceid) {
2398             $preferences[] = 'block' . $instanceid . 'hidden';
2399             $preferences[] = 'docked_block_instance_' . $instanceid;
2400         }
2401         $DB->delete_records_list('user_preferences', 'name', $preferences);
2402     }
2405 /**
2406  * Delete all the blocks that belong to a particular context.
2407  *
2408  * @param int $contextid the context id.
2409  */
2410 function blocks_delete_all_for_context($contextid) {
2411     global $DB;
2412     $instances = $DB->get_recordset('block_instances', array('parentcontextid' => $contextid));
2413     foreach ($instances as $instance) {
2414         blocks_delete_instance($instance, true);
2415     }
2416     $instances->close();
2417     $DB->delete_records('block_instances', array('parentcontextid' => $contextid));
2418     $DB->delete_records('block_positions', array('contextid' => $contextid));
2421 /**
2422  * Set a block to be visible or hidden on a particular page.
2423  *
2424  * @param object $instance a row from the block_instances, preferably LEFT JOINed with the
2425  *      block_positions table as return by block_manager.
2426  * @param moodle_page $page the back to set the visibility with respect to.
2427  * @param integer $newvisibility 1 for visible, 0 for hidden.
2428  */
2429 function blocks_set_visibility($instance, $page, $newvisibility) {
2430     global $DB;
2431     if (!empty($instance->blockpositionid)) {
2432         // Already have local information on this page.
2433         $DB->set_field('block_positions', 'visible', $newvisibility, array('id' => $instance->blockpositionid));
2434         return;
2435     }
2437     // Create a new block_positions record.
2438     $bp = new stdClass;
2439     $bp->blockinstanceid = $instance->id;
2440     $bp->contextid = $page->context->id;
2441     $bp->pagetype = $page->pagetype;
2442     if ($page->subpage) {
2443         $bp->subpage = $page->subpage;
2444     }
2445     $bp->visible = $newvisibility;
2446     $bp->region = $instance->defaultregion;
2447     $bp->weight = $instance->defaultweight;
2448     $DB->insert_record('block_positions', $bp);
2451 /**
2452  * Get the block record for a particular blockid - that is, a particular type os block.
2453  *
2454  * @param $int blockid block type id. If null, an array of all block types is returned.
2455  * @param bool $notusedanymore No longer used.
2456  * @return array|object row from block table, or all rows.
2457  */
2458 function blocks_get_record($blockid = NULL, $notusedanymore = false) {
2459     global $PAGE;
2460     $blocks = $PAGE->blocks->get_installed_blocks();
2461     if ($blockid === NULL) {
2462         return $blocks;
2463     } else if (isset($blocks[$blockid])) {
2464         return $blocks[$blockid];
2465     } else {
2466         return false;
2467     }
2470 /**
2471  * Find a given block by its blockid within a provide array
2472  *
2473  * @param int $blockid
2474  * @param array $blocksarray
2475  * @return bool|object Instance if found else false
2476  */
2477 function blocks_find_block($blockid, $blocksarray) {
2478     if (empty($blocksarray)) {
2479         return false;
2480     }
2481     foreach($blocksarray as $blockgroup) {
2482         if (empty($blockgroup)) {
2483             continue;
2484         }
2485         foreach($blockgroup as $instance) {
2486             if($instance->blockid == $blockid) {
2487                 return $instance;
2488             }
2489         }
2490     }
2491     return false;
2494 // Functions for programatically adding default blocks to pages ================
2496  /**
2497   * Parse a list of default blocks. See config-dist for a description of the format.
2498   *
2499   * @param string $blocksstr Determines the starting point that the blocks are added in the region.
2500   * @return array the parsed list of default blocks
2501   */
2502 function blocks_parse_default_blocks_list($blocksstr) {
2503     $blocks = array();
2504     $bits = explode(':', $blocksstr);
2505     if (!empty($bits)) {
2506         $leftbits = trim(array_shift($bits));
2507         if ($leftbits != '') {
2508             $blocks[BLOCK_POS_LEFT] = explode(',', $leftbits);
2509         }
2510     }
2511     if (!empty($bits)) {
2512         $rightbits = trim(array_shift($bits));
2513         if ($rightbits != '') {
2514             $blocks[BLOCK_POS_RIGHT] = explode(',', $rightbits);
2515         }
2516     }
2517     return $blocks;
2520 /**
2521  * @return array the blocks that should be added to the site course by default.
2522  */
2523 function blocks_get_default_site_course_blocks() {
2524     global $CFG;
2526     if (isset($CFG->defaultblocks_site)) {
2527         return blocks_parse_default_blocks_list($CFG->defaultblocks_site);
2528     } else {
2529         return array(
2530             BLOCK_POS_LEFT => array(),
2531             BLOCK_POS_RIGHT => array()
2532         );
2533     }
2536 /**
2537  * Add the default blocks to a course.
2538  *
2539  * @param object $course a course object.
2540  */
2541 function blocks_add_default_course_blocks($course) {
2542     global $CFG;
2544     if (isset($CFG->defaultblocks_override)) {
2545         $blocknames = blocks_parse_default_blocks_list($CFG->defaultblocks_override);
2547     } else if ($course->id == SITEID) {
2548         $blocknames = blocks_get_default_site_course_blocks();
2550     } else if (isset($CFG->{'defaultblocks_' . $course->format})) {
2551         $blocknames = blocks_parse_default_blocks_list($CFG->{'defaultblocks_' . $course->format});
2553     } else {
2554         require_once($CFG->dirroot. '/course/lib.php');
2555         $blocknames = course_get_format($course)->get_default_blocks();
2557     }
2559     if ($course->id == SITEID) {
2560         $pagetypepattern = 'site-index';
2561     } else {
2562         $pagetypepattern = 'course-view-*';
2563     }
2564     $page = new moodle_page();
2565     $page->set_course($course);
2566     $page->blocks->add_blocks($blocknames, $pagetypepattern);
2569 /**
2570  * Add the default system-context blocks. E.g. the admin tree.
2571  */
2572 function blocks_add_default_system_blocks() {
2573     global $DB;
2575     $page = new moodle_page();
2576     $page->set_context(context_system::instance());
2577     // We don't add blocks required by the theme, they will be auto-created.
2578     $page->blocks->add_blocks(array(BLOCK_POS_LEFT => array('admin_bookmarks')), 'admin-*', null, null, 2);
2580     if ($defaultmypage = $DB->get_record('my_pages', array('userid' => null, 'name' => '__default', 'private' => 1))) {
2581         $subpagepattern = $defaultmypage->id;
2582     } else {
2583         $subpagepattern = null;
2584     }
2586     $newblocks = array('private_files', 'online_users', 'badges', 'calendar_month', 'calendar_upcoming');
2587     $newcontent = array('lp', 'myoverview');
2588     $page->blocks->add_blocks(array(BLOCK_POS_RIGHT => $newblocks, 'content' => $newcontent), 'my-index', $subpagepattern);