Merge branch 'MDL-35419_23' of git://github.com/timhunt/moodle into MOODLE_23_STABLE
[moodle.git] / my / index.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  * My Moodle -- a user's personal dashboard
20  *
21  * - each user can currently have their own page (cloned from system and then customised)
22  * - only the user can see their own dashboard
23  * - users can add any blocks they want
24  * - the administrators can define a default site dashboard for users who have
25  *   not created their own dashboard
26  *
27  * This script implements the user's view of the dashboard, and allows editing
28  * of the dashboard.
29  *
30  * @package    moodlecore
31  * @subpackage my
32  * @copyright  2010 Remote-Learner.net
33  * @author     Hubert Chathi <hubert@remote-learner.net>
34  * @author     Olav Jordan <olav.jordan@remote-learner.net>
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
38 require_once(dirname(__FILE__) . '/../config.php');
39 require_once($CFG->dirroot . '/my/lib.php');
41 redirect_if_major_upgrade_required();
43 // TODO Add sesskey check to edit
44 $edit   = optional_param('edit', null, PARAM_BOOL);    // Turn editing on and off
46 require_login();
48 $strmymoodle = get_string('myhome');
50 if (isguestuser()) {  // Force them to see system default, no editing allowed
51     $userid = NULL; 
52     $USER->editing = $edit = 0;  // Just in case
53     $context = get_context_instance(CONTEXT_SYSTEM);
54     $PAGE->set_blocks_editing_capability('moodle/my:configsyspages');  // unlikely :)
55     $header = "$SITE->shortname: $strmymoodle (GUEST)";
57 } else {        // We are trying to view or edit our own My Moodle page
58     $userid = $USER->id;  // Owner of the page
59     $context = get_context_instance(CONTEXT_USER, $USER->id);
60     $PAGE->set_blocks_editing_capability('moodle/my:manageblocks');
61     $header = "$SITE->shortname: $strmymoodle";
62 }
64 // Get the My Moodle page info.  Should always return something unless the database is broken.
65 if (!$currentpage = my_get_page($userid, MY_PAGE_PRIVATE)) {
66     print_error('mymoodlesetup');
67 }
69 if (!$currentpage->userid) {
70     $context = get_context_instance(CONTEXT_SYSTEM);  // So we even see non-sticky blocks
71 }
73 // Start setting up the page
74 $params = array();
75 $PAGE->set_context($context);
76 $PAGE->set_url('/my/index.php', $params);
77 $PAGE->set_pagelayout('mydashboard');
78 $PAGE->set_pagetype('my-index');
79 $PAGE->blocks->add_region('content');
80 $PAGE->set_subpage($currentpage->id);
81 $PAGE->set_title($header);
82 $PAGE->set_heading($header);
84 if (get_home_page() != HOMEPAGE_MY) {
85     if (optional_param('setdefaulthome', false, PARAM_BOOL)) {
86         set_user_preference('user_home_page_preference', HOMEPAGE_MY);
87     } else if (!empty($CFG->defaulthomepage) && $CFG->defaulthomepage == HOMEPAGE_USER) {
88         $PAGE->settingsnav->get('usercurrentsettings')->add(get_string('makethismyhome'), new moodle_url('/my/', array('setdefaulthome'=>true)), navigation_node::TYPE_SETTING);
89     }
90 }
92 // Toggle the editing state and switches
93 if ($PAGE->user_allowed_editing()) {
94     if ($edit !== null) {             // Editing state was specified
95         $USER->editing = $edit;       // Change editing state
96         if (!$currentpage->userid && $edit) {
97             // If we are viewing a system page as ordinary user, and the user turns
98             // editing on, copy the system pages as new user pages, and get the
99             // new page record
100             if (!$currentpage = my_copy_page($USER->id, MY_PAGE_PRIVATE)) {
101                 print_error('mymoodlesetup');
102             }
103             $context = get_context_instance(CONTEXT_USER, $USER->id);
104             $PAGE->set_context($context);
105             $PAGE->set_subpage($currentpage->id);
106         }
107     } else {                          // Editing state is in session
108         if ($currentpage->userid) {   // It's a page we can edit, so load from session
109             if (!empty($USER->editing)) {
110                 $edit = 1;
111             } else {
112                 $edit = 0;
113             }
114         } else {                      // It's a system page and they are not allowed to edit system pages
115             $USER->editing = $edit = 0;          // Disable editing completely, just to be safe
116         }
117     }
119     // Add button for editing page
120     $params = array('edit' => !$edit);
122     if (!$currentpage->userid) {
123         // viewing a system page -- let the user customise it
124         $editstring = get_string('updatemymoodleon');
125         $params['edit'] = 1;
126     } else if (empty($edit)) {
127         $editstring = get_string('updatemymoodleon');
128     } else {
129         $editstring = get_string('updatemymoodleoff');
130     }
132     $url = new moodle_url("$CFG->wwwroot/my/index.php", $params);
133     $button = $OUTPUT->single_button($url, $editstring);
134     $PAGE->set_button($button);
136 } else {
137     $USER->editing = $edit = 0;
140 // HACK WARNING!  This loads up all this page's blocks in the system context
141 if ($currentpage->userid == 0) {
142     $CFG->blockmanagerclass = 'my_syspage_block_manager';
146 echo $OUTPUT->header();
148 echo $OUTPUT->blocks_for_region('content');
150 echo $OUTPUT->footer();