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

namespace mod_bigbluebuttonbn\local;

use mod_bigbluebuttonbn\instance;

use mod_bigbluebuttonbn\local\proxy\bigbluebutton_proxy;

use mod_bigbluebuttonbn\recording;

/**

 * Handles the global configuration based on config.php.

 *

 * @package   mod_bigbluebuttonbn

 * @copyright 2010 onwards, Blindside Networks Inc

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

 * @author    Jesus Federico  (jesus [at] blindsidenetworks [dt] com)

 */

class config {

    /** @var string Default bigbluebutton server url */

    public const DEFAULT_SERVER_URL = 'https://test-moodle.blindsidenetworks.com/bigbluebutton/';

    /** @var string Default bigbluebutton server shared secret */

    public const DEFAULT_SHARED_SECRET = '0b21fcaf34673a8c3ec8ed877d76ae34';

    /** @var string the default bigbluebutton checksum algorithm */

    public const DEFAULT_CHECKSUM_ALGORITHM = 'SHA256';

    /** @var array list of supported bigbluebutton checksum algorithm */

    const CHECKSUM_ALGORITHMS = [

        self::DEFAULT_CHECKSUM_ALGORITHM,

        'SHA1',

        'SHA512'

    ];

    /**

     * Returns moodle version.

     *

     * @return string

     */

    protected static function get_moodle_version_major(): string {

        global $CFG;

        $versionarray = explode('.', $CFG->version);

        return $versionarray[0];

    }

    /**

     * Returns configuration default values.

     *

     * @return array

     */

    protected static function defaultvalues(): array {

        return [

            'server_url' => '',

            'shared_secret' => '',

            'voicebridge_editable' => false,

            'importrecordings_enabled' => false,

            'importrecordings_from_deleted_enabled' => false,

            'waitformoderator_default' => false,

            'waitformoderator_editable' => true,

            'waitformoderator_ping_interval' => '10',

            'waitformoderator_cache_ttl' => '60',

            'userlimit_default' => '0',

            'userlimit_editable' => false,

            'preuploadpresentation_editable' => false,

            'recordingready_enabled' => false,

            'recordingstatus_enabled' => false,

            'meetingevents_enabled' => false,

            'participant_moderator_default' => '0',

            'profile_picture_enabled' => false,

            'scheduled_pre_opening' => '10',

            'recordings_enabled' => true,

            'recordings_deleted_default' => false,

            'recordings_deleted_editable' => false,

            'recordings_imported_default' => false,

            'recordings_imported_editable' => false,

            'recordings_preview_default' => true,

            'recordings_preview_editable' => false,

            'recording_default' => true,

            'recording_editable' => true,

            'recording_refresh_period' => recording::RECORDING_REFRESH_DEFAULT_PERIOD,

            'recording_all_from_start_default' => false,

            'recording_all_from_start_editable' => false,

            'recording_hide_button_default' => false,

            'recording_hide_button_editable' => false,

            'recording_protect_editable' => true,

            'general_warning_message' => '',

            'general_warning_roles' => 'editingteacher,teacher',

            'general_warning_box_type' => 'info',

            'general_warning_button_text' => '',

            'general_warning_button_href' => '',

            'general_warning_button_class' => '',

            'muteonstart_default' => false,

            'muteonstart_editable' => false,

            'disablecam_default' => false,

            'disablecam_editable' => true,

            'disablemic_default' => false,

            'disablemic_editable' => true,

            'disableprivatechat_default' => false,

            'disableprivatechat_editable' => true,

            'disablepublicchat_default' => false,

            'disablepublicchat_editable' => true,

            'disablenote_default' => false,

            'disablenote_editable' => true,

            'hideuserlist_default' => false,

            'hideuserlist_editable' => true,

            'welcome_default' => '',

            'welcome_editable' => true,

            'default_dpa_accepted' => false,

            'poll_interval' => bigbluebutton_proxy::DEFAULT_POLL_INTERVAL,

            'checksum_algorithm' => self::DEFAULT_CHECKSUM_ALGORITHM,

            'showpresentation_default' => true,

            'showpresentation_editable' => false,

        ];

    }

    /**

     * Returns default value for an specific setting.

     *

     * @param string $setting

     * @return string|null

     */

    public static function defaultvalue(string $setting): ?string {

        $defaultvalues = self::defaultvalues();

        if (!array_key_exists($setting, $defaultvalues)) {

            return null;

        }

        return $defaultvalues[$setting];

    }

    /**

     * Returns value for an specific setting.

     *

     * @param string $setting

     * @return string

     */

    public static function get(string $setting): string {

        global $CFG;

        if (isset($CFG->bigbluebuttonbn[$setting])) {

            return (string) $CFG->bigbluebuttonbn[$setting];

        }

        if (isset($CFG->{'bigbluebuttonbn_' . $setting})) {

            return (string) $CFG->{'bigbluebuttonbn_' . $setting};

        }

        return (string) self::defaultvalue($setting);

    }

    /**

     * Validates if recording settings are enabled.

     *

     * @return bool

     */

    public static function recordings_enabled(): bool {

        return (boolean) self::get('recordings_enabled');

    }

    /**

     * Validates if imported recording settings are enabled.

     *

     * @return bool

     */

    public static function importrecordings_enabled(): bool {

        return (boolean) self::get('importrecordings_enabled');

    }

    /**

     * Check if bbb server credentials are invalid.

     *

     * @return bool

     */

    public static function server_credentials_invalid(): bool {

        // Test server credentials across all versions of the plugin are flagged.

        $parsedurl = parse_url(self::get('server_url'));

        $defaultserverurl = parse_url(self::DEFAULT_SERVER_URL);

        if (!isset($parsedurl['host'])) {

            return false;

        }

        if (strpos($parsedurl['host'], $defaultserverurl['host']) === 0) {

            return true;

        }

        if (strpos($parsedurl['host'], 'test-install.blindsidenetworks.com') === 0) {

            return true;

        }

        return false;

    }

    /**

     * Wraps current settings in an array.

     *

     * @return array

     */

    public static function get_options(): array {

        return [

            'version_major' => self::get_moodle_version_major(),

            'voicebridge_editable' => self::get('voicebridge_editable'),

            'importrecordings_enabled' => self::get('importrecordings_enabled'),

            'importrecordings_from_deleted_enabled' => self::get('importrecordings_from_deleted_enabled'),

            'waitformoderator_default' => self::get('waitformoderator_default'),

            'waitformoderator_editable' => self::get('waitformoderator_editable'),

            'userlimit_default' => self::get('userlimit_default'),

            'userlimit_editable' => self::get('userlimit_editable'),

            'preuploadpresentation_editable' => self::get('preuploadpresentation_editable'),

            'recordings_enabled' => self::get('recordings_enabled'),

            'meetingevents_enabled' => self::get('meetingevents_enabled'),

            'recordings_deleted_default' => self::get('recordings_deleted_default'),

            'recordings_deleted_editable' => self::get('recordings_deleted_editable'),

            'recordings_imported_default' => self::get('recordings_imported_default'),

            'recordings_imported_editable' => self::get('recordings_imported_editable'),

            'recordings_preview_default' => self::get('recordings_preview_default'),

            'recordings_preview_editable' => self::get('recordings_preview_editable'),

            'recording_default' => self::get('recording_default'),

            'recording_editable' => self::get('recording_editable'),

            'recording_refresh_period' => self::get('recording_refresh_period'),

            'recording_all_from_start_default' => self::get('recording_all_from_start_default'),

            'recording_all_from_start_editable' => self::get('recording_all_from_start_editable'),

            'recording_hide_button_default' => self::get('recording_hide_button_default'),

            'recording_hide_button_editable' => self::get('recording_hide_button_editable'),

            'recording_protect_editable' => self::get('recording_protect_editable'),

            'general_warning_message' => self::get('general_warning_message'),

            'general_warning_box_type' => self::get('general_warning_box_type'),

            'general_warning_button_text' => self::get('general_warning_button_text'),

            'general_warning_button_href' => self::get('general_warning_button_href'),

            'general_warning_button_class' => self::get('general_warning_button_class'),

            'muteonstart_editable' => self::get('muteonstart_editable'),

            'muteonstart_default' => self::get('muteonstart_default'),

            'disablecam_editable' => self::get('disablecam_editable'),

            'disablecam_default' => self::get('disablecam_default'),

            'disablemic_editable' => self::get('disablemic_editable'),

            'disablemic_default' => self::get('disablemic_default'),

            'disableprivatechat_editable' => self::get('disableprivatechat_editable'),

            'disableprivatechat_default' => self::get('disableprivatechat_default'),

            'disablepublicchat_editable' => self::get('disablepublicchat_editable'),

            'disablepublicchat_default' => self::get('disablepublicchat_default'),

            'disablenote_editable' => self::get('disablenote_editable'),

            'disablenote_default' => self::get('disablenote_default'),

            'hideuserlist_editable' => self::get('hideuserlist_editable'),

            'hideuserlist_default' => self::get('hideuserlist_default'),

            'welcome_default' => self::get('welcome_default'),

            'welcome_editable' => self::get('welcome_editable'),

            'poll_interval' => self::get('poll_interval'),

            'guestaccess_enabled' => self::get('guestaccess_enabled'),

            'showpresentation_editable' => self::get('showpresentation_editable'),

            'showpresentation_default' => self::get('showpresentation_default'),

        ];

    }

    /**

     * Helper function returns an array with enabled features for an specific profile type.

     *

     * @param array $typeprofiles

     * @param string|null $type

     *

     * @return array

     */

    public static function get_enabled_features(array $typeprofiles, ?string $type = null): array {

        $enabledfeatures = [];

        $features = $typeprofiles[instance::TYPE_ALL]['features'];

        if (!is_null($type) && key_exists($type, $typeprofiles)) {

            $features = $typeprofiles[$type]['features'];

        }

        $enabledfeatures['showroom'] = (in_array('all', $features) || in_array('showroom', $features));

        // Evaluates if recordings are enabled for the Moodle site.

        $enabledfeatures['showrecordings'] = false;

        if (self::recordings_enabled()) {

            $enabledfeatures['showrecordings'] = (in_array('all', $features) || in_array('showrecordings', $features));

        }

        $enabledfeatures['importrecordings'] = false;

        if (self::importrecordings_enabled()) {

            $enabledfeatures['importrecordings'] = (in_array('all', $features) || in_array('importrecordings', $features));

        }

        return $enabledfeatures;

    }

}