MDL-30340 Trivial change in PHP doc block - the function does not accept any params
[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 define('BUI_CONTEXTS_FRONTPAGE_ONLY', 0);
57 define('BUI_CONTEXTS_FRONTPAGE_SUBS', 1);
58 define('BUI_CONTEXTS_ENTIRE_SITE', 2);
60 define('BUI_CONTEXTS_CURRENT', 0);
61 define('BUI_CONTEXTS_CURRENT_SUBS', 1);
63 /**
64  * Exception thrown when someone tried to do something with a block that does
65  * not exist on a page.
66  *
67  * @copyright 2009 Tim Hunt
68  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
69  * @since     Moodle 2.0
70  */
71 class block_not_on_page_exception extends moodle_exception {
72     /**
73      * Constructor
74      * @param int $instanceid the block instance id of the block that was looked for.
75      * @param object $page the current page.
76      */
77     public function __construct($instanceid, $page) {
78         $a = new stdClass;
79         $a->instanceid = $instanceid;
80         $a->url = $page->url->out();
81         parent::__construct('blockdoesnotexistonpage', '', $page->url->out(), $a);
82     }
83 }
85 /**
86  * This class keeps track of the block that should appear on a moodle_page.
87  *
88  * The page to work with as passed to the constructor.
89  *
90  * @copyright 2009 Tim Hunt
91  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
92  * @since     Moodle 2.0
93  */
94 class block_manager {
95     /**
96      * The UI normally only shows block weights between -MAX_WEIGHT and MAX_WEIGHT,
97      * although other weights are valid.
98      */
99     const MAX_WEIGHT = 10;
101 /// Field declarations =========================================================
103     /**
104      * the moodle_page we are managing blocks for.
105      * @var moodle_page
106      */
107     protected $page;
109     /** @var array region name => 1.*/
110     protected $regions = array();
112     /** @var string the region where new blocks are added.*/
113     protected $defaultregion = null;
115     /** @var array will be $DB->get_records('blocks') */
116     protected $allblocks = null;
118     /**
119      * @var array blocks that this user can add to this page. Will be a subset
120      * of $allblocks, but with array keys block->name. Access this via the
121      * {@link get_addable_blocks()} method to ensure it is lazy-loaded.
122      */
123     protected $addableblocks = null;
125     /**
126      * Will be an array region-name => array(db rows loaded in load_blocks);
127      * @var array
128      */
129     protected $birecordsbyregion = null;
131     /**
132      * array region-name => array(block objects); populated as necessary by
133      * the ensure_instances_exist method.
134      * @var array
135      */
136     protected $blockinstances = array();
138     /**
139      * array region-name => array(block_contents objects) what actually needs to
140      * be displayed in each region.
141      * @var array
142      */
143     protected $visibleblockcontent = array();
145     /**
146      * array region-name => array(block_contents objects) extra block-like things
147      * to be displayed in each region, before the real blocks.
148      * @var array
149      */
150     protected $extracontent = array();
152     /**
153      * Used by the block move id, to track whether a block is currently being moved.
154      *
155      * When you click on the move icon of a block, first the page needs to reload with
156      * extra UI for choosing a new position for a particular block. In that situation
157      * this field holds the id of the block being moved.
158      *
159      * @var integer|null
160      */
161     protected $movingblock = null;
163     /**
164      * Show only fake blocks
165      */
166     protected $fakeblocksonly = false;
168 /// Constructor ================================================================
170     /**
171      * Constructor.
172      * @param object $page the moodle_page object object we are managing the blocks for,
173      * or a reasonable faxilimily. (See the comment at the top of this class
174      * and {@link http://en.wikipedia.org/wiki/Duck_typing})
175      */
176     public function __construct($page) {
177         $this->page = $page;
178     }
180 /// Getter methods =============================================================
182     /**
183      * Get an array of all region names on this page where a block may appear
184      *
185      * @return array the internal names of the regions on this page where block may appear.
186      */
187     public function get_regions() {
188         if (is_null($this->defaultregion)) {
189             $this->page->initialise_theme_and_output();
190         }
191         return array_keys($this->regions);
192     }
194     /**
195      * Get the region name of the region blocks are added to by default
196      *
197      * @return string the internal names of the region where new blocks are added
198      * by default, and where any blocks from an unrecognised region are shown.
199      * (Imagine that blocks were added with one theme selected, then you switched
200      * to a theme with different block positions.)
201      */
202     public function get_default_region() {
203         $this->page->initialise_theme_and_output();
204         return $this->defaultregion;
205     }
207     /**
208      * The list of block types that may be added to this page.
209      *
210      * @return array block name => record from block table.
211      */
212     public function get_addable_blocks() {
213         $this->check_is_loaded();
215         if (!is_null($this->addableblocks)) {
216             return $this->addableblocks;
217         }
219         // Lazy load.
220         $this->addableblocks = array();
222         $allblocks = blocks_get_record();
223         if (empty($allblocks)) {
224             return $this->addableblocks;
225         }
227         $pageformat = $this->page->pagetype;
228         foreach($allblocks as $block) {
229             if ($block->visible &&
230                     (block_method_result($block->name, 'instance_allow_multiple') || !$this->is_block_present($block->name)) &&
231                     blocks_name_allowed_in_format($block->name, $pageformat) &&
232                     block_method_result($block->name, 'user_can_addto', $this->page)) {
233                 $this->addableblocks[$block->name] = $block;
234             }
235         }
237         return $this->addableblocks;
238     }
240     /**
241      * Given a block name, find out of any of them are currently present in the page
243      * @param string $blockname - the basic name of a block (eg "navigation")
244      * @return boolean - is there one of these blocks in the current page?
245      */
246     public function is_block_present($blockname) {
247         if (empty($this->blockinstances)) {
248             return false;
249         }
251         foreach ($this->blockinstances as $region) {
252             foreach ($region as $instance) {
253                 if (empty($instance->instance->blockname)) {
254                     continue;
255                 }
256                 if ($instance->instance->blockname == $blockname) {
257                     return true;
258                 }
259             }
260         }
261         return false;
262     }
264     /**
265      * Find out if a block type is known by the system
266      *
267      * @param string $blockname the name of the type of block.
268      * @param boolean $includeinvisible if false (default) only check 'visible' blocks, that is, blocks enabled by the admin.
269      * @return boolean true if this block in installed.
270      */
271     public function is_known_block_type($blockname, $includeinvisible = false) {
272         $blocks = $this->get_installed_blocks();
273         foreach ($blocks as $block) {
274             if ($block->name == $blockname && ($includeinvisible || $block->visible)) {
275                 return true;
276             }
277         }
278         return false;
279     }
281     /**
282      * Find out if a region exists on a page
283      *
284      * @param string $region a region name
285      * @return boolean true if this region exists on this page.
286      */
287     public function is_known_region($region) {
288         return array_key_exists($region, $this->regions);
289     }
291     /**
292      * Get an array of all blocks within a given region
293      *
294      * @param string $region a block region that exists on this page.
295      * @return array of block instances.
296      */
297     public function get_blocks_for_region($region) {
298         $this->check_is_loaded();
299         $this->ensure_instances_exist($region);
300         return $this->blockinstances[$region];
301     }
303     /**
304      * Returns an array of block content objects that exist in a region
305      *
306      * @param string $region a block region that exists on this page.
307      * @return array of block block_contents objects for all the blocks in a region.
308      */
309     public function get_content_for_region($region, $output) {
310         $this->check_is_loaded();
311         $this->ensure_content_created($region, $output);
312         return $this->visibleblockcontent[$region];
313     }
315     /**
316      * Helper method used by get_content_for_region.
317      * @param string $region region name
318      * @param float $weight weight. May be fractional, since you may want to move a block
319      * between ones with weight 2 and 3, say ($weight would be 2.5).
320      * @return string URL for moving block $this->movingblock to this position.
321      */
322     protected function get_move_target_url($region, $weight) {
323         return new moodle_url($this->page->url, array('bui_moveid' => $this->movingblock,
324                 'bui_newregion' => $region, 'bui_newweight' => $weight, 'sesskey' => sesskey()));
325     }
327     /**
328      * Determine whether a region contains anything. (Either any real blocks, or
329      * the add new block UI.)
330      *
331      * (You may wonder why the $output parameter is required. Unfortunately,
332      * because of the way that blocks work, the only reliable way to find out
333      * if a block will be visible is to get the content for output, and to
334      * get the content, you need a renderer. Fortunately, this is not a
335      * performance problem, because we cache the output that is generated, and
336      * in almost every case where we call region_has_content, we are about to
337      * output the blocks anyway, so we are not doing wasted effort.)
338      *
339      * @param string $region a block region that exists on this page.
340      * @param object $output a core_renderer. normally the global $OUTPUT.
341      * @return boolean Whether there is anything in this region.
342      */
343     public function region_has_content($region, $output) {
345         if (!$this->is_known_region($region)) {
346             return false;
347         }
348         $this->check_is_loaded();
349         $this->ensure_content_created($region, $output);
350         // if ($this->page->user_is_editing() && $this->page->user_can_edit_blocks()) {
351         // Mark Nielsen's patch - part 1
352         if ($this->page->user_is_editing() && $this->page->user_can_edit_blocks() && $this->movingblock) {
353             // If editing is on, we need all the block regions visible, for the
354             // move blocks UI.
355             return true;
356         }
357         return !empty($this->visibleblockcontent[$region]) || !empty($this->extracontent[$region]);
358     }
360     /**
361      * Get an array of all of the installed blocks.
362      *
363      * @return array contents of the block table.
364      */
365     public function get_installed_blocks() {
366         global $DB;
367         if (is_null($this->allblocks)) {
368             $this->allblocks = $DB->get_records('block');
369         }
370         return $this->allblocks;
371     }
373 /// Setter methods =============================================================
375     /**
376      * Add a region to a page
377      *
378      * @param string $region add a named region where blocks may appear on the
379      * current page. This is an internal name, like 'side-pre', not a string to
380      * display in the UI.
381      */
382     public function add_region($region) {
383         $this->check_not_yet_loaded();
384         $this->regions[$region] = 1;
385     }
387     /**
388      * Add an array of regions
389      * @see add_region()
390      *
391      * @param array $regions this utility method calls add_region for each array element.
392      */
393     public function add_regions($regions) {
394         foreach ($regions as $region) {
395             $this->add_region($region);
396         }
397     }
399     /**
400      * Set the default region for new blocks on the page
401      *
402      * @param string $defaultregion the internal names of the region where new
403      * blocks should be added by default, and where any blocks from an
404      * unrecognised region are shown.
405      */
406     public function set_default_region($defaultregion) {
407         $this->check_not_yet_loaded();
408         if ($defaultregion) {
409             $this->check_region_is_known($defaultregion);
410         }
411         $this->defaultregion = $defaultregion;
412     }
414     /**
415      * Add something that looks like a block, but which isn't an actual block_instance,
416      * to this page.
417      *
418      * @param block_contents $bc the content of the block-like thing.
419      * @param string $region a block region that exists on this page.
420      */
421     public function add_fake_block($bc, $region) {
422         $this->page->initialise_theme_and_output();
423         if (!$this->is_known_region($region)) {
424             $region = $this->get_default_region();
425         }
426         if (array_key_exists($region, $this->visibleblockcontent)) {
427             throw new coding_exception('block_manager has already prepared the blocks in region ' .
428                     $region . 'for output. It is too late to add a fake block.');
429         }
430         $this->extracontent[$region][] = $bc;
431     }
433     /**
434      * When the block_manager class was created, the {@link add_fake_block()}
435      * was called add_pretend_block, which is inconsisted with
436      * {@link show_only_fake_blocks()}. To fix this inconsistency, this method
437      * was renamed to add_fake_block. Please update your code.
438      * @param block_contents $bc the content of the block-like thing.
439      * @param string $region a block region that exists on this page.
440      */
441     public function add_pretend_block($bc, $region) {
442         debugging(DEBUG_DEVELOPER, 'add_pretend_block has been renamed to add_fake_block. Please rename the method call in your code.');
443         $this->add_fake_block($bc, $region);
444     }
446     /**
447      * Checks to see whether all of the blocks within the given region are docked
448      *
449      * @see region_uses_dock
450      * @param string $region
451      * @return bool True if all of the blocks within that region are docked
452      */
453     public function region_completely_docked($region, $output) {
454         if (!$this->page->theme->enable_dock) {
455             return false;
456         }
457         $this->check_is_loaded();
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 false;
462             }
463         }
464         return true;
465     }
467     /**
468      * Checks to see whether any of the blocks within the given regions are docked
469      *
470      * @see region_completely_docked
471      * @param array|string $regions array of regions (or single region)
472      * @return bool True if any of the blocks within that region are docked
473      */
474     public function region_uses_dock($regions, $output) {
475         if (!$this->page->theme->enable_dock) {
476             return false;
477         }
478         $this->check_is_loaded();
479         foreach((array)$regions as $region) {
480             $this->ensure_content_created($region, $output);
481             foreach($this->visibleblockcontent[$region] as $instance) {
482                 if(!empty($instance->content) && get_user_preferences('docked_block_instance_'.$instance->blockinstanceid, 0)) {
483                     return true;
484                 }
485             }
486         }
487         return false;
488     }
490 /// Actions ====================================================================
492     /**
493      * This method actually loads the blocks for our page from the database.
494      *
495      * @param boolean|null $includeinvisible
496      *      null (default) - load hidden blocks if $this->page->user_is_editing();
497      *      true - load hidden blocks.
498      *      false - don't load hidden blocks.
499      */
500     public function load_blocks($includeinvisible = null) {
501         global $DB, $CFG;
503         if (!is_null($this->birecordsbyregion)) {
504             // Already done.
505             return;
506         }
508         if ($CFG->version < 2009050619) {
509             // Upgrade/install not complete. Don't try too show any blocks.
510             $this->birecordsbyregion = array();
511             return;
512         }
514         // Ensure we have been initialised.
515         if (is_null($this->defaultregion)) {
516             $this->page->initialise_theme_and_output();
517             // If there are still no block regions, then there are no blocks on this page.
518             if (empty($this->regions)) {
519                 $this->birecordsbyregion = array();
520                 return;
521             }
522         }
524         // Check if we need to load normal blocks
525         if ($this->fakeblocksonly) {
526             $this->birecordsbyregion = $this->prepare_per_region_arrays();
527             return;
528         }
530         if (is_null($includeinvisible)) {
531             $includeinvisible = $this->page->user_is_editing();
532         }
533         if ($includeinvisible) {
534             $visiblecheck = '';
535         } else {
536             $visiblecheck = 'AND (bp.visible = 1 OR bp.visible IS NULL)';
537         }
539         $context = $this->page->context;
540         $contexttest = 'bi.parentcontextid = :contextid2';
541         $parentcontextparams = array();
542         $parentcontextids = get_parent_contexts($context);
543         if ($parentcontextids) {
544             list($parentcontexttest, $parentcontextparams) =
545                     $DB->get_in_or_equal($parentcontextids, SQL_PARAMS_NAMED, 'parentcontext');
546             $contexttest = "($contexttest OR (bi.showinsubcontexts = 1 AND bi.parentcontextid $parentcontexttest))";
547         }
549         $pagetypepatterns = matching_page_type_patterns($this->page->pagetype);
550         list($pagetypepatterntest, $pagetypepatternparams) =
551                 $DB->get_in_or_equal($pagetypepatterns, SQL_PARAMS_NAMED, 'pagetypepatterntest');
553         list($ccselect, $ccjoin) = context_instance_preload_sql('bi.id', CONTEXT_BLOCK, 'ctx');
555         $params = array(
556             'subpage1' => $this->page->subpage,
557             'subpage2' => $this->page->subpage,
558             'contextid1' => $context->id,
559             'contextid2' => $context->id,
560             'pagetype' => $this->page->pagetype,
561         );
562         if ($this->page->subpage === '') {
563             $params['subpage1'] = $DB->sql_empty();
564             $params['subpage2'] = $DB->sql_empty();
565         }
566         $sql = "SELECT
567                     bi.id,
568                     bp.id AS blockpositionid,
569                     bi.blockname,
570                     bi.parentcontextid,
571                     bi.showinsubcontexts,
572                     bi.pagetypepattern,
573                     bi.subpagepattern,
574                     bi.defaultregion,
575                     bi.defaultweight,
576                     COALESCE(bp.visible, 1) AS visible,
577                     COALESCE(bp.region, bi.defaultregion) AS region,
578                     COALESCE(bp.weight, bi.defaultweight) AS weight,
579                     bi.configdata
580                     $ccselect
582                 FROM {block_instances} bi
583                 JOIN {block} b ON bi.blockname = b.name
584                 LEFT JOIN {block_positions} bp ON bp.blockinstanceid = bi.id
585                                                   AND bp.contextid = :contextid1
586                                                   AND bp.pagetype = :pagetype
587                                                   AND bp.subpage = :subpage1
588                 $ccjoin
590                 WHERE
591                 $contexttest
592                 AND bi.pagetypepattern $pagetypepatterntest
593                 AND (bi.subpagepattern IS NULL OR bi.subpagepattern = :subpage2)
594                 $visiblecheck
595                 AND b.visible = 1
597                 ORDER BY
598                     COALESCE(bp.region, bi.defaultregion),
599                     COALESCE(bp.weight, bi.defaultweight),
600                     bi.id";
601         $blockinstances = $DB->get_recordset_sql($sql, $params + $parentcontextparams + $pagetypepatternparams);
603         $this->birecordsbyregion = $this->prepare_per_region_arrays();
604         $unknown = array();
605         foreach ($blockinstances as $bi) {
606             context_instance_preload($bi);
607             if ($this->is_known_region($bi->region)) {
608                 $this->birecordsbyregion[$bi->region][] = $bi;
609             } else {
610                 $unknown[] = $bi;
611             }
612         }
614         // Pages don't necessarily have a defaultregion. The  one time this can
615         // happen is when there are no theme block regions, but the script itself
616         // has a block region in the main content area.
617         if (!empty($this->defaultregion)) {
618             $this->birecordsbyregion[$this->defaultregion] =
619                     array_merge($this->birecordsbyregion[$this->defaultregion], $unknown);
620         }
621     }
623     /**
624      * Add a block to the current page, or related pages. The block is added to
625      * context $this->page->contextid. If $pagetypepattern $subpagepattern
626      *
627      * @param string $blockname The type of block to add.
628      * @param string $region the block region on this page to add the block to.
629      * @param integer $weight determines the order where this block appears in the region.
630      * @param boolean $showinsubcontexts whether this block appears in subcontexts, or just the current context.
631      * @param string|null $pagetypepattern which page types this block should appear on. Defaults to just the current page type.
632      * @param string|null $subpagepattern which subpage this block should appear on. NULL = any (the default), otherwise only the specified subpage.
633      */
634     public function add_block($blockname, $region, $weight, $showinsubcontexts, $pagetypepattern = NULL, $subpagepattern = NULL) {
635         global $DB;
636         // Allow invisible blocks because this is used when adding default page blocks, which
637         // might include invisible ones if the user makes some default blocks invisible
638         $this->check_known_block_type($blockname, true);
639         $this->check_region_is_known($region);
641         if (empty($pagetypepattern)) {
642             $pagetypepattern = $this->page->pagetype;
643         }
645         $blockinstance = new stdClass;
646         $blockinstance->blockname = $blockname;
647         $blockinstance->parentcontextid = $this->page->context->id;
648         $blockinstance->showinsubcontexts = !empty($showinsubcontexts);
649         $blockinstance->pagetypepattern = $pagetypepattern;
650         $blockinstance->subpagepattern = $subpagepattern;
651         $blockinstance->defaultregion = $region;
652         $blockinstance->defaultweight = $weight;
653         $blockinstance->configdata = '';
654         $blockinstance->id = $DB->insert_record('block_instances', $blockinstance);
656         // Ensure the block context is created.
657         get_context_instance(CONTEXT_BLOCK, $blockinstance->id);
659         // If the new instance was created, allow it to do additional setup
660         if ($block = block_instance($blockname, $blockinstance)) {
661             $block->instance_create();
662         }
663     }
665     public function add_block_at_end_of_default_region($blockname) {
666         $defaulregion = $this->get_default_region();
668         $lastcurrentblock = end($this->birecordsbyregion[$defaulregion]);
669         if ($lastcurrentblock) {
670             $weight = $lastcurrentblock->weight + 1;
671         } else {
672             $weight = 0;
673         }
675         if ($this->page->subpage) {
676             $subpage = $this->page->subpage;
677         } else {
678             $subpage = null;
679         }
681         // Special case. Course view page type include the course format, but we
682         // want to add the block non-format-specifically.
683         $pagetypepattern = $this->page->pagetype;
684         if (strpos($pagetypepattern, 'course-view') === 0) {
685             $pagetypepattern = 'course-view-*';
686         }
688         // We should end using this for ALL the blocks, making always the 1st option
689         // the default one to be used. Until then, this is one hack to avoid the
690         // 'pagetypewarning' message on blocks initial edition (MDL-27829) caused by
691         // non-existing $pagetypepattern set. This way at least we guarantee one "valid"
692         // (the FIRST $pagetypepattern will be set)
694         // We are applying it to all blocks created in mod pages for now and only if the
695         // default pagetype is not one of the available options
696         if (preg_match('/^mod-.*-/', $pagetypepattern)) {
697             $pagetypelist = generate_page_type_patterns($this->page->pagetype, null, $this->page->context);
698             // Only go for the first if the pagetype is not a valid option
699             if (is_array($pagetypelist) && !array_key_exists($pagetypepattern, $pagetypelist)) {
700                 $pagetypepattern = key($pagetypelist);
701             }
702         }
703         // Surely other pages like course-report will need this too, they just are not important
704         // enough now. This will be decided in the coming days. (MDL-27829, MDL-28150)
706         $this->add_block($blockname, $defaulregion, $weight, false, $pagetypepattern, $subpage);
707     }
709     /**
710      * Convenience method, calls add_block repeatedly for all the blocks in $blocks.
711      *
712      * @param array $blocks array with array keys the region names, and values an array of block names.
713      * @param string $pagetypepattern optional. Passed to @see add_block()
714      * @param string $subpagepattern optional. Passed to @see add_block()
715      */
716     public function add_blocks($blocks, $pagetypepattern = NULL, $subpagepattern = NULL, $showinsubcontexts=false, $weight=0) {
717         $this->add_regions(array_keys($blocks));
718         foreach ($blocks as $region => $regionblocks) {
719             $weight = 0;
720             foreach ($regionblocks as $blockname) {
721                 $this->add_block($blockname, $region, $weight, $showinsubcontexts, $pagetypepattern, $subpagepattern);
722                 $weight += 1;
723             }
724         }
725     }
727     /**
728      * Move a block to a new position on this page.
729      *
730      * If this block cannot appear on any other pages, then we change defaultposition/weight
731      * in the block_instances table. Otherwise we just set the position on this page.
732      *
733      * @param $blockinstanceid the block instance id.
734      * @param $newregion the new region name.
735      * @param $newweight the new weight.
736      */
737     public function reposition_block($blockinstanceid, $newregion, $newweight) {
738         global $DB;
740         $this->check_region_is_known($newregion);
741         $inst = $this->find_instance($blockinstanceid);
743         $bi = $inst->instance;
744         if ($bi->weight == $bi->defaultweight && $bi->region == $bi->defaultregion &&
745                 !$bi->showinsubcontexts && strpos($bi->pagetypepattern, '*') === false &&
746                 (!$this->page->subpage || $bi->subpagepattern)) {
748             // Set default position
749             $newbi = new stdClass;
750             $newbi->id = $bi->id;
751             $newbi->defaultregion = $newregion;
752             $newbi->defaultweight = $newweight;
753             $DB->update_record('block_instances', $newbi);
755             if ($bi->blockpositionid) {
756                 $bp = new stdClass;
757                 $bp->id = $bi->blockpositionid;
758                 $bp->region = $newregion;
759                 $bp->weight = $newweight;
760                 $DB->update_record('block_positions', $bp);
761             }
763         } else {
764             // Just set position on this page.
765             $bp = new stdClass;
766             $bp->region = $newregion;
767             $bp->weight = $newweight;
769             if ($bi->blockpositionid) {
770                 $bp->id = $bi->blockpositionid;
771                 $DB->update_record('block_positions', $bp);
773             } else {
774                 $bp->blockinstanceid = $bi->id;
775                 $bp->contextid = $this->page->context->id;
776                 $bp->pagetype = $this->page->pagetype;
777                 if ($this->page->subpage) {
778                     $bp->subpage = $this->page->subpage;
779                 } else {
780                     $bp->subpage = '';
781                 }
782                 $bp->visible = $bi->visible;
783                 $DB->insert_record('block_positions', $bp);
784             }
785         }
786     }
788     /**
789      * Find a given block by its instance id
790      *
791      * @param integer $instanceid
792      * @return object
793      */
794     public function find_instance($instanceid) {
795         foreach ($this->regions as $region => $notused) {
796             $this->ensure_instances_exist($region);
797             foreach($this->blockinstances[$region] as $instance) {
798                 if ($instance->instance->id == $instanceid) {
799                     return $instance;
800                 }
801             }
802         }
803         throw new block_not_on_page_exception($instanceid, $this->page);
804     }
806 /// Inner workings =============================================================
808     /**
809      * Check whether the page blocks have been loaded yet
810      *
811      * @return void Throws coding exception if already loaded
812      */
813     protected function check_not_yet_loaded() {
814         if (!is_null($this->birecordsbyregion)) {
815             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.');
816         }
817     }
819     /**
820      * Check whether the page blocks have been loaded yet
821      *
822      * Nearly identical to the above function {@link check_not_yet_loaded()} except different message
823      *
824      * @return void Throws coding exception if already loaded
825      */
826     protected function check_is_loaded() {
827         if (is_null($this->birecordsbyregion)) {
828             throw new coding_exception('block_manager has not yet loaded the blocks, to it is too soon to request the information you asked for.');
829         }
830     }
832     /**
833      * Check if a block type is known and usable
834      *
835      * @param string $blockname The block type name to search for
836      * @param bool $includeinvisible Include disabled block types in the initial pass
837      * @return void Coding Exception thrown if unknown or not enabled
838      */
839     protected function check_known_block_type($blockname, $includeinvisible = false) {
840         if (!$this->is_known_block_type($blockname, $includeinvisible)) {
841             if ($this->is_known_block_type($blockname, true)) {
842                 throw new coding_exception('Unknown block type ' . $blockname);
843             } else {
844                 throw new coding_exception('Block type ' . $blockname . ' has been disabled by the administrator.');
845             }
846         }
847     }
849     /**
850      * Check if a region is known by its name
851      *
852      * @param string $region
853      * @return void Coding Exception thrown if the region is not known
854      */
855     protected function check_region_is_known($region) {
856         if (!$this->is_known_region($region)) {
857             throw new coding_exception('Trying to reference an unknown block region ' . $region);
858         }
859     }
861     /**
862      * Returns an array of region names as keys and nested arrays for values
863      *
864      * @return array an array where the array keys are the region names, and the array
865      * values are empty arrays.
866      */
867     protected function prepare_per_region_arrays() {
868         $result = array();
869         foreach ($this->regions as $region => $notused) {
870             $result[$region] = array();
871         }
872         return $result;
873     }
875     /**
876      * Create a set of new block instance from a record array
877      *
878      * @param array $birecords An array of block instance records
879      * @return array An array of instantiated block_instance objects
880      */
881     protected function create_block_instances($birecords) {
882         $results = array();
883         foreach ($birecords as $record) {
884             if ($blockobject = block_instance($record->blockname, $record, $this->page)) {
885                 $results[] = $blockobject;
886             }
887         }
888         return $results;
889     }
891     /**
892      * Create all the block instances for all the blocks that were loaded by
893      * load_blocks. This is used, for example, to ensure that all blocks get a
894      * chance to initialise themselves via the {@link block_base::specialize()}
895      * method, before any output is done.
896      */
897     public function create_all_block_instances() {
898         foreach ($this->get_regions() as $region) {
899             $this->ensure_instances_exist($region);
900         }
901     }
903     /**
904      * Return an array of content objects from a set of block instances
905      *
906      * @param array $instances An array of block instances
907      * @param renderer_base The renderer to use.
908      * @param string $region the region name.
909      * @return array An array of block_content (and possibly block_move_target) objects.
910      */
911     protected function create_block_contents($instances, $output, $region) {
912         $results = array();
914         $lastweight = 0;
915         $lastblock = 0;
916         if ($this->movingblock) {
917             $first = reset($instances);
918             if ($first) {
919                 $lastweight = $first->instance->weight - 2;
920             }
922             $strmoveblockhere = get_string('moveblockhere', 'block');
923         }
925         foreach ($instances as $instance) {
926             $content = $instance->get_content_for_output($output);
927             if (empty($content)) {
928                 continue;
929             }
931             if ($this->movingblock && $lastweight != $instance->instance->weight &&
932                     $content->blockinstanceid != $this->movingblock && $lastblock != $this->movingblock) {
933                 $results[] = new block_move_target($strmoveblockhere, $this->get_move_target_url($region, ($lastweight + $instance->instance->weight)/2));
934             }
936             if ($content->blockinstanceid == $this->movingblock) {
937                 $content->add_class('beingmoved');
938                 $content->annotation .= get_string('movingthisblockcancel', 'block',
939                         html_writer::link($this->page->url, get_string('cancel')));
940             }
942             $results[] = $content;
943             $lastweight = $instance->instance->weight;
944             $lastblock = $instance->instance->id;
945         }
947         if ($this->movingblock && $lastblock != $this->movingblock) {
948             $results[] = new block_move_target($strmoveblockhere, $this->get_move_target_url($region, $lastweight + 1));
949         }
950         return $results;
951     }
953     /**
954      * Ensure block instances exist for a given region
955      *
956      * @param string $region Check for bi's with the instance with this name
957      */
958     protected function ensure_instances_exist($region) {
959         $this->check_region_is_known($region);
960         if (!array_key_exists($region, $this->blockinstances)) {
961             $this->blockinstances[$region] =
962                     $this->create_block_instances($this->birecordsbyregion[$region]);
963         }
964     }
966     /**
967      * Ensure that there is some content within the given region
968      *
969      * @param string $region The name of the region to check
970      */
971     protected function ensure_content_created($region, $output) {
972         $this->ensure_instances_exist($region);
973         if (!array_key_exists($region, $this->visibleblockcontent)) {
974             $contents = array();
975             if (array_key_exists($region, $this->extracontent)) {
976                 $contents = $this->extracontent[$region];
977             }
978             $contents = array_merge($contents, $this->create_block_contents($this->blockinstances[$region], $output, $region));
979             if ($region == $this->defaultregion) {
980                 $addblockui = block_add_block_ui($this->page, $output);
981                 if ($addblockui) {
982                     $contents[] = $addblockui;
983                 }
984             }
985             $this->visibleblockcontent[$region] = $contents;
986         }
987     }
989 /// Process actions from the URL ===============================================
991     /**
992      * Get the appropriate list of editing icons for a block. This is used
993      * to set {@link block_contents::$controls} in {@link block_base::get_contents_for_output()}.
994      *
995      * @param $output The core_renderer to use when generating the output. (Need to get icon paths.)
996      * @return an array in the format for {@link block_contents::$controls}
997      */
998     public function edit_controls($block) {
999         global $CFG;
1001         if (!isset($CFG->undeletableblocktypes) || (!is_array($CFG->undeletableblocktypes) && !is_string($CFG->undeletableblocktypes))) {
1002             $undeletableblocktypes = array('navigation','settings');
1003         } else if (is_string($CFG->undeletableblocktypes)) {
1004             $undeletableblocktypes = explode(',', $CFG->undeletableblocktypes);
1005         } else {
1006             $undeletableblocktypes = $CFG->undeletableblocktypes;
1007         }
1009         $controls = array();
1010         $actionurl = $this->page->url->out(false, array('sesskey'=> sesskey()));
1012         if ($this->page->user_can_edit_blocks()) {
1013             // Move icon.
1014             $controls[] = array('url' => $actionurl . '&bui_moveid=' . $block->instance->id,
1015                     'icon' => 't/move', 'caption' => get_string('move'));
1016         }
1018         if ($this->page->user_can_edit_blocks() || $block->user_can_edit()) {
1019             // Edit config icon - always show - needed for positioning UI.
1020             $controls[] = array('url' => $actionurl . '&bui_editid=' . $block->instance->id,
1021                     'icon' => 't/edit', 'caption' => get_string('configuration'));
1022         }
1024         if ($this->page->user_can_edit_blocks() && $block->user_can_edit() && $block->user_can_addto($this->page)) {
1025             if (!in_array($block->instance->blockname, $undeletableblocktypes)
1026                     || !in_array($block->instance->pagetypepattern, array('*', 'site-index'))
1027                     || $block->instance->parentcontextid != SITEID) {
1028                 // Delete icon.
1029                 $controls[] = array('url' => $actionurl . '&bui_deleteid=' . $block->instance->id,
1030                         'icon' => 't/delete', 'caption' => get_string('delete'));
1031             }
1032         }
1034         if ($this->page->user_can_edit_blocks() && $block->instance_can_be_hidden()) {
1035             // Show/hide icon.
1036             if ($block->instance->visible) {
1037                 $controls[] = array('url' => $actionurl . '&bui_hideid=' . $block->instance->id,
1038                         'icon' => 't/hide', 'caption' => get_string('hide'));
1039             } else {
1040                 $controls[] = array('url' => $actionurl . '&bui_showid=' . $block->instance->id,
1041                         'icon' => 't/show', 'caption' => get_string('show'));
1042             }
1043         }
1045         // Assign roles icon.
1046         if (has_capability('moodle/role:assign', $block->context)) {
1047             //TODO: please note it is sloppy to pass urls through page parameters!!
1048             //      it is shortened because some web servers (e.g. IIS by default) give
1049             //      a 'security' error if you try to pass a full URL as a GET parameter in another URL.
1050             $return = $this->page->url->out(false);
1051             $return = str_replace($CFG->wwwroot . '/', '', $return);
1053             $controls[] = array('url' => $CFG->wwwroot . '/' . $CFG->admin .
1054                     '/roles/assign.php?contextid=' . $block->context->id . '&returnurl=' . urlencode($return),
1055                     'icon' => 'i/roles', 'caption' => get_string('assignroles', 'role'));
1056         }
1058         return $controls;
1059     }
1061     /**
1062      * Process any block actions that were specified in the URL.
1063      *
1064      * @return boolean true if anything was done. False if not.
1065      */
1066     public function process_url_actions() {
1067         if (!$this->page->user_is_editing()) {
1068             return false;
1069         }
1070         return $this->process_url_add() || $this->process_url_delete() ||
1071             $this->process_url_show_hide() || $this->process_url_edit() ||
1072             $this->process_url_move();
1073     }
1075     /**
1076      * Handle adding a block.
1077      * @return boolean true if anything was done. False if not.
1078      */
1079     public function process_url_add() {
1080         $blocktype = optional_param('bui_addblock', null, PARAM_PLUGIN);
1081         if (!$blocktype) {
1082             return false;
1083         }
1085         require_sesskey();
1087         if (!$this->page->user_can_edit_blocks()) {
1088             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('addblock'));
1089         }
1091         if (!array_key_exists($blocktype, $this->get_addable_blocks())) {
1092             throw new moodle_exception('cannotaddthisblocktype', '', $this->page->url->out(), $blocktype);
1093         }
1095         $this->add_block_at_end_of_default_region($blocktype);
1097         // If the page URL was a guess, it will contain the bui_... param, so we must make sure it is not there.
1098         $this->page->ensure_param_not_in_url('bui_addblock');
1100         return true;
1101     }
1103     /**
1104      * Handle deleting a block.
1105      * @return boolean true if anything was done. False if not.
1106      */
1107     public function process_url_delete() {
1108         $blockid = optional_param('bui_deleteid', null, PARAM_INTEGER);
1109         if (!$blockid) {
1110             return false;
1111         }
1113         require_sesskey();
1115         $block = $this->page->blocks->find_instance($blockid);
1117         if (!$block->user_can_edit() || !$this->page->user_can_edit_blocks() || !$block->user_can_addto($this->page)) {
1118             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('deleteablock'));
1119         }
1121         blocks_delete_instance($block->instance);
1123         // If the page URL was a guess, it will contain the bui_... param, so we must make sure it is not there.
1124         $this->page->ensure_param_not_in_url('bui_deleteid');
1126         return true;
1127     }
1129     /**
1130      * Handle showing or hiding a block.
1131      * @return boolean true if anything was done. False if not.
1132      */
1133     public function process_url_show_hide() {
1134         if ($blockid = optional_param('bui_hideid', null, PARAM_INTEGER)) {
1135             $newvisibility = 0;
1136         } else if ($blockid = optional_param('bui_showid', null, PARAM_INTEGER)) {
1137             $newvisibility = 1;
1138         } else {
1139             return false;
1140         }
1142         require_sesskey();
1144         $block = $this->page->blocks->find_instance($blockid);
1146         if (!$this->page->user_can_edit_blocks()) {
1147             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('hideshowblocks'));
1148         } else if (!$block->instance_can_be_hidden()) {
1149             return false;
1150         }
1152         blocks_set_visibility($block->instance, $this->page, $newvisibility);
1154         // If the page URL was a guses, it will contain the bui_... param, so we must make sure it is not there.
1155         $this->page->ensure_param_not_in_url('bui_hideid');
1156         $this->page->ensure_param_not_in_url('bui_showid');
1158         return true;
1159     }
1161     /**
1162      * Handle showing/processing the submission from the block editing form.
1163      * @return boolean true if the form was submitted and the new config saved. Does not
1164      *      return if the editing form was displayed. False otherwise.
1165      */
1166     public function process_url_edit() {
1167         global $CFG, $DB, $PAGE, $OUTPUT;
1169         $blockid = optional_param('bui_editid', null, PARAM_INTEGER);
1170         if (!$blockid) {
1171             return false;
1172         }
1174         require_sesskey();
1175         require_once($CFG->dirroot . '/blocks/edit_form.php');
1177         $block = $this->find_instance($blockid);
1179         if (!$block->user_can_edit() && !$this->page->user_can_edit_blocks()) {
1180             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('editblock'));
1181         }
1183         $editpage = new moodle_page();
1184         $editpage->set_pagelayout('admin');
1185         $editpage->set_course($this->page->course);
1186         //$editpage->set_context($block->context);
1187         $editpage->set_context($this->page->context);
1188         if ($this->page->cm) {
1189             $editpage->set_cm($this->page->cm);
1190         }
1191         $editurlbase = str_replace($CFG->wwwroot . '/', '/', $this->page->url->out_omit_querystring());
1192         $editurlparams = $this->page->url->params();
1193         $editurlparams['bui_editid'] = $blockid;
1194         $editpage->set_url($editurlbase, $editurlparams);
1195         $editpage->set_block_actions_done();
1196         // At this point we are either going to redirect, or display the form, so
1197         // overwrite global $PAGE ready for this. (Formslib refers to it.)
1198         $PAGE = $editpage;
1199         //some functions like MoodleQuickForm::addHelpButton use $OUTPUT so we need to replace that to
1200         $output = $editpage->get_renderer('core');
1201         $OUTPUT = $output;
1203         $formfile = $CFG->dirroot . '/blocks/' . $block->name() . '/edit_form.php';
1204         if (is_readable($formfile)) {
1205             require_once($formfile);
1206             $classname = 'block_' . $block->name() . '_edit_form';
1207             if (!class_exists($classname)) {
1208                 $classname = 'block_edit_form';
1209             }
1210         } else {
1211             $classname = 'block_edit_form';
1212         }
1214         $mform = new $classname($editpage->url, $block, $this->page);
1215         $mform->set_data($block->instance);
1217         if ($mform->is_cancelled()) {
1218             redirect($this->page->url);
1220         } else if ($data = $mform->get_data()) {
1221             $bi = new stdClass;
1222             $bi->id = $block->instance->id;
1223             $bi->pagetypepattern = $data->bui_pagetypepattern;
1224             if (empty($data->bui_subpagepattern) || $data->bui_subpagepattern == '%@NULL@%') {
1225                 $bi->subpagepattern = null;
1226             } else {
1227                 $bi->subpagepattern = $data->bui_subpagepattern;
1228             }
1230             $parentcontext = get_context_instance_by_id($data->bui_parentcontextid);
1231             $systemcontext = get_context_instance(CONTEXT_SYSTEM);
1233             // Updating stickiness and contexts.  See MDL-21375 for details.
1234             if (has_capability('moodle/site:manageblocks', $parentcontext)) { // Check permissions in destination
1235                 // Explicitly set the context
1236                 $bi->parentcontextid = $parentcontext->id;
1238                 // If the context type is > 0 then we'll explicitly set the block as sticky, otherwise not
1239                 $bi->showinsubcontexts = (int)(!empty($data->bui_contexts));
1241                 // If the block wants to be system-wide, then explicitly set that
1242                 if ($data->bui_contexts == BUI_CONTEXTS_ENTIRE_SITE) {   // Only possible on a frontpage or system page
1243                     $bi->parentcontextid = $systemcontext->id;
1244                     $bi->showinsubcontexts = BUI_CONTEXTS_CURRENT_SUBS; //show in current and sub contexts
1245                     $bi->pagetypepattern = '*';
1247                 } else { // The block doesn't want to be system-wide, so let's ensure that
1248                     if ($parentcontext->id == $systemcontext->id) {  // We need to move it to the front page
1249                         $frontpagecontext = get_context_instance(CONTEXT_COURSE, SITEID);
1250                         $bi->parentcontextid = $frontpagecontext->id;
1251                         $bi->pagetypepattern = 'site-index';
1252                     }
1253                 }
1254             }
1256             $bits = explode('-', $bi->pagetypepattern);
1257             // hacks for some contexts
1258             if (($parentcontext->contextlevel == CONTEXT_COURSE) && ($parentcontext->instanceid != SITEID)) {
1259                 // For course context
1260                 // is page type pattern is mod-*, change showinsubcontext to 1
1261                 if ($bits[0] == 'mod' || $bi->pagetypepattern == '*') {
1262                     $bi->showinsubcontexts = 1;
1263                 } else {
1264                     $bi->showinsubcontexts = 0;
1265                 }
1266             } else  if ($parentcontext->contextlevel == CONTEXT_USER) {
1267                 // for user context
1268                 // subpagepattern should be null
1269                 if ($bits[0] == 'user' or $bits[0] == 'my') {
1270                     // we don't need subpagepattern in usercontext
1271                     $bi->subpagepattern = null;
1272                 }
1273             }
1275             $bi->defaultregion = $data->bui_defaultregion;
1276             $bi->defaultweight = $data->bui_defaultweight;
1277             $DB->update_record('block_instances', $bi);
1279             if (!empty($block->config)) {
1280                 $config = clone($block->config);
1281             } else {
1282                 $config = new stdClass;
1283             }
1284             foreach ($data as $configfield => $value) {
1285                 if (strpos($configfield, 'config_') !== 0) {
1286                     continue;
1287                 }
1288                 $field = substr($configfield, 7);
1289                 $config->$field = $value;
1290             }
1291             $block->instance_config_save($config);
1293             $bp = new stdClass;
1294             $bp->visible = $data->bui_visible;
1295             $bp->region = $data->bui_region;
1296             $bp->weight = $data->bui_weight;
1297             $needbprecord = !$data->bui_visible || $data->bui_region != $data->bui_defaultregion ||
1298                     $data->bui_weight != $data->bui_defaultweight;
1300             if ($block->instance->blockpositionid && !$needbprecord) {
1301                 $DB->delete_records('block_positions', array('id' => $block->instance->blockpositionid));
1303             } else if ($block->instance->blockpositionid && $needbprecord) {
1304                 $bp->id = $block->instance->blockpositionid;
1305                 $DB->update_record('block_positions', $bp);
1307             } else if ($needbprecord) {
1308                 $bp->blockinstanceid = $block->instance->id;
1309                 $bp->contextid = $this->page->context->id;
1310                 $bp->pagetype = $this->page->pagetype;
1311                 if ($this->page->subpage) {
1312                     $bp->subpage = $this->page->subpage;
1313                 } else {
1314                     $bp->subpage = '';
1315                 }
1316                 $DB->insert_record('block_positions', $bp);
1317             }
1319             redirect($this->page->url);
1321         } else {
1322             $strheading = get_string('blockconfiga', 'moodle', $block->get_title());
1323             $editpage->set_title($strheading);
1324             $editpage->set_heading($strheading);
1325             $bits = explode('-', $this->page->pagetype);
1326             if ($bits[0] == 'tag' && !empty($this->page->subpage)) {
1327                 // better navbar for tag pages
1328                 $editpage->navbar->add(get_string('tags'), new moodle_url('/tag/'));
1329                 $tag = tag_get('id', $this->page->subpage, '*');
1330                 // tag search page doesn't have subpageid
1331                 if ($tag) {
1332                     $editpage->navbar->add($tag->name, new moodle_url('/tag/index.php', array('id'=>$tag->id)));
1333                 }
1334             }
1335             $editpage->navbar->add($block->get_title());
1336             $editpage->navbar->add(get_string('configuration'));
1337             echo $output->header();
1338             echo $output->heading($strheading, 2);
1339             $mform->display();
1340             echo $output->footer();
1341             exit;
1342         }
1343     }
1345     /**
1346      * Handle showing/processing the submission from the block editing form.
1347      * @return boolean true if the form was submitted and the new config saved. Does not
1348      *      return if the editing form was displayed. False otherwise.
1349      */
1350     public function process_url_move() {
1351         global $CFG, $DB, $PAGE;
1353         $blockid = optional_param('bui_moveid', null, PARAM_INTEGER);
1354         if (!$blockid) {
1355             return false;
1356         }
1358         require_sesskey();
1360         $block = $this->find_instance($blockid);
1362         if (!$this->page->user_can_edit_blocks()) {
1363             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('editblock'));
1364         }
1366         $newregion = optional_param('bui_newregion', '', PARAM_ALPHANUMEXT);
1367         $newweight = optional_param('bui_newweight', null, PARAM_FLOAT);
1368         if (!$newregion || is_null($newweight)) {
1369             // Don't have a valid target position yet, must be just starting the move.
1370             $this->movingblock = $blockid;
1371             $this->page->ensure_param_not_in_url('bui_moveid');
1372             return false;
1373         }
1375         if (!$this->is_known_region($newregion)) {
1376             throw new moodle_exception('unknownblockregion', '', $this->page->url, $newregion);
1377         }
1379         // Move this block. This may involve moving other nearby blocks.
1380         $blocks = $this->birecordsbyregion[$newregion];
1382         $maxweight = self::MAX_WEIGHT;
1383         $minweight = -self::MAX_WEIGHT;
1385         // Initialise the used weights and spareweights array with the default values
1386         $spareweights = array();
1387         $usedweights = array();
1388         for ($i = $minweight; $i <= $maxweight; $i++) {
1389             $spareweights[$i] = $i;
1390             $usedweights[$i] = array();
1391         }
1393         // Check each block and sort out where we have used weights
1394         foreach ($blocks as $bi) {
1395             if ($bi->weight > $maxweight) {
1396                 // If this statement is true then the blocks weight is more than the
1397                 // current maximum. To ensure that we can get the best block position
1398                 // we will initialise elements within the usedweights and spareweights
1399                 // arrays between the blocks weight (which will then be the new max) and
1400                 // the current max
1401                 $parseweight = $bi->weight;
1402                 while (!array_key_exists($parseweight, $usedweights)) {
1403                     $usedweights[$parseweight] = array();
1404                     $spareweights[$parseweight] = $parseweight;
1405                     $parseweight--;
1406                 }
1407                 $maxweight = $bi->weight;
1408             } else if ($bi->weight < $minweight) {
1409                 // As above except this time the blocks weight is LESS than the
1410                 // the current minimum, so we will initialise the array from the
1411                 // blocks weight (new minimum) to the current minimum
1412                 $parseweight = $bi->weight;
1413                 while (!array_key_exists($parseweight, $usedweights)) {
1414                     $usedweights[$parseweight] = array();
1415                     $spareweights[$parseweight] = $parseweight;
1416                     $parseweight++;
1417                 }
1418                 $minweight = $bi->weight;
1419             }
1420             if ($bi->id != $block->instance->id) {
1421                 unset($spareweights[$bi->weight]);
1422                 $usedweights[$bi->weight][] = $bi->id;
1423             }
1424         }
1426         // First we find the nearest gap in the list of weights.
1427         $bestdistance = max(abs($newweight - self::MAX_WEIGHT), abs($newweight + self::MAX_WEIGHT)) + 1;
1428         $bestgap = null;
1429         foreach ($spareweights as $spareweight) {
1430             if (abs($newweight - $spareweight) < $bestdistance) {
1431                 $bestdistance = abs($newweight - $spareweight);
1432                 $bestgap = $spareweight;
1433             }
1434         }
1436         // If there is no gap, we have to go outside -self::MAX_WEIGHT .. self::MAX_WEIGHT.
1437         if (is_null($bestgap)) {
1438             $bestgap = self::MAX_WEIGHT + 1;
1439             while (!empty($usedweights[$bestgap])) {
1440                 $bestgap++;
1441             }
1442         }
1444         // Now we know the gap we are aiming for, so move all the blocks along.
1445         if ($bestgap < $newweight) {
1446             $newweight = floor($newweight);
1447             for ($weight = $bestgap + 1; $weight <= $newweight; $weight++) {
1448                 foreach ($usedweights[$weight] as $biid) {
1449                     $this->reposition_block($biid, $newregion, $weight - 1);
1450                 }
1451             }
1452             $this->reposition_block($block->instance->id, $newregion, $newweight);
1453         } else {
1454             $newweight = ceil($newweight);
1455             for ($weight = $bestgap - 1; $weight >= $newweight; $weight--) {
1456                 foreach ($usedweights[$weight] as $biid) {
1457                     $this->reposition_block($biid, $newregion, $weight + 1);
1458                 }
1459             }
1460             $this->reposition_block($block->instance->id, $newregion, $newweight);
1461         }
1463         $this->page->ensure_param_not_in_url('bui_moveid');
1464         $this->page->ensure_param_not_in_url('bui_newregion');
1465         $this->page->ensure_param_not_in_url('bui_newweight');
1466         return true;
1467     }
1469     /**
1470      * Turns the display of normal blocks either on or off.
1471      *
1472      * @param bool $setting
1473      */
1474     public function show_only_fake_blocks($setting = true) {
1475         $this->fakeblocksonly = $setting;
1476     }
1479 /// Helper functions for working with block classes ============================
1481 /**
1482  * Call a class method (one that does not require a block instance) on a block class.
1483  *
1484  * @param string $blockname the name of the block.
1485  * @param string $method the method name.
1486  * @param array $param parameters to pass to the method.
1487  * @return mixed whatever the method returns.
1488  */
1489 function block_method_result($blockname, $method, $param = NULL) {
1490     if(!block_load_class($blockname)) {
1491         return NULL;
1492     }
1493     return call_user_func(array('block_'.$blockname, $method), $param);
1496 /**
1497  * Creates a new instance of the specified block class.
1498  *
1499  * @param string $blockname the name of the block.
1500  * @param $instance block_instances DB table row (optional).
1501  * @param moodle_page $page the page this block is appearing on.
1502  * @return block_base the requested block instance.
1503  */
1504 function block_instance($blockname, $instance = NULL, $page = NULL) {
1505     if(!block_load_class($blockname)) {
1506         return false;
1507     }
1508     $classname = 'block_'.$blockname;
1509     $retval = new $classname;
1510     if($instance !== NULL) {
1511         if (is_null($page)) {
1512             global $PAGE;
1513             $page = $PAGE;
1514         }
1515         $retval->_load_instance($instance, $page);
1516     }
1517     return $retval;
1520 /**
1521  * Load the block class for a particular type of block.
1522  *
1523  * @param string $blockname the name of the block.
1524  * @return boolean success or failure.
1525  */
1526 function block_load_class($blockname) {
1527     global $CFG;
1529     if(empty($blockname)) {
1530         return false;
1531     }
1533     $classname = 'block_'.$blockname;
1535     if(class_exists($classname)) {
1536         return true;
1537     }
1539     $blockpath = $CFG->dirroot.'/blocks/'.$blockname.'/block_'.$blockname.'.php';
1541     if (file_exists($blockpath)) {
1542         require_once($CFG->dirroot.'/blocks/moodleblock.class.php');
1543         include_once($blockpath);
1544     }else{
1545         //debugging("$blockname code does not exist in $blockpath", DEBUG_DEVELOPER);
1546         return false;
1547     }
1549     return class_exists($classname);
1552 /**
1553  * Given a specific page type, return all the page type patterns that might
1554  * match it.
1555  *
1556  * @param string $pagetype for example 'course-view-weeks' or 'mod-quiz-view'.
1557  * @return array an array of all the page type patterns that might match this page type.
1558  */
1559 function matching_page_type_patterns($pagetype) {
1560     $patterns = array($pagetype);
1561     $bits = explode('-', $pagetype);
1562     if (count($bits) == 3 && $bits[0] == 'mod') {
1563         if ($bits[2] == 'view') {
1564             $patterns[] = 'mod-*-view';
1565         } else if ($bits[2] == 'index') {
1566             $patterns[] = 'mod-*-index';
1567         }
1568     }
1569     while (count($bits) > 0) {
1570         $patterns[] = implode('-', $bits) . '-*';
1571         array_pop($bits);
1572     }
1573     $patterns[] = '*';
1574     return $patterns;
1577 /**
1578  * Given a specific page type, parent context and currect context, return all the page type patterns
1579  * that might be used by this block.
1580  *
1581  * @param string $pagetype for example 'course-view-weeks' or 'mod-quiz-view'.
1582  * @param stdClass $parentcontext Block's parent context
1583  * @param stdClass $currentcontext Current context of block
1584  * @return array an array of all the page type patterns that might match this page type.
1585  */
1586 function generate_page_type_patterns($pagetype, $parentcontext = null, $currentcontext = null) {
1587     global $CFG;
1589     $bits = explode('-', $pagetype);
1591     $core = get_core_subsystems();
1592     $plugins = get_plugin_types();
1594     //progressively strip pieces off the page type looking for a match
1595     $componentarray = null;
1596     for ($i = count($bits); $i > 0; $i--) {
1597         $possiblecomponentarray = array_slice($bits, 0, $i);
1598         $possiblecomponent = implode('', $possiblecomponentarray);
1600         // Check to see if the component is a core component
1601         if (array_key_exists($possiblecomponent, $core) && !empty($core[$possiblecomponent])) {
1602             $libfile = $CFG->dirroot.'/'.$core[$possiblecomponent].'/lib.php';
1603             if (file_exists($libfile)) {
1604                 require_once($libfile);
1605                 $function = $possiblecomponent.'_page_type_list';
1606                 if (function_exists($function)) {
1607                     if ($patterns = $function($pagetype, $parentcontext, $currentcontext)) {
1608                         break;
1609                     }
1610                 }
1611             }
1612         }
1614         //check the plugin directory and look for a callback
1615         if (array_key_exists($possiblecomponent, $plugins) && !empty($plugins[$possiblecomponent])) {
1617             //We've found a plugin type. Look for a plugin name by getting the next section of page type
1618             if (count($bits) > $i) {
1619                 $pluginname = $bits[$i];
1620                 $directory = get_plugin_directory($possiblecomponent, $pluginname);
1621                 if (!empty($directory)){
1622                     $libfile = $directory.'/lib.php';
1623                     if (file_exists($libfile)) {
1624                         require_once($libfile);
1625                         $function = $possiblecomponent.'_'.$pluginname.'_page_type_list';
1626                         if (!function_exists($function)) {
1627                             $function = $pluginname.'_page_type_list';
1628                         }
1629                         if (function_exists($function)) {
1630                             if ($patterns = $function($pagetype, $parentcontext, $currentcontext)) {
1631                                 break;
1632                             }
1633                         }
1634                     }
1635                 }
1636             }
1638             //we'll only get to here if we still don't have any patterns
1639             //the plugin type may have a callback
1640             $directory = get_plugin_directory($possiblecomponent, null);
1641             if (!empty($directory)){
1642                 $libfile = $directory.'/lib.php';
1643                 if (file_exists($libfile)) {
1644                     require_once($libfile);
1645                     $function = $possiblecomponent.'_page_type_list';
1646                     if (function_exists($function)) {
1647                         if ($patterns = $function($pagetype, $parentcontext, $currentcontext)) {
1648                             break;
1649                         }
1650                     }
1651                 }
1652             }
1653         }
1654     }
1656     if (empty($patterns)) {
1657         $patterns = default_page_type_list($pagetype, $parentcontext, $currentcontext);
1658     }
1660     return $patterns;
1663 /**
1664  * Generates a default page type list when a more appropriate callback cannot be decided upon.
1665  *
1666  * @param string $pagetype
1667  * @param stdClass $parentcontext
1668  * @param stdClass $currentcontext
1669  * @return array
1670  */
1671 function default_page_type_list($pagetype, $parentcontext = null, $currentcontext = null) {
1672     // Generate page type patterns based on current page type if
1673     // callbacks haven't been defined
1674     $patterns = array($pagetype => $pagetype);
1675     $bits = explode('-', $pagetype);
1676     while (count($bits) > 0) {
1677         $pattern = implode('-', $bits) . '-*';
1678         $pagetypestringname = 'page-'.str_replace('*', 'x', $pattern);
1679         // guessing page type description
1680         if (get_string_manager()->string_exists($pagetypestringname, 'pagetype')) {
1681             $patterns[$pattern] = get_string($pagetypestringname, 'pagetype');
1682         } else {
1683             $patterns[$pattern] = $pattern;
1684         }
1685         array_pop($bits);
1686     }
1687     $patterns['*'] = get_string('page-x', 'pagetype');
1688     return $patterns;
1691 /**
1692  * Generates the page type list for the my moodle page
1693  *
1694  * @param string $pagetype
1695  * @param stdClass $parentcontext
1696  * @param stdClass $currentcontext
1697  * @return array
1698  */
1699 function my_page_type_list($pagetype, $parentcontext = null, $currentcontext = null) {
1700     return array('my-index' => 'my-index');
1703 /**
1704  * Generates the page type list for a module by either locating and using the modules callback
1705  * or by generating a default list.
1706  *
1707  * @param string $pagetype
1708  * @param stdClass $parentcontext
1709  * @param stdClass $currentcontext
1710  * @return array
1711  */
1712 function mod_page_type_list($pagetype, $parentcontext = null, $currentcontext = null) {
1713     $patterns = plugin_page_type_list($pagetype, $parentcontext, $currentcontext);
1714     if (empty($patterns)) {
1715         // if modules don't have callbacks
1716         // generate two default page type patterns for modules only
1717         $bits = explode('-', $pagetype);
1718         $patterns = array($pagetype => $pagetype);
1719         if ($bits[2] == 'view') {
1720             $patterns['mod-*-view'] = get_string('page-mod-x-view', 'pagetype');
1721         } else if ($bits[2] == 'index') {
1722             $patterns['mod-*-index'] = get_string('page-mod-x-index', 'pagetype');
1723         }
1724     }
1725     return $patterns;
1727 /// Functions update the blocks if required by the request parameters ==========
1729 /**
1730  * Return a {@link block_contents} representing the add a new block UI, if
1731  * this user is allowed to see it.
1732  *
1733  * @return block_contents an appropriate block_contents, or null if the user
1734  * cannot add any blocks here.
1735  */
1736 function block_add_block_ui($page, $output) {
1737     global $CFG, $OUTPUT;
1738     if (!$page->user_is_editing() || !$page->user_can_edit_blocks()) {
1739         return null;
1740     }
1742     $bc = new block_contents();
1743     $bc->title = get_string('addblock');
1744     $bc->add_class('block_adminblock');
1746     $missingblocks = $page->blocks->get_addable_blocks();
1747     if (empty($missingblocks)) {
1748         $bc->content = get_string('noblockstoaddhere');
1749         return $bc;
1750     }
1752     $menu = array();
1753     foreach ($missingblocks as $block) {
1754         $blockobject = block_instance($block->name);
1755         if ($blockobject !== false && $blockobject->user_can_addto($page)) {
1756             $menu[$block->name] = $blockobject->get_title();
1757         }
1758     }
1759     collatorlib::asort($menu);
1761     $actionurl = new moodle_url($page->url, array('sesskey'=>sesskey()));
1762     $select = new single_select($actionurl, 'bui_addblock', $menu, null, array(''=>get_string('adddots')), 'add_block');
1763     $bc->content = $OUTPUT->render($select);
1764     return $bc;
1767 // Functions that have been deprecated by block_manager =======================
1769 /**
1770  * @deprecated since Moodle 2.0 - use $page->blocks->get_addable_blocks();
1771  *
1772  * This function returns an array with the IDs of any blocks that you can add to your page.
1773  * Parameters are passed by reference for speed; they are not modified at all.
1774  *
1775  * @param $page the page object.
1776  * @param $blockmanager Not used.
1777  * @return array of block type ids.
1778  */
1779 function blocks_get_missing(&$page, &$blockmanager) {
1780     debugging('blocks_get_missing is deprecated. Please use $page->blocks->get_addable_blocks() instead.', DEBUG_DEVELOPER);
1781     $blocks = $page->blocks->get_addable_blocks();
1782     $ids = array();
1783     foreach ($blocks as $block) {
1784         $ids[] = $block->id;
1785     }
1786     return $ids;
1789 /**
1790  * Actually delete from the database any blocks that are currently on this page,
1791  * but which should not be there according to blocks_name_allowed_in_format.
1792  *
1793  * @todo Write/Fix this function. Currently returns immediately
1794  * @param $course
1795  */
1796 function blocks_remove_inappropriate($course) {
1797     // TODO
1798     return;
1799     /*
1800     $blockmanager = blocks_get_by_page($page);
1802     if (empty($blockmanager)) {
1803         return;
1804     }
1806     if (($pageformat = $page->pagetype) == NULL) {
1807         return;
1808     }
1810     foreach($blockmanager as $region) {
1811         foreach($region as $instance) {
1812             $block = blocks_get_record($instance->blockid);
1813             if(!blocks_name_allowed_in_format($block->name, $pageformat)) {
1814                blocks_delete_instance($instance->instance);
1815             }
1816         }
1817     }*/
1820 /**
1821  * Check that a given name is in a permittable format
1822  *
1823  * @param string $name
1824  * @param string $pageformat
1825  * @return bool
1826  */
1827 function blocks_name_allowed_in_format($name, $pageformat) {
1828     $accept = NULL;
1829     $maxdepth = -1;
1830     $formats = block_method_result($name, 'applicable_formats');
1831     if (!$formats) {
1832         $formats = array();
1833     }
1834     foreach ($formats as $format => $allowed) {
1835         $formatregex = '/^'.str_replace('*', '[^-]*', $format).'.*$/';
1836         $depth = substr_count($format, '-');
1837         if (preg_match($formatregex, $pageformat) && $depth > $maxdepth) {
1838             $maxdepth = $depth;
1839             $accept = $allowed;
1840         }
1841     }
1842     if ($accept === NULL) {
1843         $accept = !empty($formats['all']);
1844     }
1845     return $accept;
1848 /**
1849  * Delete a block, and associated data.
1850  *
1851  * @param object $instance a row from the block_instances table
1852  * @param bool $nolongerused legacy parameter. Not used, but kept for backwards compatibility.
1853  * @param bool $skipblockstables for internal use only. Makes @see blocks_delete_all_for_context() more efficient.
1854  */
1855 function blocks_delete_instance($instance, $nolongerused = false, $skipblockstables = false) {
1856     global $DB;
1858     if ($block = block_instance($instance->blockname, $instance)) {
1859         $block->instance_delete();
1860     }
1861     delete_context(CONTEXT_BLOCK, $instance->id);
1863     if (!$skipblockstables) {
1864         $DB->delete_records('block_positions', array('blockinstanceid' => $instance->id));
1865         $DB->delete_records('block_instances', array('id' => $instance->id));
1866         $DB->delete_records_list('user_preferences', 'name', array('block'.$instance->id.'hidden','docked_block_instance_'.$instance->id));
1867     }
1870 /**
1871  * Delete all the blocks that belong to a particular context.
1872  *
1873  * @param int $contextid the context id.
1874  */
1875 function blocks_delete_all_for_context($contextid) {
1876     global $DB;
1877     $instances = $DB->get_recordset('block_instances', array('parentcontextid' => $contextid));
1878     foreach ($instances as $instance) {
1879         blocks_delete_instance($instance, true);
1880     }
1881     $instances->close();
1882     $DB->delete_records('block_instances', array('parentcontextid' => $contextid));
1883     $DB->delete_records('block_positions', array('contextid' => $contextid));
1886 /**
1887  * Set a block to be visible or hidden on a particular page.
1888  *
1889  * @param object $instance a row from the block_instances, preferably LEFT JOINed with the
1890  *      block_positions table as return by block_manager.
1891  * @param moodle_page $page the back to set the visibility with respect to.
1892  * @param integer $newvisibility 1 for visible, 0 for hidden.
1893  */
1894 function blocks_set_visibility($instance, $page, $newvisibility) {
1895     global $DB;
1896     if (!empty($instance->blockpositionid)) {
1897         // Already have local information on this page.
1898         $DB->set_field('block_positions', 'visible', $newvisibility, array('id' => $instance->blockpositionid));
1899         return;
1900     }
1902     // Create a new block_positions record.
1903     $bp = new stdClass;
1904     $bp->blockinstanceid = $instance->id;
1905     $bp->contextid = $page->context->id;
1906     $bp->pagetype = $page->pagetype;
1907     if ($page->subpage) {
1908         $bp->subpage = $page->subpage;
1909     }
1910     $bp->visible = $newvisibility;
1911     $bp->region = $instance->defaultregion;
1912     $bp->weight = $instance->defaultweight;
1913     $DB->insert_record('block_positions', $bp);
1916 /**
1917  * @deprecated since 2.0
1918  * Delete all the blocks from a particular page.
1919  *
1920  * @param string $pagetype the page type.
1921  * @param integer $pageid the page id.
1922  * @return bool success or failure.
1923  */
1924 function blocks_delete_all_on_page($pagetype, $pageid) {
1925     global $DB;
1927     debugging('Call to deprecated function blocks_delete_all_on_page. ' .
1928             'This function cannot work any more. Doing nothing. ' .
1929             'Please update your code to use a block_manager method $PAGE->blocks->....', DEBUG_DEVELOPER);
1930     return false;
1933 /**
1934  * Dispite what this function is called, it seems to be mostly used to populate
1935  * the default blocks when a new course (or whatever) is created.
1936  *
1937  * @deprecated since 2.0
1938  *
1939  * @param object $page the page to add default blocks to.
1940  * @return boolean success or failure.
1941  */
1942 function blocks_repopulate_page($page) {
1943     global $CFG;
1945     debugging('Call to deprecated function blocks_repopulate_page. ' .
1946             'Use a more specific method like blocks_add_default_course_blocks, ' .
1947             'or just call $PAGE->blocks->add_blocks()', DEBUG_DEVELOPER);
1949     /// If the site override has been defined, it is the only valid one.
1950     if (!empty($CFG->defaultblocks_override)) {
1951         $blocknames = $CFG->defaultblocks_override;
1952     } else {
1953         $blocknames = $page->blocks_get_default();
1954     }
1956     $blocks = blocks_parse_default_blocks_list($blocknames);
1957     $page->blocks->add_blocks($blocks);
1959     return true;
1962 /**
1963  * Get the block record for a particular blockid - that is, a particular type os block.
1964  *
1965  * @param $int blockid block type id. If null, an array of all block types is returned.
1966  * @param bool $notusedanymore No longer used.
1967  * @return array|object row from block table, or all rows.
1968  */
1969 function blocks_get_record($blockid = NULL, $notusedanymore = false) {
1970     global $PAGE;
1971     $blocks = $PAGE->blocks->get_installed_blocks();
1972     if ($blockid === NULL) {
1973         return $blocks;
1974     } else if (isset($blocks[$blockid])) {
1975         return $blocks[$blockid];
1976     } else {
1977         return false;
1978     }
1981 /**
1982  * Find a given block by its blockid within a provide array
1983  *
1984  * @param int $blockid
1985  * @param array $blocksarray
1986  * @return bool|object Instance if found else false
1987  */
1988 function blocks_find_block($blockid, $blocksarray) {
1989     if (empty($blocksarray)) {
1990         return false;
1991     }
1992     foreach($blocksarray as $blockgroup) {
1993         if (empty($blockgroup)) {
1994             continue;
1995         }
1996         foreach($blockgroup as $instance) {
1997             if($instance->blockid == $blockid) {
1998                 return $instance;
1999             }
2000         }
2001     }
2002     return false;
2005 // Functions for programatically adding default blocks to pages ================
2007 /**
2008  * Parse a list of default blocks. See config-dist for a description of the format.
2009  *
2010  * @param string $blocksstr
2011  * @return array
2012  */
2013 function blocks_parse_default_blocks_list($blocksstr) {
2014     $blocks = array();
2015     $bits = explode(':', $blocksstr);
2016     if (!empty($bits)) {
2017         $leftbits = trim(array_shift($bits));
2018         if ($leftbits != '') {
2019             $blocks[BLOCK_POS_LEFT] = explode(',', $leftbits);
2020         }
2021     }
2022     if (!empty($bits)) {
2023         $rightbits =trim(array_shift($bits));
2024         if ($rightbits != '') {
2025             $blocks[BLOCK_POS_RIGHT] = explode(',', $rightbits);
2026         }
2027     }
2028     return $blocks;
2031 /**
2032  * @return array the blocks that should be added to the site course by default.
2033  */
2034 function blocks_get_default_site_course_blocks() {
2035     global $CFG;
2037     if (!empty($CFG->defaultblocks_site)) {
2038         return blocks_parse_default_blocks_list($CFG->defaultblocks_site);
2039     } else {
2040         return array(
2041             BLOCK_POS_LEFT => array('site_main_menu'),
2042             BLOCK_POS_RIGHT => array('course_summary', 'calendar_month')
2043         );
2044     }
2047 /**
2048  * Add the default blocks to a course.
2049  *
2050  * @param object $course a course object.
2051  */
2052 function blocks_add_default_course_blocks($course) {
2053     global $CFG;
2055     if (!empty($CFG->defaultblocks_override)) {
2056         $blocknames = blocks_parse_default_blocks_list($CFG->defaultblocks_override);
2058     } else if ($course->id == SITEID) {
2059         $blocknames = blocks_get_default_site_course_blocks();
2061     } else {
2062         $defaultblocks = 'defaultblocks_' . $course->format;
2063         if (!empty($CFG->$defaultblocks)) {
2064             $blocknames = blocks_parse_default_blocks_list($CFG->$defaultblocks);
2066         } else {
2067             $formatconfig = $CFG->dirroot.'/course/format/'.$course->format.'/config.php';
2068             $format = array(); // initialize array in external file
2069             if (is_readable($formatconfig)) {
2070                 include($formatconfig);
2071             }
2072             if (!empty($format['defaultblocks'])) {
2073                 $blocknames = blocks_parse_default_blocks_list($format['defaultblocks']);
2075             } else if (!empty($CFG->defaultblocks)){
2076                 $blocknames = blocks_parse_default_blocks_list($CFG->defaultblocks);
2078             } else {
2079                 $blocknames = array(
2080                     BLOCK_POS_LEFT => array(),
2081                     BLOCK_POS_RIGHT => array('search_forums', 'news_items', 'calendar_upcoming', 'recent_activity')
2082                 );
2083             }
2084         }
2085     }
2087     if ($course->id == SITEID) {
2088         $pagetypepattern = 'site-index';
2089     } else {
2090         $pagetypepattern = 'course-view-*';
2091     }
2092     $page = new moodle_page();
2093     $page->set_course($course);
2094     $page->blocks->add_blocks($blocknames, $pagetypepattern);
2097 /**
2098  * Add the default system-context blocks. E.g. the admin tree.
2099  */
2100 function blocks_add_default_system_blocks() {
2101     global $DB;
2103     $page = new moodle_page();
2104     $page->set_context(get_context_instance(CONTEXT_SYSTEM));
2105     $page->blocks->add_blocks(array(BLOCK_POS_LEFT => array('navigation', 'settings')), '*', null, true);
2106     $page->blocks->add_blocks(array(BLOCK_POS_LEFT => array('admin_bookmarks')), 'admin-*', null, null, 2);
2108     if ($defaultmypage = $DB->get_record('my_pages', array('userid'=>null, 'name'=>'__default', 'private'=>1))) {
2109         $subpagepattern = $defaultmypage->id;
2110     } else {
2111         $subpagepattern = null;
2112     }
2114     $page->blocks->add_blocks(array(BLOCK_POS_RIGHT => array('private_files', 'online_users'), 'content' => array('course_overview')), 'my-index', $subpagepattern, false);