Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/my/ -> lib.php (source)
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * My Moodle -- a user's personal dashboard
 *
 * This file contains common functions for the dashboard and profile pages.
 *
 * @package    moodlecore
 * @subpackage my
 * @copyright  2010 Remote-Learner.net
 * @author     Hubert Chathi <hubert@remote-learner.net>
 * @author     Olav Jordan <olav.jordan@remote-learner.net>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

define('MY_PAGE_PUBLIC', 0);
define('MY_PAGE_PRIVATE', 1);
> define('MY_PAGE_DEFAULT', '__default'); > define('MY_PAGE_COURSES', '__courses');
require_once("$CFG->libdir/blocklib.php");
< /*
> /**
* For a given user, this returns the $page information for their My Moodle page *
> * @param int|null $userid the id of the user whose page should be retrieved */ > * @param int|null $private either MY_PAGE_PRIVATE or MY_PAGE_PUBLIC function my_get_page($userid, $private=MY_PAGE_PRIVATE) { > * @param string|null $pagename Differentiate between standard /my or /courses pages.
< function my_get_page($userid, $private=MY_PAGE_PRIVATE) {
> function my_get_page(?int $userid, int $private = MY_PAGE_PRIVATE, string $pagename = MY_PAGE_DEFAULT) {
if (empty($CFG->forcedefaultmymoodle) && $userid) { // Ignore custom My Moodle pages if admin has forced them // Does the user have their own page defined? If so, return it.
< if ($customised = $DB->get_record('my_pages', array('userid' => $userid, 'private' => $private))) {
> if ($customised = $DB->get_record( > 'my_pages', > array('userid' => $userid, 'private' => $private, 'name' => $pagename), > '*', > IGNORE_MULTIPLE > )) {
return $customised; } } // Otherwise return the system default page
< return $DB->get_record('my_pages', array('userid' => null, 'name' => '__default', 'private' => $private));
> return $DB->get_record('my_pages', array('userid' => null, 'name' => $pagename, 'private' => $private), '*', IGNORE_MULTIPLE);
}
< /*
> /**
* This copies a system default page to the current user *
> * @param int $userid the id of the user whose page should be reset */ > * @param int $private either MY_PAGE_PRIVATE or MY_PAGE_PUBLIC function my_copy_page($userid, $private=MY_PAGE_PRIVATE, $pagetype='my-index') { > * @param string $pagetype either my-index or user-profile global $DB; > * @param string $pagename Differentiate between standard /my or /courses pages.
< function my_copy_page($userid, $private=MY_PAGE_PRIVATE, $pagetype='my-index') {
> function my_copy_page( > int $userid, > int $private = MY_PAGE_PRIVATE, > string $pagetype = 'my-index', > string $pagename = MY_PAGE_DEFAULT > ) {
< if ($customised = $DB->get_record('my_pages', array('userid' => $userid, 'private' => $private))) {
> if ($customised = $DB->get_record( > 'my_pages', > array('userid' => $userid, 'name' => $pagename, 'private' => $private), > '*', > IGNORE_MULTIPLE > )) {
return $customised; // We're done! } // Get the system default page
< if (!$systempage = $DB->get_record('my_pages', array('userid' => null, 'private' => $private))) {
> if (!$systempage = $DB->get_record( > 'my_pages', > array('userid' => null, 'name' => $pagename, 'private' => $private), > '*', > IGNORE_MULTIPLE > )) {
return false; // error } // Clone the basic system page record $page = clone($systempage); unset($page->id); $page->userid = $userid; $page->id = $DB->insert_record('my_pages', $page); // Clone ALL the associated blocks as well $systemcontext = context_system::instance(); $usercontext = context_user::instance($userid); $blockinstances = $DB->get_records('block_instances', array('parentcontextid' => $systemcontext->id, 'pagetypepattern' => $pagetype, 'subpagepattern' => $systempage->id));
> $roles = get_all_roles();
$newblockinstanceids = []; foreach ($blockinstances as $instance) { $originalid = $instance->id;
> $originalcontext = context_block::instance($originalid);
unset($instance->id); $instance->parentcontextid = $usercontext->id; $instance->subpagepattern = $page->id; $instance->timecreated = time(); $instance->timemodified = $instance->timecreated; $instance->id = $DB->insert_record('block_instances', $instance); $newblockinstanceids[$originalid] = $instance->id; $blockcontext = context_block::instance($instance->id); // Just creates the context record $block = block_instance($instance->blockname, $instance);
< if (!$block->instance_copy($originalid)) { < debugging("Unable to copy block-specific data for original block instance: $originalid < to new block instance: $instance->id", DEBUG_DEVELOPER);
> if (empty($block) || !$block->instance_copy($originalid)) { > debugging("Unable to copy block-specific data for original block > instance: $originalid to new block instance: $instance->id for > block: $instance->blockname", DEBUG_DEVELOPER); > } > // Check if there are any overrides on this block instance. > // We check against all roles, not just roles assigned to the user. > // This is so any overrides that are applied to the system default page > // will be applied to the user's page as well, even if their role assignment changes in the future. > foreach ($roles as $role) { > $rolecapabilities = get_capabilities_from_role_on_context($role, $originalcontext); > // If there are overrides, then apply them to the new block instance. > foreach ($rolecapabilities as $rolecapability) { > role_change_permission( > $rolecapability->roleid, > $blockcontext, > $rolecapability->capability, > $rolecapability->permission > ); > }
} } // Clone block position overrides. if ($blockpositions = $DB->get_records('block_positions', ['subpage' => $systempage->id, 'pagetype' => $pagetype, 'contextid' => $systemcontext->id])) { foreach ($blockpositions as &$positions) { $positions->subpage = $page->id; $positions->contextid = $usercontext->id; if (array_key_exists($positions->blockinstanceid, $newblockinstanceids)) { // For block instances that were defined on the default dashboard and copied to the user dashboard // use the new blockinstanceid. $positions->blockinstanceid = $newblockinstanceids[$positions->blockinstanceid]; } unset($positions->id); } $DB->insert_records('block_positions', $blockpositions); } return $page; }
< /*
> /**
* For a given user, this deletes their My Moodle page and returns them to the system default. * * @param int $userid the id of the user whose page should be reset * @param int $private either MY_PAGE_PRIVATE or MY_PAGE_PUBLIC * @param string $pagetype either my-index or user-profile
> * @param string $pagename Differentiate between standard /my or /courses pages.
* @return mixed system page, or false on error */
< function my_reset_page($userid, $private=MY_PAGE_PRIVATE, $pagetype='my-index') {
> function my_reset_page( > int $userid, > int $private = MY_PAGE_PRIVATE, > string $pagetype='my-index', > string $pagename = MY_PAGE_DEFAULT > ) {
global $DB, $CFG;
< $page = my_get_page($userid, $private);
> $page = my_get_page($userid, $private, $pagename);
if ($page->userid == $userid) { $context = context_user::instance($userid); if ($blocks = $DB->get_records('block_instances', array('parentcontextid' => $context->id, 'pagetypepattern' => $pagetype))) { foreach ($blocks as $block) { if (is_null($block->subpagepattern) || $block->subpagepattern == $page->id) { blocks_delete_instance($block); } } } $DB->delete_records('block_positions', ['subpage' => $page->id, 'pagetype' => $pagetype, 'contextid' => $context->id]);
< $DB->delete_records('my_pages', array('id' => $page->id));
> $DB->delete_records('my_pages', array('id' => $page->id, 'name' => $pagename));
} // Get the system default page
< if (!$systempage = $DB->get_record('my_pages', array('userid' => null, 'private' => $private))) {
> if (!$systempage = $DB->get_record( > 'my_pages', > array('userid' => null, 'name' => $pagename, 'private' => $private), > '*', > IGNORE_MULTIPLE > )) {
return false; // error } // Trigger dashboard has been reset event. $eventparams = array( 'context' => context_user::instance($userid), 'other' => array( 'private' => $private, 'pagetype' => $pagetype, ), ); $event = \core\event\dashboard_reset::create($eventparams); $event->trigger(); return $systempage; } /** * Resets the page customisations for all users. * * @param int $private Either MY_PAGE_PRIVATE or MY_PAGE_PUBLIC. * @param string $pagetype Either my-index or user-profile.
> * @param progress_bar|null $progressbar A progress bar to update. * @return void > * @param string $pagename Differentiate between standard /my or /courses pages.
*/
< function my_reset_page_for_all_users($private = MY_PAGE_PRIVATE, $pagetype = 'my-index') {
> function my_reset_page_for_all_users( > int $private = MY_PAGE_PRIVATE, > string $pagetype = 'my-index', > ?progress_bar $progressbar = null, > string $pagename = MY_PAGE_DEFAULT > ) {
global $DB; // This may take a while. Raise the execution time limit. core_php_time_limit::raise();
> $users = $DB->get_fieldset_select( // Find all the user pages and all block instances in them. > 'my_pages', $sql = "SELECT bi.id > 'DISTINCT(userid)', FROM {my_pages} p > 'userid IS NOT NULL AND private = :private', JOIN {context} ctx ON ctx.instanceid = p.userid AND ctx.contextlevel = :usercontextlevel > ['private' => $private] JOIN {block_instances} bi ON bi.parentcontextid = ctx.id AND > ); bi.pagetypepattern = :pagetypepattern AND > $chunks = array_chunk($users, 20); (bi.subpagepattern IS NULL OR bi.subpagepattern = " . $DB->sql_concat("''", 'p.id') . ") > WHERE p.private = :private"; > if (!empty($progressbar) && count($chunks) > 0) { $params = array('private' => $private, > $count = count($chunks); 'usercontextlevel' => CONTEXT_USER, > $message = get_string('inprogress'); 'pagetypepattern' => $pagetype); > $progressbar->update(0, $count, $message); $blockids = $DB->get_fieldset_sql($sql, $params); > } > // Wrap the SQL queries in a transaction. > foreach ($chunks as $key => $userchunk) { $transaction = $DB->start_delegated_transaction(); > list($infragment, $inparams) = $DB->get_in_or_equal($userchunk, SQL_PARAMS_NAMED);
< JOIN {block_instances} bi ON bi.parentcontextid = ctx.id AND < bi.pagetypepattern = :pagetypepattern AND < (bi.subpagepattern IS NULL OR bi.subpagepattern = " . $DB->sql_concat("''", 'p.id') . ") < WHERE p.private = :private"; < $params = array('private' => $private,
> JOIN {block_instances} bi ON bi.parentcontextid = ctx.id > AND bi.pagetypepattern = :pagetypepattern > AND (bi.subpagepattern IS NULL OR bi.subpagepattern = " . $DB->sql_cast_to_char('p.id') . ") > WHERE p.private = :private > AND p.name = :name > AND p.userid $infragment"; > > $params = array_merge([ > 'private' => $private,
< 'pagetypepattern' => $pagetype);
> 'pagetypepattern' => $pagetype, > 'name' => $pagename > ], $inparams);
// Finally delete the pages.
< $DB->delete_records_select('my_pages', 'userid IS NOT NULL AND private = :private', ['private' => $private]);
> $DB->delete_records_select( > 'my_pages', > "userid $infragment AND private = :private", > array_merge(['private' => $private], $inparams) > );
// We should be good to go now. $transaction->allow_commit();
> if (!empty($progressbar)) { // Trigger dashboard has been reset event. > $progressbar->update(((int) $key + 1), $count, $message); $eventparams = array( > } 'context' => context_system::instance(), > } 'other' => array( >
'private' => $private, 'pagetype' => $pagetype, ), ); $event = \core\event\dashboards_reset::create($eventparams); $event->trigger();
> } > if (!empty($progressbar)) { > $progressbar->update(1, 1, get_string('completed')); class my_syspage_block_manager extends block_manager { > }
// HACK WARNING! // TODO: figure out a better way to do this /** * Load blocks using the system context, rather than the user's context. * * This is needed because the My Moodle pages set the page context to the * user's context for access control, etc. But the blocks for the system * pages are stored in the system context. */ public function load_blocks($includeinvisible = null) { $origcontext = $this->page->context; $this->page->context = context_system::instance(); parent::load_blocks($includeinvisible); $this->page->context = $origcontext; } }