blocks MDL-24066 Blocks can now choose to be hideable + navigation and settings are...
[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         $this->check_region_is_known($region);
415         if (array_key_exists($region, $this->visibleblockcontent)) {
416             throw new coding_exception('block_manager has already prepared the blocks in region ' .
417                     $region . 'for output. It is too late to add a pretend block.');
418         }
419         $this->extracontent[$region][] = $bc;
420     }
422     /**
423      * Checks to see whether all of the blocks within the given region are docked
424      *
425      * @see region_uses_dock
426      * @param string $region
427      * @return bool True if all of the blocks within that region are docked
428      */
429     public function region_completely_docked($region, $output) {
430         if (!$this->page->theme->enable_dock) {
431             return false;
432         }
433         $this->check_is_loaded();
434         $this->ensure_content_created($region, $output);
435         foreach($this->visibleblockcontent[$region] as $instance) {
436             if (!empty($instance->content) && !get_user_preferences('docked_block_instance_'.$instance->blockinstanceid, 0)) {
437                 return false;
438             }
439         }
440         return true;
441     }
443     /**
444      * Checks to see whether any of the blocks within the given regions are docked
445      *
446      * @see region_completely_docked
447      * @param array|string $regions array of regions (or single region)
448      * @return bool True if any of the blocks within that region are docked
449      */
450     public function region_uses_dock($regions, $output) {
451         if (!$this->page->theme->enable_dock) {
452             return false;
453         }
454         $this->check_is_loaded();
455         foreach((array)$regions as $region) {
456             $this->ensure_content_created($region, $output);
457             foreach($this->visibleblockcontent[$region] as $instance) {
458                 if(!empty($instance->content) && get_user_preferences('docked_block_instance_'.$instance->blockinstanceid, 0)) {
459                     return true;
460                 }
461             }
462         }
463         return false;
464     }
466 /// Actions ====================================================================
468     /**
469      * This method actually loads the blocks for our page from the database.
470      *
471      * @param boolean|null $includeinvisible
472      *      null (default) - load hidden blocks if $this->page->user_is_editing();
473      *      true - load hidden blocks.
474      *      false - don't load hidden blocks.
475      */
476     public function load_blocks($includeinvisible = null) {
477         global $DB, $CFG;
479         if (!is_null($this->birecordsbyregion)) {
480             // Already done.
481             return;
482         }
484         if ($CFG->version < 2009050619) {
485             // Upgrade/install not complete. Don't try too show any blocks.
486             $this->birecordsbyregion = array();
487             return;
488         }
490         // Ensure we have been initialised.
491         if (is_null($this->defaultregion)) {
492             $this->page->initialise_theme_and_output();
493             // If there are still no block regions, then there are no blocks on this page.
494             if (empty($this->regions)) {
495                 $this->birecordsbyregion = array();
496                 return;
497             }
498         }
500         // Check if we need to load normal blocks
501         if ($this->fakeblocksonly) {
502             $this->birecordsbyregion = $this->prepare_per_region_arrays();
503             return;
504         }
506         if (is_null($includeinvisible)) {
507             $includeinvisible = $this->page->user_is_editing();
508         }
509         if ($includeinvisible) {
510             $visiblecheck = '';
511         } else {
512             $visiblecheck = 'AND (bp.visible = 1 OR bp.visible IS NULL)';
513         }
515         $context = $this->page->context;
516         $contexttest = 'bi.parentcontextid = :contextid2';
517         $parentcontextparams = array();
518         $parentcontextids = get_parent_contexts($context);
519         if ($parentcontextids) {
520             list($parentcontexttest, $parentcontextparams) =
521                     $DB->get_in_or_equal($parentcontextids, SQL_PARAMS_NAMED, 'parentcontext0000');
522             $contexttest = "($contexttest OR (bi.showinsubcontexts = 1 AND bi.parentcontextid $parentcontexttest))";
523         }
525         $pagetypepatterns = matching_page_type_patterns($this->page->pagetype);
526         list($pagetypepatterntest, $pagetypepatternparams) =
527                 $DB->get_in_or_equal($pagetypepatterns, SQL_PARAMS_NAMED, 'pagetypepatterntest0000');
529         list($ccselect, $ccjoin) = context_instance_preload_sql('b.id', CONTEXT_BLOCK, 'ctx');
531         $params = array(
532             'subpage1' => $this->page->subpage,
533             'subpage2' => $this->page->subpage,
534             'contextid1' => $context->id,
535             'contextid2' => $context->id,
536             'pagetype' => $this->page->pagetype,
537         );
538         $sql = "SELECT
539                     bi.id,
540                     bp.id AS blockpositionid,
541                     bi.blockname,
542                     bi.parentcontextid,
543                     bi.showinsubcontexts,
544                     bi.pagetypepattern,
545                     bi.subpagepattern,
546                     bi.defaultregion,
547                     bi.defaultweight,
548                     COALESCE(bp.visible, 1) AS visible,
549                     COALESCE(bp.region, bi.defaultregion) AS region,
550                     COALESCE(bp.weight, bi.defaultweight) AS weight,
551                     bi.configdata
552                     $ccselect
554                 FROM {block_instances} bi
555                 JOIN {block} b ON bi.blockname = b.name
556                 LEFT JOIN {block_positions} bp ON bp.blockinstanceid = bi.id
557                                                   AND bp.contextid = :contextid1
558                                                   AND bp.pagetype = :pagetype
559                                                   AND bp.subpage = :subpage1
560                 $ccjoin
562                 WHERE
563                 $contexttest
564                 AND bi.pagetypepattern $pagetypepatterntest
565                 AND (bi.subpagepattern IS NULL OR bi.subpagepattern = :subpage2)
566                 $visiblecheck
567                 AND b.visible = 1
569                 ORDER BY
570                     COALESCE(bp.region, bi.defaultregion),
571                     COALESCE(bp.weight, bi.defaultweight),
572                     bi.id";
573         $blockinstances = $DB->get_recordset_sql($sql, $params + $parentcontextparams + $pagetypepatternparams);
575         $this->birecordsbyregion = $this->prepare_per_region_arrays();
576         $unknown = array();
577         foreach ($blockinstances as $bi) {
578             context_instance_preload($bi);
579             if ($this->is_known_region($bi->region)) {
580                 $this->birecordsbyregion[$bi->region][] = $bi;
581             } else {
582                 $unknown[] = $bi;
583             }
584         }
586         // Pages don't necessarily have a defaultregion. The  one time this can
587         // happen is when there are no theme block regions, but the script itself
588         // has a block region in the main content area.
589         if (!empty($this->defaultregion)) {
590             $this->birecordsbyregion[$this->defaultregion] =
591                     array_merge($this->birecordsbyregion[$this->defaultregion], $unknown);
592         }
593     }
595     /**
596      * Add a block to the current page, or related pages. The block is added to
597      * context $this->page->contextid. If $pagetypepattern $subpagepattern
598      *
599      * @param string $blockname The type of block to add.
600      * @param string $region the block region on this page to add the block to.
601      * @param integer $weight determines the order where this block appears in the region.
602      * @param boolean $showinsubcontexts whether this block appears in subcontexts, or just the current context.
603      * @param string|null $pagetypepattern which page types this block should appear on. Defaults to just the current page type.
604      * @param string|null $subpagepattern which subpage this block should appear on. NULL = any (the default), otherwise only the specified subpage.
605      */
606     public function add_block($blockname, $region, $weight, $showinsubcontexts, $pagetypepattern = NULL, $subpagepattern = NULL) {
607         global $DB;
608         // Allow invisible blocks because this is used when adding default page blocks, which
609         // might include invisible ones if the user makes some default blocks invisible
610         $this->check_known_block_type($blockname, true);
611         $this->check_region_is_known($region);
613         if (empty($pagetypepattern)) {
614             $pagetypepattern = $this->page->pagetype;
615         }
617         $blockinstance = new stdClass;
618         $blockinstance->blockname = $blockname;
619         $blockinstance->parentcontextid = $this->page->context->id;
620         $blockinstance->showinsubcontexts = !empty($showinsubcontexts);
621         $blockinstance->pagetypepattern = $pagetypepattern;
622         $blockinstance->subpagepattern = $subpagepattern;
623         $blockinstance->defaultregion = $region;
624         $blockinstance->defaultweight = $weight;
625         $blockinstance->configdata = '';
626         $blockinstance->id = $DB->insert_record('block_instances', $blockinstance);
628         // Ensure the block context is created.
629         get_context_instance(CONTEXT_BLOCK, $blockinstance->id);
631         // If the new instance was created, allow it to do additional setup
632         if ($block = block_instance($blockname, $blockinstance)) {
633             $block->instance_create();
634         }
635     }
637     public function add_block_at_end_of_default_region($blockname) {
638         $defaulregion = $this->get_default_region();
640         $lastcurrentblock = end($this->birecordsbyregion[$defaulregion]);
641         if ($lastcurrentblock) {
642             $weight = $lastcurrentblock->weight + 1;
643         } else {
644             $weight = 0;
645         }
647         if ($this->page->subpage) {
648             $subpage = $this->page->subpage;
649         } else {
650             $subpage = null;
651         }
653         // Special case. Course view page type include the course format, but we
654         // want to add the block non-format-specifically.
655         $pagetypepattern = $this->page->pagetype;
656         if (strpos($pagetypepattern, 'course-view') === 0) {
657             $pagetypepattern = 'course-view-*';
658         }
660         $this->add_block($blockname, $defaulregion, $weight, false, $pagetypepattern, $subpage);
661     }
663     /**
664      * Convenience method, calls add_block repeatedly for all the blocks in $blocks.
665      *
666      * @param array $blocks array with array keys the region names, and values an array of block names.
667      * @param string $pagetypepattern optional. Passed to @see add_block()
668      * @param string $subpagepattern optional. Passed to @see add_block()
669      */
670     public function add_blocks($blocks, $pagetypepattern = NULL, $subpagepattern = NULL, $showinsubcontexts=false, $weight=0) {
671         $this->add_regions(array_keys($blocks));
672         foreach ($blocks as $region => $regionblocks) {
673             $weight = 0;
674             foreach ($regionblocks as $blockname) {
675                 $this->add_block($blockname, $region, $weight, $showinsubcontexts, $pagetypepattern, $subpagepattern);
676                 $weight += 1;
677             }
678         }
679     }
681     /**
682      * Move a block to a new position on this page.
683      *
684      * If this block cannot appear on any other pages, then we change defaultposition/weight
685      * in the block_instances table. Otherwise we just set the position on this page.
686      *
687      * @param $blockinstanceid the block instance id.
688      * @param $newregion the new region name.
689      * @param $newweight the new weight.
690      */
691     public function reposition_block($blockinstanceid, $newregion, $newweight) {
692         global $DB;
694         $this->check_region_is_known($newregion);
695         $inst = $this->find_instance($blockinstanceid);
697         $bi = $inst->instance;
698         if ($bi->weight == $bi->defaultweight && $bi->region == $bi->defaultregion &&
699                 !$bi->showinsubcontexts && strpos($bi->pagetypepattern, '*') === false &&
700                 (!$this->page->subpage || $bi->subpagepattern)) {
702             // Set default position
703             $newbi = new stdClass;
704             $newbi->id = $bi->id;
705             $newbi->defaultregion = $newregion;
706             $newbi->defaultweight = $newweight;
707             $DB->update_record('block_instances', $newbi);
709             if ($bi->blockpositionid) {
710                 $bp = new stdClass;
711                 $bp->id = $bi->blockpositionid;
712                 $bp->region = $newregion;
713                 $bp->weight = $newweight;
714                 $DB->update_record('block_positions', $bp);
715             }
717         } else {
718             // Just set position on this page.
719             $bp = new stdClass;
720             $bp->region = $newregion;
721             $bp->weight = $newweight;
723             if ($bi->blockpositionid) {
724                 $bp->id = $bi->blockpositionid;
725                 $DB->update_record('block_positions', $bp);
727             } else {
728                 $bp->blockinstanceid = $bi->id;
729                 $bp->contextid = $this->page->context->id;
730                 $bp->pagetype = $this->page->pagetype;
731                 if ($this->page->subpage) {
732                     $bp->subpage = $this->page->subpage;
733                 } else {
734                     $bp->subpage = '';
735                 }
736                 $bp->visible = $bi->visible;
737                 $DB->insert_record('block_positions', $bp);
738             }
739         }
740     }
742     /**
743      * Find a given block by its instance id
744      *
745      * @param integer $instanceid
746      * @return object
747      */
748     public function find_instance($instanceid) {
749         foreach ($this->regions as $region => $notused) {
750             $this->ensure_instances_exist($region);
751             foreach($this->blockinstances[$region] as $instance) {
752                 if ($instance->instance->id == $instanceid) {
753                     return $instance;
754                 }
755             }
756         }
757         throw new block_not_on_page_exception($instanceid, $this->page);
758     }
760 /// Inner workings =============================================================
762     /**
763      * Check whether the page blocks have been loaded yet
764      *
765      * @return void Throws coding exception if already loaded
766      */
767     protected function check_not_yet_loaded() {
768         if (!is_null($this->birecordsbyregion)) {
769             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.');
770         }
771     }
773     /**
774      * Check whether the page blocks have been loaded yet
775      *
776      * Nearly identical to the above function {@link check_not_yet_loaded()} except different message
777      *
778      * @return void Throws coding exception if already loaded
779      */
780     protected function check_is_loaded() {
781         if (is_null($this->birecordsbyregion)) {
782             throw new coding_exception('block_manager has not yet loaded the blocks, to it is too soon to request the information you asked for.');
783         }
784     }
786     /**
787      * Check if a block type is known and usable
788      *
789      * @param string $blockname The block type name to search for
790      * @param bool $includeinvisible Include disabled block types in the initial pass
791      * @return void Coding Exception thrown if unknown or not enabled
792      */
793     protected function check_known_block_type($blockname, $includeinvisible = false) {
794         if (!$this->is_known_block_type($blockname, $includeinvisible)) {
795             if ($this->is_known_block_type($blockname, true)) {
796                 throw new coding_exception('Unknown block type ' . $blockname);
797             } else {
798                 throw new coding_exception('Block type ' . $blockname . ' has been disabled by the administrator.');
799             }
800         }
801     }
803     /**
804      * Check if a region is known by its name
805      *
806      * @param string $region
807      * @return void Coding Exception thrown if the region is not known
808      */
809     protected function check_region_is_known($region) {
810         if (!$this->is_known_region($region)) {
811             throw new coding_exception('Trying to reference an unknown block region ' . $region);
812         }
813     }
815     /**
816      * Returns an array of region names as keys and nested arrays for values
817      *
818      * @return array an array where the array keys are the region names, and the array
819      * values are empty arrays.
820      */
821     protected function prepare_per_region_arrays() {
822         $result = array();
823         foreach ($this->regions as $region => $notused) {
824             $result[$region] = array();
825         }
826         return $result;
827     }
829     /**
830      * Create a set of new block instance from a record array
831      *
832      * @param array $birecords An array of block instance records
833      * @return array An array of instantiated block_instance objects
834      */
835     protected function create_block_instances($birecords) {
836         $results = array();
837         foreach ($birecords as $record) {
838             if ($blockobject = block_instance($record->blockname, $record, $this->page)) {
839                 $results[] = $blockobject;
840             }
841         }
842         return $results;
843     }
845     /**
846      * Create all the block instances for all the blocks that were loaded by
847      * load_blocks. This is used, for example, to ensure that all blocks get a
848      * chance to initialise themselves via the {@link block_base::specialize()}
849      * method, before any output is done.
850      */
851     public function create_all_block_instances() {
852         foreach ($this->get_regions() as $region) {
853             $this->ensure_instances_exist($region);
854         }
855     }
857     /**
858      * Return an array of content objects from a set of block instances
859      *
860      * @param array $instances An array of block instances
861      * @param renderer_base The renderer to use.
862      * @param string $region the region name.
863      * @return array An array of block_content (and possibly block_move_target) objects.
864      */
865     protected function create_block_contents($instances, $output, $region) {
866         $results = array();
868         $lastweight = 0;
869         $lastblock = 0;
870         if ($this->movingblock) {
871             $first = reset($instances);
872             if ($first) {
873                 $lastweight = $first->instance->weight - 2;
874             }
876             $strmoveblockhere = get_string('moveblockhere', 'block');
877         }
879         foreach ($instances as $instance) {
880             $content = $instance->get_content_for_output($output);
881             if (empty($content)) {
882                 continue;
883             }
885             if ($this->movingblock && $lastweight != $instance->instance->weight &&
886                     $content->blockinstanceid != $this->movingblock && $lastblock != $this->movingblock) {
887                 $results[] = new block_move_target($strmoveblockhere, $this->get_move_target_url($region, ($lastweight + $instance->instance->weight)/2));
888             }
890             if ($content->blockinstanceid == $this->movingblock) {
891                 $content->add_class('beingmoved');
892                 $content->annotation .= get_string('movingthisblockcancel', 'block',
893                         html_writer::link($this->page->url, get_string('cancel')));
894             }
896             $results[] = $content;
897             $lastweight = $instance->instance->weight;
898             $lastblock = $instance->instance->id;
899         }
901         if ($this->movingblock && $lastblock != $this->movingblock) {
902             $results[] = new block_move_target($strmoveblockhere, $this->get_move_target_url($region, $lastweight + 1));
903         }
904         return $results;
905     }
907     /**
908      * Ensure block instances exist for a given region
909      *
910      * @param string $region Check for bi's with the instance with this name
911      */
912     protected function ensure_instances_exist($region) {
913         $this->check_region_is_known($region);
914         if (!array_key_exists($region, $this->blockinstances)) {
915             $this->blockinstances[$region] =
916                     $this->create_block_instances($this->birecordsbyregion[$region]);
917         }
918     }
920     /**
921      * Ensure that there is some content within the given region
922      *
923      * @param string $region The name of the region to check
924      */
925     protected function ensure_content_created($region, $output) {
926         $this->ensure_instances_exist($region);
927         if (!array_key_exists($region, $this->visibleblockcontent)) {
928             $contents = array();
929             if (array_key_exists($region, $this->extracontent)) {
930                 $contents = $this->extracontent[$region];
931             }
932             $contents = array_merge($contents, $this->create_block_contents($this->blockinstances[$region], $output, $region));
933             if ($region == $this->defaultregion) {
934                 $addblockui = block_add_block_ui($this->page, $output);
935                 if ($addblockui) {
936                     $contents[] = $addblockui;
937                 }
938             }
939             $this->visibleblockcontent[$region] = $contents;
940         }
941     }
943 /// Process actions from the URL ===============================================
945     /**
946      * Get the appropriate list of editing icons for a block. This is used
947      * to set {@link block_contents::$controls} in {@link block_base::get_contents_for_output()}.
948      *
949      * @param $output The core_renderer to use when generating the output. (Need to get icon paths.)
950      * @return an array in the format for {@link block_contents::$controls}
951      */
952     public function edit_controls($block) {
953         global $CFG;
955         if (!isset($CFG->undeletableblocktypes) || (!is_array($CFG->undeletableblocktypes) && !is_string($CFG->undeletableblocktypes))) {
956             $CFG->undeletableblocktypes = array('navigation','settings');
957         } else if (is_string($CFG->undeletableblocktypes)) {
958             $CFG->undeletableblocktypes = explode(',', $CFG->undeletableblocktypes);
959         }
961         $controls = array();
962         $actionurl = $this->page->url->out(false, array('sesskey'=> sesskey()));
964         // Assign roles icon.
965         if (has_capability('moodle/role:assign', $block->context)) {
966             //TODO: please note it is sloppy to pass urls through page parameters!!
967             //      it is shortened because some web servers (e.g. IIS by default) give
968             //      a 'security' error if you try to pass a full URL as a GET parameter in another URL.
970             $return = $this->page->url->out(false);
971             $return = str_replace($CFG->wwwroot . '/', '', $return);
973             $controls[] = array('url' => $CFG->wwwroot . '/' . $CFG->admin .
974                     '/roles/assign.php?contextid=' . $block->context->id . '&returnurl=' . urlencode($return),
975                     'icon' => 'i/roles', 'caption' => get_string('assignroles', 'role'));
976         }
978         if ($this->page->user_can_edit_blocks() && $block->instance_can_be_hidden()) {
979             // Show/hide icon.
980             if ($block->instance->visible) {
981                 $controls[] = array('url' => $actionurl . '&bui_hideid=' . $block->instance->id,
982                         'icon' => 't/hide', 'caption' => get_string('hide'));
983             } else {
984                 $controls[] = array('url' => $actionurl . '&bui_showid=' . $block->instance->id,
985                         'icon' => 't/show', 'caption' => get_string('show'));
986             }
987         }
989         if ($this->page->user_can_edit_blocks() || $block->user_can_edit()) {
990             // Edit config icon - always show - needed for positioning UI.
991             $controls[] = array('url' => $actionurl . '&bui_editid=' . $block->instance->id,
992                     'icon' => 't/edit', 'caption' => get_string('configuration'));
993         }
995         if ($this->page->user_can_edit_blocks() && $block->user_can_edit() && $block->user_can_addto($this->page)) {
996             if (!in_array($block->instance->blockname, $CFG->undeletableblocktypes)) {
997                 // Delete icon.
998                 $controls[] = array('url' => $actionurl . '&bui_deleteid=' . $block->instance->id,
999                         'icon' => 't/delete', 'caption' => get_string('delete'));
1000             }
1001         }
1003         if ($this->page->user_can_edit_blocks()) {
1004             // Move icon.
1005             $controls[] = array('url' => $actionurl . '&bui_moveid=' . $block->instance->id,
1006                     'icon' => 't/move', 'caption' => get_string('move'));
1007         }
1009         return $controls;
1010     }
1012     /**
1013      * Process any block actions that were specified in the URL.
1014      *
1015      * This can only be done given a valid $page object.
1016      *
1017      * @param moodle_page $page the page to add blocks to.
1018      * @return boolean true if anything was done. False if not.
1019      */
1020     public function process_url_actions() {
1021         if (!$this->page->user_is_editing()) {
1022             return false;
1023         }
1024         return $this->process_url_add() || $this->process_url_delete() ||
1025             $this->process_url_show_hide() || $this->process_url_edit() ||
1026             $this->process_url_move();
1027     }
1029     /**
1030      * Handle adding a block.
1031      * @return boolean true if anything was done. False if not.
1032      */
1033     public function process_url_add() {
1034         $blocktype = optional_param('bui_addblock', null, PARAM_SAFEDIR);
1035         if (!$blocktype) {
1036             return false;
1037         }
1039         require_sesskey();
1041         if (!$this->page->user_can_edit_blocks()) {
1042             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('addblock'));
1043         }
1045         if (!array_key_exists($blocktype, $this->get_addable_blocks())) {
1046             throw new moodle_exception('cannotaddthisblocktype', '', $this->page->url->out(), $blocktype);
1047         }
1049         $this->add_block_at_end_of_default_region($blocktype);
1051         // If the page URL was a guess, it will contain the bui_... param, so we must make sure it is not there.
1052         $this->page->ensure_param_not_in_url('bui_addblock');
1054         return true;
1055     }
1057     /**
1058      * Handle deleting a block.
1059      * @return boolean true if anything was done. False if not.
1060      */
1061     public function process_url_delete() {
1062         $blockid = optional_param('bui_deleteid', null, PARAM_INTEGER);
1063         if (!$blockid) {
1064             return false;
1065         }
1067         require_sesskey();
1069         $block = $this->page->blocks->find_instance($blockid);
1071         if (!$block->user_can_edit() || !$this->page->user_can_edit_blocks() || !$block->user_can_addto($this->page)) {
1072             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('deleteablock'));
1073         }
1075         blocks_delete_instance($block->instance);
1077         // If the page URL was a guess, it will contain the bui_... param, so we must make sure it is not there.
1078         $this->page->ensure_param_not_in_url('bui_deleteid');
1080         return true;
1081     }
1083     /**
1084      * Handle showing or hiding a block.
1085      * @return boolean true if anything was done. False if not.
1086      */
1087     public function process_url_show_hide() {
1088         if ($blockid = optional_param('bui_hideid', null, PARAM_INTEGER)) {
1089             $newvisibility = 0;
1090         } else if ($blockid = optional_param('bui_showid', null, PARAM_INTEGER)) {
1091             $newvisibility = 1;
1092         } else {
1093             return false;
1094         }
1096         require_sesskey();
1098         $block = $this->page->blocks->find_instance($blockid);
1100         if (!$this->page->user_can_edit_blocks()) {
1101             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('hideshowblocks'));
1102         } else if (!$block->instance_can_be_hidden()) {
1103             return false;
1104         }
1106         blocks_set_visibility($block->instance, $this->page, $newvisibility);
1108         // If the page URL was a guses, it will contain the bui_... param, so we must make sure it is not there.
1109         $this->page->ensure_param_not_in_url('bui_hideid');
1110         $this->page->ensure_param_not_in_url('bui_showid');
1112         return true;
1113     }
1115     /**
1116      * Handle showing/processing the submission from the block editing form.
1117      * @return boolean true if the form was submitted and the new config saved. Does not
1118      *      return if the editing form was displayed. False otherwise.
1119      */
1120     public function process_url_edit() {
1121         global $CFG, $DB, $PAGE;
1123         $blockid = optional_param('bui_editid', null, PARAM_INTEGER);
1124         if (!$blockid) {
1125             return false;
1126         }
1128         require_sesskey();
1129         require_once($CFG->dirroot . '/blocks/edit_form.php');
1131         $block = $this->find_instance($blockid);
1133         if (!$block->user_can_edit() && !$this->page->user_can_edit_blocks()) {
1134             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('editblock'));
1135         }
1137         $editpage = new moodle_page();
1138         $editpage->set_pagelayout('admin');
1139         $editpage->set_course($this->page->course);
1140         $editpage->set_context($block->context);
1141         if ($this->page->cm) {
1142             $editpage->set_cm($this->page->cm);
1143         }
1144         $editurlbase = str_replace($CFG->wwwroot . '/', '/', $this->page->url->out_omit_querystring());
1145         $editurlparams = $this->page->url->params();
1146         $editurlparams['bui_editid'] = $blockid;
1147         $editpage->set_url($editurlbase, $editurlparams);
1148         $editpage->set_block_actions_done();
1149         // At this point we are either going to redirect, or display the form, so
1150         // overwrite global $PAGE ready for this. (Formslib refers to it.)
1151         $PAGE = $editpage;
1153         $formfile = $CFG->dirroot . '/blocks/' . $block->name() . '/edit_form.php';
1154         if (is_readable($formfile)) {
1155             require_once($formfile);
1156             $classname = 'block_' . $block->name() . '_edit_form';
1157             if (!class_exists($classname)) {
1158                 $classname = 'block_edit_form';
1159             }
1160         } else {
1161             $classname = 'block_edit_form';
1162         }
1164         $mform = new $classname($editpage->url, $block, $this->page);
1165         $mform->set_data($block->instance);
1167         if ($mform->is_cancelled()) {
1168             redirect($this->page->url);
1170         } else if ($data = $mform->get_data()) {
1171             $bi = new stdClass;
1172             $bi->id = $block->instance->id;
1173             $bi->pagetypepattern = $data->bui_pagetypepattern;
1174             if (empty($data->bui_subpagepattern) || $data->bui_subpagepattern == '%@NULL@%') {
1175                 $bi->subpagepattern = null;
1176             } else {
1177                 $bi->subpagepattern = $data->bui_subpagepattern;
1178             }
1180             $parentcontext = get_context_instance_by_id($data->bui_parentcontextid);
1181             $systemcontext = get_context_instance(CONTEXT_SYSTEM);
1183             // Updating stickiness and contexts.  See MDL-21375 for details.
1184             if (has_capability('moodle/site:manageblocks', $parentcontext)) { // Check permissions in destination
1185                 // Explicitly set the context
1186                 $bi->parentcontextid = $parentcontext->id;
1188                 // If the context type is > 0 then we'll explicitly set the block as sticky, otherwise not
1189                 $bi->showinsubcontexts = (int)(!empty($data->bui_contexts));
1191                 // If the block wants to be system-wide, then explicitly set that
1192                 if ($data->bui_contexts == 2) {   // Only possible on a frontpage or system page
1193                     $bi->parentcontextid = $systemcontext->id;
1195                 } else { // The block doesn't want to be system-wide, so let's ensure that
1196                     if ($parentcontext->id == $systemcontext->id) {  // We need to move it to the front page
1197                         $frontpagecontext = get_context_instance(CONTEXT_COURSE, SITEID);
1198                         $bi->parentcontextid = $frontpagecontext->id;
1199                         $bi->pagetypepattern = '*';  // Just in case
1200                     }
1201                 }
1202             }
1204             $bi->defaultregion = $data->bui_defaultregion;
1205             $bi->defaultweight = $data->bui_defaultweight;
1206             $DB->update_record('block_instances', $bi);
1208             if (!empty($block->config)) {
1209                 $config = clone($block->config);
1210             } else {
1211                 $config = new stdClass;
1212             }
1213             foreach ($data as $configfield => $value) {
1214                 if (strpos($configfield, 'config_') !== 0) {
1215                     continue;
1216                 }
1217                 $field = substr($configfield, 7);
1218                 $config->$field = $value;
1219             }
1220             $block->instance_config_save($config);
1222             $bp = new stdClass;
1223             $bp->visible = $data->bui_visible;
1224             $bp->region = $data->bui_region;
1225             $bp->weight = $data->bui_weight;
1226             $needbprecord = !$data->bui_visible || $data->bui_region != $data->bui_defaultregion ||
1227                     $data->bui_weight != $data->bui_defaultweight;
1229             if ($block->instance->blockpositionid && !$needbprecord) {
1230                 $DB->delete_records('block_positions', array('id' => $block->instance->blockpositionid));
1232             } else if ($block->instance->blockpositionid && $needbprecord) {
1233                 $bp->id = $block->instance->blockpositionid;
1234                 $DB->update_record('block_positions', $bp);
1236             } else if ($needbprecord) {
1237                 $bp->blockinstanceid = $block->instance->id;
1238                 $bp->contextid = $this->page->context->id;
1239                 $bp->pagetype = $this->page->pagetype;
1240                 if ($this->page->subpage) {
1241                     $bp->subpage = $this->page->subpage;
1242                 } else {
1243                     $bp->subpage = '';
1244                 }
1245                 $DB->insert_record('block_positions', $bp);
1246             }
1248             redirect($this->page->url);
1250         } else {
1251             $strheading = get_string('blockconfiga', 'moodle', $block->get_title());
1252             $editpage->set_title($strheading);
1253             $editpage->set_heading($strheading);
1254             $editpage->navbar->add($strheading);
1255             $output = $editpage->get_renderer('core');
1256             echo $output->header();
1257             echo $output->heading($strheading, 2);
1258             $mform->display();
1259             echo $output->footer();
1260             exit;
1261         }
1262     }
1264     /**
1265      * Handle showing/processing the submission from the block editing form.
1266      * @return boolean true if the form was submitted and the new config saved. Does not
1267      *      return if the editing form was displayed. False otherwise.
1268      */
1269     public function process_url_move() {
1270         global $CFG, $DB, $PAGE;
1272         $blockid = optional_param('bui_moveid', null, PARAM_INTEGER);
1273         if (!$blockid) {
1274             return false;
1275         }
1277         require_sesskey();
1279         $block = $this->find_instance($blockid);
1281         if (!$this->page->user_can_edit_blocks()) {
1282             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('editblock'));
1283         }
1285         $newregion = optional_param('bui_newregion', '', PARAM_ALPHANUMEXT);
1286         $newweight = optional_param('bui_newweight', null, PARAM_FLOAT);
1287         if (!$newregion || is_null($newweight)) {
1288             // Don't have a valid target position yet, must be just starting the move.
1289             $this->movingblock = $blockid;
1290             $this->page->ensure_param_not_in_url('bui_moveid');
1291             return false;
1292         }
1294         if (!$this->is_known_region($newregion)) {
1295             throw new moodle_exception('unknownblockregion', '', $this->page->url, $newregion);
1296         }
1298         // Move this block. This may involve moving other nearby blocks.
1299         $blocks = $this->birecordsbyregion[$newregion];
1301         $maxweight = self::MAX_WEIGHT;
1302         $minweight = -self::MAX_WEIGHT;
1304         // Initialise the used weights and spareweights array with the default values
1305         $spareweights = array();
1306         $usedweights = array();
1307         for ($i = $minweight; $i <= $maxweight; $i++) {
1308             $spareweights[$i] = $i;
1309             $usedweights[$i] = array();
1310         }
1312         // Check each block and sort out where we have used weights
1313         foreach ($blocks as $bi) {
1314             if ($bi->weight > $maxweight) {
1315                 // If this statement is true then the blocks weight is more than the
1316                 // current maximum. To ensure that we can get the best block position
1317                 // we will initialise elements within the usedweights and spareweights
1318                 // arrays between the blocks weight (which will then be the new max) and
1319                 // the current max
1320                 $parseweight = $bi->weight;
1321                 while (!array_key_exists($parseweight, $usedweights)) {
1322                     $usedweights[$parseweight] = array();
1323                     $spareweights[$parseweight] = $parseweight;
1324                     $parseweight--;
1325                 }
1326                 $maxweight = $bi->weight;
1327             } else if ($bi->weight < $minweight) {
1328                 // As above except this time the blocks weight is LESS than the
1329                 // the current minimum, so we will initialise the array from the
1330                 // blocks weight (new minimum) to the current minimum
1331                 $parseweight = $bi->weight;
1332                 while (!array_key_exists($parseweight, $usedweights)) {
1333                     $usedweights[$parseweight] = array();
1334                     $spareweights[$parseweight] = $parseweight;
1335                     $parseweight++;
1336                 }
1337                 $minweight = $bi->weight;
1338             }
1339             if ($bi->id != $block->instance->id) {
1340                 unset($spareweights[$bi->weight]);
1341                 $usedweights[$bi->weight][] = $bi->id;
1342             }
1343         }
1345         // First we find the nearest gap in the list of weights.
1346         $bestdistance = max(abs($newweight - self::MAX_WEIGHT), abs($newweight + self::MAX_WEIGHT)) + 1;
1347         $bestgap = null;
1348         foreach ($spareweights as $spareweight) {
1349             if (abs($newweight - $spareweight) < $bestdistance) {
1350                 $bestdistance = abs($newweight - $spareweight);
1351                 $bestgap = $spareweight;
1352             }
1353         }
1355         // If there is no gap, we have to go outside -self::MAX_WEIGHT .. self::MAX_WEIGHT.
1356         if (is_null($bestgap)) {
1357             $bestgap = self::MAX_WEIGHT + 1;
1358             while (!empty($usedweights[$bestgap])) {
1359                 $bestgap++;
1360             }
1361         }
1363         // Now we know the gap we are aiming for, so move all the blocks along.
1364         if ($bestgap < $newweight) {
1365             $newweight = floor($newweight);
1366             for ($weight = $bestgap + 1; $weight <= $newweight; $weight++) {
1367                 foreach ($usedweights[$weight] as $biid) {
1368                     $this->reposition_block($biid, $newregion, $weight - 1);
1369                 }
1370             }
1371             $this->reposition_block($block->instance->id, $newregion, $newweight);
1372         } else {
1373             $newweight = ceil($newweight);
1374             for ($weight = $bestgap - 1; $weight >= $newweight; $weight--) {
1375                 foreach ($usedweights[$weight] as $biid) {
1376                     $this->reposition_block($biid, $newregion, $weight + 1);
1377                 }
1378             }
1379             $this->reposition_block($block->instance->id, $newregion, $newweight);
1380         }
1382         $this->page->ensure_param_not_in_url('bui_moveid');
1383         $this->page->ensure_param_not_in_url('bui_newregion');
1384         $this->page->ensure_param_not_in_url('bui_newweight');
1385         return true;
1386     }
1388     /**
1389      * Turns the display of normal blocks either on or off.
1390      *
1391      * @param bool $setting
1392      */
1393     public function show_only_fake_blocks($setting = true) {
1394         $this->fakeblocksonly = $setting;
1395     }
1398 /// Helper functions for working with block classes ============================
1400 /**
1401  * Call a class method (one that does not require a block instance) on a block class.
1402  *
1403  * @param string $blockname the name of the block.
1404  * @param string $method the method name.
1405  * @param array $param parameters to pass to the method.
1406  * @return mixed whatever the method returns.
1407  */
1408 function block_method_result($blockname, $method, $param = NULL) {
1409     if(!block_load_class($blockname)) {
1410         return NULL;
1411     }
1412     return call_user_func(array('block_'.$blockname, $method), $param);
1415 /**
1416  * Creates a new object of the specified block class.
1417  *
1418  * @param string $blockname the name of the block.
1419  * @param $instance block_instances DB table row (optional).
1420  * @param moodle_page $page the page this block is appearing on.
1421  * @return block_base the requested block instance.
1422  */
1423 function block_instance($blockname, $instance = NULL, $page = NULL) {
1424     if(!block_load_class($blockname)) {
1425         return false;
1426     }
1427     $classname = 'block_'.$blockname;
1428     $retval = new $classname;
1429     if($instance !== NULL) {
1430         if (is_null($page)) {
1431             global $PAGE;
1432             $page = $PAGE;
1433         }
1434         $retval->_load_instance($instance, $page);
1435     }
1436     return $retval;
1439 /**
1440  * Load the block class for a particular type of block.
1441  *
1442  * @param string $blockname the name of the block.
1443  * @return boolean success or failure.
1444  */
1445 function block_load_class($blockname) {
1446     global $CFG;
1448     if(empty($blockname)) {
1449         return false;
1450     }
1452     $classname = 'block_'.$blockname;
1454     if(class_exists($classname)) {
1455         return true;
1456     }
1458     $blockpath = $CFG->dirroot.'/blocks/'.$blockname.'/block_'.$blockname.'.php';
1460     if (file_exists($blockpath)) {
1461         require_once($CFG->dirroot.'/blocks/moodleblock.class.php');
1462         include_once($blockpath);
1463     }else{
1464         //debugging("$blockname code does not exist in $blockpath", DEBUG_DEVELOPER);
1465         return false;
1466     }
1468     return class_exists($classname);
1471 /**
1472  * Given a specific page type, return all the page type patterns that might
1473  * match it.
1474  *
1475  * @param string $pagetype for example 'course-view-weeks' or 'mod-quiz-view'.
1476  * @return array an array of all the page type patterns that might match this page type.
1477  */
1478 function matching_page_type_patterns($pagetype) {
1479     $patterns = array($pagetype);
1480     $bits = explode('-', $pagetype);
1481     if (count($bits) == 3 && $bits[0] == 'mod') {
1482         if ($bits[2] == 'view') {
1483             $patterns[] = 'mod-*-view';
1484         } else if ($bits[2] == 'index') {
1485             $patterns[] = 'mod-*-index';
1486         }
1487     }
1488     while (count($bits) > 0) {
1489         $patterns[] = implode('-', $bits) . '-*';
1490         array_pop($bits);
1491     }
1492     $patterns[] = '*';
1493     return $patterns;
1496 /// Functions update the blocks if required by the request parameters ==========
1498 /**
1499  * Return a {@link block_contents} representing the add a new block UI, if
1500  * this user is allowed to see it.
1501  *
1502  * @return block_contents an appropriate block_contents, or null if the user
1503  * cannot add any blocks here.
1504  */
1505 function block_add_block_ui($page, $output) {
1506     global $CFG, $OUTPUT;
1507     if (!$page->user_is_editing() || !$page->user_can_edit_blocks()) {
1508         return null;
1509     }
1511     $bc = new block_contents();
1512     $bc->title = get_string('addblock');
1513     $bc->add_class('block_adminblock');
1515     $missingblocks = $page->blocks->get_addable_blocks();
1516     if (empty($missingblocks)) {
1517         $bc->content = get_string('noblockstoaddhere');
1518         return $bc;
1519     }
1521     $menu = array();
1522     foreach ($missingblocks as $block) {
1523         $blockobject = block_instance($block->name);
1524         if ($blockobject !== false && $blockobject->user_can_addto($page)) {
1525             $menu[$block->name] = $blockobject->get_title();
1526         }
1527     }
1528     textlib_get_instance()->asort($menu);
1530     $actionurl = new moodle_url($page->url, array('sesskey'=>sesskey()));
1531     $select = new single_select($actionurl, 'bui_addblock', $menu, null, array(''=>get_string('adddots')), 'add_block');
1532     $bc->content = $OUTPUT->render($select);
1533     return $bc;
1536 // Functions that have been deprecated by block_manager =======================
1538 /**
1539  * @deprecated since Moodle 2.0 - use $page->blocks->get_addable_blocks();
1540  *
1541  * This function returns an array with the IDs of any blocks that you can add to your page.
1542  * Parameters are passed by reference for speed; they are not modified at all.
1543  *
1544  * @param $page the page object.
1545  * @param $blockmanager Not used.
1546  * @return array of block type ids.
1547  */
1548 function blocks_get_missing(&$page, &$blockmanager) {
1549     debugging('blocks_get_missing is deprecated. Please use $page->blocks->get_addable_blocks() instead.', DEBUG_DEVELOPER);
1550     $blocks = $page->blocks->get_addable_blocks();
1551     $ids = array();
1552     foreach ($blocks as $block) {
1553         $ids[] = $block->id;
1554     }
1555     return $ids;
1558 /**
1559  * Actually delete from the database any blocks that are currently on this page,
1560  * but which should not be there according to blocks_name_allowed_in_format.
1561  *
1562  * @todo Write/Fix this function. Currently returns immediately
1563  * @param $course
1564  */
1565 function blocks_remove_inappropriate($course) {
1566     // TODO
1567     return;
1568     $blockmanager = blocks_get_by_page($page);
1570     if (empty($blockmanager)) {
1571         return;
1572     }
1574     if (($pageformat = $page->pagetype) == NULL) {
1575         return;
1576     }
1578     foreach($blockmanager as $region) {
1579         foreach($region as $instance) {
1580             $block = blocks_get_record($instance->blockid);
1581             if(!blocks_name_allowed_in_format($block->name, $pageformat)) {
1582                blocks_delete_instance($instance->instance);
1583             }
1584         }
1585     }
1588 /**
1589  * Check that a given name is in a permittable format
1590  *
1591  * @param string $name
1592  * @param string $pageformat
1593  * @return bool
1594  */
1595 function blocks_name_allowed_in_format($name, $pageformat) {
1596     $accept = NULL;
1597     $maxdepth = -1;
1598     $formats = block_method_result($name, 'applicable_formats');
1599     if (!$formats) {
1600         $formats = array();
1601     }
1602     foreach ($formats as $format => $allowed) {
1603         $formatregex = '/^'.str_replace('*', '[^-]*', $format).'.*$/';
1604         $depth = substr_count($format, '-');
1605         if (preg_match($formatregex, $pageformat) && $depth > $maxdepth) {
1606             $maxdepth = $depth;
1607             $accept = $allowed;
1608         }
1609     }
1610     if ($accept === NULL) {
1611         $accept = !empty($formats['all']);
1612     }
1613     return $accept;
1616 /**
1617  * Delete a block, and associated data.
1618  *
1619  * @param object $instance a row from the block_instances table
1620  * @param bool $nolongerused legacy parameter. Not used, but kept for backwards compatibility.
1621  * @param bool $skipblockstables for internal use only. Makes @see blocks_delete_all_for_context() more efficient.
1622  */
1623 function blocks_delete_instance($instance, $nolongerused = false, $skipblockstables = false) {
1624     global $DB;
1626     if ($block = block_instance($instance->blockname, $instance)) {
1627         $block->instance_delete();
1628     }
1629     delete_context(CONTEXT_BLOCK, $instance->id);
1631     if (!$skipblockstables) {
1632         $DB->delete_records('block_positions', array('blockinstanceid' => $instance->id));
1633         $DB->delete_records('block_instances', array('id' => $instance->id));
1634     }
1637 /**
1638  * Delete all the blocks that belong to a particular context.
1639  *
1640  * @param int $contextid the context id.
1641  */
1642 function blocks_delete_all_for_context($contextid) {
1643     global $DB;
1644     $instances = $DB->get_recordset('block_instances', array('parentcontextid' => $contextid));
1645     foreach ($instances as $instance) {
1646         blocks_delete_instance($instance, true);
1647     }
1648     $instances->close();
1649     $DB->delete_records('block_instances', array('parentcontextid' => $contextid));
1650     $DB->delete_records('block_positions', array('contextid' => $contextid));
1653 /**
1654  * Set a block to be visible or hidden on a particular page.
1655  *
1656  * @param object $instance a row from the block_instances, preferably LEFT JOINed with the
1657  *      block_positions table as return by block_manager.
1658  * @param moodle_page $page the back to set the visibility with respect to.
1659  * @param integer $newvisibility 1 for visible, 0 for hidden.
1660  */
1661 function blocks_set_visibility($instance, $page, $newvisibility) {
1662     global $DB;
1663     if (!empty($instance->blockpositionid)) {
1664         // Already have local information on this page.
1665         $DB->set_field('block_positions', 'visible', $newvisibility, array('id' => $instance->blockpositionid));
1666         return;
1667     }
1669     // Create a new block_positions record.
1670     $bp = new stdClass;
1671     $bp->blockinstanceid = $instance->id;
1672     $bp->contextid = $page->context->id;
1673     $bp->pagetype = $page->pagetype;
1674     if ($page->subpage) {
1675         $bp->subpage = $page->subpage;
1676     }
1677     $bp->visible = $newvisibility;
1678     $bp->region = $instance->defaultregion;
1679     $bp->weight = $instance->defaultweight;
1680     $DB->insert_record('block_positions', $bp);
1683 /**
1684  * @deprecated since 2.0
1685  * Delete all the blocks from a particular page.
1686  *
1687  * @param string $pagetype the page type.
1688  * @param integer $pageid the page id.
1689  * @return bool success or failure.
1690  */
1691 function blocks_delete_all_on_page($pagetype, $pageid) {
1692     global $DB;
1694     debugging('Call to deprecated function blocks_delete_all_on_page. ' .
1695             'This function cannot work any more. Doing nothing. ' .
1696             'Please update your code to use a block_manager method $PAGE->blocks->....', DEBUG_DEVELOPER);
1697     return false;
1700 /**
1701  * Dispite what this function is called, it seems to be mostly used to populate
1702  * the default blocks when a new course (or whatever) is created.
1703  *
1704  * @deprecated since 2.0
1705  *
1706  * @param object $page the page to add default blocks to.
1707  * @return boolean success or failure.
1708  */
1709 function blocks_repopulate_page($page) {
1710     global $CFG;
1712     debugging('Call to deprecated function blocks_repopulate_page. ' .
1713             'Use a more specific method like blocks_add_default_course_blocks, ' .
1714             'or just call $PAGE->blocks->add_blocks()', DEBUG_DEVELOPER);
1716     /// If the site override has been defined, it is the only valid one.
1717     if (!empty($CFG->defaultblocks_override)) {
1718         $blocknames = $CFG->defaultblocks_override;
1719     } else {
1720         $blocknames = $page->blocks_get_default();
1721     }
1723     $blocks = blocks_parse_default_blocks_list($blocknames);
1724     $page->blocks->add_blocks($blocks);
1726     return true;
1729 /**
1730  * Get the block record for a particular blockid - that is, a particular type os block.
1731  *
1732  * @param $int blockid block type id. If null, an array of all block types is returned.
1733  * @param bool $notusedanymore No longer used.
1734  * @return array|object row from block table, or all rows.
1735  */
1736 function blocks_get_record($blockid = NULL, $notusedanymore = false) {
1737     global $PAGE;
1738     $blocks = $PAGE->blocks->get_installed_blocks();
1739     if ($blockid === NULL) {
1740         return $blocks;
1741     } else if (isset($blocks[$blockid])) {
1742         return $blocks[$blockid];
1743     } else {
1744         return false;
1745     }
1748 /**
1749  * Find a given block by its blockid within a provide array
1750  *
1751  * @param int $blockid
1752  * @param array $blocksarray
1753  * @return bool|object Instance if found else false
1754  */
1755 function blocks_find_block($blockid, $blocksarray) {
1756     if (empty($blocksarray)) {
1757         return false;
1758     }
1759     foreach($blocksarray as $blockgroup) {
1760         if (empty($blockgroup)) {
1761             continue;
1762         }
1763         foreach($blockgroup as $instance) {
1764             if($instance->blockid == $blockid) {
1765                 return $instance;
1766             }
1767         }
1768     }
1769     return false;
1772 // Functions for programatically adding default blocks to pages ================
1774 /**
1775  * Parse a list of default blocks. See config-dist for a description of the format.
1776  *
1777  * @param string $blocksstr
1778  * @return array
1779  */
1780 function blocks_parse_default_blocks_list($blocksstr) {
1781     $blocks = array();
1782     $bits = explode(':', $blocksstr);
1783     if (!empty($bits)) {
1784         $leftbits = trim(array_shift($bits));
1785         if ($leftbits != '') {
1786             $blocks[BLOCK_POS_LEFT] = explode(',', $leftbits);
1787         }
1788     }
1789     if (!empty($bits)) {
1790         $rightbits =trim(array_shift($bits));
1791         if ($rightbits != '') {
1792             $blocks[BLOCK_POS_RIGHT] = explode(',', $rightbits);
1793         }
1794     }
1795     return $blocks;
1798 /**
1799  * @return array the blocks that should be added to the site course by default.
1800  */
1801 function blocks_get_default_site_course_blocks() {
1802     global $CFG;
1804     if (!empty($CFG->defaultblocks_site)) {
1805         return blocks_parse_default_blocks_list($CFG->defaultblocks_site);
1806     } else {
1807         return array(
1808             BLOCK_POS_LEFT => array('site_main_menu'),
1809             BLOCK_POS_RIGHT => array('course_summary', 'calendar_month')
1810         );
1811     }
1814 /**
1815  * Add the default blocks to a course.
1816  *
1817  * @param object $course a course object.
1818  */
1819 function blocks_add_default_course_blocks($course) {
1820     global $CFG;
1822     if (!empty($CFG->defaultblocks_override)) {
1823         $blocknames = blocks_parse_default_blocks_list($CFG->defaultblocks_override);
1825     } else if ($course->id == SITEID) {
1826         $blocknames = blocks_get_default_site_course_blocks();
1828     } else {
1829         $defaultblocks = 'defaultblocks_' . $course->format;
1830         if (!empty($CFG->$defaultblocks)) {
1831             $blocknames = blocks_parse_default_blocks_list($CFG->$defaultblocks);
1833         } else {
1834             $formatconfig = $CFG->dirroot.'/course/format/'.$course->format.'/config.php';
1835             if (is_readable($formatconfig)) {
1836                 require($formatconfig);
1837             }
1838             if (!empty($format['defaultblocks'])) {
1839                 $blocknames = blocks_parse_default_blocks_list($format['defaultblocks']);
1841             } else if (!empty($CFG->defaultblocks)){
1842                 $blocknames = blocks_parse_default_blocks_list($CFG->defaultblocks);
1844             } else {
1845                 $blocknames = array(
1846                     BLOCK_POS_LEFT => array(),
1847                     BLOCK_POS_RIGHT => array('search_forums', 'news_items', 'calendar_upcoming', 'recent_activity')
1848                 );
1849             }
1850         }
1851     }
1853     if ($course->id == SITEID) {
1854         $pagetypepattern = 'site-index';
1855     } else {
1856         $pagetypepattern = 'course-view-*';
1857     }
1858     $page = new moodle_page();
1859     $page->set_course($course);
1860     $page->blocks->add_blocks($blocknames, $pagetypepattern);
1863 /**
1864  * Add the default system-context blocks. E.g. the admin tree.
1865  */
1866 function blocks_add_default_system_blocks() {
1867     global $DB;
1869     $page = new moodle_page();
1870     $page->set_context(get_context_instance(CONTEXT_SYSTEM));
1871     $page->blocks->add_blocks(array(BLOCK_POS_LEFT => array('navigation', 'settings')), '*', null, true);
1872     $page->blocks->add_blocks(array(BLOCK_POS_LEFT => array('admin_bookmarks')), 'admin-*', null, null, 2);
1874     if ($defaultmypage = $DB->get_record('my_pages', array('userid'=>null, 'name'=>'__default', 'private'=>1))) {
1875         $subpagepattern = $defaultmypage->id;
1876     } else {
1877         $subpagepattern = null;
1878     }
1880     $page->blocks->add_blocks(array(BLOCK_POS_RIGHT => array('private_files', 'online_users'), 'content' => array('course_overview')), 'my-index', $subpagepattern, false);