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

/**

 * This file contains a class definition for the Context Settings resource

 *

 * @package    ltiservice_toolsettings

 * @copyright  2014 Vital Source Technologies http://vitalsource.com

 * @author     Stephen Vickers

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

 */

namespace ltiservice_toolsettings\local\resources;

use ltiservice_toolsettings\local\service\toolsettings;

defined('MOODLE_INTERNAL') || die();

/**

 * A resource implementing the Context-level (ToolProxyBinding) Settings.

 *

 * @package    ltiservice_toolsettings

 * @since      Moodle 2.8

 * @copyright  2014 Vital Source Technologies http://vitalsource.com

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

 */

class contextsettings extends \mod_lti\local\ltiservice\resource_base {

    /**

     * Class constructor.

     *

     * @param \mod_lti\local\ltiservice\service_base $service Service instance

     */

    public function __construct($service) {

        parent::__construct($service);

        $this->id = 'ToolProxyBindingSettings';

        $this->template = '/{context_type}/{context_id}/bindings/{vendor_code}/{product_code}(/custom)';

        $this->variables[] = 'ToolProxyBinding.custom.url';

        $this->formats[] = 'application/vnd.ims.lti.v2.toolsettings+json';

        $this->formats[] = 'application/vnd.ims.lti.v2.toolsettings.simple+json';

        $this->methods[] = 'GET';

        $this->methods[] = 'PUT';

    }

    /**

     * Execute the request for this resource.

     *

     * @param \mod_lti\local\ltiservice\response $response  Response object for this request.

     */

    public function execute($response) {

        $params = $this->parse_template();

        $contexttype = $params['context_type'];

        $contextid = $params['context_id'];

        $vendorcode = $params['vendor_code'];

        $productcode = $params['product_code'];

        $bubble = optional_param('bubble', '', PARAM_ALPHA);

        $typeid = null;

        if (($vendorcode === 'tool') && is_numeric($productcode)) {

            $typeid = $productcode;

        }

        $ok = !empty($contexttype) && !empty($contextid) &&

              !empty($vendorcode) && !empty($productcode) &&

              $this->check_tool($typeid, $response->get_request_data(),

                  array(toolsettings::SCOPE_TOOL_SETTINGS));

        if (!$ok) {

            $response->set_code(401);

        } else {

            $toolproxy = $this->get_service()->get_tool_proxy();

            if (!empty($toolproxy)) {

                $ok = $toolproxy->guid === $productcode;

                $typeid = null;

                $id = $toolproxy->id;

            } else {

                $ok = $vendorcode === 'tool';

                $typeid = intval($productcode);

                $id = -$typeid;

            }

            $contenttype = $response->get_accept();

            $simpleformat = !empty($contenttype) && ($contenttype == $this->formats[1]);

            if ($ok) {

                $ok = (empty($bubble) || ((($bubble == 'distinct') || ($bubble == 'all')))) &&

                     (!$simpleformat || empty($bubble) || ($bubble != 'all')) &&

                     (empty($bubble) || ($response->get_request_method() == 'GET'));

            }

            if (!$ok) {

                $response->set_code(404);

            } else {

                $systemsetting = null;

                $contextsettings = lti_get_tool_settings($id, $contextid);

                if (!empty($bubble)) {

                    $systemsetting = new systemsettings($this->get_service());

                    $systemsetting->params['tool_proxy_id'] = $productcode;

                    if ($id >= 0) {

                        $systemsetting->params['config_type'] = 'toolproxy';

                    } else {

                        $systemsetting->params['config_type'] = 'tool';

                    }

                    $systemsettings = lti_get_tool_settings($id);

                    if ($bubble == 'distinct') {

                        toolsettings::distinct_settings($systemsettings, $contextsettings, null);

                    }

                } else {

                    $systemsettings = null;

                }

                if ($response->get_request_method() == 'GET') {

                    $json = '';

                    if ($simpleformat) {

                        $response->set_content_type($this->formats[1]);

                        $json .= "{";

                    } else {

                        $response->set_content_type($this->formats[0]);

                        $json .= "{\n  \"@context\":\"http://purl.imsglobal.org/ctx/lti/v2/ToolSettings\",\n  \"@graph\":[\n";

                    }

                    $settings = toolsettings::settings_to_json($systemsettings, $simpleformat, 'ToolProxy', $systemsetting);

                    $json .= $settings;

                    $isfirst = strlen($settings) <= 0;

                    $settings = toolsettings::settings_to_json($contextsettings, $simpleformat, 'ToolProxyBinding', $this);

                    if ((strlen($settings) > 0) && !$isfirst) {

                        $json .= ",";

                    }

                    $json .= $settings;

                    if ($simpleformat) {

                        $json .= "\n}";

                    } else {

                        $json .= "\n  ]\n}";

                    }

                    $response->set_body($json);

                } else { // PUT.

                    $settings = null;

                    if ($response->get_content_type() == $this->formats[0]) {

                        $json = json_decode($response->get_request_data());

                        $ok = !empty($json);

                        if ($ok) {

                            $ok = isset($json->{"@graph"}) && is_array($json->{"@graph"}) && (count($json->{"@graph"}) == 1) &&

                                  ($json->{"@graph"}[0]->{"@type"} == 'ToolProxyBinding');

                        }

                        if ($ok) {

                            $settings = $json->{"@graph"}[0]->custom;

                            unset($settings->{'@id'});

                        }

                    } else {  // Simple JSON.

                        $json = json_decode($response->get_request_data(), true);

                        $ok = !empty($json);

                        if ($ok) {

                            $ok = is_array($json);

                        }

                        if ($ok) {

                            $settings = $json;

                        }

                    }

                    if ($ok) {

                        lti_set_tool_settings($settings, $id, $contextid);

                    } else {

                        $response->set_code(406);

                    }

                }

            }

        }

    }

    /**

     * Parse a value for custom parameter substitution variables.

     *

     * @param string $value String to be parsed

     *

     * @return string

     */

    public function parse_value($value) {

        global $COURSE;

        if (strpos($value, '$ToolProxyBinding.custom.url') !== false) {

            if ($COURSE->format == 'site') {

                $this->params['context_type'] = 'Group';

            } else {

                $this->params['context_type'] = 'CourseSection';

            }

            $this->params['context_id'] = $COURSE->id;

            if (!empty($this->get_service()->get_tool_proxy())) {

                $this->params['vendor_code'] = $this->get_service()->get_tool_proxy()->vendorcode;

                $this->params['product_code'] = $this->get_service()->get_tool_proxy()->guid;

            } else {

                $this->params['vendor_code'] = 'tool';

                $this->params['product_code'] = $this->get_service()->get_type()->id;

            }

            $value = str_replace('$ToolProxyBinding.custom.url', parent::get_endpoint(), $value);

        }

        return $value;

    }

}