7b2c82065f42c908313ab5f1c486c5f46ff21a22
[moodle.git] / lib / ajax / blocks.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Provide interface for blocks AJAX actions
19  *
20  * @copyright  2011 Lancaster University Network Services Limited
21  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  * @package core
23  */
25 define('AJAX_SCRIPT', true);
26 require_once(dirname(__FILE__) . '/../../config.php');
28 // Initialise ALL common incoming parameters here, up front.
29 $courseid = required_param('courseid', PARAM_INT);
30 $pagelayout = required_param('pagelayout', PARAM_ALPHAEXT);
31 $pagetype = required_param('pagetype', PARAM_ALPHAEXT);
32 $contextid = required_param('contextid', PARAM_INT);
33 $subpage = optional_param('subpage', '', PARAM_ALPHANUMEXT);
34 $cmid = optional_param('cmid', null, PARAM_INT);
35 $action = optional_param('action', '', PARAM_ALPHA);
36 // Params for blocks-move actions.
37 $buimoveid = optional_param('bui_moveid', 0, PARAM_INT);
38 $buinewregion = optional_param('bui_newregion', '', PARAM_ALPHAEXT);
39 $buibeforeid = optional_param('bui_beforeid', 0, PARAM_INT);
41 // Setting pagetype and URL.
42 $PAGE->set_pagetype($pagetype);
43 $PAGE->set_url('/lib/ajax/blocks.php', array('courseid' => $courseid, 'pagelayout' => $pagelayout, 'pagetype' => $pagetype));
45 // Verifying login and session.
46 $cm = null;
47 if (!is_null($cmid)) {
48     $cm = get_coursemodule_from_id(null, $cmid, $courseid, false, MUST_EXIST);
49 }
50 require_login($courseid, false, $cm);
51 require_sesskey();
53 // Set context from ID, so we don't have to guess it from other info.
54 $PAGE->set_context(context::instance_by_id($contextid));
56 // Setting layout to replicate blocks configuration for the page we edit.
57 $PAGE->set_pagelayout($pagelayout);
58 $PAGE->set_subpage($subpage);
59 $pagetype = explode('-', $pagetype);
60 switch ($pagetype[0]) {
61     case 'my':
62         // My Home page needs to have 'content' block region set up.
63         $PAGE->set_blocks_editing_capability('moodle/my:manageblocks');
64         $PAGE->blocks->add_region('content');
65         break;
66     case 'user':
67         if ($pagelayout == 'mydashboard') {
68             // User profile pages also need the 'content' block region set up.
69             $PAGE->blocks->add_region('content');
70             // If it's not the current user's profile, we need a different capability.
71             if ($PAGE->context->contextlevel == CONTEXT_USER && $PAGE->context->instanceid != $USER->id) {
72                 $PAGE->set_blocks_editing_capability('moodle/user:manageblocks');
73             } else {
74                 $PAGE->set_blocks_editing_capability('moodle/user:manageownblocks');
75             }
76         }
77         break;
78 }
80 // Send headers.
81 echo $OUTPUT->header();
83 switch ($action) {
84     case 'move':
85         // Loading blocks and instances for the region.
86         $PAGE->blocks->load_blocks();
87         $instances = $PAGE->blocks->get_blocks_for_region($buinewregion);
89         $buinewweight = null;
90         if ($buibeforeid == 0) {
91             if (count($instances) === 0) {
92                 // Moving the block into an empty region. Give it the default weight.
93                 $buinewweight = 0;
94             } else {
95                 // Moving to very bottom.
96                 $last = end($instances);
97                 $buinewweight = $last->instance->weight + 1;
98             }
99         } else {
100             // Moving somewhere.
101             $lastweight = 0;
102             $lastblock = 0;
103             $first = reset($instances);
104             if ($first) {
105                 $lastweight = $first->instance->weight - 2;
106             }
108             foreach ($instances as $instance) {
109                 if ($instance->instance->id == $buibeforeid) {
110                     // Location found, just calculate weight like in block_manager->create_block_contents() and quit the loop.
111                     if ($lastblock == $buimoveid) {
112                         // Same block, same place - nothing to move.
113                         break;
114                     }
115                     $buinewweight = ($lastweight + $instance->instance->weight) / 2;
116                     break;
117                 }
118                 $lastweight = $instance->instance->weight;
119                 $lastblock = $instance->instance->id;
120             }
121         }
123         // Move block if we need.
124         if (isset($buinewweight)) {
125             // Nasty hack.
126             $_POST['bui_newweight'] = $buinewweight;
127             $PAGE->blocks->process_url_move();
128         }
129         break;