be0831f008c3e718d3ccb0ee931b8e701ed1a1c3
[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  * @deprecated since Moodle 2.0. No longer used.
33  */
34 define('BLOCK_MOVE_LEFT',   0x01);
35 define('BLOCK_MOVE_RIGHT',  0x02);
36 define('BLOCK_MOVE_UP',     0x04);
37 define('BLOCK_MOVE_DOWN',   0x08);
38 define('BLOCK_CONFIGURE',   0x10);
39 /**#@-*/
41 /**#@+
42  * Default names for the block regions in the standard theme.
43  */
44 define('BLOCK_POS_LEFT',  'side-pre');
45 define('BLOCK_POS_RIGHT', 'side-post');
46 /**#@-*/
48 /**#@+
49  * @deprecated since Moodle 2.0. No longer used.
50  */
51 define('BLOCKS_PINNED_TRUE',0);
52 define('BLOCKS_PINNED_FALSE',1);
53 define('BLOCKS_PINNED_BOTH',2);
54 /**#@-*/
56 /**
57  * Exception thrown when someone tried to do something with a block that does
58  * not exist on a page.
59  *
60  * @copyright 2009 Tim Hunt
61  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
62  * @since     Moodle 2.0
63  */
64 class block_not_on_page_exception extends moodle_exception {
65     /**
66      * Constructor
67      * @param int $instanceid the block instance id of the block that was looked for.
68      * @param object $page the current page.
69      */
70     public function __construct($instanceid, $page) {
71         $a = new stdClass;
72         $a->instanceid = $instanceid;
73         $a->url = $page->url->out();
74         parent::__construct('blockdoesnotexistonpage', '', $page->url->out(), $a);
75     }
76 }
78 /**
79  * This class keeps track of the block that should appear on a moodle_page.
80  *
81  * The page to work with as passed to the constructor.
82  *
83  * @copyright 2009 Tim Hunt
84  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
85  * @since     Moodle 2.0
86  */
87 class block_manager {
88     /**
89      * The UI normally only shows block weights between -MAX_WEIGHT and MAX_WEIGHT,
90      * although other weights are valid.
91      */
92     const MAX_WEIGHT = 10;
94 /// Field declarations =========================================================
96     /**
97      * the moodle_page we are managing blocks for.
98      * @var moodle_page
99      */
100     protected $page;
102     /** @var array region name => 1.*/
103     protected $regions = array();
105     /** @var string the region where new blocks are added.*/
106     protected $defaultregion = null;
108     /** @var array will be $DB->get_records('blocks') */
109     protected $allblocks = null;
111     /**
112      * @var array blocks that this user can add to this page. Will be a subset
113      * of $allblocks, but with array keys block->name. Access this via the
114      * {@link get_addable_blocks()} method to ensure it is lazy-loaded.
115      */
116     protected $addableblocks = null;
118     /**
119      * Will be an array region-name => array(db rows loaded in load_blocks);
120      * @var array
121      */
122     protected $birecordsbyregion = null;
124     /**
125      * array region-name => array(block objects); populated as necessary by
126      * the ensure_instances_exist method.
127      * @var array
128      */
129     protected $blockinstances = array();
131     /**
132      * array region-name => array(block_contents objects) what actually needs to
133      * be displayed in each region.
134      * @var array
135      */
136     protected $visibleblockcontent = array();
138     /**
139      * array region-name => array(block_contents objects) extra block-like things
140      * to be displayed in each region, before the real blocks.
141      * @var array
142      */
143     protected $extracontent = array();
145     /**
146      * Used by the block move id, to track whether a block is currently being moved.
147      *
148      * When you click on the move icon of a block, first the page needs to reload with
149      * extra UI for choosing a new position for a particular block. In that situation
150      * this field holds the id of the block being moved.
151      *
152      * @var integer|null
153      */
154     protected $movingblock = null;
156     /**
157      * Show only fake blocks
158      */
159     protected $fakeblocksonly = false;
161 /// Constructor ================================================================
163     /**
164      * Constructor.
165      * @param object $page the moodle_page object object we are managing the blocks for,
166      * or a reasonable faxilimily. (See the comment at the top of this class
167      * and {@link http://en.wikipedia.org/wiki/Duck_typing})
168      */
169     public function __construct($page) {
170         $this->page = $page;
171     }
173 /// Getter methods =============================================================
175     /**
176      * Get an array of all region names on this page where a block may appear
177      *
178      * @return array the internal names of the regions on this page where block may appear.
179      */
180     public function get_regions() {
181         if (is_null($this->defaultregion)) {
182             $this->page->initialise_theme_and_output();
183         }
184         return array_keys($this->regions);
185     }
187     /**
188      * Get the region name of the region blocks are added to by default
189      *
190      * @return string the internal names of the region where new blocks are added
191      * by default, and where any blocks from an unrecognised region are shown.
192      * (Imagine that blocks were added with one theme selected, then you switched
193      * to a theme with different block positions.)
194      */
195     public function get_default_region() {
196         $this->page->initialise_theme_and_output();
197         return $this->defaultregion;
198     }
200     /**
201      * The list of block types that may be added to this page.
202      *
203      * @return array block name => record from block table.
204      */
205     public function get_addable_blocks() {
206         $this->check_is_loaded();
208         if (!is_null($this->addableblocks)) {
209             return $this->addableblocks;
210         }
212         // Lazy load.
213         $this->addableblocks = array();
215         $allblocks = blocks_get_record();
216         if (empty($allblocks)) {
217             return $this->addableblocks;
218         }
220         $pageformat = $this->page->pagetype;
221         foreach($allblocks as $block) {
222             if ($block->visible &&
223                     (block_method_result($block->name, 'instance_allow_multiple') || !$this->is_block_present($block->name)) &&
224                     blocks_name_allowed_in_format($block->name, $pageformat) &&
225                     block_method_result($block->name, 'user_can_addto', $this->page)) {
226                 $this->addableblocks[$block->name] = $block;
227             }
228         }
230         return $this->addableblocks;
231     }
233     /**
234      * Given a block name, find out of any of them are currently present in the page
236      * @param string $blockname - the basic name of a block (eg "navigation")
237      * @return boolean - is there one of these blocks in the current page?
238      */
239     public function is_block_present($blockname) {
240         if (empty($this->blockinstances)) {
241             return false;
242         }
244         foreach ($this->blockinstances as $region) {
245             foreach ($region as $instance) {
246                 if (empty($instance->instance->blockname)) {
247                     continue;
248                 }
249                 if ($instance->instance->blockname == $blockname) {
250                     return true;
251                 }
252             }
253         }
254         return false;
255     }
257     /**
258      * Find out if a block type is known by the system
259      *
260      * @param string $blockname the name of the type of block.
261      * @param boolean $includeinvisible if false (default) only check 'visible' blocks, that is, blocks enabled by the admin.
262      * @return boolean true if this block in installed.
263      */
264     public function is_known_block_type($blockname, $includeinvisible = false) {
265         $blocks = $this->get_installed_blocks();
266         foreach ($blocks as $block) {
267             if ($block->name == $blockname && ($includeinvisible || $block->visible)) {
268                 return true;
269             }
270         }
271         return false;
272     }
274     /**
275      * Find out if a region exists on a page
276      *
277      * @param string $region a region name
278      * @return boolean true if this region exists on this page.
279      */
280     public function is_known_region($region) {
281         return array_key_exists($region, $this->regions);
282     }
284     /**
285      * Get an array of all blocks within a given region
286      *
287      * @param string $region a block region that exists on this page.
288      * @return array of block instances.
289      */
290     public function get_blocks_for_region($region) {
291         $this->check_is_loaded();
292         $this->ensure_instances_exist($region);
293         return $this->blockinstances[$region];
294     }
296     /**
297      * Returns an array of block content objects that exist in a region
298      *
299      * @param string $region a block region that exists on this page.
300      * @return array of block block_contents objects for all the blocks in a region.
301      */
302     public function get_content_for_region($region, $output) {
303         $this->check_is_loaded();
304         $this->ensure_content_created($region, $output);
305         return $this->visibleblockcontent[$region];
306     }
308     /**
309      * Helper method used by get_content_for_region.
310      * @param string $region region name
311      * @param float $weight weight. May be fractional, since you may want to move a block
312      * between ones with weight 2 and 3, say ($weight would be 2.5).
313      * @return string URL for moving block $this->movingblock to this position.
314      */
315     protected function get_move_target_url($region, $weight) {
316         return new moodle_url($this->page->url, array('bui_moveid' => $this->movingblock,
317                 'bui_newregion' => $region, 'bui_newweight' => $weight, 'sesskey' => sesskey()));
318     }
320     /**
321      * Determine whether a region contains anything. (Either any real blocks, or
322      * the add new block UI.)
323      *
324      * (You may wonder why the $output parameter is required. Unfortunately,
325      * because of the way that blocks work, the only reliable way to find out
326      * if a block will be visible is to get the content for output, and to
327      * get the content, you need a renderer. Fortunately, this is not a
328      * performance problem, because we cache the output that is generated, and
329      * in almost every case where we call region_has_content, we are about to
330      * output the blocks anyway, so we are not doing wasted effort.)
331      *
332      * @param string $region a block region that exists on this page.
333      * @param object $output a core_renderer. normally the global $OUTPUT.
334      * @return boolean Whether there is anything in this region.
335      */
336     public function region_has_content($region, $output) {
338         if (!$this->is_known_region($region)) {
339             return false;
340         }
341         $this->check_is_loaded();
342         $this->ensure_content_created($region, $output);
343         if ($this->page->user_is_editing() && $this->page->user_can_edit_blocks()) {
344             // If editing is on, we need all the block regions visible, for the
345             // move blocks UI.
346             return true;
347         }
348         return !empty($this->visibleblockcontent[$region]) || !empty($this->extracontent[$region]);
349     }
351     /**
352      * Get an array of all of the installed blocks.
353      *
354      * @return array contents of the block table.
355      */
356     public function get_installed_blocks() {
357         global $DB;
358         if (is_null($this->allblocks)) {
359             $this->allblocks = $DB->get_records('block');
360         }
361         return $this->allblocks;
362     }
364 /// Setter methods =============================================================
366     /**
367      * Add a region to a page
368      *
369      * @param string $region add a named region where blocks may appear on the
370      * current page. This is an internal name, like 'side-pre', not a string to
371      * display in the UI.
372      */
373     public function add_region($region) {
374         $this->check_not_yet_loaded();
375         $this->regions[$region] = 1;
376     }
378     /**
379      * Add an array of regions
380      * @see add_region()
381      *
382      * @param array $regions this utility method calls add_region for each array element.
383      */
384     public function add_regions($regions) {
385         foreach ($regions as $region) {
386             $this->add_region($region);
387         }
388     }
390     /**
391      * Set the default region for new blocks on the page
392      *
393      * @param string $defaultregion the internal names of the region where new
394      * blocks should be added by default, and where any blocks from an
395      * unrecognised region are shown.
396      */
397     public function set_default_region($defaultregion) {
398         $this->check_not_yet_loaded();
399         if ($defaultregion) {
400             $this->check_region_is_known($defaultregion);
401         }
402         $this->defaultregion = $defaultregion;
403     }
405     /**
406      * Add something that looks like a block, but which isn't an actual block_instance,
407      * to this page.
408      *
409      * @param block_contents $bc the content of the block like thing.
410      * @param string $region a block region that exists on this page.
411      */
412     public function add_pretend_block($bc, $region) {
413         $this->page->initialise_theme_and_output();
414         if (!$this->is_known_region($region)) {
415             $region = $this->get_default_region();
416         }
417         if (array_key_exists($region, $this->visibleblockcontent)) {
418             throw new coding_exception('block_manager has already prepared the blocks in region ' .
419                     $region . 'for output. It is too late to add a pretend block.');
420         }
421         $this->extracontent[$region][] = $bc;
422     }
424     /**
425      * Checks to see whether all of the blocks within the given region are docked
426      *
427      * @see region_uses_dock
428      * @param string $region
429      * @return bool True if all of the blocks within that region are docked
430      */
431     public function region_completely_docked($region, $output) {
432         if (!$this->page->theme->enable_dock) {
433             return false;
434         }
435         $this->check_is_loaded();
436         $this->ensure_content_created($region, $output);
437         foreach($this->visibleblockcontent[$region] as $instance) {
438             if (!empty($instance->content) && !get_user_preferences('docked_block_instance_'.$instance->blockinstanceid, 0)) {
439                 return false;
440             }
441         }
442         return true;
443     }
445     /**
446      * Checks to see whether any of the blocks within the given regions are docked
447      *
448      * @see region_completely_docked
449      * @param array|string $regions array of regions (or single region)
450      * @return bool True if any of the blocks within that region are docked
451      */
452     public function region_uses_dock($regions, $output) {
453         if (!$this->page->theme->enable_dock) {
454             return false;
455         }
456         $this->check_is_loaded();
457         foreach((array)$regions as $region) {
458             $this->ensure_content_created($region, $output);
459             foreach($this->visibleblockcontent[$region] as $instance) {
460                 if(!empty($instance->content) && get_user_preferences('docked_block_instance_'.$instance->blockinstanceid, 0)) {
461                     return true;
462                 }
463             }
464         }
465         return false;
466     }
468 /// Actions ====================================================================
470     /**
471      * This method actually loads the blocks for our page from the database.
472      *
473      * @param boolean|null $includeinvisible
474      *      null (default) - load hidden blocks if $this->page->user_is_editing();
475      *      true - load hidden blocks.
476      *      false - don't load hidden blocks.
477      */
478     public function load_blocks($includeinvisible = null) {
479         global $DB, $CFG;
481         if (!is_null($this->birecordsbyregion)) {
482             // Already done.
483             return;
484         }
486         if ($CFG->version < 2009050619) {
487             // Upgrade/install not complete. Don't try too show any blocks.
488             $this->birecordsbyregion = array();
489             return;
490         }
492         // Ensure we have been initialised.
493         if (is_null($this->defaultregion)) {
494             $this->page->initialise_theme_and_output();
495             // If there are still no block regions, then there are no blocks on this page.
496             if (empty($this->regions)) {
497                 $this->birecordsbyregion = array();
498                 return;
499             }
500         }
502         // Check if we need to load normal blocks
503         if ($this->fakeblocksonly) {
504             $this->birecordsbyregion = $this->prepare_per_region_arrays();
505             return;
506         }
508         if (is_null($includeinvisible)) {
509             $includeinvisible = $this->page->user_is_editing();
510         }
511         if ($includeinvisible) {
512             $visiblecheck = '';
513         } else {
514             $visiblecheck = 'AND (bp.visible = 1 OR bp.visible IS NULL)';
515         }
517         $context = $this->page->context;
518         $contexttest = 'bi.parentcontextid = :contextid2';
519         $parentcontextparams = array();
520         $parentcontextids = get_parent_contexts($context);
521         if ($parentcontextids) {
522             list($parentcontexttest, $parentcontextparams) =
523                     $DB->get_in_or_equal($parentcontextids, SQL_PARAMS_NAMED, 'parentcontext0000');
524             $contexttest = "($contexttest OR (bi.showinsubcontexts = 1 AND bi.parentcontextid $parentcontexttest))";
525         }
527         $pagetypepatterns = matching_page_type_patterns($this->page->pagetype);
528         list($pagetypepatterntest, $pagetypepatternparams) =
529                 $DB->get_in_or_equal($pagetypepatterns, SQL_PARAMS_NAMED, 'pagetypepatterntest0000');
531         list($ccselect, $ccjoin) = context_instance_preload_sql('b.id', CONTEXT_BLOCK, 'ctx');
533         $params = array(
534             'subpage1' => $this->page->subpage,
535             'subpage2' => $this->page->subpage,
536             'contextid1' => $context->id,
537             'contextid2' => $context->id,
538             'pagetype' => $this->page->pagetype,
539         );
540         $sql = "SELECT
541                     bi.id,
542                     bp.id AS blockpositionid,
543                     bi.blockname,
544                     bi.parentcontextid,
545                     bi.showinsubcontexts,
546                     bi.pagetypepattern,
547                     bi.subpagepattern,
548                     bi.defaultregion,
549                     bi.defaultweight,
550                     COALESCE(bp.visible, 1) AS visible,
551                     COALESCE(bp.region, bi.defaultregion) AS region,
552                     COALESCE(bp.weight, bi.defaultweight) AS weight,
553                     bi.configdata
554                     $ccselect
556                 FROM {block_instances} bi
557                 JOIN {block} b ON bi.blockname = b.name
558                 LEFT JOIN {block_positions} bp ON bp.blockinstanceid = bi.id
559                                                   AND bp.contextid = :contextid1
560                                                   AND bp.pagetype = :pagetype
561                                                   AND bp.subpage = :subpage1
562                 $ccjoin
564                 WHERE
565                 $contexttest
566                 AND bi.pagetypepattern $pagetypepatterntest
567                 AND (bi.subpagepattern IS NULL OR bi.subpagepattern = :subpage2)
568                 $visiblecheck
569                 AND b.visible = 1
571                 ORDER BY
572                     COALESCE(bp.region, bi.defaultregion),
573                     COALESCE(bp.weight, bi.defaultweight),
574                     bi.id";
575         $blockinstances = $DB->get_recordset_sql($sql, $params + $parentcontextparams + $pagetypepatternparams);
577         $this->birecordsbyregion = $this->prepare_per_region_arrays();
578         $unknown = array();
579         foreach ($blockinstances as $bi) {
580             context_instance_preload($bi);
581             if ($this->is_known_region($bi->region)) {
582                 $this->birecordsbyregion[$bi->region][] = $bi;
583             } else {
584                 $unknown[] = $bi;
585             }
586         }
588         // Pages don't necessarily have a defaultregion. The  one time this can
589         // happen is when there are no theme block regions, but the script itself
590         // has a block region in the main content area.
591         if (!empty($this->defaultregion)) {
592             $this->birecordsbyregion[$this->defaultregion] =
593                     array_merge($this->birecordsbyregion[$this->defaultregion], $unknown);
594         }
595     }
597     /**
598      * Add a block to the current page, or related pages. The block is added to
599      * context $this->page->contextid. If $pagetypepattern $subpagepattern
600      *
601      * @param string $blockname The type of block to add.
602      * @param string $region the block region on this page to add the block to.
603      * @param integer $weight determines the order where this block appears in the region.
604      * @param boolean $showinsubcontexts whether this block appears in subcontexts, or just the current context.
605      * @param string|null $pagetypepattern which page types this block should appear on. Defaults to just the current page type.
606      * @param string|null $subpagepattern which subpage this block should appear on. NULL = any (the default), otherwise only the specified subpage.
607      */
608     public function add_block($blockname, $region, $weight, $showinsubcontexts, $pagetypepattern = NULL, $subpagepattern = NULL) {
609         global $DB;
610         // Allow invisible blocks because this is used when adding default page blocks, which
611         // might include invisible ones if the user makes some default blocks invisible
612         $this->check_known_block_type($blockname, true);
613         $this->check_region_is_known($region);
615         if (empty($pagetypepattern)) {
616             $pagetypepattern = $this->page->pagetype;
617         }
619         $blockinstance = new stdClass;
620         $blockinstance->blockname = $blockname;
621         $blockinstance->parentcontextid = $this->page->context->id;
622         $blockinstance->showinsubcontexts = !empty($showinsubcontexts);
623         $blockinstance->pagetypepattern = $pagetypepattern;
624         $blockinstance->subpagepattern = $subpagepattern;
625         $blockinstance->defaultregion = $region;
626         $blockinstance->defaultweight = $weight;
627         $blockinstance->configdata = '';
628         $blockinstance->id = $DB->insert_record('block_instances', $blockinstance);
630         // Ensure the block context is created.
631         get_context_instance(CONTEXT_BLOCK, $blockinstance->id);
633         // If the new instance was created, allow it to do additional setup
634         if ($block = block_instance($blockname, $blockinstance)) {
635             $block->instance_create();
636         }
637     }
639     public function add_block_at_end_of_default_region($blockname) {
640         $defaulregion = $this->get_default_region();
642         $lastcurrentblock = end($this->birecordsbyregion[$defaulregion]);
643         if ($lastcurrentblock) {
644             $weight = $lastcurrentblock->weight + 1;
645         } else {
646             $weight = 0;
647         }
649         if ($this->page->subpage) {
650             $subpage = $this->page->subpage;
651         } else {
652             $subpage = null;
653         }
655         // Special case. Course view page type include the course format, but we
656         // want to add the block non-format-specifically.
657         $pagetypepattern = $this->page->pagetype;
658         if (strpos($pagetypepattern, 'course-view') === 0) {
659             $pagetypepattern = 'course-view-*';
660         }
662         $this->add_block($blockname, $defaulregion, $weight, false, $pagetypepattern, $subpage);
663     }
665     /**
666      * Convenience method, calls add_block repeatedly for all the blocks in $blocks.
667      *
668      * @param array $blocks array with array keys the region names, and values an array of block names.
669      * @param string $pagetypepattern optional. Passed to @see add_block()
670      * @param string $subpagepattern optional. Passed to @see add_block()
671      */
672     public function add_blocks($blocks, $pagetypepattern = NULL, $subpagepattern = NULL, $showinsubcontexts=false, $weight=0) {
673         $this->add_regions(array_keys($blocks));
674         foreach ($blocks as $region => $regionblocks) {
675             $weight = 0;
676             foreach ($regionblocks as $blockname) {
677                 $this->add_block($blockname, $region, $weight, $showinsubcontexts, $pagetypepattern, $subpagepattern);
678                 $weight += 1;
679             }
680         }
681     }
683     /**
684      * Move a block to a new position on this page.
685      *
686      * If this block cannot appear on any other pages, then we change defaultposition/weight
687      * in the block_instances table. Otherwise we just set the position on this page.
688      *
689      * @param $blockinstanceid the block instance id.
690      * @param $newregion the new region name.
691      * @param $newweight the new weight.
692      */
693     public function reposition_block($blockinstanceid, $newregion, $newweight) {
694         global $DB;
696         $this->check_region_is_known($newregion);
697         $inst = $this->find_instance($blockinstanceid);
699         $bi = $inst->instance;
700         if ($bi->weight == $bi->defaultweight && $bi->region == $bi->defaultregion &&
701                 !$bi->showinsubcontexts && strpos($bi->pagetypepattern, '*') === false &&
702                 (!$this->page->subpage || $bi->subpagepattern)) {
704             // Set default position
705             $newbi = new stdClass;
706             $newbi->id = $bi->id;
707             $newbi->defaultregion = $newregion;
708             $newbi->defaultweight = $newweight;
709             $DB->update_record('block_instances', $newbi);
711             if ($bi->blockpositionid) {
712                 $bp = new stdClass;
713                 $bp->id = $bi->blockpositionid;
714                 $bp->region = $newregion;
715                 $bp->weight = $newweight;
716                 $DB->update_record('block_positions', $bp);
717             }
719         } else {
720             // Just set position on this page.
721             $bp = new stdClass;
722             $bp->region = $newregion;
723             $bp->weight = $newweight;
725             if ($bi->blockpositionid) {
726                 $bp->id = $bi->blockpositionid;
727                 $DB->update_record('block_positions', $bp);
729             } else {
730                 $bp->blockinstanceid = $bi->id;
731                 $bp->contextid = $this->page->context->id;
732                 $bp->pagetype = $this->page->pagetype;
733                 if ($this->page->subpage) {
734                     $bp->subpage = $this->page->subpage;
735                 } else {
736                     $bp->subpage = '';
737                 }
738                 $bp->visible = $bi->visible;
739                 $DB->insert_record('block_positions', $bp);
740             }
741         }
742     }
744     /**
745      * Find a given block by its instance id
746      *
747      * @param integer $instanceid
748      * @return object
749      */
750     public function find_instance($instanceid) {
751         foreach ($this->regions as $region => $notused) {
752             $this->ensure_instances_exist($region);
753             foreach($this->blockinstances[$region] as $instance) {
754                 if ($instance->instance->id == $instanceid) {
755                     return $instance;
756                 }
757             }
758         }
759         throw new block_not_on_page_exception($instanceid, $this->page);
760     }
762 /// Inner workings =============================================================
764     /**
765      * Check whether the page blocks have been loaded yet
766      *
767      * @return void Throws coding exception if already loaded
768      */
769     protected function check_not_yet_loaded() {
770         if (!is_null($this->birecordsbyregion)) {
771             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.');
772         }
773     }
775     /**
776      * Check whether the page blocks have been loaded yet
777      *
778      * Nearly identical to the above function {@link check_not_yet_loaded()} except different message
779      *
780      * @return void Throws coding exception if already loaded
781      */
782     protected function check_is_loaded() {
783         if (is_null($this->birecordsbyregion)) {
784             throw new coding_exception('block_manager has not yet loaded the blocks, to it is too soon to request the information you asked for.');
785         }
786     }
788     /**
789      * Check if a block type is known and usable
790      *
791      * @param string $blockname The block type name to search for
792      * @param bool $includeinvisible Include disabled block types in the initial pass
793      * @return void Coding Exception thrown if unknown or not enabled
794      */
795     protected function check_known_block_type($blockname, $includeinvisible = false) {
796         if (!$this->is_known_block_type($blockname, $includeinvisible)) {
797             if ($this->is_known_block_type($blockname, true)) {
798                 throw new coding_exception('Unknown block type ' . $blockname);
799             } else {
800                 throw new coding_exception('Block type ' . $blockname . ' has been disabled by the administrator.');
801             }
802         }
803     }
805     /**
806      * Check if a region is known by its name
807      *
808      * @param string $region
809      * @return void Coding Exception thrown if the region is not known
810      */
811     protected function check_region_is_known($region) {
812         if (!$this->is_known_region($region)) {
813             throw new coding_exception('Trying to reference an unknown block region ' . $region);
814         }
815     }
817     /**
818      * Returns an array of region names as keys and nested arrays for values
819      *
820      * @return array an array where the array keys are the region names, and the array
821      * values are empty arrays.
822      */
823     protected function prepare_per_region_arrays() {
824         $result = array();
825         foreach ($this->regions as $region => $notused) {
826             $result[$region] = array();
827         }
828         return $result;
829     }
831     /**
832      * Create a set of new block instance from a record array
833      *
834      * @param array $birecords An array of block instance records
835      * @return array An array of instantiated block_instance objects
836      */
837     protected function create_block_instances($birecords) {
838         $results = array();
839         foreach ($birecords as $record) {
840             if ($blockobject = block_instance($record->blockname, $record, $this->page)) {
841                 $results[] = $blockobject;
842             }
843         }
844         return $results;
845     }
847     /**
848      * Create all the block instances for all the blocks that were loaded by
849      * load_blocks. This is used, for example, to ensure that all blocks get a
850      * chance to initialise themselves via the {@link block_base::specialize()}
851      * method, before any output is done.
852      */
853     public function create_all_block_instances() {
854         foreach ($this->get_regions() as $region) {
855             $this->ensure_instances_exist($region);
856         }
857     }
859     /**
860      * Return an array of content objects from a set of block instances
861      *
862      * @param array $instances An array of block instances
863      * @param renderer_base The renderer to use.
864      * @param string $region the region name.
865      * @return array An array of block_content (and possibly block_move_target) objects.
866      */
867     protected function create_block_contents($instances, $output, $region) {
868         $results = array();
870         $lastweight = 0;
871         $lastblock = 0;
872         if ($this->movingblock) {
873             $first = reset($instances);
874             if ($first) {
875                 $lastweight = $first->instance->weight - 2;
876             }
878             $strmoveblockhere = get_string('moveblockhere', 'block');
879         }
881         foreach ($instances as $instance) {
882             $content = $instance->get_content_for_output($output);
883             if (empty($content)) {
884                 continue;
885             }
887             if ($this->movingblock && $lastweight != $instance->instance->weight &&
888                     $content->blockinstanceid != $this->movingblock && $lastblock != $this->movingblock) {
889                 $results[] = new block_move_target($strmoveblockhere, $this->get_move_target_url($region, ($lastweight + $instance->instance->weight)/2));
890             }
892             if ($content->blockinstanceid == $this->movingblock) {
893                 $content->add_class('beingmoved');
894                 $content->annotation .= get_string('movingthisblockcancel', 'block',
895                         html_writer::link($this->page->url, get_string('cancel')));
896             }
898             $results[] = $content;
899             $lastweight = $instance->instance->weight;
900             $lastblock = $instance->instance->id;
901         }
903         if ($this->movingblock && $lastblock != $this->movingblock) {
904             $results[] = new block_move_target($strmoveblockhere, $this->get_move_target_url($region, $lastweight + 1));
905         }
906         return $results;
907     }
909     /**
910      * Ensure block instances exist for a given region
911      *
912      * @param string $region Check for bi's with the instance with this name
913      */
914     protected function ensure_instances_exist($region) {
915         $this->check_region_is_known($region);
916         if (!array_key_exists($region, $this->blockinstances)) {
917             $this->blockinstances[$region] =
918                     $this->create_block_instances($this->birecordsbyregion[$region]);
919         }
920     }
922     /**
923      * Ensure that there is some content within the given region
924      *
925      * @param string $region The name of the region to check
926      */
927     protected function ensure_content_created($region, $output) {
928         $this->ensure_instances_exist($region);
929         if (!array_key_exists($region, $this->visibleblockcontent)) {
930             $contents = array();
931             if (array_key_exists($region, $this->extracontent)) {
932                 $contents = $this->extracontent[$region];
933             }
934             $contents = array_merge($contents, $this->create_block_contents($this->blockinstances[$region], $output, $region));
935             if ($region == $this->defaultregion) {
936                 $addblockui = block_add_block_ui($this->page, $output);
937                 if ($addblockui) {
938                     $contents[] = $addblockui;
939                 }
940             }
941             $this->visibleblockcontent[$region] = $contents;
942         }
943     }
945 /// Process actions from the URL ===============================================
947     /**
948      * Get the appropriate list of editing icons for a block. This is used
949      * to set {@link block_contents::$controls} in {@link block_base::get_contents_for_output()}.
950      *
951      * @param $output The core_renderer to use when generating the output. (Need to get icon paths.)
952      * @return an array in the format for {@link block_contents::$controls}
953      */
954     public function edit_controls($block) {
955         global $CFG;
957         if (!isset($CFG->undeletableblocktypes) || (!is_array($CFG->undeletableblocktypes) && !is_string($CFG->undeletableblocktypes))) {
958             $CFG->undeletableblocktypes = array('navigation','settings');
959         } else if (is_string($CFG->undeletableblocktypes)) {
960             $CFG->undeletableblocktypes = explode(',', $CFG->undeletableblocktypes);
961         }
963         $controls = array();
964         $actionurl = $this->page->url->out(false, array('sesskey'=> sesskey()));
966         // Assign roles icon.
967         if (has_capability('moodle/role:assign', $block->context)) {
968             //TODO: please note it is sloppy to pass urls through page parameters!!
969             //      it is shortened because some web servers (e.g. IIS by default) give
970             //      a 'security' error if you try to pass a full URL as a GET parameter in another URL.
972             $return = $this->page->url->out(false);
973             $return = str_replace($CFG->wwwroot . '/', '', $return);
975             $controls[] = array('url' => $CFG->wwwroot . '/' . $CFG->admin .
976                     '/roles/assign.php?contextid=' . $block->context->id . '&returnurl=' . urlencode($return),
977                     'icon' => 'i/roles', 'caption' => get_string('assignroles', 'role'));
978         }
980         if ($this->page->user_can_edit_blocks() && $block->instance_can_be_hidden()) {
981             // Show/hide icon.
982             if ($block->instance->visible) {
983                 $controls[] = array('url' => $actionurl . '&bui_hideid=' . $block->instance->id,
984                         'icon' => 't/hide', 'caption' => get_string('hide'));
985             } else {
986                 $controls[] = array('url' => $actionurl . '&bui_showid=' . $block->instance->id,
987                         'icon' => 't/show', 'caption' => get_string('show'));
988             }
989         }
991         if ($this->page->user_can_edit_blocks() || $block->user_can_edit()) {
992             // Edit config icon - always show - needed for positioning UI.
993             $controls[] = array('url' => $actionurl . '&bui_editid=' . $block->instance->id,
994                     'icon' => 't/edit', 'caption' => get_string('configuration'));
995         }
997         if ($this->page->user_can_edit_blocks() && $block->user_can_edit() && $block->user_can_addto($this->page)) {
998             if (!in_array($block->instance->blockname, $CFG->undeletableblocktypes)) {
999                 // Delete icon.
1000                 $controls[] = array('url' => $actionurl . '&bui_deleteid=' . $block->instance->id,
1001                         'icon' => 't/delete', 'caption' => get_string('delete'));
1002             }
1003         }
1005         if ($this->page->user_can_edit_blocks()) {
1006             // Move icon.
1007             $controls[] = array('url' => $actionurl . '&bui_moveid=' . $block->instance->id,
1008                     'icon' => 't/move', 'caption' => get_string('move'));
1009         }
1011         return $controls;
1012     }
1014     /**
1015      * Process any block actions that were specified in the URL.
1016      *
1017      * This can only be done given a valid $page object.
1018      *
1019      * @param moodle_page $page the page to add blocks to.
1020      * @return boolean true if anything was done. False if not.
1021      */
1022     public function process_url_actions() {
1023         if (!$this->page->user_is_editing()) {
1024             return false;
1025         }
1026         return $this->process_url_add() || $this->process_url_delete() ||
1027             $this->process_url_show_hide() || $this->process_url_edit() ||
1028             $this->process_url_move();
1029     }
1031     /**
1032      * Handle adding a block.
1033      * @return boolean true if anything was done. False if not.
1034      */
1035     public function process_url_add() {
1036         $blocktype = optional_param('bui_addblock', null, PARAM_SAFEDIR);
1037         if (!$blocktype) {
1038             return false;
1039         }
1041         require_sesskey();
1043         if (!$this->page->user_can_edit_blocks()) {
1044             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('addblock'));
1045         }
1047         if (!array_key_exists($blocktype, $this->get_addable_blocks())) {
1048             throw new moodle_exception('cannotaddthisblocktype', '', $this->page->url->out(), $blocktype);
1049         }
1051         $this->add_block_at_end_of_default_region($blocktype);
1053         // If the page URL was a guess, it will contain the bui_... param, so we must make sure it is not there.
1054         $this->page->ensure_param_not_in_url('bui_addblock');
1056         return true;
1057     }
1059     /**
1060      * Handle deleting a block.
1061      * @return boolean true if anything was done. False if not.
1062      */
1063     public function process_url_delete() {
1064         $blockid = optional_param('bui_deleteid', null, PARAM_INTEGER);
1065         if (!$blockid) {
1066             return false;
1067         }
1069         require_sesskey();
1071         $block = $this->page->blocks->find_instance($blockid);
1073         if (!$block->user_can_edit() || !$this->page->user_can_edit_blocks() || !$block->user_can_addto($this->page)) {
1074             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('deleteablock'));
1075         }
1077         blocks_delete_instance($block->instance);
1079         // If the page URL was a guess, it will contain the bui_... param, so we must make sure it is not there.
1080         $this->page->ensure_param_not_in_url('bui_deleteid');
1082         return true;
1083     }
1085     /**
1086      * Handle showing or hiding a block.
1087      * @return boolean true if anything was done. False if not.
1088      */
1089     public function process_url_show_hide() {
1090         if ($blockid = optional_param('bui_hideid', null, PARAM_INTEGER)) {
1091             $newvisibility = 0;
1092         } else if ($blockid = optional_param('bui_showid', null, PARAM_INTEGER)) {
1093             $newvisibility = 1;
1094         } else {
1095             return false;
1096         }
1098         require_sesskey();
1100         $block = $this->page->blocks->find_instance($blockid);
1102         if (!$this->page->user_can_edit_blocks()) {
1103             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('hideshowblocks'));
1104         } else if (!$block->instance_can_be_hidden()) {
1105             return false;
1106         }
1108         blocks_set_visibility($block->instance, $this->page, $newvisibility);
1110         // If the page URL was a guses, it will contain the bui_... param, so we must make sure it is not there.
1111         $this->page->ensure_param_not_in_url('bui_hideid');
1112         $this->page->ensure_param_not_in_url('bui_showid');
1114         return true;
1115     }
1117     /**
1118      * Handle showing/processing the submission from the block editing form.
1119      * @return boolean true if the form was submitted and the new config saved. Does not
1120      *      return if the editing form was displayed. False otherwise.
1121      */
1122     public function process_url_edit() {
1123         global $CFG, $DB, $PAGE;
1125         $blockid = optional_param('bui_editid', null, PARAM_INTEGER);
1126         if (!$blockid) {
1127             return false;
1128         }
1130         require_sesskey();
1131         require_once($CFG->dirroot . '/blocks/edit_form.php');
1133         $block = $this->find_instance($blockid);
1135         if (!$block->user_can_edit() && !$this->page->user_can_edit_blocks()) {
1136             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('editblock'));
1137         }
1139         $editpage = new moodle_page();
1140         $editpage->set_pagelayout('admin');
1141         $editpage->set_course($this->page->course);
1142         $editpage->set_context($block->context);
1143         if ($this->page->cm) {
1144             $editpage->set_cm($this->page->cm);
1145         }
1146         $editurlbase = str_replace($CFG->wwwroot . '/', '/', $this->page->url->out_omit_querystring());
1147         $editurlparams = $this->page->url->params();
1148         $editurlparams['bui_editid'] = $blockid;
1149         $editpage->set_url($editurlbase, $editurlparams);
1150         $editpage->set_block_actions_done();
1151         // At this point we are either going to redirect, or display the form, so
1152         // overwrite global $PAGE ready for this. (Formslib refers to it.)
1153         $PAGE = $editpage;
1155         $formfile = $CFG->dirroot . '/blocks/' . $block->name() . '/edit_form.php';
1156         if (is_readable($formfile)) {
1157             require_once($formfile);
1158             $classname = 'block_' . $block->name() . '_edit_form';
1159             if (!class_exists($classname)) {
1160                 $classname = 'block_edit_form';
1161             }
1162         } else {
1163             $classname = 'block_edit_form';
1164         }
1166         $mform = new $classname($editpage->url, $block, $this->page);
1167         $mform->set_data($block->instance);
1169         if ($mform->is_cancelled()) {
1170             redirect($this->page->url);
1172         } else if ($data = $mform->get_data()) {
1173             $bi = new stdClass;
1174             $bi->id = $block->instance->id;
1175             $bi->pagetypepattern = $data->bui_pagetypepattern;
1176             if (empty($data->bui_subpagepattern) || $data->bui_subpagepattern == '%@NULL@%') {
1177                 $bi->subpagepattern = null;
1178             } else {
1179                 $bi->subpagepattern = $data->bui_subpagepattern;
1180             }
1182             $parentcontext = get_context_instance_by_id($data->bui_parentcontextid);
1183             $systemcontext = get_context_instance(CONTEXT_SYSTEM);
1185             // Updating stickiness and contexts.  See MDL-21375 for details.
1186             if (has_capability('moodle/site:manageblocks', $parentcontext)) { // Check permissions in destination
1187                 // Explicitly set the context
1188                 $bi->parentcontextid = $parentcontext->id;
1190                 // If the context type is > 0 then we'll explicitly set the block as sticky, otherwise not
1191                 $bi->showinsubcontexts = (int)(!empty($data->bui_contexts));
1193                 // If the block wants to be system-wide, then explicitly set that
1194                 if ($data->bui_contexts == 2) {   // Only possible on a frontpage or system page
1195                     $bi->parentcontextid = $systemcontext->id;
1197                 } else { // The block doesn't want to be system-wide, so let's ensure that
1198                     if ($parentcontext->id == $systemcontext->id) {  // We need to move it to the front page
1199                         $frontpagecontext = get_context_instance(CONTEXT_COURSE, SITEID);
1200                         $bi->parentcontextid = $frontpagecontext->id;
1201                         $bi->pagetypepattern = '*';  // Just in case
1202                     }
1203                 }
1204             }
1206             $bi->defaultregion = $data->bui_defaultregion;
1207             $bi->defaultweight = $data->bui_defaultweight;
1208             $DB->update_record('block_instances', $bi);
1210             if (!empty($block->config)) {
1211                 $config = clone($block->config);
1212             } else {
1213                 $config = new stdClass;
1214             }
1215             foreach ($data as $configfield => $value) {
1216                 if (strpos($configfield, 'config_') !== 0) {
1217                     continue;
1218                 }
1219                 $field = substr($configfield, 7);
1220                 $config->$field = $value;
1221             }
1222             $block->instance_config_save($config);
1224             $bp = new stdClass;
1225             $bp->visible = $data->bui_visible;
1226             $bp->region = $data->bui_region;
1227             $bp->weight = $data->bui_weight;
1228             $needbprecord = !$data->bui_visible || $data->bui_region != $data->bui_defaultregion ||
1229                     $data->bui_weight != $data->bui_defaultweight;
1231             if ($block->instance->blockpositionid && !$needbprecord) {
1232                 $DB->delete_records('block_positions', array('id' => $block->instance->blockpositionid));
1234             } else if ($block->instance->blockpositionid && $needbprecord) {
1235                 $bp->id = $block->instance->blockpositionid;
1236                 $DB->update_record('block_positions', $bp);
1238             } else if ($needbprecord) {
1239                 $bp->blockinstanceid = $block->instance->id;
1240                 $bp->contextid = $this->page->context->id;
1241                 $bp->pagetype = $this->page->pagetype;
1242                 if ($this->page->subpage) {
1243                     $bp->subpage = $this->page->subpage;
1244                 } else {
1245                     $bp->subpage = '';
1246                 }
1247                 $DB->insert_record('block_positions', $bp);
1248             }
1250             redirect($this->page->url);
1252         } else {
1253             $strheading = get_string('blockconfiga', 'moodle', $block->get_title());
1254             $editpage->set_title($strheading);
1255             $editpage->set_heading($strheading);
1256             $editpage->navbar->add($strheading);
1257             $output = $editpage->get_renderer('core');
1258             echo $output->header();
1259             echo $output->heading($strheading, 2);
1260             $mform->display();
1261             echo $output->footer();
1262             exit;
1263         }
1264     }
1266     /**
1267      * Handle showing/processing the submission from the block editing form.
1268      * @return boolean true if the form was submitted and the new config saved. Does not
1269      *      return if the editing form was displayed. False otherwise.
1270      */
1271     public function process_url_move() {
1272         global $CFG, $DB, $PAGE;
1274         $blockid = optional_param('bui_moveid', null, PARAM_INTEGER);
1275         if (!$blockid) {
1276             return false;
1277         }
1279         require_sesskey();
1281         $block = $this->find_instance($blockid);
1283         if (!$this->page->user_can_edit_blocks()) {
1284             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('editblock'));
1285         }
1287         $newregion = optional_param('bui_newregion', '', PARAM_ALPHANUMEXT);
1288         $newweight = optional_param('bui_newweight', null, PARAM_FLOAT);
1289         if (!$newregion || is_null($newweight)) {
1290             // Don't have a valid target position yet, must be just starting the move.
1291             $this->movingblock = $blockid;
1292             $this->page->ensure_param_not_in_url('bui_moveid');
1293             return false;
1294         }
1296         if (!$this->is_known_region($newregion)) {
1297             throw new moodle_exception('unknownblockregion', '', $this->page->url, $newregion);
1298         }
1300         // Move this block. This may involve moving other nearby blocks.
1301         $blocks = $this->birecordsbyregion[$newregion];
1303         $maxweight = self::MAX_WEIGHT;
1304         $minweight = -self::MAX_WEIGHT;
1306         // Initialise the used weights and spareweights array with the default values
1307         $spareweights = array();
1308         $usedweights = array();
1309         for ($i = $minweight; $i <= $maxweight; $i++) {
1310             $spareweights[$i] = $i;
1311             $usedweights[$i] = array();
1312         }
1314         // Check each block and sort out where we have used weights
1315         foreach ($blocks as $bi) {
1316             if ($bi->weight > $maxweight) {
1317                 // If this statement is true then the blocks weight is more than the
1318                 // current maximum. To ensure that we can get the best block position
1319                 // we will initialise elements within the usedweights and spareweights
1320                 // arrays between the blocks weight (which will then be the new max) and
1321                 // the current max
1322                 $parseweight = $bi->weight;
1323                 while (!array_key_exists($parseweight, $usedweights)) {
1324                     $usedweights[$parseweight] = array();
1325                     $spareweights[$parseweight] = $parseweight;
1326                     $parseweight--;
1327                 }
1328                 $maxweight = $bi->weight;
1329             } else if ($bi->weight < $minweight) {
1330                 // As above except this time the blocks weight is LESS than the
1331                 // the current minimum, so we will initialise the array from the
1332                 // blocks weight (new minimum) to the current minimum
1333                 $parseweight = $bi->weight;
1334                 while (!array_key_exists($parseweight, $usedweights)) {
1335                     $usedweights[$parseweight] = array();
1336                     $spareweights[$parseweight] = $parseweight;
1337                     $parseweight++;
1338                 }
1339                 $minweight = $bi->weight;
1340             }
1341             if ($bi->id != $block->instance->id) {
1342                 unset($spareweights[$bi->weight]);
1343                 $usedweights[$bi->weight][] = $bi->id;
1344             }
1345         }
1347         // First we find the nearest gap in the list of weights.
1348         $bestdistance = max(abs($newweight - self::MAX_WEIGHT), abs($newweight + self::MAX_WEIGHT)) + 1;
1349         $bestgap = null;
1350         foreach ($spareweights as $spareweight) {
1351             if (abs($newweight - $spareweight) < $bestdistance) {
1352                 $bestdistance = abs($newweight - $spareweight);
1353                 $bestgap = $spareweight;
1354             }
1355         }
1357         // If there is no gap, we have to go outside -self::MAX_WEIGHT .. self::MAX_WEIGHT.
1358         if (is_null($bestgap)) {
1359             $bestgap = self::MAX_WEIGHT + 1;
1360             while (!empty($usedweights[$bestgap])) {
1361                 $bestgap++;
1362             }
1363         }
1365         // Now we know the gap we are aiming for, so move all the blocks along.
1366         if ($bestgap < $newweight) {
1367             $newweight = floor($newweight);
1368             for ($weight = $bestgap + 1; $weight <= $newweight; $weight++) {
1369                 foreach ($usedweights[$weight] as $biid) {
1370                     $this->reposition_block($biid, $newregion, $weight - 1);
1371                 }
1372             }
1373             $this->reposition_block($block->instance->id, $newregion, $newweight);
1374         } else {
1375             $newweight = ceil($newweight);
1376             for ($weight = $bestgap - 1; $weight >= $newweight; $weight--) {
1377                 foreach ($usedweights[$weight] as $biid) {
1378                     $this->reposition_block($biid, $newregion, $weight + 1);
1379                 }
1380             }
1381             $this->reposition_block($block->instance->id, $newregion, $newweight);
1382         }
1384         $this->page->ensure_param_not_in_url('bui_moveid');
1385         $this->page->ensure_param_not_in_url('bui_newregion');
1386         $this->page->ensure_param_not_in_url('bui_newweight');
1387         return true;
1388     }
1390     /**
1391      * Turns the display of normal blocks either on or off.
1392      *
1393      * @param bool $setting
1394      */
1395     public function show_only_fake_blocks($setting = true) {
1396         $this->fakeblocksonly = $setting;
1397     }
1400 /// Helper functions for working with block classes ============================
1402 /**
1403  * Call a class method (one that does not require a block instance) on a block class.
1404  *
1405  * @param string $blockname the name of the block.
1406  * @param string $method the method name.
1407  * @param array $param parameters to pass to the method.
1408  * @return mixed whatever the method returns.
1409  */
1410 function block_method_result($blockname, $method, $param = NULL) {
1411     if(!block_load_class($blockname)) {
1412         return NULL;
1413     }
1414     return call_user_func(array('block_'.$blockname, $method), $param);
1417 /**
1418  * Creates a new instance of the specified block class.
1419  *
1420  * @param string $blockname the name of the block.
1421  * @param $instance block_instances DB table row (optional).
1422  * @param moodle_page $page the page this block is appearing on.
1423  * @return block_base the requested block instance.
1424  */
1425 function block_instance($blockname, $instance = NULL, $page = NULL) {
1426     if(!block_load_class($blockname)) {
1427         return false;
1428     }
1429     $classname = 'block_'.$blockname;
1430     $retval = new $classname;
1431     if($instance !== NULL) {
1432         if (is_null($page)) {
1433             global $PAGE;
1434             $page = $PAGE;
1435         }
1436         $retval->_load_instance($instance, $page);
1437     }
1438     return $retval;
1441 /**
1442  * Load the block class for a particular type of block.
1443  *
1444  * @param string $blockname the name of the block.
1445  * @return boolean success or failure.
1446  */
1447 function block_load_class($blockname) {
1448     global $CFG;
1450     if(empty($blockname)) {
1451         return false;
1452     }
1454     $classname = 'block_'.$blockname;
1456     if(class_exists($classname)) {
1457         return true;
1458     }
1460     $blockpath = $CFG->dirroot.'/blocks/'.$blockname.'/block_'.$blockname.'.php';
1462     if (file_exists($blockpath)) {
1463         require_once($CFG->dirroot.'/blocks/moodleblock.class.php');
1464         include_once($blockpath);
1465     }else{
1466         //debugging("$blockname code does not exist in $blockpath", DEBUG_DEVELOPER);
1467         return false;
1468     }
1470     return class_exists($classname);
1473 /**
1474  * Given a specific page type, return all the page type patterns that might
1475  * match it.
1476  *
1477  * @param string $pagetype for example 'course-view-weeks' or 'mod-quiz-view'.
1478  * @return array an array of all the page type patterns that might match this page type.
1479  */
1480 function matching_page_type_patterns($pagetype) {
1481     $patterns = array($pagetype);
1482     $bits = explode('-', $pagetype);
1483     if (count($bits) == 3 && $bits[0] == 'mod') {
1484         if ($bits[2] == 'view') {
1485             $patterns[] = 'mod-*-view';
1486         } else if ($bits[2] == 'index') {
1487             $patterns[] = 'mod-*-index';
1488         }
1489     }
1490     while (count($bits) > 0) {
1491         $patterns[] = implode('-', $bits) . '-*';
1492         array_pop($bits);
1493     }
1494     $patterns[] = '*';
1495     return $patterns;
1498 /// Functions update the blocks if required by the request parameters ==========
1500 /**
1501  * Return a {@link block_contents} representing the add a new block UI, if
1502  * this user is allowed to see it.
1503  *
1504  * @return block_contents an appropriate block_contents, or null if the user
1505  * cannot add any blocks here.
1506  */
1507 function block_add_block_ui($page, $output) {
1508     global $CFG, $OUTPUT;
1509     if (!$page->user_is_editing() || !$page->user_can_edit_blocks()) {
1510         return null;
1511     }
1513     $bc = new block_contents();
1514     $bc->title = get_string('addblock');
1515     $bc->add_class('block_adminblock');
1517     $missingblocks = $page->blocks->get_addable_blocks();
1518     if (empty($missingblocks)) {
1519         $bc->content = get_string('noblockstoaddhere');
1520         return $bc;
1521     }
1523     $menu = array();
1524     foreach ($missingblocks as $block) {
1525         $blockobject = block_instance($block->name);
1526         if ($blockobject !== false && $blockobject->user_can_addto($page)) {
1527             $menu[$block->name] = $blockobject->get_title();
1528         }
1529     }
1530     textlib_get_instance()->asort($menu);
1532     $actionurl = new moodle_url($page->url, array('sesskey'=>sesskey()));
1533     $select = new single_select($actionurl, 'bui_addblock', $menu, null, array(''=>get_string('adddots')), 'add_block');
1534     $bc->content = $OUTPUT->render($select);
1535     return $bc;
1538 // Functions that have been deprecated by block_manager =======================
1540 /**
1541  * @deprecated since Moodle 2.0 - use $page->blocks->get_addable_blocks();
1542  *
1543  * This function returns an array with the IDs of any blocks that you can add to your page.
1544  * Parameters are passed by reference for speed; they are not modified at all.
1545  *
1546  * @param $page the page object.
1547  * @param $blockmanager Not used.
1548  * @return array of block type ids.
1549  */
1550 function blocks_get_missing(&$page, &$blockmanager) {
1551     debugging('blocks_get_missing is deprecated. Please use $page->blocks->get_addable_blocks() instead.', DEBUG_DEVELOPER);
1552     $blocks = $page->blocks->get_addable_blocks();
1553     $ids = array();
1554     foreach ($blocks as $block) {
1555         $ids[] = $block->id;
1556     }
1557     return $ids;
1560 /**
1561  * Actually delete from the database any blocks that are currently on this page,
1562  * but which should not be there according to blocks_name_allowed_in_format.
1563  *
1564  * @todo Write/Fix this function. Currently returns immediately
1565  * @param $course
1566  */
1567 function blocks_remove_inappropriate($course) {
1568     // TODO
1569     return;
1570     /*
1571     $blockmanager = blocks_get_by_page($page);
1573     if (empty($blockmanager)) {
1574         return;
1575     }
1577     if (($pageformat = $page->pagetype) == NULL) {
1578         return;
1579     }
1581     foreach($blockmanager as $region) {
1582         foreach($region as $instance) {
1583             $block = blocks_get_record($instance->blockid);
1584             if(!blocks_name_allowed_in_format($block->name, $pageformat)) {
1585                blocks_delete_instance($instance->instance);
1586             }
1587         }
1588     }*/
1591 /**
1592  * Check that a given name is in a permittable format
1593  *
1594  * @param string $name
1595  * @param string $pageformat
1596  * @return bool
1597  */
1598 function blocks_name_allowed_in_format($name, $pageformat) {
1599     $accept = NULL;
1600     $maxdepth = -1;
1601     $formats = block_method_result($name, 'applicable_formats');
1602     if (!$formats) {
1603         $formats = array();
1604     }
1605     foreach ($formats as $format => $allowed) {
1606         $formatregex = '/^'.str_replace('*', '[^-]*', $format).'.*$/';
1607         $depth = substr_count($format, '-');
1608         if (preg_match($formatregex, $pageformat) && $depth > $maxdepth) {
1609             $maxdepth = $depth;
1610             $accept = $allowed;
1611         }
1612     }
1613     if ($accept === NULL) {
1614         $accept = !empty($formats['all']);
1615     }
1616     return $accept;
1619 /**
1620  * Delete a block, and associated data.
1621  *
1622  * @param object $instance a row from the block_instances table
1623  * @param bool $nolongerused legacy parameter. Not used, but kept for backwards compatibility.
1624  * @param bool $skipblockstables for internal use only. Makes @see blocks_delete_all_for_context() more efficient.
1625  */
1626 function blocks_delete_instance($instance, $nolongerused = false, $skipblockstables = false) {
1627     global $DB;
1629     if ($block = block_instance($instance->blockname, $instance)) {
1630         $block->instance_delete();
1631     }
1632     delete_context(CONTEXT_BLOCK, $instance->id);
1634     if (!$skipblockstables) {
1635         $DB->delete_records('block_positions', array('blockinstanceid' => $instance->id));
1636         $DB->delete_records('block_instances', array('id' => $instance->id));
1637         $DB->delete_records_list('user_preferences', 'name', array('block'.$instance->id.'hidden','docked_block_instance_'.$instance->id));
1638     }
1641 /**
1642  * Delete all the blocks that belong to a particular context.
1643  *
1644  * @param int $contextid the context id.
1645  */
1646 function blocks_delete_all_for_context($contextid) {
1647     global $DB;
1648     $instances = $DB->get_recordset('block_instances', array('parentcontextid' => $contextid));
1649     foreach ($instances as $instance) {
1650         blocks_delete_instance($instance, true);
1651     }
1652     $instances->close();
1653     $DB->delete_records('block_instances', array('parentcontextid' => $contextid));
1654     $DB->delete_records('block_positions', array('contextid' => $contextid));
1657 /**
1658  * Set a block to be visible or hidden on a particular page.
1659  *
1660  * @param object $instance a row from the block_instances, preferably LEFT JOINed with the
1661  *      block_positions table as return by block_manager.
1662  * @param moodle_page $page the back to set the visibility with respect to.
1663  * @param integer $newvisibility 1 for visible, 0 for hidden.
1664  */
1665 function blocks_set_visibility($instance, $page, $newvisibility) {
1666     global $DB;
1667     if (!empty($instance->blockpositionid)) {
1668         // Already have local information on this page.
1669         $DB->set_field('block_positions', 'visible', $newvisibility, array('id' => $instance->blockpositionid));
1670         return;
1671     }
1673     // Create a new block_positions record.
1674     $bp = new stdClass;
1675     $bp->blockinstanceid = $instance->id;
1676     $bp->contextid = $page->context->id;
1677     $bp->pagetype = $page->pagetype;
1678     if ($page->subpage) {
1679         $bp->subpage = $page->subpage;
1680     }
1681     $bp->visible = $newvisibility;
1682     $bp->region = $instance->defaultregion;
1683     $bp->weight = $instance->defaultweight;
1684     $DB->insert_record('block_positions', $bp);
1687 /**
1688  * @deprecated since 2.0
1689  * Delete all the blocks from a particular page.
1690  *
1691  * @param string $pagetype the page type.
1692  * @param integer $pageid the page id.
1693  * @return bool success or failure.
1694  */
1695 function blocks_delete_all_on_page($pagetype, $pageid) {
1696     global $DB;
1698     debugging('Call to deprecated function blocks_delete_all_on_page. ' .
1699             'This function cannot work any more. Doing nothing. ' .
1700             'Please update your code to use a block_manager method $PAGE->blocks->....', DEBUG_DEVELOPER);
1701     return false;
1704 /**
1705  * Dispite what this function is called, it seems to be mostly used to populate
1706  * the default blocks when a new course (or whatever) is created.
1707  *
1708  * @deprecated since 2.0
1709  *
1710  * @param object $page the page to add default blocks to.
1711  * @return boolean success or failure.
1712  */
1713 function blocks_repopulate_page($page) {
1714     global $CFG;
1716     debugging('Call to deprecated function blocks_repopulate_page. ' .
1717             'Use a more specific method like blocks_add_default_course_blocks, ' .
1718             'or just call $PAGE->blocks->add_blocks()', DEBUG_DEVELOPER);
1720     /// If the site override has been defined, it is the only valid one.
1721     if (!empty($CFG->defaultblocks_override)) {
1722         $blocknames = $CFG->defaultblocks_override;
1723     } else {
1724         $blocknames = $page->blocks_get_default();
1725     }
1727     $blocks = blocks_parse_default_blocks_list($blocknames);
1728     $page->blocks->add_blocks($blocks);
1730     return true;
1733 /**
1734  * Get the block record for a particular blockid - that is, a particular type os block.
1735  *
1736  * @param $int blockid block type id. If null, an array of all block types is returned.
1737  * @param bool $notusedanymore No longer used.
1738  * @return array|object row from block table, or all rows.
1739  */
1740 function blocks_get_record($blockid = NULL, $notusedanymore = false) {
1741     global $PAGE;
1742     $blocks = $PAGE->blocks->get_installed_blocks();
1743     if ($blockid === NULL) {
1744         return $blocks;
1745     } else if (isset($blocks[$blockid])) {
1746         return $blocks[$blockid];
1747     } else {
1748         return false;
1749     }
1752 /**
1753  * Find a given block by its blockid within a provide array
1754  *
1755  * @param int $blockid
1756  * @param array $blocksarray
1757  * @return bool|object Instance if found else false
1758  */
1759 function blocks_find_block($blockid, $blocksarray) {
1760     if (empty($blocksarray)) {
1761         return false;
1762     }
1763     foreach($blocksarray as $blockgroup) {
1764         if (empty($blockgroup)) {
1765             continue;
1766         }
1767         foreach($blockgroup as $instance) {
1768             if($instance->blockid == $blockid) {
1769                 return $instance;
1770             }
1771         }
1772     }
1773     return false;
1776 // Functions for programatically adding default blocks to pages ================
1778 /**
1779  * Parse a list of default blocks. See config-dist for a description of the format.
1780  *
1781  * @param string $blocksstr
1782  * @return array
1783  */
1784 function blocks_parse_default_blocks_list($blocksstr) {
1785     $blocks = array();
1786     $bits = explode(':', $blocksstr);
1787     if (!empty($bits)) {
1788         $leftbits = trim(array_shift($bits));
1789         if ($leftbits != '') {
1790             $blocks[BLOCK_POS_LEFT] = explode(',', $leftbits);
1791         }
1792     }
1793     if (!empty($bits)) {
1794         $rightbits =trim(array_shift($bits));
1795         if ($rightbits != '') {
1796             $blocks[BLOCK_POS_RIGHT] = explode(',', $rightbits);
1797         }
1798     }
1799     return $blocks;
1802 /**
1803  * @return array the blocks that should be added to the site course by default.
1804  */
1805 function blocks_get_default_site_course_blocks() {
1806     global $CFG;
1808     if (!empty($CFG->defaultblocks_site)) {
1809         return blocks_parse_default_blocks_list($CFG->defaultblocks_site);
1810     } else {
1811         return array(
1812             BLOCK_POS_LEFT => array('site_main_menu'),
1813             BLOCK_POS_RIGHT => array('course_summary', 'calendar_month')
1814         );
1815     }
1818 /**
1819  * Add the default blocks to a course.
1820  *
1821  * @param object $course a course object.
1822  */
1823 function blocks_add_default_course_blocks($course) {
1824     global $CFG;
1826     if (!empty($CFG->defaultblocks_override)) {
1827         $blocknames = blocks_parse_default_blocks_list($CFG->defaultblocks_override);
1829     } else if ($course->id == SITEID) {
1830         $blocknames = blocks_get_default_site_course_blocks();
1832     } else {
1833         $defaultblocks = 'defaultblocks_' . $course->format;
1834         if (!empty($CFG->$defaultblocks)) {
1835             $blocknames = blocks_parse_default_blocks_list($CFG->$defaultblocks);
1837         } else {
1838             $formatconfig = $CFG->dirroot.'/course/format/'.$course->format.'/config.php';
1839             $format = array(); // initialize array in external file
1840             if (is_readable($formatconfig)) {
1841                 include($formatconfig);
1842             }
1843             if (!empty($format['defaultblocks'])) {
1844                 $blocknames = blocks_parse_default_blocks_list($format['defaultblocks']);
1846             } else if (!empty($CFG->defaultblocks)){
1847                 $blocknames = blocks_parse_default_blocks_list($CFG->defaultblocks);
1849             } else {
1850                 $blocknames = array(
1851                     BLOCK_POS_LEFT => array(),
1852                     BLOCK_POS_RIGHT => array('search_forums', 'news_items', 'calendar_upcoming', 'recent_activity')
1853                 );
1854             }
1855         }
1856     }
1858     if ($course->id == SITEID) {
1859         $pagetypepattern = 'site-index';
1860     } else {
1861         $pagetypepattern = 'course-view-*';
1862     }
1863     $page = new moodle_page();
1864     $page->set_course($course);
1865     $page->blocks->add_blocks($blocknames, $pagetypepattern);
1868 /**
1869  * Add the default system-context blocks. E.g. the admin tree.
1870  */
1871 function blocks_add_default_system_blocks() {
1872     global $DB;
1874     $page = new moodle_page();
1875     $page->set_context(get_context_instance(CONTEXT_SYSTEM));
1876     $page->blocks->add_blocks(array(BLOCK_POS_LEFT => array('navigation', 'settings')), '*', null, true);
1877     $page->blocks->add_blocks(array(BLOCK_POS_LEFT => array('admin_bookmarks')), 'admin-*', null, null, 2);
1879     if ($defaultmypage = $DB->get_record('my_pages', array('userid'=>null, 'name'=>'__default', 'private'=>1))) {
1880         $subpagepattern = $defaultmypage->id;
1881     } else {
1882         $subpagepattern = null;
1883     }
1885     $page->blocks->add_blocks(array(BLOCK_POS_RIGHT => array('private_files', 'online_users'), 'content' => array('course_overview')), 'my-index', $subpagepattern, false);