my/index.php

   1 <?php
   2
   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/>.
  17
  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  */
  37
  38 require_once(dirname(__FILE__) . '/../config.php');
  39 require_once($CFG->dirroot . '/my/lib.php');
  40
  41 redirect_if_major_upgrade_required();
  42
  43 // TODO Add sesskey check to edit
  44 $edit   = optional_param('edit', null, PARAM_BOOL);    // Turn editing on and off
  45 $reset  = optional_param('reset', null, PARAM_BOOL);
  46
  47 require_login();
  48
  49 $hassiteconfig = has_capability('moodle/site:config', context_system::instance());
  50 if ($hassiteconfig && moodle_needs_upgrading()) {
  51     redirect(new moodle_url('/admin/index.php'));
  52 }
  53
  54 $strmymoodle = get_string('myhome');
  55
  56 if (isguestuser()) {  // Force them to see system default, no editing allowed
  57     // If guests are not allowed my moodle, send them to front page.
  58     if (empty($CFG->allowguestmymoodle)) {
  59         redirect(new moodle_url('/', array('redirect' => 0)));
  60     }
  61
  62     $userid = null;
  63     $USER->editing = $edit = 0;  // Just in case
  64     $context = context_system::instance();
  65     $PAGE->set_blocks_editing_capability('moodle/my:configsyspages');  // unlikely :)
  66     $header = "$SITE->shortname: $strmymoodle (GUEST)";
  67
  68 } else {        // We are trying to view or edit our own My Moodle page
  69     $userid = $USER->id;  // Owner of the page
  70     $context = context_user::instance($USER->id);
  71     $PAGE->set_blocks_editing_capability('moodle/my:manageblocks');
  72     $header = "$SITE->shortname: $strmymoodle";
  73 }
  74
  75 // Get the My Moodle page info.  Should always return something unless the database is broken.
  76 if (!$currentpage = my_get_page($userid, MY_PAGE_PRIVATE)) {
  77     print_error('mymoodlesetup');
  78 }
  79
  80 if (!$currentpage->userid) {
  81     $context = context_system::instance();  // So we even see non-sticky blocks
  82 }
  83
  84 // Start setting up the page
  85 $params = array();
  86 $PAGE->set_context($context);
  87 $PAGE->set_url('/my/index.php', $params);
  88 $PAGE->set_pagelayout('mydashboard');
  89 $PAGE->set_pagetype('my-index');
  90 $PAGE->blocks->add_region('content');
  91 $PAGE->set_subpage($currentpage->id);
  92 $PAGE->set_title($header);
  93 $PAGE->set_heading($header);
  94
  95 if (!isguestuser()) {   // Skip default home page for guests
  96     if (get_home_page() != HOMEPAGE_MY) {
  97         if (optional_param('setdefaulthome', false, PARAM_BOOL)) {
  98             set_user_preference('user_home_page_preference', HOMEPAGE_MY);
  99         } else if (!empty($CFG->defaulthomepage) && $CFG->defaulthomepage == HOMEPAGE_USER) {
 100             $PAGE->settingsnav->get('usercurrentsettings')->add(get_string('makethismyhome'), new moodle_url('/my/', array('setdefaulthome'=>true)), navigation_node::TYPE_SETTING);
 101         }
 102     }
 103 }
 104
 105 // Toggle the editing state and switches
 106 if ($PAGE->user_allowed_editing()) {
 107     if ($reset !== null) {
 108         if (!is_null($userid)) {
 109             require_sesskey();
 110             if(!$currentpage = my_reset_page($userid, MY_PAGE_PRIVATE)){
 111                 print_error('reseterror', 'my');
 112             }
 113             redirect(new moodle_url('/my'));
 114         }
 115     } else if ($edit !== null) {             // Editing state was specified
 116         $USER->editing = $edit;       // Change editing state
 117         if (!$currentpage->userid && $edit) {
 118             // If we are viewing a system page as ordinary user, and the user turns
 119             // editing on, copy the system pages as new user pages, and get the
 120             // new page record
 121             if (!$currentpage = my_copy_page($USER->id, MY_PAGE_PRIVATE)) {
 122                 print_error('mymoodlesetup');
 123             }
 124             $context = context_user::instance($USER->id);
 125             $PAGE->set_context($context);
 126             $PAGE->set_subpage($currentpage->id);
 127         }
 128     } else {                          // Editing state is in session
 129         if ($currentpage->userid) {   // It's a page we can edit, so load from session
 130             if (!empty($USER->editing)) {
 131                 $edit = 1;
 132             } else {
 133                 $edit = 0;
 134             }
 135         } else {                      // It's a system page and they are not allowed to edit system pages
 136             $USER->editing = $edit = 0;          // Disable editing completely, just to be safe
 137         }
 138     }
 139
 140     // Add button for editing page
 141     $params = array('edit' => !$edit);
 142
 143     $resetbutton = '';
 144     $resetstring = get_string('resetpage', 'my');
 145     $reseturl = new moodle_url("$CFG->wwwroot/my/index.php", array('edit' => 1, 'reset' => 1));
 146
 147     if (!$currentpage->userid) {
 148         // viewing a system page -- let the user customise it
 149         $editstring = get_string('updatemymoodleon');
 150         $params['edit'] = 1;
 151     } else if (empty($edit)) {
 152         $editstring = get_string('updatemymoodleon');
 153     } else {
 154         $editstring = get_string('updatemymoodleoff');
 155         $resetbutton = $OUTPUT->single_button($reseturl, $resetstring);
 156     }
 157
 158     $url = new moodle_url("$CFG->wwwroot/my/index.php", $params);
 159     $button = $OUTPUT->single_button($url, $editstring);
 160     $PAGE->set_button($resetbutton . $button);
 161
 162 } else {
 163     $USER->editing = $edit = 0;
 164 }
 165
 166 // HACK WARNING!  This loads up all this page's blocks in the system context
 167 if ($currentpage->userid == 0) {
 168     $CFG->blockmanagerclass = 'my_syspage_block_manager';
 169 }
 170
 171
 172 echo $OUTPUT->header();
 173
 174 echo $OUTPUT->custom_block_region('content');
 175
 176 echo $OUTPUT->footer();