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