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

/**

 * External API.

 *

 * @package    block_dash

 * @copyright  2019 bdecent gmbh <https://bdecent.de>

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

 */

namespace block_dash;

defined('MOODLE_INTERNAL') || die('No direct access');

require_once("$CFG->libdir/externallib.php");

use block_dash\local\block_builder;

use block_dash\local\data_source\form\preferences_form;

use block_dash\output\renderer;

use block_dash\local\configuration\configuration;

use block_dash\local\data_source\data_source_factory;

use external_api;

/**

 * External API class.

 *

 * @package    block_dash

 * @copyright  2019 bdecent gmbh <https://bdecent.de>

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

 */

class external extends external_api {

    // Region get_block_content.

    /**

     * Returns description of get_database_schema_structure() parameters.

     *

     * @return \external_function_parameters

     */

    public static function get_block_content_parameters() {

        return new \external_function_parameters([

            'block_instance_id' => new \external_value(PARAM_INT),

            'filter_form_data' => new \external_value(PARAM_RAW),

            'page' => new \external_value(PARAM_INT, 'Paginator page.', VALUE_DEFAULT, 0),

            'sort_field' => new \external_value(PARAM_TEXT, 'Field to sort by', VALUE_DEFAULT, null),

            'sort_direction' => new \external_value(PARAM_TEXT, 'Sort direction of field', VALUE_DEFAULT, null),

            'pagelayout' => new \external_value(PARAM_TEXT, 'pagelayout', VALUE_DEFAULT, ''),

            'pagecontext' => new \external_value(PARAM_INT, 'Page Context', VALUE_DEFAULT, 0),

        ]);

    }

    /**

     * Get block content.

     *

     * @param int $blockinstanceid

     * @param string $filterformdata

     * @param int $page

     * @param string $sortfield

     * @param string $sortdirection

     * @param string $pagelayout

     * @param int $pagecontext

     *

     * @return array

     * @throws \coding_exception

     * @throws \invalid_parameter_exception

     * @throws \moodle_exception

     * @throws \restricted_context_exception

     */

    public static function get_block_content($blockinstanceid, $filterformdata, $page, $sortfield, $sortdirection,

        $pagelayout = '', $pagecontext = 0) {

        global $PAGE, $DB, $OUTPUT, $SITE;

        $params = self::validate_parameters(self::get_block_content_parameters(), [

            'block_instance_id' => $blockinstanceid,

            'page' => $page,

            'filter_form_data' => $filterformdata,

            'sort_field' => $sortfield,

            'sort_direction' => $sortdirection,

            'pagelayout' => $pagelayout,

            'pagecontext' => $pagecontext,

        ]);

        if ($pagecontext) {

            $context = \context::instance_by_id($pagecontext);

            $PAGE->set_context($context);

        }

        if ($pagelayout) {

            $PAGE->set_pagelayout($pagelayout);

        }

        $public = false;

        $blockinstance = $DB->get_record('block_instances', ['id' => $params['block_instance_id']]);

        $block = block_instance($blockinstance->blockname, $blockinstance);

        if (strpos($block->instance->pagetypepattern, 'dashaddon-dashboard') !== false) {

            if ($dashboard = \dashaddon_dashboard\model\dashboard::get_record(

                    ['shortname' => $block->instance->defaultregion])) {

                if ($dashboard->get('permission') == \dashaddon_dashboard\model\dashboard::PERMISSION_PUBLIC) {

                    $public = true;

                }

            }

        }

        if (!$public) {

            // Verify the block created for frontpage. and user not loggedin allow to access the block content.

            list($unused, $course, $cm) = get_context_info_array($block->context->id);

            if (isset($course->id) && $course->id == $SITE->id && !isloggedin()) {

                require_course_login($course);

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

                $PAGE->set_context($coursecontext);

            } else {

                self::validate_context($block->context);

            }

        } else {

            $PAGE->set_context($block->context);

        }

        /** @var renderer $renderer */

        $renderer = $PAGE->get_renderer('block_dash');

        if ($block) {

            if ($params['sort_field']) {

                $block->set_sort($params['sort_field'], $params['sort_direction']);

            }

            $bb = block_builder::create($block);

            foreach (json_decode($params['filter_form_data'], true) as $filter) {

                $bb->get_configuration()

                    ->get_data_source()

                    ->get_filter_collection()

                    ->apply_filter($filter['name'], $filter['value']);

            }

            $datasource = $bb->get_configuration()->get_data_source();

            $bb->get_configuration()->get_data_source()->get_paginator()->set_current_page($params['page']);

            if (get_class($datasource->get_layout()) == 'local_dash\layout\cards_layout' || $datasource->is_widget()

                    && $datasource->supports_currentscript()) {

                // Cloned from moodle lib\external\externalib.php 422.

                // Hack alert: Set a default URL to stop the annoying debug.

                $PAGE->set_url('/');

                // Hack alert: Forcing bootstrap_renderer to initiate moodle page.

                $OUTPUT->header();

                $PAGE->start_collecting_javascript_requirements();

                $datarendered = $renderer->render_data_source($bb->get_configuration()->get_data_source());

                $javascript = $PAGE->requires->get_end_code();

            } else {

                $datarendered = $renderer->render_data_source($bb->get_configuration()->get_data_source());

                $javascript = '';

            }

            return ['html' => $datarendered, 'scripts' => $javascript];

        }

        return ['html' => 'Error', 'scripts' => ''];

    }

    /**

     * Returns description of get_block_content() result value.

     *

     * @return \external_description

     */

    public static function get_block_content_returns() {

        return new \external_single_structure([

            'html' => new \external_value(PARAM_RAW),

            'scripts' => new \external_value(PARAM_RAW),

        ]);

    }

    // Endregion.

    // Region submit_preferences_form.

    /**

     * Describes the parameters for submit_create_group_form webservice.

     * @return \external_function_parameters

     */

    public static function submit_preferences_form_parameters() {

        return new \external_function_parameters([

            'contextid' => new \external_value(PARAM_INT, 'The context id for the block'),

            'jsonformdata' => new \external_value(PARAM_RAW, 'The form data encoded as a json array'),

        ]);

    }

    /**

     * Submit the preferences form.

     *

     * @param int $contextid The context id for the course.

     * @param string $jsonformdata The data from the form, encoded as a json array.

     * @return array

     * @throws \invalid_parameter_exception

     * @throws \coding_exception

     * @throws \required_capability_exception

     * @throws \moodle_exception

     */

    public static function submit_preferences_form($contextid, $jsonformdata) {

        global $DB;

        $params = self::validate_parameters(self::submit_preferences_form_parameters(), [

            'contextid' => $contextid,

            'jsonformdata' => $jsonformdata,

        ]);

        $context = \context::instance_by_id($params['contextid'], MUST_EXIST);

        self::validate_context($context);

        require_capability('block/dash:addinstance', $context);

        $serialiseddata = json_decode($params['jsonformdata']);

        $data = [];

        parse_str($serialiseddata, $data);

        $blockinstance = $DB->get_record('block_instances', ['id' => $context->instanceid]);

        $block = block_instance($blockinstance->blockname, $blockinstance);

        if (!empty($block->config)) {

            $config = clone($block->config);

        } else {

            $config = new \stdClass;

        }

        if (!isset($config->preferences)) {

            $config->preferences = [];

        }

        if (!isset($data['config_preferences']) || is_null($data['config_preferences'])) {

            $data['config_preferences'] = [];

        }

        if (isset($data['config_data_source_idnumber'])) {

            $config->data_source_idnumber = $data['config_data_source_idnumber'];

            $datasource = data_source_factory::build_data_source($config->data_source_idnumber,

                $context);

            if ($datasource) {

                if (method_exists($datasource, 'set_default_preferences')) {

                    $datasource->set_default_preferences($data);

                }

            }

        }

        $configpreferences = $data['config_preferences'];

        $config->preferences = self::recursive_config_merge($config->preferences, $configpreferences, '');

        $block->instance_config_save($config);

        return [

            'validationerrors' => false,

        ];

    }

    /**

     * Recursively merge in new config.

     *

     * @param string $existingconfig

     * @param array|object $newconfig

     * @param bool $recursive

     * @return mixed

     */

    private static function recursive_config_merge($existingconfig, $newconfig, $recursive = false) {

        // If existing config is a scalar value than always overwrite. No point in looping new config.

        // This allows preferences that were a scalar to be assigned as arrays by new preferences.

        if (is_scalar($existingconfig)) {

            return $newconfig;

        }

        // If array contains only scalars, overwrite with new config. No more looping required for this level.

        if (is_array($existingconfig) && !self::is_array_multidimensional($existingconfig)) {

            if (!$recursive) {

                return array_merge($existingconfig, $newconfig);

            } else {

                return $newconfig;

            }

        }

        // Recursively overwrite values.

        foreach ($newconfig as $key => $value) {

            if (is_scalar($value)) {

                $existingconfig[$key] = $value;

            } else if (is_array($value)) {

                $v = self::recursive_config_merge(isset($existingconfig[$key]) ? $existingconfig[$key]

                    : [], $newconfig[$key], true);

                unset($existingconfig[$key]);

                $existingconfig[$key] = $v;

            }

        }

        return $existingconfig;

    }

    /**

     * Check if array is multidimensional. True if it contains an array, false meaning all values are scalar.

     *

     * @param array $array

     * @return bool

     */

    private static function is_array_multidimensional(array $array): bool {

        foreach ($array as $element) {

            if (is_array($element)) {

                return true;

            }

        }

        return false;

    }

    /**

     * Returns description of method result value.

     *

     * @return \external_description

     * @since Moodle 3.0

     */

    public static function submit_preferences_form_returns() {

        return new \external_single_structure([

            'validationerrors' => new \external_value(PARAM_BOOL, 'Were there validation errors', VALUE_REQUIRED),

        ]);

    }

    // Endregion.

}