991b34d4cf85d47a02d9bd9c30d0b301f189d138
[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             // If editing is on, we need all the block regions visible, for the
352             // move blocks UI.
353             return true;
354         }
355         return !empty($this->visibleblockcontent[$region]) || !empty($this->extracontent[$region]);
356     }
358     /**
359      * Get an array of all of the installed blocks.
360      *
361      * @return array contents of the block table.
362      */
363     public function get_installed_blocks() {
364         global $DB;
365         if (is_null($this->allblocks)) {
366             $this->allblocks = $DB->get_records('block');
367         }
368         return $this->allblocks;
369     }
371 /// Setter methods =============================================================
373     /**
374      * Add a region to a page
375      *
376      * @param string $region add a named region where blocks may appear on the
377      * current page. This is an internal name, like 'side-pre', not a string to
378      * display in the UI.
379      */
380     public function add_region($region) {
381         $this->check_not_yet_loaded();
382         $this->regions[$region] = 1;
383     }
385     /**
386      * Add an array of regions
387      * @see add_region()
388      *
389      * @param array $regions this utility method calls add_region for each array element.
390      */
391     public function add_regions($regions) {
392         foreach ($regions as $region) {
393             $this->add_region($region);
394         }
395     }
397     /**
398      * Set the default region for new blocks on the page
399      *
400      * @param string $defaultregion the internal names of the region where new
401      * blocks should be added by default, and where any blocks from an
402      * unrecognised region are shown.
403      */
404     public function set_default_region($defaultregion) {
405         $this->check_not_yet_loaded();
406         if ($defaultregion) {
407             $this->check_region_is_known($defaultregion);
408         }
409         $this->defaultregion = $defaultregion;
410     }
412     /**
413      * Add something that looks like a block, but which isn't an actual block_instance,
414      * to this page.
415      *
416      * @param block_contents $bc the content of the block-like thing.
417      * @param string $region a block region that exists on this page.
418      */
419     public function add_fake_block($bc, $region) {
420         $this->page->initialise_theme_and_output();
421         if (!$this->is_known_region($region)) {
422             $region = $this->get_default_region();
423         }
424         if (array_key_exists($region, $this->visibleblockcontent)) {
425             throw new coding_exception('block_manager has already prepared the blocks in region ' .
426                     $region . 'for output. It is too late to add a fake block.');
427         }
428         $this->extracontent[$region][] = $bc;
429     }
431     /**
432      * When the block_manager class was created, the {@link add_fake_block()}
433      * was called add_pretend_block, which is inconsisted with
434      * {@link show_only_fake_blocks()}. To fix this inconsistency, this method
435      * was renamed to add_fake_block. Please update your code.
436      * @param block_contents $bc the content of the block-like thing.
437      * @param string $region a block region that exists on this page.
438      */
439     public function add_pretend_block($bc, $region) {
440         debugging(DEBUG_DEVELOPER, 'add_pretend_block has been renamed to add_fake_block. Please rename the method call in your code.');
441         $this->add_fake_block($bc, $region);
442     }
444     /**
445      * Checks to see whether all of the blocks within the given region are docked
446      *
447      * @see region_uses_dock
448      * @param string $region
449      * @return bool True if all of the blocks within that region are docked
450      */
451     public function region_completely_docked($region, $output) {
452         if (!$this->page->theme->enable_dock) {
453             return false;
454         }
455         $this->check_is_loaded();
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 false;
460             }
461         }
462         return true;
463     }
465     /**
466      * Checks to see whether any of the blocks within the given regions are docked
467      *
468      * @see region_completely_docked
469      * @param array|string $regions array of regions (or single region)
470      * @return bool True if any of the blocks within that region are docked
471      */
472     public function region_uses_dock($regions, $output) {
473         if (!$this->page->theme->enable_dock) {
474             return false;
475         }
476         $this->check_is_loaded();
477         foreach((array)$regions as $region) {
478             $this->ensure_content_created($region, $output);
479             foreach($this->visibleblockcontent[$region] as $instance) {
480                 if(!empty($instance->content) && get_user_preferences('docked_block_instance_'.$instance->blockinstanceid, 0)) {
481                     return true;
482                 }
483             }
484         }
485         return false;
486     }
488 /// Actions ====================================================================
490     /**
491      * This method actually loads the blocks for our page from the database.
492      *
493      * @param boolean|null $includeinvisible
494      *      null (default) - load hidden blocks if $this->page->user_is_editing();
495      *      true - load hidden blocks.
496      *      false - don't load hidden blocks.
497      */
498     public function load_blocks($includeinvisible = null) {
499         global $DB, $CFG;
501         if (!is_null($this->birecordsbyregion)) {
502             // Already done.
503             return;
504         }
506         if ($CFG->version < 2009050619) {
507             // Upgrade/install not complete. Don't try too show any blocks.
508             $this->birecordsbyregion = array();
509             return;
510         }
512         // Ensure we have been initialised.
513         if (is_null($this->defaultregion)) {
514             $this->page->initialise_theme_and_output();
515             // If there are still no block regions, then there are no blocks on this page.
516             if (empty($this->regions)) {
517                 $this->birecordsbyregion = array();
518                 return;
519             }
520         }
522         // Check if we need to load normal blocks
523         if ($this->fakeblocksonly) {
524             $this->birecordsbyregion = $this->prepare_per_region_arrays();
525             return;
526         }
528         if (is_null($includeinvisible)) {
529             $includeinvisible = $this->page->user_is_editing();
530         }
531         if ($includeinvisible) {
532             $visiblecheck = '';
533         } else {
534             $visiblecheck = 'AND (bp.visible = 1 OR bp.visible IS NULL)';
535         }
537         $context = $this->page->context;
538         $contexttest = 'bi.parentcontextid = :contextid2';
539         $parentcontextparams = array();
540         $parentcontextids = get_parent_contexts($context);
541         if ($parentcontextids) {
542             list($parentcontexttest, $parentcontextparams) =
543                     $DB->get_in_or_equal($parentcontextids, SQL_PARAMS_NAMED, 'parentcontext');
544             $contexttest = "($contexttest OR (bi.showinsubcontexts = 1 AND bi.parentcontextid $parentcontexttest))";
545         }
547         $pagetypepatterns = matching_page_type_patterns($this->page->pagetype);
548         list($pagetypepatterntest, $pagetypepatternparams) =
549                 $DB->get_in_or_equal($pagetypepatterns, SQL_PARAMS_NAMED, 'pagetypepatterntest');
551         list($ccselect, $ccjoin) = context_instance_preload_sql('bi.id', CONTEXT_BLOCK, 'ctx');
553         $params = array(
554             'subpage1' => $this->page->subpage,
555             'subpage2' => $this->page->subpage,
556             'contextid1' => $context->id,
557             'contextid2' => $context->id,
558             'pagetype' => $this->page->pagetype,
559         );
560         $sql = "SELECT
561                     bi.id,
562                     bp.id AS blockpositionid,
563                     bi.blockname,
564                     bi.parentcontextid,
565                     bi.showinsubcontexts,
566                     bi.pagetypepattern,
567                     bi.subpagepattern,
568                     bi.defaultregion,
569                     bi.defaultweight,
570                     COALESCE(bp.visible, 1) AS visible,
571                     COALESCE(bp.region, bi.defaultregion) AS region,
572                     COALESCE(bp.weight, bi.defaultweight) AS weight,
573                     bi.configdata
574                     $ccselect
576                 FROM {block_instances} bi
577                 JOIN {block} b ON bi.blockname = b.name
578                 LEFT JOIN {block_positions} bp ON bp.blockinstanceid = bi.id
579                                                   AND bp.contextid = :contextid1
580                                                   AND bp.pagetype = :pagetype
581                                                   AND bp.subpage = :subpage1
582                 $ccjoin
584                 WHERE
585                 $contexttest
586                 AND bi.pagetypepattern $pagetypepatterntest
587                 AND (bi.subpagepattern IS NULL OR bi.subpagepattern = :subpage2)
588                 $visiblecheck
589                 AND b.visible = 1
591                 ORDER BY
592                     COALESCE(bp.region, bi.defaultregion),
593                     COALESCE(bp.weight, bi.defaultweight),
594                     bi.id";
595         $blockinstances = $DB->get_recordset_sql($sql, $params + $parentcontextparams + $pagetypepatternparams);
597         $this->birecordsbyregion = $this->prepare_per_region_arrays();
598         $unknown = array();
599         foreach ($blockinstances as $bi) {
600             context_instance_preload($bi);
601             if ($this->is_known_region($bi->region)) {
602                 $this->birecordsbyregion[$bi->region][] = $bi;
603             } else {
604                 $unknown[] = $bi;
605             }
606         }
608         // Pages don't necessarily have a defaultregion. The  one time this can
609         // happen is when there are no theme block regions, but the script itself
610         // has a block region in the main content area.
611         if (!empty($this->defaultregion)) {
612             $this->birecordsbyregion[$this->defaultregion] =
613                     array_merge($this->birecordsbyregion[$this->defaultregion], $unknown);
614         }
615     }
617     /**
618      * Add a block to the current page, or related pages. The block is added to
619      * context $this->page->contextid. If $pagetypepattern $subpagepattern
620      *
621      * @param string $blockname The type of block to add.
622      * @param string $region the block region on this page to add the block to.
623      * @param integer $weight determines the order where this block appears in the region.
624      * @param boolean $showinsubcontexts whether this block appears in subcontexts, or just the current context.
625      * @param string|null $pagetypepattern which page types this block should appear on. Defaults to just the current page type.
626      * @param string|null $subpagepattern which subpage this block should appear on. NULL = any (the default), otherwise only the specified subpage.
627      */
628     public function add_block($blockname, $region, $weight, $showinsubcontexts, $pagetypepattern = NULL, $subpagepattern = NULL) {
629         global $DB;
630         // Allow invisible blocks because this is used when adding default page blocks, which
631         // might include invisible ones if the user makes some default blocks invisible
632         $this->check_known_block_type($blockname, true);
633         $this->check_region_is_known($region);
635         if (empty($pagetypepattern)) {
636             $pagetypepattern = $this->page->pagetype;
637         }
639         $blockinstance = new stdClass;
640         $blockinstance->blockname = $blockname;
641         $blockinstance->parentcontextid = $this->page->context->id;
642         $blockinstance->showinsubcontexts = !empty($showinsubcontexts);
643         $blockinstance->pagetypepattern = $pagetypepattern;
644         $blockinstance->subpagepattern = $subpagepattern;
645         $blockinstance->defaultregion = $region;
646         $blockinstance->defaultweight = $weight;
647         $blockinstance->configdata = '';
648         $blockinstance->id = $DB->insert_record('block_instances', $blockinstance);
650         // Ensure the block context is created.
651         get_context_instance(CONTEXT_BLOCK, $blockinstance->id);
653         // If the new instance was created, allow it to do additional setup
654         if ($block = block_instance($blockname, $blockinstance)) {
655             $block->instance_create();
656         }
657     }
659     public function add_block_at_end_of_default_region($blockname) {
660         $defaulregion = $this->get_default_region();
662         $lastcurrentblock = end($this->birecordsbyregion[$defaulregion]);
663         if ($lastcurrentblock) {
664             $weight = $lastcurrentblock->weight + 1;
665         } else {
666             $weight = 0;
667         }
669         if ($this->page->subpage) {
670             $subpage = $this->page->subpage;
671         } else {
672             $subpage = null;
673         }
675         // Special case. Course view page type include the course format, but we
676         // want to add the block non-format-specifically.
677         $pagetypepattern = $this->page->pagetype;
678         if (strpos($pagetypepattern, 'course-view') === 0) {
679             $pagetypepattern = 'course-view-*';
680         }
682         $this->add_block($blockname, $defaulregion, $weight, false, $pagetypepattern, $subpage);
683     }
685     /**
686      * Convenience method, calls add_block repeatedly for all the blocks in $blocks.
687      *
688      * @param array $blocks array with array keys the region names, and values an array of block names.
689      * @param string $pagetypepattern optional. Passed to @see add_block()
690      * @param string $subpagepattern optional. Passed to @see add_block()
691      */
692     public function add_blocks($blocks, $pagetypepattern = NULL, $subpagepattern = NULL, $showinsubcontexts=false, $weight=0) {
693         $this->add_regions(array_keys($blocks));
694         foreach ($blocks as $region => $regionblocks) {
695             $weight = 0;
696             foreach ($regionblocks as $blockname) {
697                 $this->add_block($blockname, $region, $weight, $showinsubcontexts, $pagetypepattern, $subpagepattern);
698                 $weight += 1;
699             }
700         }
701     }
703     /**
704      * Move a block to a new position on this page.
705      *
706      * If this block cannot appear on any other pages, then we change defaultposition/weight
707      * in the block_instances table. Otherwise we just set the position on this page.
708      *
709      * @param $blockinstanceid the block instance id.
710      * @param $newregion the new region name.
711      * @param $newweight the new weight.
712      */
713     public function reposition_block($blockinstanceid, $newregion, $newweight) {
714         global $DB;
716         $this->check_region_is_known($newregion);
717         $inst = $this->find_instance($blockinstanceid);
719         $bi = $inst->instance;
720         if ($bi->weight == $bi->defaultweight && $bi->region == $bi->defaultregion &&
721                 !$bi->showinsubcontexts && strpos($bi->pagetypepattern, '*') === false &&
722                 (!$this->page->subpage || $bi->subpagepattern)) {
724             // Set default position
725             $newbi = new stdClass;
726             $newbi->id = $bi->id;
727             $newbi->defaultregion = $newregion;
728             $newbi->defaultweight = $newweight;
729             $DB->update_record('block_instances', $newbi);
731             if ($bi->blockpositionid) {
732                 $bp = new stdClass;
733                 $bp->id = $bi->blockpositionid;
734                 $bp->region = $newregion;
735                 $bp->weight = $newweight;
736                 $DB->update_record('block_positions', $bp);
737             }
739         } else {
740             // Just set position on this page.
741             $bp = new stdClass;
742             $bp->region = $newregion;
743             $bp->weight = $newweight;
745             if ($bi->blockpositionid) {
746                 $bp->id = $bi->blockpositionid;
747                 $DB->update_record('block_positions', $bp);
749             } else {
750                 $bp->blockinstanceid = $bi->id;
751                 $bp->contextid = $this->page->context->id;
752                 $bp->pagetype = $this->page->pagetype;
753                 if ($this->page->subpage) {
754                     $bp->subpage = $this->page->subpage;
755                 } else {
756                     $bp->subpage = '';
757                 }
758                 $bp->visible = $bi->visible;
759                 $DB->insert_record('block_positions', $bp);
760             }
761         }
762     }
764     /**
765      * Find a given block by its instance id
766      *
767      * @param integer $instanceid
768      * @return object
769      */
770     public function find_instance($instanceid) {
771         foreach ($this->regions as $region => $notused) {
772             $this->ensure_instances_exist($region);
773             foreach($this->blockinstances[$region] as $instance) {
774                 if ($instance->instance->id == $instanceid) {
775                     return $instance;
776                 }
777             }
778         }
779         throw new block_not_on_page_exception($instanceid, $this->page);
780     }
782 /// Inner workings =============================================================
784     /**
785      * Check whether the page blocks have been loaded yet
786      *
787      * @return void Throws coding exception if already loaded
788      */
789     protected function check_not_yet_loaded() {
790         if (!is_null($this->birecordsbyregion)) {
791             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.');
792         }
793     }
795     /**
796      * Check whether the page blocks have been loaded yet
797      *
798      * Nearly identical to the above function {@link check_not_yet_loaded()} except different message
799      *
800      * @return void Throws coding exception if already loaded
801      */
802     protected function check_is_loaded() {
803         if (is_null($this->birecordsbyregion)) {
804             throw new coding_exception('block_manager has not yet loaded the blocks, to it is too soon to request the information you asked for.');
805         }
806     }
808     /**
809      * Check if a block type is known and usable
810      *
811      * @param string $blockname The block type name to search for
812      * @param bool $includeinvisible Include disabled block types in the initial pass
813      * @return void Coding Exception thrown if unknown or not enabled
814      */
815     protected function check_known_block_type($blockname, $includeinvisible = false) {
816         if (!$this->is_known_block_type($blockname, $includeinvisible)) {
817             if ($this->is_known_block_type($blockname, true)) {
818                 throw new coding_exception('Unknown block type ' . $blockname);
819             } else {
820                 throw new coding_exception('Block type ' . $blockname . ' has been disabled by the administrator.');
821             }
822         }
823     }
825     /**
826      * Check if a region is known by its name
827      *
828      * @param string $region
829      * @return void Coding Exception thrown if the region is not known
830      */
831     protected function check_region_is_known($region) {
832         if (!$this->is_known_region($region)) {
833             throw new coding_exception('Trying to reference an unknown block region ' . $region);
834         }
835     }
837     /**
838      * Returns an array of region names as keys and nested arrays for values
839      *
840      * @return array an array where the array keys are the region names, and the array
841      * values are empty arrays.
842      */
843     protected function prepare_per_region_arrays() {
844         $result = array();
845         foreach ($this->regions as $region => $notused) {
846             $result[$region] = array();
847         }
848         return $result;
849     }
851     /**
852      * Create a set of new block instance from a record array
853      *
854      * @param array $birecords An array of block instance records
855      * @return array An array of instantiated block_instance objects
856      */
857     protected function create_block_instances($birecords) {
858         $results = array();
859         foreach ($birecords as $record) {
860             if ($blockobject = block_instance($record->blockname, $record, $this->page)) {
861                 $results[] = $blockobject;
862             }
863         }
864         return $results;
865     }
867     /**
868      * Create all the block instances for all the blocks that were loaded by
869      * load_blocks. This is used, for example, to ensure that all blocks get a
870      * chance to initialise themselves via the {@link block_base::specialize()}
871      * method, before any output is done.
872      */
873     public function create_all_block_instances() {
874         foreach ($this->get_regions() as $region) {
875             $this->ensure_instances_exist($region);
876         }
877     }
879     /**
880      * Return an array of content objects from a set of block instances
881      *
882      * @param array $instances An array of block instances
883      * @param renderer_base The renderer to use.
884      * @param string $region the region name.
885      * @return array An array of block_content (and possibly block_move_target) objects.
886      */
887     protected function create_block_contents($instances, $output, $region) {
888         $results = array();
890         $lastweight = 0;
891         $lastblock = 0;
892         if ($this->movingblock) {
893             $first = reset($instances);
894             if ($first) {
895                 $lastweight = $first->instance->weight - 2;
896             }
898             $strmoveblockhere = get_string('moveblockhere', 'block');
899         }
901         foreach ($instances as $instance) {
902             $content = $instance->get_content_for_output($output);
903             if (empty($content)) {
904                 continue;
905             }
907             if ($this->movingblock && $lastweight != $instance->instance->weight &&
908                     $content->blockinstanceid != $this->movingblock && $lastblock != $this->movingblock) {
909                 $results[] = new block_move_target($strmoveblockhere, $this->get_move_target_url($region, ($lastweight + $instance->instance->weight)/2));
910             }
912             if ($content->blockinstanceid == $this->movingblock) {
913                 $content->add_class('beingmoved');
914                 $content->annotation .= get_string('movingthisblockcancel', 'block',
915                         html_writer::link($this->page->url, get_string('cancel')));
916             }
918             $results[] = $content;
919             $lastweight = $instance->instance->weight;
920             $lastblock = $instance->instance->id;
921         }
923         if ($this->movingblock && $lastblock != $this->movingblock) {
924             $results[] = new block_move_target($strmoveblockhere, $this->get_move_target_url($region, $lastweight + 1));
925         }
926         return $results;
927     }
929     /**
930      * Ensure block instances exist for a given region
931      *
932      * @param string $region Check for bi's with the instance with this name
933      */
934     protected function ensure_instances_exist($region) {
935         $this->check_region_is_known($region);
936         if (!array_key_exists($region, $this->blockinstances)) {
937             $this->blockinstances[$region] =
938                     $this->create_block_instances($this->birecordsbyregion[$region]);
939         }
940     }
942     /**
943      * Ensure that there is some content within the given region
944      *
945      * @param string $region The name of the region to check
946      */
947     protected function ensure_content_created($region, $output) {
948         $this->ensure_instances_exist($region);
949         if (!array_key_exists($region, $this->visibleblockcontent)) {
950             $contents = array();
951             if (array_key_exists($region, $this->extracontent)) {
952                 $contents = $this->extracontent[$region];
953             }
954             $contents = array_merge($contents, $this->create_block_contents($this->blockinstances[$region], $output, $region));
955             if ($region == $this->defaultregion) {
956                 $addblockui = block_add_block_ui($this->page, $output);
957                 if ($addblockui) {
958                     $contents[] = $addblockui;
959                 }
960             }
961             $this->visibleblockcontent[$region] = $contents;
962         }
963     }
965 /// Process actions from the URL ===============================================
967     /**
968      * Get the appropriate list of editing icons for a block. This is used
969      * to set {@link block_contents::$controls} in {@link block_base::get_contents_for_output()}.
970      *
971      * @param $output The core_renderer to use when generating the output. (Need to get icon paths.)
972      * @return an array in the format for {@link block_contents::$controls}
973      */
974     public function edit_controls($block) {
975         global $CFG;
977         if (!isset($CFG->undeletableblocktypes) || (!is_array($CFG->undeletableblocktypes) && !is_string($CFG->undeletableblocktypes))) {
978             $CFG->undeletableblocktypes = array('navigation','settings');
979         } else if (is_string($CFG->undeletableblocktypes)) {
980             $CFG->undeletableblocktypes = explode(',', $CFG->undeletableblocktypes);
981         }
983         $controls = array();
984         $actionurl = $this->page->url->out(false, array('sesskey'=> sesskey()));
986         // Assign roles icon.
987         if (has_capability('moodle/role:assign', $block->context)) {
988             //TODO: please note it is sloppy to pass urls through page parameters!!
989             //      it is shortened because some web servers (e.g. IIS by default) give
990             //      a 'security' error if you try to pass a full URL as a GET parameter in another URL.
992             $return = $this->page->url->out(false);
993             $return = str_replace($CFG->wwwroot . '/', '', $return);
995             $controls[] = array('url' => $CFG->wwwroot . '/' . $CFG->admin .
996                     '/roles/assign.php?contextid=' . $block->context->id . '&returnurl=' . urlencode($return),
997                     'icon' => 'i/roles', 'caption' => get_string('assignroles', 'role'));
998         }
1000         if ($this->page->user_can_edit_blocks() && $block->instance_can_be_hidden()) {
1001             // Show/hide icon.
1002             if ($block->instance->visible) {
1003                 $controls[] = array('url' => $actionurl . '&bui_hideid=' . $block->instance->id,
1004                         'icon' => 't/hide', 'caption' => get_string('hide'));
1005             } else {
1006                 $controls[] = array('url' => $actionurl . '&bui_showid=' . $block->instance->id,
1007                         'icon' => 't/show', 'caption' => get_string('show'));
1008             }
1009         }
1011         if ($this->page->user_can_edit_blocks() || $block->user_can_edit()) {
1012             // Edit config icon - always show - needed for positioning UI.
1013             $controls[] = array('url' => $actionurl . '&bui_editid=' . $block->instance->id,
1014                     'icon' => 't/edit', 'caption' => get_string('configuration'));
1015         }
1017         if ($this->page->user_can_edit_blocks() && $block->user_can_edit() && $block->user_can_addto($this->page)) {
1018             if (!in_array($block->instance->blockname, $CFG->undeletableblocktypes)) {
1019                 // Delete icon.
1020                 $controls[] = array('url' => $actionurl . '&bui_deleteid=' . $block->instance->id,
1021                         'icon' => 't/delete', 'caption' => get_string('delete'));
1022             }
1023         }
1025         if ($this->page->user_can_edit_blocks()) {
1026             // Move icon.
1027             $controls[] = array('url' => $actionurl . '&bui_moveid=' . $block->instance->id,
1028                     'icon' => 't/move', 'caption' => get_string('move'));
1029         }
1031         return $controls;
1032     }
1034     /**
1035      * Process any block actions that were specified in the URL.
1036      *
1037      * This can only be done given a valid $page object.
1038      *
1039      * @param moodle_page $page the page to add blocks to.
1040      * @return boolean true if anything was done. False if not.
1041      */
1042     public function process_url_actions() {
1043         if (!$this->page->user_is_editing()) {
1044             return false;
1045         }
1046         return $this->process_url_add() || $this->process_url_delete() ||
1047             $this->process_url_show_hide() || $this->process_url_edit() ||
1048             $this->process_url_move();
1049     }
1051     /**
1052      * Handle adding a block.
1053      * @return boolean true if anything was done. False if not.
1054      */
1055     public function process_url_add() {
1056         $blocktype = optional_param('bui_addblock', null, PARAM_SAFEDIR);
1057         if (!$blocktype) {
1058             return false;
1059         }
1061         require_sesskey();
1063         if (!$this->page->user_can_edit_blocks()) {
1064             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('addblock'));
1065         }
1067         if (!array_key_exists($blocktype, $this->get_addable_blocks())) {
1068             throw new moodle_exception('cannotaddthisblocktype', '', $this->page->url->out(), $blocktype);
1069         }
1071         $this->add_block_at_end_of_default_region($blocktype);
1073         // If the page URL was a guess, it will contain the bui_... param, so we must make sure it is not there.
1074         $this->page->ensure_param_not_in_url('bui_addblock');
1076         return true;
1077     }
1079     /**
1080      * Handle deleting a block.
1081      * @return boolean true if anything was done. False if not.
1082      */
1083     public function process_url_delete() {
1084         $blockid = optional_param('bui_deleteid', null, PARAM_INTEGER);
1085         if (!$blockid) {
1086             return false;
1087         }
1089         require_sesskey();
1091         $block = $this->page->blocks->find_instance($blockid);
1093         if (!$block->user_can_edit() || !$this->page->user_can_edit_blocks() || !$block->user_can_addto($this->page)) {
1094             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('deleteablock'));
1095         }
1097         blocks_delete_instance($block->instance);
1099         // If the page URL was a guess, it will contain the bui_... param, so we must make sure it is not there.
1100         $this->page->ensure_param_not_in_url('bui_deleteid');
1102         return true;
1103     }
1105     /**
1106      * Handle showing or hiding a block.
1107      * @return boolean true if anything was done. False if not.
1108      */
1109     public function process_url_show_hide() {
1110         if ($blockid = optional_param('bui_hideid', null, PARAM_INTEGER)) {
1111             $newvisibility = 0;
1112         } else if ($blockid = optional_param('bui_showid', null, PARAM_INTEGER)) {
1113             $newvisibility = 1;
1114         } else {
1115             return false;
1116         }
1118         require_sesskey();
1120         $block = $this->page->blocks->find_instance($blockid);
1122         if (!$this->page->user_can_edit_blocks()) {
1123             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('hideshowblocks'));
1124         } else if (!$block->instance_can_be_hidden()) {
1125             return false;
1126         }
1128         blocks_set_visibility($block->instance, $this->page, $newvisibility);
1130         // If the page URL was a guses, it will contain the bui_... param, so we must make sure it is not there.
1131         $this->page->ensure_param_not_in_url('bui_hideid');
1132         $this->page->ensure_param_not_in_url('bui_showid');
1134         return true;
1135     }
1137     /**
1138      * Handle showing/processing the submission from the block editing form.
1139      * @return boolean true if the form was submitted and the new config saved. Does not
1140      *      return if the editing form was displayed. False otherwise.
1141      */
1142     public function process_url_edit() {
1143         global $CFG, $DB, $PAGE, $OUTPUT;
1145         $blockid = optional_param('bui_editid', null, PARAM_INTEGER);
1146         if (!$blockid) {
1147             return false;
1148         }
1150         require_sesskey();
1151         require_once($CFG->dirroot . '/blocks/edit_form.php');
1153         $block = $this->find_instance($blockid);
1155         if (!$block->user_can_edit() && !$this->page->user_can_edit_blocks()) {
1156             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('editblock'));
1157         }
1159         $editpage = new moodle_page();
1160         $editpage->set_pagelayout('admin');
1161         $editpage->set_course($this->page->course);
1162         //$editpage->set_context($block->context);
1163         $editpage->set_context($this->page->context);
1164         if ($this->page->cm) {
1165             $editpage->set_cm($this->page->cm);
1166         }
1167         $editurlbase = str_replace($CFG->wwwroot . '/', '/', $this->page->url->out_omit_querystring());
1168         $editurlparams = $this->page->url->params();
1169         $editurlparams['bui_editid'] = $blockid;
1170         $editpage->set_url($editurlbase, $editurlparams);
1171         $editpage->set_block_actions_done();
1172         // At this point we are either going to redirect, or display the form, so
1173         // overwrite global $PAGE ready for this. (Formslib refers to it.)
1174         $PAGE = $editpage;
1175         //some functions like MoodleQuickForm::addHelpButton use $OUTPUT so we need to replace that to
1176         $output = $editpage->get_renderer('core');
1177         $OUTPUT = $output;
1179         $formfile = $CFG->dirroot . '/blocks/' . $block->name() . '/edit_form.php';
1180         if (is_readable($formfile)) {
1181             require_once($formfile);
1182             $classname = 'block_' . $block->name() . '_edit_form';
1183             if (!class_exists($classname)) {
1184                 $classname = 'block_edit_form';
1185             }
1186         } else {
1187             $classname = 'block_edit_form';
1188         }
1190         $mform = new $classname($editpage->url, $block, $this->page);
1191         $mform->set_data($block->instance);
1193         if ($mform->is_cancelled()) {
1194             redirect($this->page->url);
1196         } else if ($data = $mform->get_data()) {
1197             $bi = new stdClass;
1198             $bi->id = $block->instance->id;
1199             $bi->pagetypepattern = $data->bui_pagetypepattern;
1200             if (empty($data->bui_subpagepattern) || $data->bui_subpagepattern == '%@NULL@%') {
1201                 $bi->subpagepattern = null;
1202             } else {
1203                 $bi->subpagepattern = $data->bui_subpagepattern;
1204             }
1206             $parentcontext = get_context_instance_by_id($data->bui_parentcontextid);
1207             $systemcontext = get_context_instance(CONTEXT_SYSTEM);
1209             // Updating stickiness and contexts.  See MDL-21375 for details.
1210             if (has_capability('moodle/site:manageblocks', $parentcontext)) { // Check permissions in destination
1211                 // Explicitly set the context
1212                 $bi->parentcontextid = $parentcontext->id;
1214                 // If the context type is > 0 then we'll explicitly set the block as sticky, otherwise not
1215                 $bi->showinsubcontexts = (int)(!empty($data->bui_contexts));
1217                 // If the block wants to be system-wide, then explicitly set that
1218                 if ($data->bui_contexts == BUI_CONTEXTS_ENTIRE_SITE) {   // Only possible on a frontpage or system page
1219                     $bi->parentcontextid = $systemcontext->id;
1220                     $bi->showinsubcontexts = BUI_CONTEXTS_CURRENT_SUBS; //show in current and sub contexts
1221                     $bi->pagetypepattern = '*';
1223                 } else { // The block doesn't want to be system-wide, so let's ensure that
1224                     if ($parentcontext->id == $systemcontext->id) {  // We need to move it to the front page
1225                         $frontpagecontext = get_context_instance(CONTEXT_COURSE, SITEID);
1226                         $bi->parentcontextid = $frontpagecontext->id;
1227                         $bi->pagetypepattern = 'site-index';
1228                     }
1229                 }
1230             }
1232             $bits = explode('-', $bi->pagetypepattern);
1233             // hacks for some contexts
1234             if (($parentcontext->contextlevel == CONTEXT_COURSE) && ($parentcontext->instanceid != SITEID)) {
1235                 // For course context
1236                 // is page type pattern is mod-*, change showinsubcontext to 1
1237                 if ($bits[0] == 'mod' || $bi->pagetypepattern == '*') {
1238                     $bi->showinsubcontexts = 1;
1239                 } else {
1240                     $bi->showinsubcontexts = 0;
1241                 }
1242             } else  if ($parentcontext->contextlevel == CONTEXT_USER) {
1243                 // for user context
1244                 // subpagepattern should be null
1245                 if ($bits[0] == 'user' or $bits[0] == 'my') {
1246                     // we don't need subpagepattern in usercontext
1247                     $bi->subpagepattern = null;
1248                 }
1249             }
1251             $bi->defaultregion = $data->bui_defaultregion;
1252             $bi->defaultweight = $data->bui_defaultweight;
1253             $DB->update_record('block_instances', $bi);
1255             if (!empty($block->config)) {
1256                 $config = clone($block->config);
1257             } else {
1258                 $config = new stdClass;
1259             }
1260             foreach ($data as $configfield => $value) {
1261                 if (strpos($configfield, 'config_') !== 0) {
1262                     continue;
1263                 }
1264                 $field = substr($configfield, 7);
1265                 $config->$field = $value;
1266             }
1267             $block->instance_config_save($config);
1269             $bp = new stdClass;
1270             $bp->visible = $data->bui_visible;
1271             $bp->region = $data->bui_region;
1272             $bp->weight = $data->bui_weight;
1273             $needbprecord = !$data->bui_visible || $data->bui_region != $data->bui_defaultregion ||
1274                     $data->bui_weight != $data->bui_defaultweight;
1276             if ($block->instance->blockpositionid && !$needbprecord) {
1277                 $DB->delete_records('block_positions', array('id' => $block->instance->blockpositionid));
1279             } else if ($block->instance->blockpositionid && $needbprecord) {
1280                 $bp->id = $block->instance->blockpositionid;
1281                 $DB->update_record('block_positions', $bp);
1283             } else if ($needbprecord) {
1284                 $bp->blockinstanceid = $block->instance->id;
1285                 $bp->contextid = $this->page->context->id;
1286                 $bp->pagetype = $this->page->pagetype;
1287                 if ($this->page->subpage) {
1288                     $bp->subpage = $this->page->subpage;
1289                 } else {
1290                     $bp->subpage = '';
1291                 }
1292                 $DB->insert_record('block_positions', $bp);
1293             }
1295             redirect($this->page->url);
1297         } else {
1298             $strheading = get_string('blockconfiga', 'moodle', $block->get_title());
1299             $editpage->set_title($strheading);
1300             $editpage->set_heading($strheading);
1301             $bits = explode('-', $this->page->pagetype);
1302             if ($bits[0] == 'tag' && !empty($this->page->subpage)) {
1303                 // better navbar for tag pages
1304                 $editpage->navbar->add(get_string('tags'), new moodle_url('/tag/'));
1305                 $tag = tag_get('id', $this->page->subpage, '*');
1306                 // tag search page doesn't have subpageid
1307                 if ($tag) {
1308                     $editpage->navbar->add($tag->name, new moodle_url('/tag/index.php', array('id'=>$tag->id)));
1309                 }
1310             }
1311             $editpage->navbar->add($block->get_title());
1312             $editpage->navbar->add(get_string('configuration'));
1313             echo $output->header();
1314             echo $output->heading($strheading, 2);
1315             $mform->display();
1316             echo $output->footer();
1317             exit;
1318         }
1319     }
1321     /**
1322      * Handle showing/processing the submission from the block editing form.
1323      * @return boolean true if the form was submitted and the new config saved. Does not
1324      *      return if the editing form was displayed. False otherwise.
1325      */
1326     public function process_url_move() {
1327         global $CFG, $DB, $PAGE;
1329         $blockid = optional_param('bui_moveid', null, PARAM_INTEGER);
1330         if (!$blockid) {
1331             return false;
1332         }
1334         require_sesskey();
1336         $block = $this->find_instance($blockid);
1338         if (!$this->page->user_can_edit_blocks()) {
1339             throw new moodle_exception('nopermissions', '', $this->page->url->out(), get_string('editblock'));
1340         }
1342         $newregion = optional_param('bui_newregion', '', PARAM_ALPHANUMEXT);
1343         $newweight = optional_param('bui_newweight', null, PARAM_FLOAT);
1344         if (!$newregion || is_null($newweight)) {
1345             // Don't have a valid target position yet, must be just starting the move.
1346             $this->movingblock = $blockid;
1347             $this->page->ensure_param_not_in_url('bui_moveid');
1348             return false;
1349         }
1351         if (!$this->is_known_region($newregion)) {
1352             throw new moodle_exception('unknownblockregion', '', $this->page->url, $newregion);
1353         }
1355         // Move this block. This may involve moving other nearby blocks.
1356         $blocks = $this->birecordsbyregion[$newregion];
1358         $maxweight = self::MAX_WEIGHT;
1359         $minweight = -self::MAX_WEIGHT;
1361         // Initialise the used weights and spareweights array with the default values
1362         $spareweights = array();
1363         $usedweights = array();
1364         for ($i = $minweight; $i <= $maxweight; $i++) {
1365             $spareweights[$i] = $i;
1366             $usedweights[$i] = array();
1367         }
1369         // Check each block and sort out where we have used weights
1370         foreach ($blocks as $bi) {
1371             if ($bi->weight > $maxweight) {
1372                 // If this statement is true then the blocks weight is more than the
1373                 // current maximum. To ensure that we can get the best block position
1374                 // we will initialise elements within the usedweights and spareweights
1375                 // arrays between the blocks weight (which will then be the new max) and
1376                 // the current max
1377                 $parseweight = $bi->weight;
1378                 while (!array_key_exists($parseweight, $usedweights)) {
1379                     $usedweights[$parseweight] = array();
1380                     $spareweights[$parseweight] = $parseweight;
1381                     $parseweight--;
1382                 }
1383                 $maxweight = $bi->weight;
1384             } else if ($bi->weight < $minweight) {
1385                 // As above except this time the blocks weight is LESS than the
1386                 // the current minimum, so we will initialise the array from the
1387                 // blocks weight (new minimum) to the current minimum
1388                 $parseweight = $bi->weight;
1389                 while (!array_key_exists($parseweight, $usedweights)) {
1390                     $usedweights[$parseweight] = array();
1391                     $spareweights[$parseweight] = $parseweight;
1392                     $parseweight++;
1393                 }
1394                 $minweight = $bi->weight;
1395             }
1396             if ($bi->id != $block->instance->id) {
1397                 unset($spareweights[$bi->weight]);
1398                 $usedweights[$bi->weight][] = $bi->id;
1399             }
1400         }
1402         // First we find the nearest gap in the list of weights.
1403         $bestdistance = max(abs($newweight - self::MAX_WEIGHT), abs($newweight + self::MAX_WEIGHT)) + 1;
1404         $bestgap = null;
1405         foreach ($spareweights as $spareweight) {
1406             if (abs($newweight - $spareweight) < $bestdistance) {
1407                 $bestdistance = abs($newweight - $spareweight);
1408                 $bestgap = $spareweight;
1409             }
1410         }
1412         // If there is no gap, we have to go outside -self::MAX_WEIGHT .. self::MAX_WEIGHT.
1413         if (is_null($bestgap)) {
1414             $bestgap = self::MAX_WEIGHT + 1;
1415             while (!empty($usedweights[$bestgap])) {
1416                 $bestgap++;
1417             }
1418         }
1420         // Now we know the gap we are aiming for, so move all the blocks along.
1421         if ($bestgap < $newweight) {
1422             $newweight = floor($newweight);
1423             for ($weight = $bestgap + 1; $weight <= $newweight; $weight++) {
1424                 foreach ($usedweights[$weight] as $biid) {
1425                     $this->reposition_block($biid, $newregion, $weight - 1);
1426                 }
1427             }
1428             $this->reposition_block($block->instance->id, $newregion, $newweight);
1429         } else {
1430             $newweight = ceil($newweight);
1431             for ($weight = $bestgap - 1; $weight >= $newweight; $weight--) {
1432                 foreach ($usedweights[$weight] as $biid) {
1433                     $this->reposition_block($biid, $newregion, $weight + 1);
1434                 }
1435             }
1436             $this->reposition_block($block->instance->id, $newregion, $newweight);
1437         }
1439         $this->page->ensure_param_not_in_url('bui_moveid');
1440         $this->page->ensure_param_not_in_url('bui_newregion');
1441         $this->page->ensure_param_not_in_url('bui_newweight');
1442         return true;
1443     }
1445     /**
1446      * Turns the display of normal blocks either on or off.
1447      *
1448      * @param bool $setting
1449      */
1450     public function show_only_fake_blocks($setting = true) {
1451         $this->fakeblocksonly = $setting;
1452     }
1455 /// Helper functions for working with block classes ============================
1457 /**
1458  * Call a class method (one that does not require a block instance) on a block class.
1459  *
1460  * @param string $blockname the name of the block.
1461  * @param string $method the method name.
1462  * @param array $param parameters to pass to the method.
1463  * @return mixed whatever the method returns.
1464  */
1465 function block_method_result($blockname, $method, $param = NULL) {
1466     if(!block_load_class($blockname)) {
1467         return NULL;
1468     }
1469     return call_user_func(array('block_'.$blockname, $method), $param);
1472 /**
1473  * Creates a new instance of the specified block class.
1474  *
1475  * @param string $blockname the name of the block.
1476  * @param $instance block_instances DB table row (optional).
1477  * @param moodle_page $page the page this block is appearing on.
1478  * @return block_base the requested block instance.
1479  */
1480 function block_instance($blockname, $instance = NULL, $page = NULL) {
1481     if(!block_load_class($blockname)) {
1482         return false;
1483     }
1484     $classname = 'block_'.$blockname;
1485     $retval = new $classname;
1486     if($instance !== NULL) {
1487         if (is_null($page)) {
1488             global $PAGE;
1489             $page = $PAGE;
1490         }
1491         $retval->_load_instance($instance, $page);
1492     }
1493     return $retval;
1496 /**
1497  * Load the block class for a particular type of block.
1498  *
1499  * @param string $blockname the name of the block.
1500  * @return boolean success or failure.
1501  */
1502 function block_load_class($blockname) {
1503     global $CFG;
1505     if(empty($blockname)) {
1506         return false;
1507     }
1509     $classname = 'block_'.$blockname;
1511     if(class_exists($classname)) {
1512         return true;
1513     }
1515     $blockpath = $CFG->dirroot.'/blocks/'.$blockname.'/block_'.$blockname.'.php';
1517     if (file_exists($blockpath)) {
1518         require_once($CFG->dirroot.'/blocks/moodleblock.class.php');
1519         include_once($blockpath);
1520     }else{
1521         //debugging("$blockname code does not exist in $blockpath", DEBUG_DEVELOPER);
1522         return false;
1523     }
1525     return class_exists($classname);
1528 /**
1529  * Given a specific page type, return all the page type patterns that might
1530  * match it.
1531  *
1532  * @param string $pagetype for example 'course-view-weeks' or 'mod-quiz-view'.
1533  * @return array an array of all the page type patterns that might match this page type.
1534  */
1535 function matching_page_type_patterns($pagetype) {
1536     $patterns = array($pagetype);
1537     $bits = explode('-', $pagetype);
1538     if (count($bits) == 3 && $bits[0] == 'mod') {
1539         if ($bits[2] == 'view') {
1540             $patterns[] = 'mod-*-view';
1541         } else if ($bits[2] == 'index') {
1542             $patterns[] = 'mod-*-index';
1543         }
1544     }
1545     while (count($bits) > 0) {
1546         $patterns[] = implode('-', $bits) . '-*';
1547         array_pop($bits);
1548     }
1549     $patterns[] = '*';
1550     return $patterns;
1553 /**
1554  * Given a specific page type, parent context and currect context, return all the page type patterns
1555  * that might be used by this block.
1556  *
1557  * @param string $pagetype for example 'course-view-weeks' or 'mod-quiz-view'.
1558  * @param stdClass $parentcontext Block's parent context
1559  * @param stdClass $currentcontext Current context of block
1560  * @return array an array of all the page type patterns that might match this page type.
1561  */
1562 function generate_page_type_patterns($pagetype, $parentcontext = null, $currentcontext = null) {
1563     global $CFG;
1565     $bits = explode('-', $pagetype);
1567     $core = get_core_subsystems();
1568     $plugins = get_plugin_types();
1570     //progressively strip pieces off the page type looking for a match
1571     $componentarray = null;
1572     for ($i = count($bits); $i > 0; $i--) {
1573         $possiblecomponentarray = array_slice($bits, 0, $i);
1574         $possiblecomponent = implode('', $possiblecomponentarray);
1576         // Check to see if the component is a core component
1577         if (array_key_exists($possiblecomponent, $core) && !empty($core[$possiblecomponent])) {
1578             $libfile = $CFG->dirroot.'/'.$core[$possiblecomponent].'/lib.php';
1579             if (file_exists($libfile)) {
1580                 require_once($libfile);
1581                 $function = $possiblecomponent.'_page_type_list';
1582                 if (function_exists($function)) {
1583                     if ($patterns = $function($pagetype, $parentcontext, $currentcontext)) {
1584                         break;
1585                     }
1586                 }
1587             }
1588         }
1590         //check the plugin directory and look for a callback
1591         if (array_key_exists($possiblecomponent, $plugins) && !empty($plugins[$possiblecomponent])) {
1593             //We've found a plugin type. Look for a plugin name by getting the next section of page type
1594             if (count($bits) > $i) {
1595                 $pluginname = $bits[$i];
1596                 $directory = get_plugin_directory($possiblecomponent, $pluginname);
1597                 if (!empty($directory)){
1598                     $libfile = $directory.'/lib.php';
1599                     if (file_exists($libfile)) {
1600                         require_once($libfile);
1601                         $function = $pluginname.'_page_type_list';
1602                         if (function_exists($function)) {
1603                             if ($patterns = $function($pagetype, $parentcontext, $currentcontext)) {
1604                                 break;
1605                             }
1606                         }
1607                     }
1608                 }
1609             }
1611             //we'll only get to here if we still don't have any patterns
1612             //the plugin type may have a callback
1613             $directory = get_plugin_directory($possiblecomponent, null);
1614             if (!empty($directory)){
1615                 $libfile = $directory.'/lib.php';
1616                 if (file_exists($libfile)) {
1617                     require_once($libfile);
1618                     $function = $possiblecomponent.'_page_type_list';
1619                     if (function_exists($function)) {
1620                         if ($patterns = $function($pagetype, $parentcontext, $currentcontext)) {
1621                             break;
1622                         }
1623                     }
1624                 }
1625             }
1626         }
1627     }
1629     if (empty($patterns)) {
1630         $patterns = default_page_type_list($pagetype, $parentcontext, $currentcontext);
1631     }
1633     return $patterns;
1636 /**
1637  * Generates a default page type list when a more appropriate callback cannot be decided upon.
1638  *
1639  * @param string $pagetype
1640  * @param stdClass $parentcontext
1641  * @param stdClass $currentcontext
1642  * @return array
1643  */
1644 function default_page_type_list($pagetype, $parentcontext = null, $currentcontext = null) {
1645     // Generate page type patterns based on current page type if
1646     // callbacks haven't been defined
1647     $patterns = array($pagetype => $pagetype);
1648     $bits = explode('-', $pagetype);
1649     while (count($bits) > 0) {
1650         $pattern = implode('-', $bits) . '-*';
1651         $pagetypestringname = 'page-'.str_replace('*', 'x', $pattern);
1652         // guessing page type description
1653         if (get_string_manager()->string_exists($pagetypestringname, 'pagetype')) {
1654             $patterns[$pattern] = get_string($pagetypestringname, 'pagetype');
1655         } else {
1656             $patterns[$pattern] = $pattern;
1657         }
1658         array_pop($bits);
1659     }
1660     $patterns['*'] = get_string('page-x', 'pagetype');
1661     return $patterns;
1664 /**
1665  * Generates the page type list for the my moodle page
1666  *
1667  * @param string $pagetype
1668  * @param stdClass $parentcontext
1669  * @param stdClass $currentcontext
1670  * @return array
1671  */
1672 function my_page_type_list($pagetype, $parentcontext = null, $currentcontext = null) {
1673     return array('my-index' => 'my-index');
1676 /**
1677  * Generates the page type list for a module by either locating and using the modules callback
1678  * or by generating a default list.
1679  *
1680  * @param string $pagetype
1681  * @param stdClass $parentcontext
1682  * @param stdClass $currentcontext
1683  * @return array
1684  */
1685 function mod_page_type_list($pagetype, $parentcontext = null, $currentcontext = null) {
1686     $patterns = plugin_page_type_list($pagetype, $parentcontext, $currentcontext);
1687     if (empty($patterns)) {
1688         // if modules don't have callbacks
1689         // generate two default page type patterns for modules only
1690         $bits = explode('-', $pagetype);
1691         $patterns = array($pagetype => $pagetype);
1692         if ($bits[2] == 'view') {
1693             $patterns['mod-*-view'] = get_string('page-mod-x-view', 'pagetype');
1694         } else if ($bits[2] == 'index') {
1695             $patterns['mod-*-index'] = get_string('page-mod-x-index', 'pagetype');
1696         }
1697     }
1698     return $patterns;
1700 /// Functions update the blocks if required by the request parameters ==========
1702 /**
1703  * Return a {@link block_contents} representing the add a new block UI, if
1704  * this user is allowed to see it.
1705  *
1706  * @return block_contents an appropriate block_contents, or null if the user
1707  * cannot add any blocks here.
1708  */
1709 function block_add_block_ui($page, $output) {
1710     global $CFG, $OUTPUT;
1711     if (!$page->user_is_editing() || !$page->user_can_edit_blocks()) {
1712         return null;
1713     }
1715     $bc = new block_contents();
1716     $bc->title = get_string('addblock');
1717     $bc->add_class('block_adminblock');
1719     $missingblocks = $page->blocks->get_addable_blocks();
1720     if (empty($missingblocks)) {
1721         $bc->content = get_string('noblockstoaddhere');
1722         return $bc;
1723     }
1725     $menu = array();
1726     foreach ($missingblocks as $block) {
1727         $blockobject = block_instance($block->name);
1728         if ($blockobject !== false && $blockobject->user_can_addto($page)) {
1729             $menu[$block->name] = $blockobject->get_title();
1730         }
1731     }
1732     textlib_get_instance()->asort($menu);
1734     $actionurl = new moodle_url($page->url, array('sesskey'=>sesskey()));
1735     $select = new single_select($actionurl, 'bui_addblock', $menu, null, array(''=>get_string('adddots')), 'add_block');
1736     $bc->content = $OUTPUT->render($select);
1737     return $bc;
1740 // Functions that have been deprecated by block_manager =======================
1742 /**
1743  * @deprecated since Moodle 2.0 - use $page->blocks->get_addable_blocks();
1744  *
1745  * This function returns an array with the IDs of any blocks that you can add to your page.
1746  * Parameters are passed by reference for speed; they are not modified at all.
1747  *
1748  * @param $page the page object.
1749  * @param $blockmanager Not used.
1750  * @return array of block type ids.
1751  */
1752 function blocks_get_missing(&$page, &$blockmanager) {
1753     debugging('blocks_get_missing is deprecated. Please use $page->blocks->get_addable_blocks() instead.', DEBUG_DEVELOPER);
1754     $blocks = $page->blocks->get_addable_blocks();
1755     $ids = array();
1756     foreach ($blocks as $block) {
1757         $ids[] = $block->id;
1758     }
1759     return $ids;
1762 /**
1763  * Actually delete from the database any blocks that are currently on this page,
1764  * but which should not be there according to blocks_name_allowed_in_format.
1765  *
1766  * @todo Write/Fix this function. Currently returns immediately
1767  * @param $course
1768  */
1769 function blocks_remove_inappropriate($course) {
1770     // TODO
1771     return;
1772     /*
1773     $blockmanager = blocks_get_by_page($page);
1775     if (empty($blockmanager)) {
1776         return;
1777     }
1779     if (($pageformat = $page->pagetype) == NULL) {
1780         return;
1781     }
1783     foreach($blockmanager as $region) {
1784         foreach($region as $instance) {
1785             $block = blocks_get_record($instance->blockid);
1786             if(!blocks_name_allowed_in_format($block->name, $pageformat)) {
1787                blocks_delete_instance($instance->instance);
1788             }
1789         }
1790     }*/
1793 /**
1794  * Check that a given name is in a permittable format
1795  *
1796  * @param string $name
1797  * @param string $pageformat
1798  * @return bool
1799  */
1800 function blocks_name_allowed_in_format($name, $pageformat) {
1801     $accept = NULL;
1802     $maxdepth = -1;
1803     $formats = block_method_result($name, 'applicable_formats');
1804     if (!$formats) {
1805         $formats = array();
1806     }
1807     foreach ($formats as $format => $allowed) {
1808         $formatregex = '/^'.str_replace('*', '[^-]*', $format).'.*$/';
1809         $depth = substr_count($format, '-');
1810         if (preg_match($formatregex, $pageformat) && $depth > $maxdepth) {
1811             $maxdepth = $depth;
1812             $accept = $allowed;
1813         }
1814     }
1815     if ($accept === NULL) {
1816         $accept = !empty($formats['all']);
1817     }
1818     return $accept;
1821 /**
1822  * Delete a block, and associated data.
1823  *
1824  * @param object $instance a row from the block_instances table
1825  * @param bool $nolongerused legacy parameter. Not used, but kept for backwards compatibility.
1826  * @param bool $skipblockstables for internal use only. Makes @see blocks_delete_all_for_context() more efficient.
1827  */
1828 function blocks_delete_instance($instance, $nolongerused = false, $skipblockstables = false) {
1829     global $DB;
1831     if ($block = block_instance($instance->blockname, $instance)) {
1832         $block->instance_delete();
1833     }
1834     delete_context(CONTEXT_BLOCK, $instance->id);
1836     if (!$skipblockstables) {
1837         $DB->delete_records('block_positions', array('blockinstanceid' => $instance->id));
1838         $DB->delete_records('block_instances', array('id' => $instance->id));
1839         $DB->delete_records_list('user_preferences', 'name', array('block'.$instance->id.'hidden','docked_block_instance_'.$instance->id));
1840     }
1843 /**
1844  * Delete all the blocks that belong to a particular context.
1845  *
1846  * @param int $contextid the context id.
1847  */
1848 function blocks_delete_all_for_context($contextid) {
1849     global $DB;
1850     $instances = $DB->get_recordset('block_instances', array('parentcontextid' => $contextid));
1851     foreach ($instances as $instance) {
1852         blocks_delete_instance($instance, true);
1853     }
1854     $instances->close();
1855     $DB->delete_records('block_instances', array('parentcontextid' => $contextid));
1856     $DB->delete_records('block_positions', array('contextid' => $contextid));
1859 /**
1860  * Set a block to be visible or hidden on a particular page.
1861  *
1862  * @param object $instance a row from the block_instances, preferably LEFT JOINed with the
1863  *      block_positions table as return by block_manager.
1864  * @param moodle_page $page the back to set the visibility with respect to.
1865  * @param integer $newvisibility 1 for visible, 0 for hidden.
1866  */
1867 function blocks_set_visibility($instance, $page, $newvisibility) {
1868     global $DB;
1869     if (!empty($instance->blockpositionid)) {
1870         // Already have local information on this page.
1871         $DB->set_field('block_positions', 'visible', $newvisibility, array('id' => $instance->blockpositionid));
1872         return;
1873     }
1875     // Create a new block_positions record.
1876     $bp = new stdClass;
1877     $bp->blockinstanceid = $instance->id;
1878     $bp->contextid = $page->context->id;
1879     $bp->pagetype = $page->pagetype;
1880     if ($page->subpage) {
1881         $bp->subpage = $page->subpage;
1882     }
1883     $bp->visible = $newvisibility;
1884     $bp->region = $instance->defaultregion;
1885     $bp->weight = $instance->defaultweight;
1886     $DB->insert_record('block_positions', $bp);
1889 /**
1890  * @deprecated since 2.0
1891  * Delete all the blocks from a particular page.
1892  *
1893  * @param string $pagetype the page type.
1894  * @param integer $pageid the page id.
1895  * @return bool success or failure.
1896  */
1897 function blocks_delete_all_on_page($pagetype, $pageid) {
1898     global $DB;
1900     debugging('Call to deprecated function blocks_delete_all_on_page. ' .
1901             'This function cannot work any more. Doing nothing. ' .
1902             'Please update your code to use a block_manager method $PAGE->blocks->....', DEBUG_DEVELOPER);
1903     return false;
1906 /**
1907  * Dispite what this function is called, it seems to be mostly used to populate
1908  * the default blocks when a new course (or whatever) is created.
1909  *
1910  * @deprecated since 2.0
1911  *
1912  * @param object $page the page to add default blocks to.
1913  * @return boolean success or failure.
1914  */
1915 function blocks_repopulate_page($page) {
1916     global $CFG;
1918     debugging('Call to deprecated function blocks_repopulate_page. ' .
1919             'Use a more specific method like blocks_add_default_course_blocks, ' .
1920             'or just call $PAGE->blocks->add_blocks()', DEBUG_DEVELOPER);
1922     /// If the site override has been defined, it is the only valid one.
1923     if (!empty($CFG->defaultblocks_override)) {
1924         $blocknames = $CFG->defaultblocks_override;
1925     } else {
1926         $blocknames = $page->blocks_get_default();
1927     }
1929     $blocks = blocks_parse_default_blocks_list($blocknames);
1930     $page->blocks->add_blocks($blocks);
1932     return true;
1935 /**
1936  * Get the block record for a particular blockid - that is, a particular type os block.
1937  *
1938  * @param $int blockid block type id. If null, an array of all block types is returned.
1939  * @param bool $notusedanymore No longer used.
1940  * @return array|object row from block table, or all rows.
1941  */
1942 function blocks_get_record($blockid = NULL, $notusedanymore = false) {
1943     global $PAGE;
1944     $blocks = $PAGE->blocks->get_installed_blocks();
1945     if ($blockid === NULL) {
1946         return $blocks;
1947     } else if (isset($blocks[$blockid])) {
1948         return $blocks[$blockid];
1949     } else {
1950         return false;
1951     }
1954 /**
1955  * Find a given block by its blockid within a provide array
1956  *
1957  * @param int $blockid
1958  * @param array $blocksarray
1959  * @return bool|object Instance if found else false
1960  */
1961 function blocks_find_block($blockid, $blocksarray) {
1962     if (empty($blocksarray)) {
1963         return false;
1964     }
1965     foreach($blocksarray as $blockgroup) {
1966         if (empty($blockgroup)) {
1967             continue;
1968         }
1969         foreach($blockgroup as $instance) {
1970             if($instance->blockid == $blockid) {
1971                 return $instance;
1972             }
1973         }
1974     }
1975     return false;
1978 // Functions for programatically adding default blocks to pages ================
1980 /**
1981  * Parse a list of default blocks. See config-dist for a description of the format.
1982  *
1983  * @param string $blocksstr
1984  * @return array
1985  */
1986 function blocks_parse_default_blocks_list($blocksstr) {
1987     $blocks = array();
1988     $bits = explode(':', $blocksstr);
1989     if (!empty($bits)) {
1990         $leftbits = trim(array_shift($bits));
1991         if ($leftbits != '') {
1992             $blocks[BLOCK_POS_LEFT] = explode(',', $leftbits);
1993         }
1994     }
1995     if (!empty($bits)) {
1996         $rightbits =trim(array_shift($bits));
1997         if ($rightbits != '') {
1998             $blocks[BLOCK_POS_RIGHT] = explode(',', $rightbits);
1999         }
2000     }
2001     return $blocks;
2004 /**
2005  * @return array the blocks that should be added to the site course by default.
2006  */
2007 function blocks_get_default_site_course_blocks() {
2008     global $CFG;
2010     if (!empty($CFG->defaultblocks_site)) {
2011         return blocks_parse_default_blocks_list($CFG->defaultblocks_site);
2012     } else {
2013         return array(
2014             BLOCK_POS_LEFT => array('site_main_menu'),
2015             BLOCK_POS_RIGHT => array('course_summary', 'calendar_month')
2016         );
2017     }
2020 /**
2021  * Add the default blocks to a course.
2022  *
2023  * @param object $course a course object.
2024  */
2025 function blocks_add_default_course_blocks($course) {
2026     global $CFG;
2028     if (!empty($CFG->defaultblocks_override)) {
2029         $blocknames = blocks_parse_default_blocks_list($CFG->defaultblocks_override);
2031     } else if ($course->id == SITEID) {
2032         $blocknames = blocks_get_default_site_course_blocks();
2034     } else {
2035         $defaultblocks = 'defaultblocks_' . $course->format;
2036         if (!empty($CFG->$defaultblocks)) {
2037             $blocknames = blocks_parse_default_blocks_list($CFG->$defaultblocks);
2039         } else {
2040             $formatconfig = $CFG->dirroot.'/course/format/'.$course->format.'/config.php';
2041             $format = array(); // initialize array in external file
2042             if (is_readable($formatconfig)) {
2043                 include($formatconfig);
2044             }
2045             if (!empty($format['defaultblocks'])) {
2046                 $blocknames = blocks_parse_default_blocks_list($format['defaultblocks']);
2048             } else if (!empty($CFG->defaultblocks)){
2049                 $blocknames = blocks_parse_default_blocks_list($CFG->defaultblocks);
2051             } else {
2052                 $blocknames = array(
2053                     BLOCK_POS_LEFT => array(),
2054                     BLOCK_POS_RIGHT => array('search_forums', 'news_items', 'calendar_upcoming', 'recent_activity')
2055                 );
2056             }
2057         }
2058     }
2060     if ($course->id == SITEID) {
2061         $pagetypepattern = 'site-index';
2062     } else {
2063         $pagetypepattern = 'course-view-*';
2064     }
2065     $page = new moodle_page();
2066     $page->set_course($course);
2067     $page->blocks->add_blocks($blocknames, $pagetypepattern);
2070 /**
2071  * Add the default system-context blocks. E.g. the admin tree.
2072  */
2073 function blocks_add_default_system_blocks() {
2074     global $DB;
2076     $page = new moodle_page();
2077     $page->set_context(get_context_instance(CONTEXT_SYSTEM));
2078     $page->blocks->add_blocks(array(BLOCK_POS_LEFT => array('navigation', 'settings')), '*', null, true);
2079     $page->blocks->add_blocks(array(BLOCK_POS_LEFT => array('admin_bookmarks')), 'admin-*', null, null, 2);
2081     if ($defaultmypage = $DB->get_record('my_pages', array('userid'=>null, 'name'=>'__default', 'private'=>1))) {
2082         $subpagepattern = $defaultmypage->id;
2083     } else {
2084         $subpagepattern = null;
2085     }
2087     $page->blocks->add_blocks(array(BLOCK_POS_RIGHT => array('private_files', 'online_users'), 'content' => array('course_overview')), 'my-index', $subpagepattern, false);