Merge branch 'feature/MDL-56830' of https://github.com/fwsl/moodle
[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 = self::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         $undeletableblocks = self::get_undeletable_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($block->name, $undeletableblocks)) {
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      * Helper method used by get_content_for_region.
324      * @param string $region region name
325      * @param float $weight weight. May be fractional, since you may want to move a block
326      * between ones with weight 2 and 3, say ($weight would be 2.5).
327      * @return string URL for moving block $this->movingblock to this position.
328      */
329     protected function get_move_target_url($region, $weight) {
330         return new moodle_url($this->page->url, array('bui_moveid' => $this->movingblock,
331                 'bui_newregion' => $region, 'bui_newweight' => $weight, 'sesskey' => sesskey()));
332     }
334     /**
335      * Determine whether a region contains anything. (Either any real blocks, or
336      * the add new block UI.)
337      *
338      * (You may wonder why the $output parameter is required. Unfortunately,
339      * because of the way that blocks work, the only reliable way to find out
340      * if a block will be visible is to get the content for output, and to
341      * get the content, you need a renderer. Fortunately, this is not a
342      * performance problem, because we cache the output that is generated, and
343      * in almost every case where we call region_has_content, we are about to
344      * output the blocks anyway, so we are not doing wasted effort.)
345      *
346      * @param string $region a block region that exists on this page.
347      * @param core_renderer $output a core_renderer. normally the global $OUTPUT.
348      * @return boolean Whether there is anything in this region.
349      */
350     public function region_has_content($region, $output) {
352         if (!$this->is_known_region($region)) {
353             return false;
354         }
355         $this->check_is_loaded();
356         $this->ensure_content_created($region, $output);
357         // if ($this->page->user_is_editing() && $this->page->user_can_edit_blocks()) {
358         // Mark Nielsen's patch - part 1
359         if ($this->page->user_is_editing() && $this->page->user_can_edit_blocks() && $this->movingblock) {
360             // If editing is on, we need all the block regions visible, for the
361             // move blocks UI.
362             return true;
363         }
364         return !empty($this->visibleblockcontent[$region]) || !empty($this->extracontent[$region]);
365     }
367     /**
368      * Get an array of all of the installed blocks.
369      *
370      * @return array contents of the block table.
371      */
372     public function get_installed_blocks() {
373         global $DB;
374         if (is_null($this->allblocks)) {
375             $this->allblocks = $DB->get_records('block');
376         }
377         return $this->allblocks;
378     }
380     /**
381      * @return array names of block types that must exist on every page with this theme.
382      */
383     public static function get_required_by_theme_block_types() {
384         global $CFG, $PAGE;
385         $requiredbythemeblocks = false;
386         if (isset($PAGE->theme->requiredblocks)) {
387             $requiredbythemeblocks = $PAGE->theme->requiredblocks;
388         }
390         if ($requiredbythemeblocks === false) {
391             return array('navigation', 'settings');
392         } else if ($requiredbythemeblocks === '') {
393             return array();
394         } else if (is_string($requiredbythemeblocks)) {
395             return explode(',', $requiredbythemeblocks);
396         } else {
397             return $requiredbythemeblocks;
398         }
399     }
401     /**
402      * Make this block type undeletable and unaddable.
403      *
404      * @param mixed $blockidorname string or int
405      */
406     public static function protect_block($blockidorname) {
407         global $DB;
409         $syscontext = context_system::instance();
411         require_capability('moodle/site:config', $syscontext);
413         $block = false;
414         if (is_int($blockidorname)) {
415             $block = $DB->get_record('block', array('id' => $blockidorname), 'id, name', MUST_EXIST);
416         } else {
417             $block = $DB->get_record('block', array('name' => $blockidorname), 'id, name', MUST_EXIST);
418         }
419         $undeletableblocktypes = self::get_undeletable_block_types();
420         if (!in_array($block->name, $undeletableblocktypes)) {
421             $undeletableblocktypes[] = $block->name;
422             set_config('undeletableblocktypes', implode(',', $undeletableblocktypes));
423             add_to_config_log('block_protect', "0", "1", $block->name);
424         }
425     }
427     /**
428      * Make this block type deletable and addable.
429      *
430      * @param mixed $blockidorname string or int
431      */
432     public static function unprotect_block($blockidorname) {
433         global $DB;
435         $syscontext = context_system::instance();
437         require_capability('moodle/site:config', $syscontext);
439         $block = false;
440         if (is_int($blockidorname)) {
441             $block = $DB->get_record('block', array('id' => $blockidorname), 'id, name', MUST_EXIST);
442         } else {
443             $block = $DB->get_record('block', array('name' => $blockidorname), 'id, name', MUST_EXIST);
444         }
445         $undeletableblocktypes = self::get_undeletable_block_types();
446         if (in_array($block->name, $undeletableblocktypes)) {
447             $undeletableblocktypes = array_diff($undeletableblocktypes, array($block->name));
448             set_config('undeletableblocktypes', implode(',', $undeletableblocktypes));
449             add_to_config_log('block_protect', "1", "0", $block->name);
450         }
452     }
454     /**
455      * Get the list of "protected" blocks via admin block manager ui.
456      *
457      * @return array names of block types that cannot be added or deleted. E.g. array('navigation','settings').
458      */
459     public static function get_undeletable_block_types() {
460         global $CFG, $PAGE;
461         $undeletableblocks = false;
462         if (isset($CFG->undeletableblocktypes)) {
463             $undeletableblocks = $CFG->undeletableblocktypes;
464         }
466         if (empty($undeletableblocks)) {
467             return array();
468         } else if (is_string($undeletableblocks)) {
469             return explode(',', $undeletableblocks);
470         } else {
471             return $undeletableblocks;
472         }
473     }
475 /// Setter methods =============================================================
477     /**
478      * Add a region to a page
479      *
480      * @param string $region add a named region where blocks may appear on the current page.
481      *      This is an internal name, like 'side-pre', not a string to display in the UI.
482      * @param bool $custom True if this is a custom block region, being added by the page rather than the theme layout.
483      */
484     public function add_region($region, $custom = true) {
485         global $SESSION;
486         $this->check_not_yet_loaded();
487         if ($custom) {
488             if (array_key_exists($region, $this->regions)) {
489                 // This here is EXACTLY why we should not be adding block regions into a page. It should
490                 // ALWAYS be done in a theme layout.
491                 debugging('A custom region conflicts with a block region in the theme.', DEBUG_DEVELOPER);
492             }
493             // We need to register this custom region against the page type being used.
494             // This allows us to check, when performing block actions, that unrecognised regions can be worked with.
495             $type = $this->page->pagetype;
496             if (!isset($SESSION->custom_block_regions)) {
497                 $SESSION->custom_block_regions = array($type => array($region));
498             } else if (!isset($SESSION->custom_block_regions[$type])) {
499                 $SESSION->custom_block_regions[$type] = array($region);
500             } else if (!in_array($region, $SESSION->custom_block_regions[$type])) {
501                 $SESSION->custom_block_regions[$type][] = $region;
502             }
503         }
504         $this->regions[$region] = 1;
505     }
507     /**
508      * Add an array of regions
509      * @see add_region()
510      *
511      * @param array $regions this utility method calls add_region for each array element.
512      */
513     public function add_regions($regions, $custom = true) {
514         foreach ($regions as $region) {
515             $this->add_region($region, $custom);
516         }
517     }
519     /**
520      * Finds custom block regions associated with a page type and registers them with this block manager.
521      *
522      * @param string $pagetype
523      */
524     public function add_custom_regions_for_pagetype($pagetype) {
525         global $SESSION;
526         if (isset($SESSION->custom_block_regions[$pagetype])) {
527             foreach ($SESSION->custom_block_regions[$pagetype] as $customregion) {
528                 $this->add_region($customregion, false);
529             }
530         }
531     }
533     /**
534      * Set the default region for new blocks on the page
535      *
536      * @param string $defaultregion the internal names of the region where new
537      * blocks should be added by default, and where any blocks from an
538      * unrecognised region are shown.
539      */
540     public function set_default_region($defaultregion) {
541         $this->check_not_yet_loaded();
542         if ($defaultregion) {
543             $this->check_region_is_known($defaultregion);
544         }
545         $this->defaultregion = $defaultregion;
546     }
548     /**
549      * Add something that looks like a block, but which isn't an actual block_instance,
550      * to this page.
551      *
552      * @param block_contents $bc the content of the block-like thing.
553      * @param string $region a block region that exists on this page.
554      */
555     public function add_fake_block($bc, $region) {
556         $this->page->initialise_theme_and_output();
557         if (!$this->is_known_region($region)) {
558             $region = $this->get_default_region();
559         }
560         if (array_key_exists($region, $this->visibleblockcontent)) {
561             throw new coding_exception('block_manager has already prepared the blocks in region ' .
562                     $region . 'for output. It is too late to add a fake block.');
563         }
564         if (!isset($bc->attributes['data-block'])) {
565             $bc->attributes['data-block'] = '_fake';
566         }
567         $bc->attributes['class'] .= ' block_fake';
568         $this->extracontent[$region][] = $bc;
569     }
571     /**
572      * Checks to see whether all of the blocks within the given region are docked
573      *
574      * @see region_uses_dock
575      * @param string $region
576      * @return bool True if all of the blocks within that region are docked
577      */
578     public function region_completely_docked($region, $output) {
579         global $CFG;
580         // If theme doesn't allow docking or allowblockstodock is not set, then return.
581         if (!$this->page->theme->enable_dock || empty($CFG->allowblockstodock)) {
582             return false;
583         }
585         // Do not dock the region when the user attemps to move a block.
586         if ($this->movingblock) {
587             return false;
588         }
590         // Block regions should not be docked during editing when all the blocks are hidden.
591         if ($this->page->user_is_editing() && $this->page->user_can_edit_blocks()) {
592             return false;
593         }
595         $this->check_is_loaded();
596         $this->ensure_content_created($region, $output);
597         if (!$this->region_has_content($region, $output)) {
598             // If the region has no content then nothing is docked at all of course.
599             return false;
600         }
601         foreach ($this->visibleblockcontent[$region] as $instance) {
602             if (!get_user_preferences('docked_block_instance_'.$instance->blockinstanceid, 0)) {
603                 return false;
604             }
605         }
606         return true;
607     }
609     /**
610      * Checks to see whether any of the blocks within the given regions are docked
611      *
612      * @see region_completely_docked
613      * @param array|string $regions array of regions (or single region)
614      * @return bool True if any of the blocks within that region are docked
615      */
616     public function region_uses_dock($regions, $output) {
617         if (!$this->page->theme->enable_dock) {
618             return false;
619         }
620         $this->check_is_loaded();
621         foreach((array)$regions as $region) {
622             $this->ensure_content_created($region, $output);
623             foreach($this->visibleblockcontent[$region] as $instance) {
624                 if(!empty($instance->content) && get_user_preferences('docked_block_instance_'.$instance->blockinstanceid, 0)) {
625                     return true;
626                 }
627             }
628         }
629         return false;
630     }
632 /// Actions ====================================================================
634     /**
635      * This method actually loads the blocks for our page from the database.
636      *
637      * @param boolean|null $includeinvisible
638      *      null (default) - load hidden blocks if $this->page->user_is_editing();
639      *      true - load hidden blocks.
640      *      false - don't load hidden blocks.
641      */
642     public function load_blocks($includeinvisible = null) {
643         global $DB, $CFG;
645         if (!is_null($this->birecordsbyregion)) {
646             // Already done.
647             return;
648         }
650         if ($CFG->version < 2009050619) {
651             // Upgrade/install not complete. Don't try too show any blocks.
652             $this->birecordsbyregion = array();
653             return;
654         }
656         // Ensure we have been initialised.
657         if (is_null($this->defaultregion)) {
658             $this->page->initialise_theme_and_output();
659             // If there are still no block regions, then there are no blocks on this page.
660             if (empty($this->regions)) {
661                 $this->birecordsbyregion = array();
662                 return;
663             }
664         }
666         // Check if we need to load normal blocks
667         if ($this->fakeblocksonly) {
668             $this->birecordsbyregion = $this->prepare_per_region_arrays();
669             return;
670         }
672         // Exclude auto created blocks if they are not undeletable in this theme.
673         $requiredbytheme = $this->get_required_by_theme_block_types();
674         $requiredbythemecheck = '';
675         $requiredbythemeparams = array();
676         $requiredbythemenotparams = array();
677         if (!empty($requiredbytheme)) {
678             list($testsql, $requiredbythemeparams) = $DB->get_in_or_equal($requiredbytheme, SQL_PARAMS_NAMED, 'requiredbytheme');
679             list($testnotsql, $requiredbythemenotparams) = $DB->get_in_or_equal($requiredbytheme, SQL_PARAMS_NAMED,
680                                                                                 'notrequiredbytheme', false);
681             $requiredbythemecheck = 'AND ((bi.blockname ' . $testsql . ' AND bi.requiredbytheme = 1) OR ' .
682                                 ' (bi.blockname ' . $testnotsql . ' AND bi.requiredbytheme = 0))';
683         } else {
684             $requiredbythemecheck = 'AND (bi.requiredbytheme = 0)';
685         }
687         if (is_null($includeinvisible)) {
688             $includeinvisible = $this->page->user_is_editing();
689         }
690         if ($includeinvisible) {
691             $visiblecheck = '';
692         } else {
693             $visiblecheck = 'AND (bp.visible = 1 OR bp.visible IS NULL)';
694         }
696         $context = $this->page->context;
697         $contexttest = 'bi.parentcontextid IN (:contextid2, :contextid3)';
698         $parentcontextparams = array();
699         $parentcontextids = $context->get_parent_context_ids();
700         if ($parentcontextids) {
701             list($parentcontexttest, $parentcontextparams) =
702                     $DB->get_in_or_equal($parentcontextids, SQL_PARAMS_NAMED, 'parentcontext');
703             $contexttest = "($contexttest OR (bi.showinsubcontexts = 1 AND bi.parentcontextid $parentcontexttest))";
704         }
706         $pagetypepatterns = matching_page_type_patterns($this->page->pagetype);
707         list($pagetypepatterntest, $pagetypepatternparams) =
708                 $DB->get_in_or_equal($pagetypepatterns, SQL_PARAMS_NAMED, 'pagetypepatterntest');
710         $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
711         $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = bi.id AND ctx.contextlevel = :contextlevel)";
713         $systemcontext = context_system::instance();
714         $params = array(
715             'contextlevel' => CONTEXT_BLOCK,
716             'subpage1' => $this->page->subpage,
717             'subpage2' => $this->page->subpage,
718             'contextid1' => $context->id,
719             'contextid2' => $context->id,
720             'contextid3' => $systemcontext->id,
721             'pagetype' => $this->page->pagetype,
722         );
723         if ($this->page->subpage === '') {
724             $params['subpage1'] = '';
725             $params['subpage2'] = '';
726         }
727         $sql = "SELECT
728                     bi.id,
729                     bp.id AS blockpositionid,
730                     bi.blockname,
731                     bi.parentcontextid,
732                     bi.showinsubcontexts,
733                     bi.pagetypepattern,
734                     bi.requiredbytheme,
735                     bi.subpagepattern,
736                     bi.defaultregion,
737                     bi.defaultweight,
738                     COALESCE(bp.visible, 1) AS visible,
739                     COALESCE(bp.region, bi.defaultregion) AS region,
740                     COALESCE(bp.weight, bi.defaultweight) AS weight,
741                     bi.configdata
742                     $ccselect
744                 FROM {block_instances} bi
745                 JOIN {block} b ON bi.blockname = b.name
746                 LEFT JOIN {block_positions} bp ON bp.blockinstanceid = bi.id
747                                                   AND bp.contextid = :contextid1
748                                                   AND bp.pagetype = :pagetype
749                                                   AND bp.subpage = :subpage1
750                 $ccjoin
752                 WHERE
753                 $contexttest
754                 AND bi.pagetypepattern $pagetypepatterntest
755                 AND (bi.subpagepattern IS NULL OR bi.subpagepattern = :subpage2)
756                 $visiblecheck
757                 AND b.visible = 1
758                 $requiredbythemecheck
760                 ORDER BY
761                     COALESCE(bp.region, bi.defaultregion),
762                     COALESCE(bp.weight, bi.defaultweight),
763                     bi.id";
765         $allparams = $params + $parentcontextparams + $pagetypepatternparams + $requiredbythemeparams + $requiredbythemenotparams;
766         $blockinstances = $DB->get_recordset_sql($sql, $allparams);
768         $this->birecordsbyregion = $this->prepare_per_region_arrays();
769         $unknown = array();
770         foreach ($blockinstances as $bi) {
771             context_helper::preload_from_record($bi);
772             if ($this->is_known_region($bi->region)) {
773                 $this->birecordsbyregion[$bi->region][] = $bi;
774             } else {
775                 $unknown[] = $bi;
776             }
777         }
779         // Pages don't necessarily have a defaultregion. The  one time this can
780         // happen is when there are no theme block regions, but the script itself
781         // has a block region in the main content area.
782         if (!empty($this->defaultregion)) {
783             $this->birecordsbyregion[$this->defaultregion] =
784                     array_merge($this->birecordsbyregion[$this->defaultregion], $unknown);
785         }
786     }
788     /**
789      * Add a block to the current page, or related pages. The block is added to
790      * context $this->page->contextid. If $pagetypepattern $subpagepattern
791      *
792      * @param string $blockname The type of block to add.
793      * @param string $region the block region on this page to add the block to.
794      * @param integer $weight determines the order where this block appears in the region.
795      * @param boolean $showinsubcontexts whether this block appears in subcontexts, or just the current context.
796      * @param string|null $pagetypepattern which page types this block should appear on. Defaults to just the current page type.
797      * @param string|null $subpagepattern which subpage this block should appear on. NULL = any (the default), otherwise only the specified subpage.
798      */
799     public function add_block($blockname, $region, $weight, $showinsubcontexts, $pagetypepattern = NULL, $subpagepattern = NULL) {
800         global $DB;
801         // Allow invisible blocks because this is used when adding default page blocks, which
802         // might include invisible ones if the user makes some default blocks invisible
803         $this->check_known_block_type($blockname, true);
804         $this->check_region_is_known($region);
806         if (empty($pagetypepattern)) {
807             $pagetypepattern = $this->page->pagetype;
808         }
810         $blockinstance = new stdClass;
811         $blockinstance->blockname = $blockname;
812         $blockinstance->parentcontextid = $this->page->context->id;
813         $blockinstance->showinsubcontexts = !empty($showinsubcontexts);
814         $blockinstance->pagetypepattern = $pagetypepattern;
815         $blockinstance->subpagepattern = $subpagepattern;
816         $blockinstance->defaultregion = $region;
817         $blockinstance->defaultweight = $weight;
818         $blockinstance->configdata = '';
819         $blockinstance->id = $DB->insert_record('block_instances', $blockinstance);
821         // Ensure the block context is created.
822         context_block::instance($blockinstance->id);
824         // If the new instance was created, allow it to do additional setup
825         if ($block = block_instance($blockname, $blockinstance)) {
826             $block->instance_create();
827         }
828     }
830     public function add_block_at_end_of_default_region($blockname) {
831         if (empty($this->birecordsbyregion)) {
832             // No blocks or block regions exist yet.
833             return;
834         }
835         $defaulregion = $this->get_default_region();
837         $lastcurrentblock = end($this->birecordsbyregion[$defaulregion]);
838         if ($lastcurrentblock) {
839             $weight = $lastcurrentblock->weight + 1;
840         } else {
841             $weight = 0;
842         }
844         if ($this->page->subpage) {
845             $subpage = $this->page->subpage;
846         } else {
847             $subpage = null;
848         }
850         // Special case. Course view page type include the course format, but we
851         // want to add the block non-format-specifically.
852         $pagetypepattern = $this->page->pagetype;
853         if (strpos($pagetypepattern, 'course-view') === 0) {
854             $pagetypepattern = 'course-view-*';
855         }
857         // We should end using this for ALL the blocks, making always the 1st option
858         // the default one to be used. Until then, this is one hack to avoid the
859         // 'pagetypewarning' message on blocks initial edition (MDL-27829) caused by
860         // non-existing $pagetypepattern set. This way at least we guarantee one "valid"
861         // (the FIRST $pagetypepattern will be set)
863         // We are applying it to all blocks created in mod pages for now and only if the
864         // default pagetype is not one of the available options
865         if (preg_match('/^mod-.*-/', $pagetypepattern)) {
866             $pagetypelist = generate_page_type_patterns($this->page->pagetype, null, $this->page->context);
867             // Only go for the first if the pagetype is not a valid option
868             if (is_array($pagetypelist) && !array_key_exists($pagetypepattern, $pagetypelist)) {
869                 $pagetypepattern = key($pagetypelist);
870             }
871         }
872         // Surely other pages like course-report will need this too, they just are not important
873         // enough now. This will be decided in the coming days. (MDL-27829, MDL-28150)
875         $this->add_block($blockname, $defaulregion, $weight, false, $pagetypepattern, $subpage);
876     }
878     /**
879      * Convenience method, calls add_block repeatedly for all the blocks in $blocks. Optionally, a starting weight
880      * can be used to decide the starting point that blocks are added in the region, the weight is passed to {@link add_block}
881      * and incremented by the position of the block in the $blocks array
882      *
883      * @param array $blocks array with array keys the region names, and values an array of block names.
884      * @param string $pagetypepattern optional. Passed to {@link add_block()}
885      * @param string $subpagepattern optional. Passed to {@link add_block()}
886      * @param boolean $showinsubcontexts optional. Passed to {@link add_block()}
887      * @param integer $weight optional. Determines the starting point that the blocks are added in the region.
888      */
889     public function add_blocks($blocks, $pagetypepattern = NULL, $subpagepattern = NULL, $showinsubcontexts=false, $weight=0) {
890         $initialweight = $weight;
891         $this->add_regions(array_keys($blocks), false);
892         foreach ($blocks as $region => $regionblocks) {
893             foreach ($regionblocks as $offset => $blockname) {
894                 $weight = $initialweight + $offset;
895                 $this->add_block($blockname, $region, $weight, $showinsubcontexts, $pagetypepattern, $subpagepattern);
896             }
897         }
898     }
900     /**
901      * Move a block to a new position on this page.
902      *
903      * If this block cannot appear on any other pages, then we change defaultposition/weight
904      * in the block_instances table. Otherwise we just set the position on this page.
905      *
906      * @param $blockinstanceid the block instance id.
907      * @param $newregion the new region name.
908      * @param $newweight the new weight.
909      */
910     public function reposition_block($blockinstanceid, $newregion, $newweight) {
911         global $DB;
913         $this->check_region_is_known($newregion);
914         $inst = $this->find_instance($blockinstanceid);
916         $bi = $inst->instance;
917         if ($bi->weight == $bi->defaultweight && $bi->region == $bi->defaultregion &&
918                 !$bi->showinsubcontexts && strpos($bi->pagetypepattern, '*') === false &&
919                 (!$this->page->subpage || $bi->subpagepattern)) {
921             // Set default position
922             $newbi = new stdClass;
923             $newbi->id = $bi->id;
924             $newbi->defaultregion = $newregion;
925             $newbi->defaultweight = $newweight;
926             $DB->update_record('block_instances', $newbi);
928             if ($bi->blockpositionid) {
929                 $bp = new stdClass;
930                 $bp->id = $bi->blockpositionid;
931                 $bp->region = $newregion;
932                 $bp->weight = $newweight;
933                 $DB->update_record('block_positions', $bp);
934             }
936         } else {
937             // Just set position on this page.
938             $bp = new stdClass;
939             $bp->region = $newregion;
940             $bp->weight = $newweight;
942             if ($bi->blockpositionid) {
943                 $bp->id = $bi->blockpositionid;
944                 $DB->update_record('block_positions', $bp);
946             } else {
947                 $bp->blockinstanceid = $bi->id;
948                 $bp->contextid = $this->page->context->id;
949                 $bp->pagetype = $this->page->pagetype;
950                 if ($this->page->subpage) {
951                     $bp->subpage = $this->page->subpage;
952                 } else {
953                     $bp->subpage = '';
954                 }
955                 $bp->visible = $bi->visible;
956                 $DB->insert_record('block_positions', $bp);
957             }
958         }
959     }
961     /**
962      * Find a given block by its instance id
963      *
964      * @param integer $instanceid
965      * @return block_base
966      */
967     public function find_instance($instanceid) {
968         foreach ($this->regions as $region => $notused) {
969             $this->ensure_instances_exist($region);
970             foreach($this->blockinstances[$region] as $instance) {
971                 if ($instance->instance->id == $instanceid) {
972                     return $instance;
973                 }
974             }
975         }
976         throw new block_not_on_page_exception($instanceid, $this->page);
977     }
979 /// Inner workings =============================================================
981     /**
982      * Check whether the page blocks have been loaded yet
983      *
984      * @return void Throws coding exception if already loaded
985      */
986     protected function check_not_yet_loaded() {
987         if (!is_null($this->birecordsbyregion)) {
988             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.');
989         }
990     }
992     /**
993      * Check whether the page blocks have been loaded yet
994      *
995      * Nearly identical to the above function {@link check_not_yet_loaded()} except different message
996      *
997      * @return void Throws coding exception if already loaded
998      */
999     protected function check_is_loaded() {
1000         if (is_null($this->birecordsbyregion)) {
1001             throw new coding_exception('block_manager has not yet loaded the blocks, to it is too soon to request the information you asked for.');
1002         }
1003     }
1005     /**
1006      * Check if a block type is known and usable
1007      *
1008      * @param string $blockname The block type name to search for
1009      * @param bool $includeinvisible Include disabled block types in the initial pass
1010      * @return void Coding Exception thrown if unknown or not enabled
1011      */
1012     protected function check_known_block_type($blockname, $includeinvisible = false) {
1013         if (!$this->is_known_block_type($blockname, $includeinvisible)) {
1014             if ($this->is_known_block_type($blockname, true)) {
1015                 throw new coding_exception('Unknown block type ' . $blockname);
1016             } else {
1017                 throw new coding_exception('Block type ' . $blockname . ' has been disabled by the administrator.');
1018             }
1019         }
1020     }
1022     /**
1023      * Check if a region is known by its name
1024      *
1025      * @param string $region
1026      * @return void Coding Exception thrown if the region is not known
1027      */
1028     protected function check_region_is_known($region) {
1029         if (!$this->is_known_region($region)) {
1030             throw new coding_exception('Trying to reference an unknown block region ' . $region);
1031         }
1032     }
1034     /**
1035      * Returns an array of region names as keys and nested arrays for values
1036      *
1037      * @return array an array where the array keys are the region names, and the array
1038      * values are empty arrays.
1039      */
1040     protected function prepare_per_region_arrays() {
1041         $result = array();
1042         foreach ($this->regions as $region => $notused) {
1043             $result[$region] = array();
1044         }
1045         return $result;
1046     }
1048     /**
1049      * Create a set of new block instance from a record array
1050      *
1051      * @param array $birecords An array of block instance records
1052      * @return array An array of instantiated block_instance objects
1053      */
1054     protected function create_block_instances($birecords) {
1055         $results = array();
1056         foreach ($birecords as $record) {
1057             if ($blockobject = block_instance($record->blockname, $record, $this->page)) {
1058                 $results[] = $blockobject;
1059             }
1060         }
1061         return $results;
1062     }
1064     /**
1065      * Create all the block instances for all the blocks that were loaded by
1066      * load_blocks. This is used, for example, to ensure that all blocks get a
1067      * chance to initialise themselves via the {@link block_base::specialize()}
1068      * method, before any output is done.
1069      *
1070      * It is also used to create any blocks that are "requiredbytheme" by the current theme.
1071      * These blocks that are auto-created have requiredbytheme set on the block instance
1072      * so they are only visible on themes that require them.
1073      */
1074     public function create_all_block_instances() {
1075         global $PAGE;
1076         $missing = false;
1078         // If there are any un-removable blocks that were not created - force them.
1079         $requiredbytheme = $this->get_required_by_theme_block_types();
1080         if (!$this->fakeblocksonly) {
1081             foreach ($requiredbytheme as $forced) {
1082                 if (empty($forced)) {
1083                     continue;
1084                 }
1085                 $found = false;
1086                 foreach ($this->get_regions() as $region) {
1087                     foreach($this->birecordsbyregion[$region] as $instance) {
1088                         if ($instance->blockname == $forced) {
1089                             $found = true;
1090                         }
1091                     }
1092                 }
1093                 if (!$found) {
1094                     $this->add_block_required_by_theme($forced);
1095                     $missing = true;
1096                 }
1097             }
1098         }
1100         if ($missing) {
1101             // Some blocks were missing. Lets do it again.
1102             $this->birecordsbyregion = null;
1103             $this->load_blocks();
1104         }
1105         foreach ($this->get_regions() as $region) {
1106             $this->ensure_instances_exist($region);
1107         }
1109     }
1111     /**
1112      * Add a block that is required by the current theme but has not been
1113      * created yet. This is a special type of block that only shows in themes that
1114      * require it (by listing it in undeletable_block_types).
1115      *
1116      * @param string $blockname the name of the block type.
1117      */
1118     protected function add_block_required_by_theme($blockname) {
1119         global $DB;
1121         if (empty($this->birecordsbyregion)) {
1122             // No blocks or block regions exist yet.
1123             return;
1124         }
1126         // Never auto create blocks when we are showing fake blocks only.
1127         if ($this->fakeblocksonly) {
1128             return;
1129         }
1131         // Never add a duplicate block required by theme.
1132         if ($DB->record_exists('block_instances', array('blockname' => $blockname, 'requiredbytheme' => 1))) {
1133             return;
1134         }
1136         $systemcontext = context_system::instance();
1137         $defaultregion = $this->get_default_region();
1138         // Add a special system wide block instance only for themes that require it.
1139         $blockinstance = new stdClass;
1140         $blockinstance->blockname = $blockname;
1141         $blockinstance->parentcontextid = $systemcontext->id;
1142         $blockinstance->showinsubcontexts = true;
1143         $blockinstance->requiredbytheme = true;
1144         $blockinstance->pagetypepattern = '*';
1145         $blockinstance->subpagepattern = null;
1146         $blockinstance->defaultregion = $defaultregion;
1147         $blockinstance->defaultweight = 0;
1148         $blockinstance->configdata = '';
1149         $blockinstance->id = $DB->insert_record('block_instances', $blockinstance);
1151         // Ensure the block context is created.
1152         context_block::instance($blockinstance->id);
1154         // If the new instance was created, allow it to do additional setup.
1155         if ($block = block_instance($blockname, $blockinstance)) {
1156             $block->instance_create();
1157         }
1158     }
1160     /**
1161      * Return an array of content objects from a set of block instances
1162      *
1163      * @param array $instances An array of block instances
1164      * @param renderer_base The renderer to use.
1165      * @param string $region the region name.
1166      * @return array An array of block_content (and possibly block_move_target) objects.
1167      */
1168     protected function create_block_contents($instances, $output, $region) {
1169         $results = array();
1171         $lastweight = 0;
1172         $lastblock = 0;
1173         if ($this->movingblock) {
1174             $first = reset($instances);
1175             if ($first) {
1176                 $lastweight = $first->instance->weight - 2;
1177             }
1178         }
1180         foreach ($instances as $instance) {
1181             $content = $instance->get_content_for_output($output);
1182             if (empty($content)) {
1183                 continue;
1184             }
1186             if ($this->movingblock && $lastweight != $instance->instance->weight &&
1187                     $content->blockinstanceid != $this->movingblock && $lastblock != $this->movingblock) {
1188                 $results[] = new block_move_target($this->get_move_target_url($region, ($lastweight + $instance->instance->weight)/2));
1189             }
1191             if ($content->blockinstanceid == $this->movingblock) {
1192                 $content->add_class('beingmoved');
1193                 $content->annotation .= get_string('movingthisblockcancel', 'block',
1194                         html_writer::link($this->page->url, get_string('cancel')));
1195             }
1197             $results[] = $content;
1198             $lastweight = $instance->instance->weight;
1199             $lastblock = $instance->instance->id;
1200         }
1202         if ($this->movingblock && $lastblock != $this->movingblock) {
1203             $results[] = new block_move_target($this->get_move_target_url($region, $lastweight + 1));
1204         }
1205         return $results;
1206     }
1208     /**
1209      * Ensure block instances exist for a given region
1210      *
1211      * @param string $region Check for bi's with the instance with this name
1212      */
1213     protected function ensure_instances_exist($region) {
1214         $this->check_region_is_known($region);
1215         if (!array_key_exists($region, $this->blockinstances)) {
1216             $this->blockinstances[$region] =
1217                     $this->create_block_instances($this->birecordsbyregion[$region]);
1218         }
1219     }
1221     /**
1222      * Ensure that there is some content within the given region
1223      *
1224      * @param string $region The name of the region to check
1225      */
1226     public function ensure_content_created($region, $output) {
1227         $this->ensure_instances_exist($region);
1228         if (!array_key_exists($region, $this->visibleblockcontent)) {
1229             $contents = array();
1230             if (array_key_exists($region, $this->extracontent)) {
1231                 $contents = $this->extracontent[$region];
1232             }
1233             $contents = array_merge($contents, $this->create_block_contents($this->blockinstances[$region], $output, $region));
1234             if (($region == $this->defaultregion) && (!isset($this->page->theme->addblockposition) ||
1235                     $this->page->theme->addblockposition == BLOCK_ADDBLOCK_POSITION_DEFAULT)) {
1236                 $addblockui = block_add_block_ui($this->page, $output);
1237                 if ($addblockui) {
1238                     $contents[] = $addblockui;
1239                 }
1240             }
1241             $this->visibleblockcontent[$region] = $contents;
1242         }
1243     }
1245 /// Process actions from the URL ===============================================
1247     /**
1248      * Get the appropriate list of editing icons for a block. This is used
1249      * to set {@link block_contents::$controls} in {@link block_base::get_contents_for_output()}.
1250      *
1251      * @param $output The core_renderer to use when generating the output. (Need to get icon paths.)
1252      * @return an array in the format for {@link block_contents::$controls}
1253      */
1254     public function edit_controls($block) {
1255         global $CFG;
1257         $controls = array();
1258         $actionurl = $this->page->url->out(false, array('sesskey'=> sesskey()));
1259         $blocktitle = $block->title;
1260         if (empty($blocktitle)) {
1261             $blocktitle = $block->arialabel;
1262         }
1264         if ($this->page->user_can_edit_blocks()) {
1265             // Move icon.
1266             $str = new lang_string('moveblock', 'block', $blocktitle);
1267             $controls[] = new action_menu_link_primary(
1268                 new moodle_url($actionurl, array('bui_moveid' => $block->instance->id)),
1269                 new pix_icon('t/move', $str, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1270                 $str,
1271                 array('class' => 'editing_move')
1272             );
1274         }
1276         if ($this->page->user_can_edit_blocks() || $block->user_can_edit()) {
1277             // Edit config icon - always show - needed for positioning UI.
1278             $str = new lang_string('configureblock', 'block', $blocktitle);
1279             $controls[] = new action_menu_link_secondary(
1280                 new moodle_url($actionurl, array('bui_editid' => $block->instance->id)),
1281                 new pix_icon('t/edit', $str, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1282                 $str,
1283                 array('class' => 'editing_edit')
1284             );
1286         }
1288         if ($this->page->user_can_edit_blocks() && $block->instance_can_be_hidden()) {
1289             // Show/hide icon.
1290             if ($block->instance->visible) {
1291                 $str = new lang_string('hideblock', 'block', $blocktitle);
1292                 $url = new moodle_url($actionurl, array('bui_hideid' => $block->instance->id));
1293                 $icon = new pix_icon('t/hide', $str, 'moodle', array('class' => 'iconsmall', 'title' => ''));
1294                 $attributes = array('class' => 'editing_hide');
1295             } else {
1296                 $str = new lang_string('showblock', 'block', $blocktitle);
1297                 $url = new moodle_url($actionurl, array('bui_showid' => $block->instance->id));
1298                 $icon = new pix_icon('t/show', $str, 'moodle', array('class' => 'iconsmall', 'title' => ''));
1299                 $attributes = array('class' => 'editing_show');
1300             }
1301             $controls[] = new action_menu_link_secondary($url, $icon, $str, $attributes);
1302         }
1304         // Assign roles.
1305         if (get_assignable_roles($block->context, ROLENAME_SHORT)) {
1306             $rolesurl = new moodle_url('/admin/roles/assign.php', array('contextid' => $block->context->id,
1307                 'returnurl' => $this->page->url->out_as_local_url()));
1308             $str = new lang_string('assignrolesinblock', 'block', $blocktitle);
1309             $controls[] = new action_menu_link_secondary(
1310                 $rolesurl,
1311                 new pix_icon('i/assignroles', $str, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1312                 $str, array('class' => 'editing_assignroles')
1313             );
1314         }
1316         // Permissions.
1317         if (has_capability('moodle/role:review', $block->context) or get_overridable_roles($block->context)) {
1318             $rolesurl = new moodle_url('/admin/roles/permissions.php', array('contextid' => $block->context->id,
1319                 'returnurl' => $this->page->url->out_as_local_url()));
1320             $str = get_string('permissions', 'role');
1321             $controls[] = new action_menu_link_secondary(
1322                 $rolesurl,
1323                 new pix_icon('i/permissions', $str, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1324                 $str, array('class' => 'editing_permissions')
1325             );
1326         }
1328         // Change permissions.
1329         if (has_any_capability(array('moodle/role:safeoverride', 'moodle/role:override', 'moodle/role:assign'), $block->context)) {
1330             $rolesurl = new moodle_url('/admin/roles/check.php', array('contextid' => $block->context->id,
1331                 'returnurl' => $this->page->url->out_as_local_url()));
1332             $str = get_string('checkpermissions', 'role');
1333             $controls[] = new action_menu_link_secondary(
1334                 $rolesurl,
1335                 new pix_icon('i/checkpermissions', $str, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1336                 $str, array('class' => 'editing_checkroles')
1337             );
1338         }
1340         if ($this->user_can_delete_block($block)) {
1341             // Delete icon.
1342             $str = new lang_string('deleteblock', 'block', $blocktitle);
1343             $controls[] = new action_menu_link_secondary(
1344                 new moodle_url($actionurl, array('bui_deleteid' => $block->instance->id)),
1345                 new pix_icon('t/delete', $str, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1346                 $str,
1347                 array('class' => 'editing_delete')
1348             );
1349         }
1351         return $controls;
1352     }
1354     /**
1355      * @param block_base $block a block that appears on this page.
1356      * @return boolean boolean whether the currently logged in user is allowed to delete this block.
1357      */
1358     protected function user_can_delete_block($block) {
1359         return $this->page->user_can_edit_blocks() && $block->user_can_edit() &&
1360                 $block->user_can_addto($this->page) &&
1361                 !in_array($block->instance->blockname, self::get_undeletable_block_types()) &&
1362                 !in_array($block->instance->blockname, self::get_required_by_theme_block_types());
1363     }
1365     /**
1366      * Process any block actions that were specified in the URL.
1367      *
1368      * @return boolean true if anything was done. False if not.
1369      */
1370     public function process_url_actions() {
1371         if (!$this->page->user_is_editing()) {
1372             return false;
1373         }
1374         return $this->process_url_add() || $this->process_url_delete() ||
1375             $this->process_url_show_hide() || $this->process_url_edit() ||
1376             $this->process_url_move();
1377     }
1379     /**
1380      * Handle adding a block.
1381      * @return boolean true if anything was done. False if not.
1382      */
1383     public function process_url_add() {
1384         global $CFG, $PAGE, $OUTPUT;
1386         $blocktype = optional_param('bui_addblock', null, PARAM_PLUGIN);
1387         if ($blocktype === null) {
1388             return false;
1389         }
1391         require_sesskey();
1393         if (!$this->page->user_can_edit_blocks()) {
1394             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('addblock'));
1395         }
1397         $addableblocks = $this->get_addable_blocks();
1399         if ($blocktype === '') {
1400             // Display add block selection.
1401             $addpage = new moodle_page();
1402             $addpage->set_pagelayout('admin');
1403             $addpage->blocks->show_only_fake_blocks(true);
1404             $addpage->set_course($this->page->course);
1405             $addpage->set_context($this->page->context);
1406             if ($this->page->cm) {
1407                 $addpage->set_cm($this->page->cm);
1408             }
1410             $addpagebase = str_replace($CFG->wwwroot . '/', '/', $this->page->url->out_omit_querystring());
1411             $addpageparams = $this->page->url->params();
1412             $addpage->set_url($addpagebase, $addpageparams);
1413             $addpage->set_block_actions_done();
1414             // At this point we are going to display the block selector, overwrite global $PAGE ready for this.
1415             $PAGE = $addpage;
1416             // Some functions use $OUTPUT so we need to replace that too.
1417             $OUTPUT = $addpage->get_renderer('core');
1419             $site = get_site();
1420             $straddblock = get_string('addblock');
1422             $PAGE->navbar->add($straddblock);
1423             $PAGE->set_title($straddblock);
1424             $PAGE->set_heading($site->fullname);
1425             echo $OUTPUT->header();
1426             echo $OUTPUT->heading($straddblock);
1428             if (!$addableblocks) {
1429                 echo $OUTPUT->box(get_string('noblockstoaddhere'));
1430                 echo $OUTPUT->container($OUTPUT->action_link($addpage->url, get_string('back')), 'm-x-3 m-b-1');
1431             } else {
1432                 $url = new moodle_url($addpage->url, array('sesskey' => sesskey()));
1433                 echo $OUTPUT->render_from_template('core/add_block_body',
1434                     ['blocks' => array_values($addableblocks),
1435                      'url' => '?' . $url->get_query_string(false)]);
1436                 echo $OUTPUT->container($OUTPUT->action_link($addpage->url, get_string('cancel')), 'm-x-3 m-b-1');
1437             }
1439             echo $OUTPUT->footer();
1440             // Make sure that nothing else happens after we have displayed this form.
1441             exit;
1442         }
1444         if (!array_key_exists($blocktype, $addableblocks)) {
1445             throw new moodle_exception('cannotaddthisblocktype', '', $this->page->url->out(), $blocktype);
1446         }
1448         $this->add_block_at_end_of_default_region($blocktype);
1450         // If the page URL was a guess, it will contain the bui_... param, so we must make sure it is not there.
1451         $this->page->ensure_param_not_in_url('bui_addblock');
1453         return true;
1454     }
1456     /**
1457      * Handle deleting a block.
1458      * @return boolean true if anything was done. False if not.
1459      */
1460     public function process_url_delete() {
1461         global $CFG, $PAGE, $OUTPUT;
1463         $blockid = optional_param('bui_deleteid', null, PARAM_INT);
1464         $confirmdelete = optional_param('bui_confirm', null, PARAM_INT);
1466         if (!$blockid) {
1467             return false;
1468         }
1470         require_sesskey();
1471         $block = $this->page->blocks->find_instance($blockid);
1472         if (!$this->user_can_delete_block($block)) {
1473             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('deleteablock'));
1474         }
1476         if (!$confirmdelete) {
1477             $deletepage = new moodle_page();
1478             $deletepage->set_pagelayout('admin');
1479             $deletepage->blocks->show_only_fake_blocks(true);
1480             $deletepage->set_course($this->page->course);
1481             $deletepage->set_context($this->page->context);
1482             if ($this->page->cm) {
1483                 $deletepage->set_cm($this->page->cm);
1484             }
1486             $deleteurlbase = str_replace($CFG->wwwroot . '/', '/', $this->page->url->out_omit_querystring());
1487             $deleteurlparams = $this->page->url->params();
1488             $deletepage->set_url($deleteurlbase, $deleteurlparams);
1489             $deletepage->set_block_actions_done();
1490             // At this point we are either going to redirect, or display the form, so
1491             // overwrite global $PAGE ready for this. (Formslib refers to it.)
1492             $PAGE = $deletepage;
1493             //some functions like MoodleQuickForm::addHelpButton use $OUTPUT so we need to replace that too
1494             $output = $deletepage->get_renderer('core');
1495             $OUTPUT = $output;
1497             $site = get_site();
1498             $blocktitle = $block->get_title();
1499             $strdeletecheck = get_string('deletecheck', 'block', $blocktitle);
1500             $message = get_string('deleteblockcheck', 'block', $blocktitle);
1502             // If the block is being shown in sub contexts display a warning.
1503             if ($block->instance->showinsubcontexts == 1) {
1504                 $parentcontext = context::instance_by_id($block->instance->parentcontextid);
1505                 $systemcontext = context_system::instance();
1506                 $messagestring = new stdClass();
1507                 $messagestring->location = $parentcontext->get_context_name();
1509                 // Checking for blocks that may have visibility on the front page and pages added on that.
1510                 if ($parentcontext->id != $systemcontext->id && is_inside_frontpage($parentcontext)) {
1511                     $messagestring->pagetype = get_string('showonfrontpageandsubs', 'block');
1512                 } else {
1513                     $pagetypes = generate_page_type_patterns($this->page->pagetype, $parentcontext);
1514                     $messagestring->pagetype = $block->instance->pagetypepattern;
1515                     if (isset($pagetypes[$block->instance->pagetypepattern])) {
1516                         $messagestring->pagetype = $pagetypes[$block->instance->pagetypepattern];
1517                     }
1518                 }
1520                 $message = get_string('deleteblockwarning', 'block', $messagestring);
1521             }
1523             $PAGE->navbar->add($strdeletecheck);
1524             $PAGE->set_title($blocktitle . ': ' . $strdeletecheck);
1525             $PAGE->set_heading($site->fullname);
1526             echo $OUTPUT->header();
1527             $confirmurl = new moodle_url($deletepage->url, array('sesskey' => sesskey(), 'bui_deleteid' => $block->instance->id, 'bui_confirm' => 1));
1528             $cancelurl = new moodle_url($deletepage->url);
1529             $yesbutton = new single_button($confirmurl, get_string('yes'));
1530             $nobutton = new single_button($cancelurl, get_string('no'));
1531             echo $OUTPUT->confirm($message, $yesbutton, $nobutton);
1532             echo $OUTPUT->footer();
1533             // Make sure that nothing else happens after we have displayed this form.
1534             exit;
1535         } else {
1536             blocks_delete_instance($block->instance);
1537             // bui_deleteid and bui_confirm should not be in the PAGE url.
1538             $this->page->ensure_param_not_in_url('bui_deleteid');
1539             $this->page->ensure_param_not_in_url('bui_confirm');
1540             return true;
1541         }
1542     }
1544     /**
1545      * Handle showing or hiding a block.
1546      * @return boolean true if anything was done. False if not.
1547      */
1548     public function process_url_show_hide() {
1549         if ($blockid = optional_param('bui_hideid', null, PARAM_INT)) {
1550             $newvisibility = 0;
1551         } else if ($blockid = optional_param('bui_showid', null, PARAM_INT)) {
1552             $newvisibility = 1;
1553         } else {
1554             return false;
1555         }
1557         require_sesskey();
1559         $block = $this->page->blocks->find_instance($blockid);
1561         if (!$this->page->user_can_edit_blocks()) {
1562             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('hideshowblocks'));
1563         } else if (!$block->instance_can_be_hidden()) {
1564             return false;
1565         }
1567         blocks_set_visibility($block->instance, $this->page, $newvisibility);
1569         // If the page URL was a guses, it will contain the bui_... param, so we must make sure it is not there.
1570         $this->page->ensure_param_not_in_url('bui_hideid');
1571         $this->page->ensure_param_not_in_url('bui_showid');
1573         return true;
1574     }
1576     /**
1577      * Handle showing/processing the submission from the block editing form.
1578      * @return boolean true if the form was submitted and the new config saved. Does not
1579      *      return if the editing form was displayed. False otherwise.
1580      */
1581     public function process_url_edit() {
1582         global $CFG, $DB, $PAGE, $OUTPUT;
1584         $blockid = optional_param('bui_editid', null, PARAM_INT);
1585         if (!$blockid) {
1586             return false;
1587         }
1589         require_sesskey();
1590         require_once($CFG->dirroot . '/blocks/edit_form.php');
1592         $block = $this->find_instance($blockid);
1594         if (!$block->user_can_edit() && !$this->page->user_can_edit_blocks()) {
1595             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('editblock'));
1596         }
1598         $editpage = new moodle_page();
1599         $editpage->set_pagelayout('admin');
1600         $editpage->blocks->show_only_fake_blocks(true);
1601         $editpage->set_course($this->page->course);
1602         //$editpage->set_context($block->context);
1603         $editpage->set_context($this->page->context);
1604         if ($this->page->cm) {
1605             $editpage->set_cm($this->page->cm);
1606         }
1607         $editurlbase = str_replace($CFG->wwwroot . '/', '/', $this->page->url->out_omit_querystring());
1608         $editurlparams = $this->page->url->params();
1609         $editurlparams['bui_editid'] = $blockid;
1610         $editpage->set_url($editurlbase, $editurlparams);
1611         $editpage->set_block_actions_done();
1612         // At this point we are either going to redirect, or display the form, so
1613         // overwrite global $PAGE ready for this. (Formslib refers to it.)
1614         $PAGE = $editpage;
1615         //some functions like MoodleQuickForm::addHelpButton use $OUTPUT so we need to replace that to
1616         $output = $editpage->get_renderer('core');
1617         $OUTPUT = $output;
1619         $formfile = $CFG->dirroot . '/blocks/' . $block->name() . '/edit_form.php';
1620         if (is_readable($formfile)) {
1621             require_once($formfile);
1622             $classname = 'block_' . $block->name() . '_edit_form';
1623             if (!class_exists($classname)) {
1624                 $classname = 'block_edit_form';
1625             }
1626         } else {
1627             $classname = 'block_edit_form';
1628         }
1630         $mform = new $classname($editpage->url, $block, $this->page);
1631         $mform->set_data($block->instance);
1633         if ($mform->is_cancelled()) {
1634             redirect($this->page->url);
1636         } else if ($data = $mform->get_data()) {
1637             $bi = new stdClass;
1638             $bi->id = $block->instance->id;
1640             // This may get overwritten by the special case handling below.
1641             $bi->pagetypepattern = $data->bui_pagetypepattern;
1642             $bi->showinsubcontexts = (bool) $data->bui_contexts;
1643             if (empty($data->bui_subpagepattern) || $data->bui_subpagepattern == '%@NULL@%') {
1644                 $bi->subpagepattern = null;
1645             } else {
1646                 $bi->subpagepattern = $data->bui_subpagepattern;
1647             }
1649             $systemcontext = context_system::instance();
1650             $frontpagecontext = context_course::instance(SITEID);
1651             $parentcontext = context::instance_by_id($data->bui_parentcontextid);
1653             // Updating stickiness and contexts.  See MDL-21375 for details.
1654             if (has_capability('moodle/site:manageblocks', $parentcontext)) { // Check permissions in destination
1656                 // Explicitly set the default context
1657                 $bi->parentcontextid = $parentcontext->id;
1659                 if ($data->bui_editingatfrontpage) {   // The block is being edited on the front page
1661                     // The interface here is a special case because the pagetype pattern is
1662                     // totally derived from the context menu.  Here are the excpetions.   MDL-30340
1664                     switch ($data->bui_contexts) {
1665                         case BUI_CONTEXTS_ENTIRE_SITE:
1666                             // The user wants to show the block across the entire site
1667                             $bi->parentcontextid = $systemcontext->id;
1668                             $bi->showinsubcontexts = true;
1669                             $bi->pagetypepattern  = '*';
1670                             break;
1671                         case BUI_CONTEXTS_FRONTPAGE_SUBS:
1672                             // The user wants the block shown on the front page and all subcontexts
1673                             $bi->parentcontextid = $frontpagecontext->id;
1674                             $bi->showinsubcontexts = true;
1675                             $bi->pagetypepattern  = '*';
1676                             break;
1677                         case BUI_CONTEXTS_FRONTPAGE_ONLY:
1678                             // The user want to show the front page on the frontpage only
1679                             $bi->parentcontextid = $frontpagecontext->id;
1680                             $bi->showinsubcontexts = false;
1681                             $bi->pagetypepattern  = 'site-index';
1682                             // This is the only relevant page type anyway but we'll set it explicitly just
1683                             // in case the front page grows site-index-* subpages of its own later
1684                             break;
1685                     }
1686                 }
1687             }
1689             $bits = explode('-', $bi->pagetypepattern);
1690             // hacks for some contexts
1691             if (($parentcontext->contextlevel == CONTEXT_COURSE) && ($parentcontext->instanceid != SITEID)) {
1692                 // For course context
1693                 // is page type pattern is mod-*, change showinsubcontext to 1
1694                 if ($bits[0] == 'mod' || $bi->pagetypepattern == '*') {
1695                     $bi->showinsubcontexts = 1;
1696                 } else {
1697                     $bi->showinsubcontexts = 0;
1698                 }
1699             } else  if ($parentcontext->contextlevel == CONTEXT_USER) {
1700                 // for user context
1701                 // subpagepattern should be null
1702                 if ($bits[0] == 'user' or $bits[0] == 'my') {
1703                     // we don't need subpagepattern in usercontext
1704                     $bi->subpagepattern = null;
1705                 }
1706             }
1708             $bi->defaultregion = $data->bui_defaultregion;
1709             $bi->defaultweight = $data->bui_defaultweight;
1710             $DB->update_record('block_instances', $bi);
1712             if (!empty($block->config)) {
1713                 $config = clone($block->config);
1714             } else {
1715                 $config = new stdClass;
1716             }
1717             foreach ($data as $configfield => $value) {
1718                 if (strpos($configfield, 'config_') !== 0) {
1719                     continue;
1720                 }
1721                 $field = substr($configfield, 7);
1722                 $config->$field = $value;
1723             }
1724             $block->instance_config_save($config);
1726             $bp = new stdClass;
1727             $bp->visible = $data->bui_visible;
1728             $bp->region = $data->bui_region;
1729             $bp->weight = $data->bui_weight;
1730             $needbprecord = !$data->bui_visible || $data->bui_region != $data->bui_defaultregion ||
1731                     $data->bui_weight != $data->bui_defaultweight;
1733             if ($block->instance->blockpositionid && !$needbprecord) {
1734                 $DB->delete_records('block_positions', array('id' => $block->instance->blockpositionid));
1736             } else if ($block->instance->blockpositionid && $needbprecord) {
1737                 $bp->id = $block->instance->blockpositionid;
1738                 $DB->update_record('block_positions', $bp);
1740             } else if ($needbprecord) {
1741                 $bp->blockinstanceid = $block->instance->id;
1742                 $bp->contextid = $this->page->context->id;
1743                 $bp->pagetype = $this->page->pagetype;
1744                 if ($this->page->subpage) {
1745                     $bp->subpage = $this->page->subpage;
1746                 } else {
1747                     $bp->subpage = '';
1748                 }
1749                 $DB->insert_record('block_positions', $bp);
1750             }
1752             redirect($this->page->url);
1754         } else {
1755             $strheading = get_string('blockconfiga', 'moodle', $block->get_title());
1756             $editpage->set_title($strheading);
1757             $editpage->set_heading($strheading);
1758             $bits = explode('-', $this->page->pagetype);
1759             if ($bits[0] == 'tag' && !empty($this->page->subpage)) {
1760                 // better navbar for tag pages
1761                 $editpage->navbar->add(get_string('tags'), new moodle_url('/tag/'));
1762                 $tag = core_tag_tag::get($this->page->subpage);
1763                 // tag search page doesn't have subpageid
1764                 if ($tag) {
1765                     $editpage->navbar->add($tag->get_display_name(), $tag->get_view_url());
1766                 }
1767             }
1768             $editpage->navbar->add($block->get_title());
1769             $editpage->navbar->add(get_string('configuration'));
1770             echo $output->header();
1771             echo $output->heading($strheading, 2);
1772             $mform->display();
1773             echo $output->footer();
1774             exit;
1775         }
1776     }
1778     /**
1779      * Handle showing/processing the submission from the block editing form.
1780      * @return boolean true if the form was submitted and the new config saved. Does not
1781      *      return if the editing form was displayed. False otherwise.
1782      */
1783     public function process_url_move() {
1784         global $CFG, $DB, $PAGE;
1786         $blockid = optional_param('bui_moveid', null, PARAM_INT);
1787         if (!$blockid) {
1788             return false;
1789         }
1791         require_sesskey();
1793         $block = $this->find_instance($blockid);
1795         if (!$this->page->user_can_edit_blocks()) {
1796             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('editblock'));
1797         }
1799         $newregion = optional_param('bui_newregion', '', PARAM_ALPHANUMEXT);
1800         $newweight = optional_param('bui_newweight', null, PARAM_FLOAT);
1801         if (!$newregion || is_null($newweight)) {
1802             // Don't have a valid target position yet, must be just starting the move.
1803             $this->movingblock = $blockid;
1804             $this->page->ensure_param_not_in_url('bui_moveid');
1805             return false;
1806         }
1808         if (!$this->is_known_region($newregion)) {
1809             throw new moodle_exception('unknownblockregion', '', $this->page->url, $newregion);
1810         }
1812         // Move this block. This may involve moving other nearby blocks.
1813         $blocks = $this->birecordsbyregion[$newregion];
1815         $maxweight = self::MAX_WEIGHT;
1816         $minweight = -self::MAX_WEIGHT;
1818         // Initialise the used weights and spareweights array with the default values
1819         $spareweights = array();
1820         $usedweights = array();
1821         for ($i = $minweight; $i <= $maxweight; $i++) {
1822             $spareweights[$i] = $i;
1823             $usedweights[$i] = array();
1824         }
1826         // Check each block and sort out where we have used weights
1827         foreach ($blocks as $bi) {
1828             if ($bi->weight > $maxweight) {
1829                 // If this statement is true then the blocks weight is more than the
1830                 // current maximum. To ensure that we can get the best block position
1831                 // we will initialise elements within the usedweights and spareweights
1832                 // arrays between the blocks weight (which will then be the new max) and
1833                 // the current max
1834                 $parseweight = $bi->weight;
1835                 while (!array_key_exists($parseweight, $usedweights)) {
1836                     $usedweights[$parseweight] = array();
1837                     $spareweights[$parseweight] = $parseweight;
1838                     $parseweight--;
1839                 }
1840                 $maxweight = $bi->weight;
1841             } else if ($bi->weight < $minweight) {
1842                 // As above except this time the blocks weight is LESS than the
1843                 // the current minimum, so we will initialise the array from the
1844                 // blocks weight (new minimum) to the current minimum
1845                 $parseweight = $bi->weight;
1846                 while (!array_key_exists($parseweight, $usedweights)) {
1847                     $usedweights[$parseweight] = array();
1848                     $spareweights[$parseweight] = $parseweight;
1849                     $parseweight++;
1850                 }
1851                 $minweight = $bi->weight;
1852             }
1853             if ($bi->id != $block->instance->id) {
1854                 unset($spareweights[$bi->weight]);
1855                 $usedweights[$bi->weight][] = $bi->id;
1856             }
1857         }
1859         // First we find the nearest gap in the list of weights.
1860         $bestdistance = max(abs($newweight - self::MAX_WEIGHT), abs($newweight + self::MAX_WEIGHT)) + 1;
1861         $bestgap = null;
1862         foreach ($spareweights as $spareweight) {
1863             if (abs($newweight - $spareweight) < $bestdistance) {
1864                 $bestdistance = abs($newweight - $spareweight);
1865                 $bestgap = $spareweight;
1866             }
1867         }
1869         // If there is no gap, we have to go outside -self::MAX_WEIGHT .. self::MAX_WEIGHT.
1870         if (is_null($bestgap)) {
1871             $bestgap = self::MAX_WEIGHT + 1;
1872             while (!empty($usedweights[$bestgap])) {
1873                 $bestgap++;
1874             }
1875         }
1877         // Now we know the gap we are aiming for, so move all the blocks along.
1878         if ($bestgap < $newweight) {
1879             $newweight = floor($newweight);
1880             for ($weight = $bestgap + 1; $weight <= $newweight; $weight++) {
1881                 if (array_key_exists($weight, $usedweights)) {
1882                     foreach ($usedweights[$weight] as $biid) {
1883                         $this->reposition_block($biid, $newregion, $weight - 1);
1884                     }
1885                 }
1886             }
1887             $this->reposition_block($block->instance->id, $newregion, $newweight);
1888         } else {
1889             $newweight = ceil($newweight);
1890             for ($weight = $bestgap - 1; $weight >= $newweight; $weight--) {
1891                 if (array_key_exists($weight, $usedweights)) {
1892                     foreach ($usedweights[$weight] as $biid) {
1893                         $this->reposition_block($biid, $newregion, $weight + 1);
1894                     }
1895                 }
1896             }
1897             $this->reposition_block($block->instance->id, $newregion, $newweight);
1898         }
1900         $this->page->ensure_param_not_in_url('bui_moveid');
1901         $this->page->ensure_param_not_in_url('bui_newregion');
1902         $this->page->ensure_param_not_in_url('bui_newweight');
1903         return true;
1904     }
1906     /**
1907      * Turns the display of normal blocks either on or off.
1908      *
1909      * @param bool $setting
1910      */
1911     public function show_only_fake_blocks($setting = true) {
1912         $this->fakeblocksonly = $setting;
1913     }
1916 /// Helper functions for working with block classes ============================
1918 /**
1919  * Call a class method (one that does not require a block instance) on a block class.
1920  *
1921  * @param string $blockname the name of the block.
1922  * @param string $method the method name.
1923  * @param array $param parameters to pass to the method.
1924  * @return mixed whatever the method returns.
1925  */
1926 function block_method_result($blockname, $method, $param = NULL) {
1927     if(!block_load_class($blockname)) {
1928         return NULL;
1929     }
1930     return call_user_func(array('block_'.$blockname, $method), $param);
1933 /**
1934  * Creates a new instance of the specified block class.
1935  *
1936  * @param string $blockname the name of the block.
1937  * @param $instance block_instances DB table row (optional).
1938  * @param moodle_page $page the page this block is appearing on.
1939  * @return block_base the requested block instance.
1940  */
1941 function block_instance($blockname, $instance = NULL, $page = NULL) {
1942     if(!block_load_class($blockname)) {
1943         return false;
1944     }
1945     $classname = 'block_'.$blockname;
1946     $retval = new $classname;
1947     if($instance !== NULL) {
1948         if (is_null($page)) {
1949             global $PAGE;
1950             $page = $PAGE;
1951         }
1952         $retval->_load_instance($instance, $page);
1953     }
1954     return $retval;
1957 /**
1958  * Load the block class for a particular type of block.
1959  *
1960  * @param string $blockname the name of the block.
1961  * @return boolean success or failure.
1962  */
1963 function block_load_class($blockname) {
1964     global $CFG;
1966     if(empty($blockname)) {
1967         return false;
1968     }
1970     $classname = 'block_'.$blockname;
1972     if(class_exists($classname)) {
1973         return true;
1974     }
1976     $blockpath = $CFG->dirroot.'/blocks/'.$blockname.'/block_'.$blockname.'.php';
1978     if (file_exists($blockpath)) {
1979         require_once($CFG->dirroot.'/blocks/moodleblock.class.php');
1980         include_once($blockpath);
1981     }else{
1982         //debugging("$blockname code does not exist in $blockpath", DEBUG_DEVELOPER);
1983         return false;
1984     }
1986     return class_exists($classname);
1989 /**
1990  * Given a specific page type, return all the page type patterns that might
1991  * match it.
1992  *
1993  * @param string $pagetype for example 'course-view-weeks' or 'mod-quiz-view'.
1994  * @return array an array of all the page type patterns that might match this page type.
1995  */
1996 function matching_page_type_patterns($pagetype) {
1997     $patterns = array($pagetype);
1998     $bits = explode('-', $pagetype);
1999     if (count($bits) == 3 && $bits[0] == 'mod') {
2000         if ($bits[2] == 'view') {
2001             $patterns[] = 'mod-*-view';
2002         } else if ($bits[2] == 'index') {
2003             $patterns[] = 'mod-*-index';
2004         }
2005     }
2006     while (count($bits) > 0) {
2007         $patterns[] = implode('-', $bits) . '-*';
2008         array_pop($bits);
2009     }
2010     $patterns[] = '*';
2011     return $patterns;
2014 /**
2015  * Give an specific pattern, return all the page type patterns that would also match it.
2016  *
2017  * @param  string $pattern the pattern, e.g. 'mod-forum-*' or 'mod-quiz-view'.
2018  * @return array of all the page type patterns matching.
2019  */
2020 function matching_page_type_patterns_from_pattern($pattern) {
2021     $patterns = array($pattern);
2022     if ($pattern === '*') {
2023         return $patterns;
2024     }
2026     // Only keep the part before the star because we will append -* to all the bits.
2027     $star = strpos($pattern, '-*');
2028     if ($star !== false) {
2029         $pattern = substr($pattern, 0, $star);
2030     }
2032     $patterns = array_merge($patterns, matching_page_type_patterns($pattern));
2033     $patterns = array_unique($patterns);
2035     return $patterns;
2038 /**
2039  * Given a specific page type, parent context and currect context, return all the page type patterns
2040  * that might be used by this block.
2041  *
2042  * @param string $pagetype for example 'course-view-weeks' or 'mod-quiz-view'.
2043  * @param stdClass $parentcontext Block's parent context
2044  * @param stdClass $currentcontext Current context of block
2045  * @return array an array of all the page type patterns that might match this page type.
2046  */
2047 function generate_page_type_patterns($pagetype, $parentcontext = null, $currentcontext = null) {
2048     global $CFG; // Required for includes bellow.
2050     $bits = explode('-', $pagetype);
2052     $core = core_component::get_core_subsystems();
2053     $plugins = core_component::get_plugin_types();
2055     //progressively strip pieces off the page type looking for a match
2056     $componentarray = null;
2057     for ($i = count($bits); $i > 0; $i--) {
2058         $possiblecomponentarray = array_slice($bits, 0, $i);
2059         $possiblecomponent = implode('', $possiblecomponentarray);
2061         // Check to see if the component is a core component
2062         if (array_key_exists($possiblecomponent, $core) && !empty($core[$possiblecomponent])) {
2063             $libfile = $core[$possiblecomponent].'/lib.php';
2064             if (file_exists($libfile)) {
2065                 require_once($libfile);
2066                 $function = $possiblecomponent.'_page_type_list';
2067                 if (function_exists($function)) {
2068                     if ($patterns = $function($pagetype, $parentcontext, $currentcontext)) {
2069                         break;
2070                     }
2071                 }
2072             }
2073         }
2075         //check the plugin directory and look for a callback
2076         if (array_key_exists($possiblecomponent, $plugins) && !empty($plugins[$possiblecomponent])) {
2078             //We've found a plugin type. Look for a plugin name by getting the next section of page type
2079             if (count($bits) > $i) {
2080                 $pluginname = $bits[$i];
2081                 $directory = core_component::get_plugin_directory($possiblecomponent, $pluginname);
2082                 if (!empty($directory)){
2083                     $libfile = $directory.'/lib.php';
2084                     if (file_exists($libfile)) {
2085                         require_once($libfile);
2086                         $function = $possiblecomponent.'_'.$pluginname.'_page_type_list';
2087                         if (!function_exists($function)) {
2088                             $function = $pluginname.'_page_type_list';
2089                         }
2090                         if (function_exists($function)) {
2091                             if ($patterns = $function($pagetype, $parentcontext, $currentcontext)) {
2092                                 break;
2093                             }
2094                         }
2095                     }
2096                 }
2097             }
2099             //we'll only get to here if we still don't have any patterns
2100             //the plugin type may have a callback
2101             $directory = $plugins[$possiblecomponent];
2102             $libfile = $directory.'/lib.php';
2103             if (file_exists($libfile)) {
2104                 require_once($libfile);
2105                 $function = $possiblecomponent.'_page_type_list';
2106                 if (function_exists($function)) {
2107                     if ($patterns = $function($pagetype, $parentcontext, $currentcontext)) {
2108                         break;
2109                     }
2110                 }
2111             }
2112         }
2113     }
2115     if (empty($patterns)) {
2116         $patterns = default_page_type_list($pagetype, $parentcontext, $currentcontext);
2117     }
2119     // Ensure that the * pattern is always available if editing block 'at distance', so
2120     // we always can 'bring back' it to the original context. MDL-30340
2121     if ((!isset($currentcontext) or !isset($parentcontext) or $currentcontext->id != $parentcontext->id) && !isset($patterns['*'])) {
2122         // TODO: We could change the string here, showing its 'bring back' meaning
2123         $patterns['*'] = get_string('page-x', 'pagetype');
2124     }
2126     return $patterns;
2129 /**
2130  * Generates a default page type list when a more appropriate callback cannot be decided upon.
2131  *
2132  * @param string $pagetype
2133  * @param stdClass $parentcontext
2134  * @param stdClass $currentcontext
2135  * @return array
2136  */
2137 function default_page_type_list($pagetype, $parentcontext = null, $currentcontext = null) {
2138     // Generate page type patterns based on current page type if
2139     // callbacks haven't been defined
2140     $patterns = array($pagetype => $pagetype);
2141     $bits = explode('-', $pagetype);
2142     while (count($bits) > 0) {
2143         $pattern = implode('-', $bits) . '-*';
2144         $pagetypestringname = 'page-'.str_replace('*', 'x', $pattern);
2145         // guessing page type description
2146         if (get_string_manager()->string_exists($pagetypestringname, 'pagetype')) {
2147             $patterns[$pattern] = get_string($pagetypestringname, 'pagetype');
2148         } else {
2149             $patterns[$pattern] = $pattern;
2150         }
2151         array_pop($bits);
2152     }
2153     $patterns['*'] = get_string('page-x', 'pagetype');
2154     return $patterns;
2157 /**
2158  * Generates the page type list for the my moodle page
2159  *
2160  * @param string $pagetype
2161  * @param stdClass $parentcontext
2162  * @param stdClass $currentcontext
2163  * @return array
2164  */
2165 function my_page_type_list($pagetype, $parentcontext = null, $currentcontext = null) {
2166     return array('my-index' => get_string('page-my-index', 'pagetype'));
2169 /**
2170  * Generates the page type list for a module by either locating and using the modules callback
2171  * or by generating a default list.
2172  *
2173  * @param string $pagetype
2174  * @param stdClass $parentcontext
2175  * @param stdClass $currentcontext
2176  * @return array
2177  */
2178 function mod_page_type_list($pagetype, $parentcontext = null, $currentcontext = null) {
2179     $patterns = plugin_page_type_list($pagetype, $parentcontext, $currentcontext);
2180     if (empty($patterns)) {
2181         // if modules don't have callbacks
2182         // generate two default page type patterns for modules only
2183         $bits = explode('-', $pagetype);
2184         $patterns = array($pagetype => $pagetype);
2185         if ($bits[2] == 'view') {
2186             $patterns['mod-*-view'] = get_string('page-mod-x-view', 'pagetype');
2187         } else if ($bits[2] == 'index') {
2188             $patterns['mod-*-index'] = get_string('page-mod-x-index', 'pagetype');
2189         }
2190     }
2191     return $patterns;
2193 /// Functions update the blocks if required by the request parameters ==========
2195 /**
2196  * Return a {@link block_contents} representing the add a new block UI, if
2197  * this user is allowed to see it.
2198  *
2199  * @return block_contents an appropriate block_contents, or null if the user
2200  * cannot add any blocks here.
2201  */
2202 function block_add_block_ui($page, $output) {
2203     global $CFG, $OUTPUT;
2204     if (!$page->user_is_editing() || !$page->user_can_edit_blocks()) {
2205         return null;
2206     }
2208     $bc = new block_contents();
2209     $bc->title = get_string('addblock');
2210     $bc->add_class('block_adminblock');
2211     $bc->attributes['data-block'] = 'adminblock';
2213     $missingblocks = $page->blocks->get_addable_blocks();
2214     if (empty($missingblocks)) {
2215         $bc->content = get_string('noblockstoaddhere');
2216         return $bc;
2217     }
2219     $menu = array();
2220     foreach ($missingblocks as $block) {
2221         $menu[$block->name] = $block->title;
2222     }
2224     $actionurl = new moodle_url($page->url, array('sesskey'=>sesskey()));
2225     $select = new single_select($actionurl, 'bui_addblock', $menu, null, array(''=>get_string('adddots')), 'add_block');
2226     $select->set_label(get_string('addblock'), array('class'=>'accesshide'));
2227     $bc->content = $OUTPUT->render($select);
2228     return $bc;
2231 /**
2232  * Actually delete from the database any blocks that are currently on this page,
2233  * but which should not be there according to blocks_name_allowed_in_format.
2234  *
2235  * @todo Write/Fix this function. Currently returns immediately
2236  * @param $course
2237  */
2238 function blocks_remove_inappropriate($course) {
2239     // TODO
2240     return;
2241     /*
2242     $blockmanager = blocks_get_by_page($page);
2244     if (empty($blockmanager)) {
2245         return;
2246     }
2248     if (($pageformat = $page->pagetype) == NULL) {
2249         return;
2250     }
2252     foreach($blockmanager as $region) {
2253         foreach($region as $instance) {
2254             $block = blocks_get_record($instance->blockid);
2255             if(!blocks_name_allowed_in_format($block->name, $pageformat)) {
2256                blocks_delete_instance($instance->instance);
2257             }
2258         }
2259     }*/
2262 /**
2263  * Check that a given name is in a permittable format
2264  *
2265  * @param string $name
2266  * @param string $pageformat
2267  * @return bool
2268  */
2269 function blocks_name_allowed_in_format($name, $pageformat) {
2270     $accept = NULL;
2271     $maxdepth = -1;
2272     if (!$bi = block_instance($name)) {
2273         return false;
2274     }
2276     $formats = $bi->applicable_formats();
2277     if (!$formats) {
2278         $formats = array();
2279     }
2280     foreach ($formats as $format => $allowed) {
2281         $formatregex = '/^'.str_replace('*', '[^-]*', $format).'.*$/';
2282         $depth = substr_count($format, '-');
2283         if (preg_match($formatregex, $pageformat) && $depth > $maxdepth) {
2284             $maxdepth = $depth;
2285             $accept = $allowed;
2286         }
2287     }
2288     if ($accept === NULL) {
2289         $accept = !empty($formats['all']);
2290     }
2291     return $accept;
2294 /**
2295  * Delete a block, and associated data.
2296  *
2297  * @param object $instance a row from the block_instances table
2298  * @param bool $nolongerused legacy parameter. Not used, but kept for backwards compatibility.
2299  * @param bool $skipblockstables for internal use only. Makes @see blocks_delete_all_for_context() more efficient.
2300  */
2301 function blocks_delete_instance($instance, $nolongerused = false, $skipblockstables = false) {
2302     global $DB;
2304     // Allow plugins to use this block before we completely delete it.
2305     if ($pluginsfunction = get_plugins_with_function('pre_block_delete')) {
2306         foreach ($pluginsfunction as $plugintype => $plugins) {
2307             foreach ($plugins as $pluginfunction) {
2308                 $pluginfunction($instance);
2309             }
2310         }
2311     }
2313     if ($block = block_instance($instance->blockname, $instance)) {
2314         $block->instance_delete();
2315     }
2316     context_helper::delete_instance(CONTEXT_BLOCK, $instance->id);
2318     if (!$skipblockstables) {
2319         $DB->delete_records('block_positions', array('blockinstanceid' => $instance->id));
2320         $DB->delete_records('block_instances', array('id' => $instance->id));
2321         $DB->delete_records_list('user_preferences', 'name', array('block'.$instance->id.'hidden','docked_block_instance_'.$instance->id));
2322     }
2325 /**
2326  * Delete multiple blocks at once.
2327  *
2328  * @param array $instanceids A list of block instance ID.
2329  */
2330 function blocks_delete_instances($instanceids) {
2331     global $DB;
2333     $limit = 1000;
2334     $count = count($instanceids);
2335     $chunks = [$instanceids];
2336     if ($count > $limit) {
2337         $chunks = array_chunk($instanceids, $limit);
2338     }
2340     // Perform deletion for each chunk.
2341     foreach ($chunks as $chunk) {
2342         $instances = $DB->get_recordset_list('block_instances', 'id', $chunk);
2343         foreach ($instances as $instance) {
2344             blocks_delete_instance($instance, false, true);
2345         }
2346         $instances->close();
2348         $DB->delete_records_list('block_positions', 'blockinstanceid', $chunk);
2349         $DB->delete_records_list('block_instances', 'id', $chunk);
2351         $preferences = array();
2352         foreach ($chunk as $instanceid) {
2353             $preferences[] = 'block' . $instanceid . 'hidden';
2354             $preferences[] = 'docked_block_instance_' . $instanceid;
2355         }
2356         $DB->delete_records_list('user_preferences', 'name', $preferences);
2357     }
2360 /**
2361  * Delete all the blocks that belong to a particular context.
2362  *
2363  * @param int $contextid the context id.
2364  */
2365 function blocks_delete_all_for_context($contextid) {
2366     global $DB;
2367     $instances = $DB->get_recordset('block_instances', array('parentcontextid' => $contextid));
2368     foreach ($instances as $instance) {
2369         blocks_delete_instance($instance, true);
2370     }
2371     $instances->close();
2372     $DB->delete_records('block_instances', array('parentcontextid' => $contextid));
2373     $DB->delete_records('block_positions', array('contextid' => $contextid));
2376 /**
2377  * Set a block to be visible or hidden on a particular page.
2378  *
2379  * @param object $instance a row from the block_instances, preferably LEFT JOINed with the
2380  *      block_positions table as return by block_manager.
2381  * @param moodle_page $page the back to set the visibility with respect to.
2382  * @param integer $newvisibility 1 for visible, 0 for hidden.
2383  */
2384 function blocks_set_visibility($instance, $page, $newvisibility) {
2385     global $DB;
2386     if (!empty($instance->blockpositionid)) {
2387         // Already have local information on this page.
2388         $DB->set_field('block_positions', 'visible', $newvisibility, array('id' => $instance->blockpositionid));
2389         return;
2390     }
2392     // Create a new block_positions record.
2393     $bp = new stdClass;
2394     $bp->blockinstanceid = $instance->id;
2395     $bp->contextid = $page->context->id;
2396     $bp->pagetype = $page->pagetype;
2397     if ($page->subpage) {
2398         $bp->subpage = $page->subpage;
2399     }
2400     $bp->visible = $newvisibility;
2401     $bp->region = $instance->defaultregion;
2402     $bp->weight = $instance->defaultweight;
2403     $DB->insert_record('block_positions', $bp);
2406 /**
2407  * Get the block record for a particular blockid - that is, a particular type os block.
2408  *
2409  * @param $int blockid block type id. If null, an array of all block types is returned.
2410  * @param bool $notusedanymore No longer used.
2411  * @return array|object row from block table, or all rows.
2412  */
2413 function blocks_get_record($blockid = NULL, $notusedanymore = false) {
2414     global $PAGE;
2415     $blocks = $PAGE->blocks->get_installed_blocks();
2416     if ($blockid === NULL) {
2417         return $blocks;
2418     } else if (isset($blocks[$blockid])) {
2419         return $blocks[$blockid];
2420     } else {
2421         return false;
2422     }
2425 /**
2426  * Find a given block by its blockid within a provide array
2427  *
2428  * @param int $blockid
2429  * @param array $blocksarray
2430  * @return bool|object Instance if found else false
2431  */
2432 function blocks_find_block($blockid, $blocksarray) {
2433     if (empty($blocksarray)) {
2434         return false;
2435     }
2436     foreach($blocksarray as $blockgroup) {
2437         if (empty($blockgroup)) {
2438             continue;
2439         }
2440         foreach($blockgroup as $instance) {
2441             if($instance->blockid == $blockid) {
2442                 return $instance;
2443             }
2444         }
2445     }
2446     return false;
2449 // Functions for programatically adding default blocks to pages ================
2451  /**
2452   * Parse a list of default blocks. See config-dist for a description of the format.
2453   *
2454   * @param string $blocksstr Determines the starting point that the blocks are added in the region.
2455   * @return array the parsed list of default blocks
2456   */
2457 function blocks_parse_default_blocks_list($blocksstr) {
2458     $blocks = array();
2459     $bits = explode(':', $blocksstr);
2460     if (!empty($bits)) {
2461         $leftbits = trim(array_shift($bits));
2462         if ($leftbits != '') {
2463             $blocks[BLOCK_POS_LEFT] = explode(',', $leftbits);
2464         }
2465     }
2466     if (!empty($bits)) {
2467         $rightbits = trim(array_shift($bits));
2468         if ($rightbits != '') {
2469             $blocks[BLOCK_POS_RIGHT] = explode(',', $rightbits);
2470         }
2471     }
2472     return $blocks;
2475 /**
2476  * @return array the blocks that should be added to the site course by default.
2477  */
2478 function blocks_get_default_site_course_blocks() {
2479     global $CFG;
2481     if (isset($CFG->defaultblocks_site)) {
2482         return blocks_parse_default_blocks_list($CFG->defaultblocks_site);
2483     } else {
2484         return array(
2485             BLOCK_POS_LEFT => array(),
2486             BLOCK_POS_RIGHT => array()
2487         );
2488     }
2491 /**
2492  * Add the default blocks to a course.
2493  *
2494  * @param object $course a course object.
2495  */
2496 function blocks_add_default_course_blocks($course) {
2497     global $CFG;
2499     if (isset($CFG->defaultblocks_override)) {
2500         $blocknames = blocks_parse_default_blocks_list($CFG->defaultblocks_override);
2502     } else if ($course->id == SITEID) {
2503         $blocknames = blocks_get_default_site_course_blocks();
2505     } else if (isset($CFG->{'defaultblocks_' . $course->format})) {
2506         $blocknames = blocks_parse_default_blocks_list($CFG->{'defaultblocks_' . $course->format});
2508     } else {
2509         require_once($CFG->dirroot. '/course/lib.php');
2510         $blocknames = course_get_format($course)->get_default_blocks();
2512     }
2514     if ($course->id == SITEID) {
2515         $pagetypepattern = 'site-index';
2516     } else {
2517         $pagetypepattern = 'course-view-*';
2518     }
2519     $page = new moodle_page();
2520     $page->set_course($course);
2521     $page->blocks->add_blocks($blocknames, $pagetypepattern);
2524 /**
2525  * Add the default system-context blocks. E.g. the admin tree.
2526  */
2527 function blocks_add_default_system_blocks() {
2528     global $DB;
2530     $page = new moodle_page();
2531     $page->set_context(context_system::instance());
2532     // We don't add blocks required by the theme, they will be auto-created.
2533     $page->blocks->add_blocks(array(BLOCK_POS_LEFT => array('admin_bookmarks')), 'admin-*', null, null, 2);
2535     if ($defaultmypage = $DB->get_record('my_pages', array('userid' => null, 'name' => '__default', 'private' => 1))) {
2536         $subpagepattern = $defaultmypage->id;
2537     } else {
2538         $subpagepattern = null;
2539     }
2541     $newblocks = array('private_files', 'online_users', 'badges', 'calendar_month', 'calendar_upcoming');
2542     $newcontent = array('lp', 'course_overview');
2543     $page->blocks->add_blocks(array(BLOCK_POS_RIGHT => $newblocks, 'content' => $newcontent), 'my-index', $subpagepattern);