lib.php

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

/**
 * General lib file
 *
 * @package   filter_oembed
 * @author    Guy Thomas <gthomas@moodlerooms.com>
 * @copyright Copyright (c) 2016 Blackboard Inc.
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

use filter_oembed\forms\provider;

/**
 * Serve the edit form as a fragment.
 *
 * @package filter_oembed
 * @param array $args List of named arguments for the fragment loader.
 * @return string
 */
function filter_oembed_output_fragment_provider($args) {
    global $PAGE, $CFG;

    $output = $PAGE->get_renderer('core', '', RENDERER_TARGET_GENERAL);

    $oembed = \filter_oembed\service\oembed::get_instance('all');

    $data = null;
    $ajaxdata = null;
    $isnew = false;
    if (!empty($args['formdata'])) {
        $data = [];
        parse_str($args['formdata'], $data);
        if ($data) {
            $ajaxdata = $data;
        }
    } else {
        if (!isset($args['pid'])) {
            throw new coding_exception('missing "pid" param');
        } else if ($args['pid'] === 'new' || $args['pid'] === 0 || $args['pid'] === '0') {
            // Creating a new provider.
            $isnew = true;
            $data = [
                'providername' => '',
                'providerurl' => '',
                'endpoints' => '',
                'enabled' => 1,
                'rendermode' => 'server',
                'source' => 'local::new',
            ];
        } else {
            $data = $oembed->get_provider_row($args['pid']);
            if (!$data) {
                throw new coding_exception('Invalid "pid" param', $args['pid']);
            }
            $data = (array)$data;
        }
    }

    if (!isset($ajaxdata['enabled'])) {
        $ajaxdata['enabled'] = 0;
    }
    $actionurl = $CFG->wwwroot . '/filter/oembed/manageproviders.php';
    // Pass the source type as custom data so it can by used to detetmine the type of edit.
    $form = new provider(
        $actionurl,
        \filter_oembed\provider\provider::source_type($data['source']),
        'post',
        '',
        null,
        true,
        $ajaxdata
    );
    $form->validate_defined_fields(true);
    $data['sourcetext'] = $data['source'];
    $form->set_data($data);

    $msg = '';
    if (!empty($ajaxdata)) {
        if ($form->is_validated()) {
            // Check if this is a new provider being created.
            if ($ajaxdata['source'] === 'local::new' || empty($ajaxdata['id'])) {
                $newpid = $oembed->create_local_provider($ajaxdata);
                if ($newpid) {
                    $msg = $output->notification(get_string('saveok', 'filter_oembed'), 'notifysuccess');
                    return '<div class="js-oembed-newprovider" data-newproviderid = "' . $newpid . '"></div>' . $msg;
                } else {
                    $msg = $output->notification(get_string('savefailed', 'filter_oembed'), 'notifyproblem');
                }
            } else {
                // If editing a downloaded provider, create a new local one and disable the download one.
                $sourcetype = \filter_oembed\provider\provider::source_type($ajaxdata['source']);
                if ($sourcetype == \filter_oembed\provider\provider::PROVIDER_SOURCE_DOWNLOAD) {
                    $newpid = $oembed->copy_provider_to_local($ajaxdata);
                    if ($newpid) {
                        $msg = $output->notification(
                            get_string('copytolocal', 'filter_oembed', $ajaxdata['providername']),
                            'notifysuccess'
                        );
                        // Return an empty div with the new provider id in it so we can target it later with the message in $msg.
                        return '<div class="js-oembed-newprovider" data-newproviderid = "' . $newpid . '"></div>' . $msg;
                    } else {
                        $msg = $output->notification(
                            get_string('nocopytolocal', 'filter_oembed', $ajaxdata['providername']),
                            'notifyproblem'
                        );
                    }
                } else {
                    $success = $oembed->update_provider_row($ajaxdata);
                    if ($success) {
                        $msg = $output->notification(get_string('saveok', 'filter_oembed'), 'notifysuccess');
                    } else {
                        $msg = $output->notification(get_string('savefailed', 'filter_oembed'), 'notifyproblem');
                    }
                }
            }
        }
    }
    return $form->render() . $msg;
}