Proyectos de Subversion Moodle

<?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/>.

/**

 * Public API of the log report.

 *

 * Defines the APIs used by log reports

 *

 * @package    report_log

 * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

use core\report_helper;

defined('MOODLE_INTERNAL') || die;

/**

 * This function extends the navigation with the report items

 *

 * @param navigation_node $navigation The navigation node to extend

 * @param stdClass $course The course to object for the report

 * @param stdClass $context The context of the course

 */

function report_log_extend_navigation_course($navigation, $course, $context) {

    if (

        has_capability('report/log:view', $context)

        && report_helper::has_valid_group($context)

    ) {

        $url = new moodle_url('/report/log/index.php', array('id'=>$course->id));

        $navigation->add(get_string('pluginname', 'report_log'), $url, navigation_node::TYPE_SETTING, null, null, new pix_icon('i/report', ''));

    }

}

/**

 * Callback to verify if the given instance of store is supported by this report or not.

 *

 * @param string $instance store instance.

 *

 * @return bool returns true if the store is supported by the report, false otherwise.

 */

function report_log_supports_logstore($instance) {

    if ($instance instanceof \core\log\sql_reader) {

        return true;

    }

    return false;

}

/**

 * This function extends the course navigation with the report items

 *

 * @param navigation_node $navigation The navigation node to extend

 * @param stdClass $user

 * @param stdClass $course The course to object for the report

 */

function report_log_extend_navigation_user($navigation, $user, $course) {

    list($all, $today) = report_log_can_access_user_report($user, $course);

    if ($today) {

        $url = new moodle_url('/report/log/user.php', array('id'=>$user->id, 'course'=>$course->id, 'mode'=>'today'));

        $navigation->add(get_string('todaylogs'), $url);

    }

    if ($all) {

        $url = new moodle_url('/report/log/user.php', array('id'=>$user->id, 'course'=>$course->id, 'mode'=>'all'));

        $navigation->add(get_string('alllogs'), $url);

    }

}

/**

 * Is current user allowed to access this report

 *

 * @access private defined in lib.php for performance reasons

 * @global stdClass $USER

 * @param stdClass $user

 * @param stdClass $course

 * @return array with two elements $all, $today

 */

function report_log_can_access_user_report($user, $course) {

    global $USER;

    $coursecontext = context_course::instance($course->id);

    $personalcontext = context_user::instance($user->id);

    if ($user->id == $USER->id) {

        if ($course->showreports and (is_viewing($coursecontext, $USER) or is_enrolled($coursecontext, $USER))) {

            return array(true, true);

        }

    } else if (has_capability('moodle/user:viewuseractivitiesreport', $personalcontext)) {

        if ($course->showreports and (is_viewing($coursecontext, $user) or is_enrolled($coursecontext, $user))) {

            return array(true, true);

        }

    }

    // Check if $USER shares group with $user (in case separated groups are enabled and 'moodle/site:accessallgroups' is disabled).

    if (!groups_user_groups_visible($course, $user->id)) {

        return array(false, false);

    }

    $today = false;

    $all = false;

    if (has_capability('report/log:viewtoday', $coursecontext)) {

        $today = true;

    }

    if (has_capability('report/log:view', $coursecontext)) {

        $all = true;

    }

    return array($all, $today);

}

/**

 * This function extends the module navigation with the report items

 *

 * @param navigation_node $navigation The navigation node to extend

 * @param stdClass $cm

 */

function report_log_extend_navigation_module($navigation, $cm) {

    if (

        has_capability('report/log:view', context_course::instance($cm->course))

        && report_helper::has_valid_group(context_module::instance($cm->id))

    ) {

        $url = new moodle_url('/report/log/index.php', [

            'chooselog' => '1',

            'id' => $cm->course,

            'modid' => $cm->id,

            'isactivitypage' => '1',

        ]);

        $navigation->add(get_string('logs'), $url, navigation_node::TYPE_SETTING, null, 'logreport', new pix_icon('i/report', ''));

    }

}

/**

 * Return a list of page types

 *

 * @param string $pagetype current page type

 * @param stdClass $parentcontext Block's parent context

 * @param stdClass $currentcontext Current context of block

 * @return array a list of page types

 */

function report_log_page_type_list($pagetype, $parentcontext, $currentcontext) {

    $array = array(

        '*'                => get_string('page-x', 'pagetype'),

        'report-*'         => get_string('page-report-x', 'pagetype'),

        'report-log-*'     => get_string('page-report-log-x',  'report_log'),

        'report-log-index' => get_string('page-report-log-index',  'report_log'),

        'report-log-user'  => get_string('page-report-log-user',  'report_log')

    );

    return $array;

}

/**

 * Add nodes to myprofile page.

 *

 * @param \core_user\output\myprofile\tree $tree Tree object

 * @param stdClass $user user object

 * @param bool $iscurrentuser

 * @param stdClass $course Course object

 *

 * @return bool

 */

function report_log_myprofile_navigation(core_user\output\myprofile\tree $tree, $user, $iscurrentuser, $course) {

    if (empty($course)) {

        // We want to display these reports under the site context.

        $course = get_fast_modinfo(SITEID)->get_course();

    }

    list($all, $today) = report_log_can_access_user_report($user, $course);

    if ($today) {

        // Today's log.

        $url = new moodle_url('/report/log/user.php',

            array('id' => $user->id, 'course' => $course->id, 'mode' => 'today'));

        $node = new core_user\output\myprofile\node('reports', 'todayslogs', get_string('todaylogs'), null, $url);

        $tree->add_node($node);

    }

    if ($all) {

        // All logs.

        $url = new moodle_url('/report/log/user.php',

            array('id' => $user->id, 'course' => $course->id, 'mode' => 'all'));

        $node = new core_user\output\myprofile\node('reports', 'alllogs', get_string('alllogs'), null, $url);

        $tree->add_node($node);

    }

    return true;

}