Subtree merged git://github.com/skodak/moodle-mod_book.git (master branch) into mod...
[moodle.git] / my / lib.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  * My Moodle -- a user's personal dashboard
19  *
20  * This file contains common functions for the dashboard and profile pages.
21  *
22  * @package    moodlecore
23  * @subpackage my
24  * @copyright  2010 Remote-Learner.net
25  * @author     Hubert Chathi <hubert@remote-learner.net>
26  * @author     Olav Jordan <olav.jordan@remote-learner.net>
27  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28  */
30 define('MY_PAGE_PUBLIC', 0);
31 define('MY_PAGE_PRIVATE', 1);
33 require_once("$CFG->libdir/blocklib.php");
35 /*
36  * For a given user, this returns the $page information for their My Moodle page
37  *
38  */
39 function my_get_page($userid, $private=MY_PAGE_PRIVATE) {
40     global $DB, $CFG;
42     if (empty($CFG->forcedefaultmymoodle) && $userid) {  // Ignore custom My Moodle pages if admin has forced them
43         // Does the user have their own page defined?  If so, return it.
44         if ($customised = $DB->get_record('my_pages', array('userid' => $userid, 'private' => $private))) {
45             return $customised;
46         }
47     }
49     // Otherwise return the system default page
50     return $DB->get_record('my_pages', array('userid' => null, 'name' => '__default', 'private' => $private));
51 }
54 /*
55  * This copies a system default page to the current user
56  *
57  */
58 function my_copy_page($userid, $private=MY_PAGE_PRIVATE, $pagetype='my-index') {
59     global $DB;
61     if ($customised = $DB->record_exists('my_pages', array('userid' => $userid, 'private' => $private))) {
62         return $customised;  // We're done!
63     }
65     // Get the system default page
66     if (!$systempage = $DB->get_record('my_pages', array('userid' => null, 'private' => $private))) {
67         return false;  // error
68     }
70     // Clone the basic system page record
71     $page = clone($systempage);
72     unset($page->id);
73     $page->userid = $userid;
74     $page->id = $DB->insert_record('my_pages', $page);
76     // Clone ALL the associated blocks as well
77     $systemcontext = get_context_instance(CONTEXT_SYSTEM);
78     $usercontext = get_context_instance(CONTEXT_USER, $userid);
80     $blockinstances = $DB->get_records('block_instances', array('parentcontextid' => $systemcontext->id,
81                                                                 'pagetypepattern' => $pagetype,
82                                                                 'subpagepattern' => $systempage->id));
83     foreach ($blockinstances as $instance) {
84         unset($instance->id);
85         $instance->parentcontextid = $usercontext->id;
86         $instance->subpagepattern = $page->id;
87         $instance->id = $DB->insert_record('block_instances', $instance);
88         $blockcontext = get_context_instance(CONTEXT_BLOCK, $instance->id);  // Just creates the context record
89     }
91     // FIXME: block position overrides should be merged in with block instance
92     //$blockpositions = $DB->get_records('block_positions', array('subpage' => $page->name));
93     //foreach($blockpositions as $positions) {
94     //    $positions->subpage = $page->name;
95     //    $DB->insert_record('block_positions', $tc);
96     //}
98     return $page;
99 }
101 class my_syspage_block_manager extends block_manager {
102     // HACK WARNING!
103     // TODO: figure out a better way to do this
104     /**
105      * Load blocks using the system context, rather than the user's context.
106      *
107      * This is needed because the My Moodle pages set the page context to the
108      * user's context for access control, etc.  But the blocks for the system
109      * pages are stored in the system context.
110      */
111     public function load_blocks($includeinvisible = null) {
112         $origcontext = $this->page->context;
113         $this->page->context = get_context_instance(CONTEXT_SYSTEM);
114         parent::load_blocks($includeinvisible);
115         $this->page->context = $origcontext;
116     }