bbb_broker.php ➔ bigbluebuttonbn_broker_required_parameters() - Code Metrics - Inspection of "v2.2-dev: Rework on bigbluebuttonbn_get_recording_..." - blindsidenetworks/moodle-mod_bigbluebuttonbn - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( f92a9e...10847d )

by Jesus
created 2017-04-25 20:41 UTC
bbb_broker.php ➔ bigbluebuttonbn_broker_required_parameters() A

↳ Parent: Project
Complexity

Conditions	1
Paths	1
Size

Total Lines	23
Code Lines	19
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	19
nc	1
nop	0
dl	0
loc	23
rs	9.0856
c	0
b	0
f	0
<?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/>.

/**
 * Intermediator for managing actions executed by the BigBlueButton server.
 *
 * @author    Jesus Federico  (jesus [at] blindsidenetworks [dt] com)
 * @copyright 2015-2017 Blindside Networks Inc
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v2 or later
 */

require_once(dirname(dirname(dirname(__FILE__))).'/config.php');
require_once(dirname(__FILE__).'/locallib.php');

use \Firebase\JWT\JWT;

global $PAGE, $USER, $CFG, $SESSION, $DB;

$params['action'] = optional_param('action', '', PARAM_TEXT);
$params['callback'] = optional_param('callback', '', PARAM_TEXT);
$params['id'] = optional_param('id', '', PARAM_TEXT);
$params['idx'] = optional_param('idx', '', PARAM_TEXT);
$params['bigbluebuttonbn'] = optional_param('bigbluebuttonbn', 0, PARAM_INT);
$params['signed_parameters'] = optional_param('signed_parameters', '', PARAM_TEXT);
$params['forced'] = optional_param('forced', 'false', PARAM_TEXT);
$params['meta'] = optional_param('meta', '', PARAM_TEXT);

if (empty($params['action'])) {
    header('HTTP/1.0 400 Bad Request. Parameter ['.$params['action'].'] was not included');
    return;
}

$error = bigbluebuttonbn_broker_validate_parameters($params);
if (!empty($error)) {
    header('HTTP/1.0 400 Bad Request. '.$error);
    return;
}

if (isset($params['bigbluebuttonbn']) && $params['bigbluebuttonbn'] != 0) {
    $bigbluebuttonbn = $DB->get_record('bigbluebuttonbn', array('id' => $params['bigbluebuttonbn']), '*', MUST_EXIST);
    $course = $DB->get_record('course', array('id' => $bigbluebuttonbn->course), '*', MUST_EXIST);
    $cm = get_coursemodule_from_instance('bigbluebuttonbn', $bigbluebuttonbn->id, $course->id, false, MUST_EXIST);
    $context = context_module::instance($cm->id);
}

if ($params['action'] != 'recording_ready' && $params['action'] != 'live_session_events') {
    if (!isset($SESSION->bigbluebuttonbn_bbbsession) || is_null($SESSION->bigbluebuttonbn_bbbsession)) {
        header('HTTP/1.0 400 Bad Request. No session variable set');
        return;
    }
    $bbbsession = $SESSION->bigbluebuttonbn_bbbsession;
}

if (!isloggedin() && $PAGE->course->id == SITEID) {
    $userid = guest_user()->id;
} else {
    $userid = $USER->id;
}
$hascourseaccess = ($PAGE->course->id == SITEID) || can_access_course($PAGE->course, $userid);

if (!$hascourseaccess) {
    header('HTTP/1.0 401 Unauthorized');
    return;
}

$type = null;
if (isset($bbbsession['bigbluebuttonbn']->type)) {
    $type = $bbbsession['bigbluebuttonbn']->type;
}

$typeprofiles = bigbluebuttonbn_get_instance_type_profiles();
$enabledfeatures = bigbluebuttonbn_get_enabled_features($typeprofiles, $type);

try {
    header('Content-Type: application/javascript; charset=utf-8');
    $a = strtolower($params['action']);
    if ($a == 'meeting_info') {
        $meetinginfo = bigbluebuttonbn_broker_meeting_info($bbbsession, $params, ($params['forced'] == 'true'));
        echo $meetinginfo;
        return;
    }

    if ($a == 'meeting_end') {
        $meetingend = bigbluebuttonbn_broker_meeting_end($bbbsession, $params, $bbbsession['bigbluebuttonbn'], $bbbsession['cm']);
        echo $meetingend;
        return;
    }

    if ($a == 'recording_links') {
        $recordinglinks = bigbluebuttonbn_broker_recording_links($bbbsession, $params);
        echo $recordinglinks;
        return;
    }

    if ($a == 'recording_info') {
        $recordinginfo = bigbluebuttonbn_broker_recording_info($bbbsession, $params, $enabledfeatures['showroom']);
        echo $recordinginfo;
        return;
    }

    if ($a == 'recording_publish' || $a == 'recording_unpublish' || $a == 'recording_delete' || $a == 'recording_edit') {
        $recordingaction = bigbluebuttonbn_broker_recording_action(
            $bbbsession, $params, $enabledfeatures['showroom'], $bbbsession['bigbluebuttonbn'], $bbbsession['cm']);
        echo $recordingaction;
        return;
    }

    if ($a == 'recording_import') {
        echo bigbluebuttonbn_broker_recording_import($bbbsession, $params);
        return;
    }

    if ($a == 'recording_ready') {
        bigbluebuttonbn_broker_recording_ready($params, $bigbluebuttonbn);
        return;
    }

    if ($a == 'live_session_events') {
        bigbluebuttonbn_broker_live_session_events($params, $bigbluebuttonbn, $cm);
        return;
    }

    header('HTTP/1.0 400 Bad request. The action '. $a . ' doesn\'t exist');
    return;

} catch (Exception $e) {
    header('HTTP/1.0 500 Internal Server Error. '.$e->getMessage());
    return;
}

function bigbluebuttonbn_broker_meeting_info($bbbsession, $params, $forced) {
    $callbackresponse = array();

    $info = bigbluebuttonbn_get_meeting_info($params['id'], $forced);
    $callbackresponse['info'] = $info;

    $running = false;
    if ($info['returncode'] == 'SUCCESS') {
        $running = ($info['running'] === 'true');
    }
    $callbackresponse['running'] = $running;

    $status = array();
    $status["join_url"] = $bbbsession['joinURL'];
    $status["join_button_text"] = get_string('view_conference_action_join', 'bigbluebuttonbn');
    $status["end_button_text"] = get_string('view_conference_action_end', 'bigbluebuttonbn');

    $participantcount = 0;
    if (isset($info['participantCount'])) {
        $participantcount = $info['participantCount'];
    }
    $canjoin = bigbluebuttonbn_broker_meeting_info_can_join($bbbsession, $running, $participantcount);
    $status["can_join"] = $canjoin["can_join"];
    $status["message"] = $canjoin["message"];

    $canend = bigbluebuttonbn_broker_meeting_info_can_end($bbbsession, $running);
    $status["can_end"] = $canend["can_end"];

    $callbackresponse['status'] = $status;

    $callbackresponsedata = json_encode($callbackresponse);
    return "{$params['callback']}({$callbackresponsedata});";
}

function bigbluebuttonbn_broker_meeting_info_can_join($bbbsession, $running, $participantcount) {
    $status = array("can_join" => false);
    if ($running) {
        $status["message"] = get_string('view_error_userlimit_reached', 'bigbluebuttonbn');
        if ($bbbsession['userlimit'] == 0 || $participantcount < $bbbsession['userlimit']) {

            $status["message"] = get_string('view_message_conference_in_progress', 'bigbluebuttonbn');
            $status["can_join"] = true;
        }
        return $status;
    }

    // If user is administrator, moderator or if is viewer and no waiting is required.
    $status["message"] = get_string('view_message_conference_wait_for_moderator', 'bigbluebuttonbn');
    if ($bbbsession['administrator'] || $bbbsession['moderator'] || !$bbbsession['wait']) {

        $status["message"] = get_string('view_message_conference_room_ready', 'bigbluebuttonbn');
        $status["can_join"] = true;
    }
    return $status;
}

function bigbluebuttonbn_broker_meeting_info_can_end($bbbsession, $running) {
    $status = array("can_end" => false);
    if ($running && ($bbbsession['administrator'] || $bbbsession['moderator'])) {
        $status["can_end"] = true;
    }
    return $status;
}

function bigbluebuttonbn_broker_meeting_end($bbbsession, $params, $bigbluebuttonbn, $cm) {

    if (!$bbbsession['administrator'] && !$bbbsession['moderator']) {
        header('HTTP/1.0 401 Unauthorized. User not authorized to execute end command');
        return;
    }

    $callbackresponse = array('status' => true);

    // Execute the end command.
    bigbluebuttonbn_end_meeting($params['id'], $bbbsession['modPW']);
    // Moodle event logger: Create an event for meeting ended.
    if (isset($bigbluebuttonbn)) {
        bigbluebuttonbn_event_log(BIGBLUEBUTTON_EVENT_MEETING_ENDED, $bigbluebuttonbn, $cm);
    }
    // Update the cache.
    bigbluebuttonbn_get_meeting_info($params['id'], BIGBLUEBUTTONBN_FORCED);

    $callbackresponsedata = json_encode($callbackresponse);
    return "{$params['callback']}({$callbackresponsedata});";
}

function bigbluebuttonbn_broker_recording_links($bbbsession, $params) {

    if (!$bbbsession['managerecordings']) {
        header('HTTP/1.0 401 Unauthorized. User not authorized to execute end command');
        return;
    }

    $callbackresponse = array('status' => false);

    if (isset($params['id']) && $params['id'] != '') {
        $importedall = bigbluebuttonbn_get_recording_imported_instances($params['id']);
        $callbackresponse['status'] = true;
        $callbackresponse['links'] = count($importedall);
    }
    $callbackresponsedata = json_encode($callbackresponse);
    return "{$params['callback']}({$callbackresponsedata});";
}

function bigbluebuttonbn_broker_recording_info($bbbsession, $params, $showroom) {

    if (!$bbbsession['managerecordings']) {
        header('HTTP/1.0 401 Unauthorized. User not authorized to execute end command');
        return;
    }

    $callbackresponse = array('status' => false);

    $courseid = $bbbsession['course']->id;
    $bigbluebuttonbnid = null;
    if ($showroom) {
        $bigbluebuttonbnid = $bbbsession['bigbluebuttonbn']->id;
    }
    $includedeleted = $bbbsession['bigbluebuttonbn']->recordings_deleted_activities;
    // Retrieve the array of imported recordings.
    $recordings = bigbluebuttonbn_get_recordings($courseid, $bigbluebuttonbnid, $showroom, $includedeleted);
    if (array_key_exists($params['id'], $recordings)) {
        // Look up for an update on the imported recording.
        if (!array_key_exists('messageKey', $recordings[$params['id']])) {

            // The recording was found.
            $callbackresponse = bigbluebuttonbn_broker_recording_info_current($recordings[$params['id']], $params);
        }
        $callbackresponsedata = json_encode($callbackresponse);
        return "{$params['callback']}({$callbackresponsedata});";
    }

    // As the recordingid was not identified as imported recording link, look up for a real recording.
    $recordings = bigbluebuttonbn_get_recordings_array($params['idx'], $params['id']);
    if (array_key_exists($params['id'], $recordings)) {

        // The recording was found.
        $callbackresponse = bigbluebuttonbn_broker_recording_info_current($recordings[$params['id']], $params);
    }
    $callbackresponsedata = json_encode($callbackresponse);
    return "{$params['callback']}({$callbackresponsedata});";
}

function bigbluebuttonbn_broker_recording_info_current($recording, $params) {
    $callbackresponse['status'] = true;
    $callbackresponse['published'] = (string) $recording['published'];
    if (!isset($params['meta'])) {
        return $callbackresponse;
    }

    $meta = json_decode($params['meta']);
    foreach (array_keys($meta) as $key) {
        if (isset($recording[$key])) {
            $callbackresponse[$key] = $recording[$key];
        }
    }
    return $callbackresponse;
}

function bigbluebuttonbn_broker_recording_action($bbbsession, $params, $showroom, $bigbluebuttonbn, $cm) {
    if (!$bbbsession['managerecordings']) {
        header('HTTP/1.0 401 Unauthorized. User not authorized to execute end command');
        return;
    }

    // Retrieve array of recordings that includes real and imported.
    $bigbluebuttonbnid = null;
    if ($showroom) {
        $bigbluebuttonbnid = $bbbsession['bigbluebuttonbn']->id;
    }
    $recordings = bigbluebuttonbn_get_recordings($bbbsession['course']->id, $bigbluebuttonbnid, $showroom,
        $bbbsession['bigbluebuttonbn']->recordings_deleted_activities);

    $action = strtolower($params['action']);
    $events = bigbluebuttonbn_events_action();

    // Excecute action.
    $eventlog = $events[$action];
    $callbackresponse = bigbluebuttonbn_broker_recording_action_perform($action, $bbbsession, $params, $recordings);
    if ($callbackresponse['status']) {
        // Moodle event logger: Create an event for action performed on recording.
        bigbluebuttonbn_event_log($eventlog, $bigbluebuttonbn, $cm);
    }

    $callbackresponsedata = json_encode($callbackresponse);
    return "{$params['callback']}({$callbackresponsedata});";
}

function bigbluebuttonbn_broker_recording_action_perform($action, $bbbsession, $params, $recordings) {
    if ($action == 'recording_publish') {
        return bigbluebuttonbn_broker_recording_action_publish($bbbsession, $params, $recordings);
    }
    if ($action == 'recording_unpublish') {
        return bigbluebuttonbn_broker_recording_action_unpublish($bbbsession, $params, $recordings);
    }
    if ($action == 'recording_edit') {
        return bigbluebuttonbn_broker_recording_action_edit($bbbsession, $params, $recordings);
    }
    if ($action == 'recording_delete') {
        return bigbluebuttonbn_broker_recording_action_delete($bbbsession, $params, $recordings);
    }
}

function bigbluebuttonbn_broker_recording_action_publish($bbbsession, $params, $recordings) {
    $status = true;
    if (bigbluebuttonbn_broker_recording_is_imported($recordings, $params['id'])) {
        // Execute publish on imported recording link, if the real recording is published.
        $realrecordings = bigbluebuttonbn_get_recordings_array(
            $recordings[$params['id']]['meetingID'], $recordings[$params['id']]['recordID']);
        $status = ($realrecordings[$params['id']]['published'] === 'true');
        if ($status) {
            // Only if the physical recording is published, execute publish on imported recording link.
            bigbluebuttonbn_publish_recording_imported($params['id'], $bbbsession['bigbluebuttonbn']->id, true);
        }
    } else {
        // As the recordingid was not identified as imported recording link, execute publish on a real recording.
        bigbluebuttonbn_publish_recordings($params['id'], 'true');
    }

    $response = array('status' => $status);
    if (!$status) {
        $response['message'] = get_string('view_recording_publish_link_error', 'bigbluebuttonbn');
    }
    return $response;
}

function bigbluebuttonbn_broker_recording_action_unpublish($bbbsession, $params, $recordings) {
    global $DB;

    if (bigbluebuttonbn_broker_recording_is_imported($recordings, $params['id'])) {

        // Execute unpublish on imported recording link.
        return array(
          'status' => bigbluebuttonbn_publish_recording_imported(
              $params['id'], $bbbsession['bigbluebuttonbn']->id, false
            )
          );
    }

    // As the recordingid was not identified as imported recording link, execute unpublish on a real recording.
    // First: Unpublish imported links associated to the recording.
    $importedall = bigbluebuttonbn_get_recording_imported_instances($params['id']);

    if ($importedall > 0) {
        foreach ($importedall as $key => $record) {
            $meta = json_decode($record->meta, true);
            // Prepare data for the update.
            $meta['recording']['published'] = 'false';
            $importedall[$key]->meta = json_encode($meta);

            // Proceed with the update.
            $DB->update_record('bigbluebuttonbn_logs', $importedall[$key]);
        }
    }
    // Second: Execute the real unpublish.
    return array(
      'status' => bigbluebuttonbn_publish_recordings($params['id'], 'false')
      );
}

function bigbluebuttonbn_broker_recording_action_edit($bbbsession, $params, $recordings) {
    if (bigbluebuttonbn_broker_recording_is_imported($recordings, $params['id'])) {
        error_log("Updating imported");
        // Execute update on imported recording link.
        return array(
          'status' => bigbluebuttonbn_update_recording_imported(
              $params['id'], $bbbsession['bigbluebuttonbn']->id, json_decode($params['meta'])
            )
          );
    }

    // As the recordingid was not identified as imported recording link, execute update on a real recording.
    // (No need to update imported links as the update only affects the actual recording).
    // Execute update on actual recording.
    error_log("Updating real");
    return array(
      'status' => bigbluebuttonbn_update_recordings($params['id'], json_decode($params['meta']))
      );
}

function bigbluebuttonbn_broker_recording_action_delete($bbbsession, $params, $recordings) {
    global $DB;

    if (bigbluebuttonbn_broker_recording_is_imported($recordings, $params['id'])) {

        // Execute delete on imported recording link.
        return array(
          'status' => bigbluebuttonbn_delete_recording_imported(
              $params['id'], $bbbsession['bigbluebuttonbn']->id
            )
          );
    }

    // As the recordingid was not identified as imported recording link, execute delete on a real recording.
    // Delete imported links associated to the recording.
    $importedall = bigbluebuttonbn_get_recording_imported_instances($params['id']);

    if ($importedall > 0) {
        foreach (array_keys($importedall) as $key) {
            // Execute delete on imported links.
            $DB->delete_records('bigbluebuttonbn_logs', array('id' => $key));
        }
    }
    // Execute the actual delete.
    return array(
      'status' => bigbluebuttonbn_delete_recordings($params['id'])
      );
}

function bigbluebuttonbn_broker_recording_ready($params, $bigbluebuttonbn) {

    // Decodes the received JWT string.
    try {
        $decodedparameters = JWT::decode($params['signed_parameters'], bigbluebuttonbn_get_cfg_shared_secret(),
            array('HS256'));
    } catch (Exception $e) {
        $error = 'Caught exception: '.$e->getMessage();
        header('HTTP/1.0 400 Bad Request. '.$error);
        return;
    }

    // Validate that the bigbluebuttonbn activity corresponds to the meeting_id received.
    $meetingidelements = explode('[', $decodedparameters->meeting_id);
    $meetingidelements = explode('-', $meetingidelements[0]);

    if (!isset($bigbluebuttonbn) || $bigbluebuttonbn->meetingid != $meetingidelements[0]) {
        header('HTTP/1.0 410 Gone. The activity may have been deleted');
        return;
    }

    // Sends the messages.
    try {
        bigbluebuttonbn_send_notification_recording_ready($bigbluebuttonbn);
        header('HTTP/1.0 202 Accepted');
    } catch (Exception $e) {
        $error = 'Caught exception: '.$e->getMessage();
        header('HTTP/1.0 503 Service Unavailable. '.$error);
    }
}

function bigbluebuttonbn_broker_recording_import($bbbsession, $params) {
    global $SESSION;

    if (!$bbbsession['managerecordings']) {
        header('HTTP/1.0 401 Unauthorized. User not authorized to execute end command');
        return;
    }

    $importrecordings = $SESSION->bigbluebuttonbn_importrecordings;
    if (!isset($importrecordings[$params['id']])) {
        $error = "Recording {$params['id']} could not be found. It can not be imported";
        header('HTTP/1.0 404 Not found. '.$error);
        return;
    }

    $callbackresponse = array('status' => true);

    $importrecordings[$params['id']]['imported'] = true;
    $overrides = array('meetingid' => $importrecordings[$params['id']]['meetingID']);
    $meta = '{"recording":'.json_encode($importrecordings[$params['id']]).'}';
    bigbluebuttonbn_logs($bbbsession, BIGBLUEBUTTONBN_LOG_EVENT_IMPORT, $overrides, $meta);
    // Moodle event logger: Create an event for recording imported.
    if (isset($bbbsession['bigbluebutton']) && isset($bbbsession['cm'])) {
        bigbluebuttonbn_event_log(BIGBLUEBUTTON_EVENT_RECORDING_IMPORTED, $bbbsession['bigbluebuttonbn'], $bbbsession['cm']);
    }

    $callbackresponsedata = json_encode($callbackresponse);
    return "{$params['callback']}({$callbackresponsedata});";
}

function bigbluebuttonbn_broker_live_session_events($params, $bigbluebuttonbn, $cm) {
    // Decodes the received JWT string.
    try {
        $decodedparameters = JWT::decode($params['signed_parameters'], bigbluebuttonbn_get_cfg_shared_secret(),
            array('HS256'));
    } catch (Exception $e) {
        $error = 'Caught exception: '.$e->getMessage();
        header('HTTP/1.0 400 Bad Request. '.$error);
        return;
    }

    // Validate that the bigbluebuttonbn activity corresponds to the meeting_id received.
    $meetingidelements = explode('[', $decodedparameters->meeting_id);
    $meetingidelements = explode('-', $meetingidelements[0]);

    if (!isset($bigbluebuttonbn) || $bigbluebuttonbn->meetingid != $meetingidelements[0]) {
        header('HTTP/1.0 410 Gone. The activity may have been deleted');
        return;
    }

    // Store the events.
    try {
        foreach ($decodedparameters->events as $event) {
            bigbluebuttonbn_live_session_event_log($event, $bigbluebuttonbn, $cm);
        }
        header('HTTP/1.0 202 Accepted');
    } catch (Exception $e) {
        $error = "Caught exception: {$e->getMessage()}";
        header("HTTP/1.0 503 Service Unavailable. {$error}");
    }
}

function bigbluebuttonbn_broker_validate_parameters($params) {
    $requiredparams = bigbluebuttonbn_broker_required_parameters();

    if (!isset($params['callback'])) {
        return 'This call must include a javascript callback.';
    }

    if (!isset($params['action'])) {
        return 'Action parameter must be included.';
    }

    $action = strtolower($params['action']);
    if (!array_key_exists($action, $requiredparams)) {
        return 'Action '.$params['action'].' can not be performed.';
    }

    return bigbluebuttonbn_broker_validate_parameters_message($params, $requiredparams[$action]);
}

function bigbluebuttonbn_broker_validate_parameters_message($params, $requiredparams) {
    foreach ($requiredparams as $param => $message) {
        if (!array_key_exists($param, $params) || $params[$param] == '') {
            return $message;
        }
    }
}

function bigbluebuttonbn_broker_required_parameters() {
    return [
        'server_ping' => ['id' => 'The meetingID must be specified.'],
        'meeting_info' => ['id' => 'The meetingID must be specified.'],
        'meeting_end' => ['id' => 'The meetingID must be specified.'],
        'recording_info' => ['id' => 'The recordingID must be specified.'],
        'recording_links' => ['id' => 'The recordingID must be specified.'],
        'recording_publish' => ['id' => 'The recordingID must be specified.'],
        'recording_unpublish' => ['id' => 'The recordingID must be specified.'],
        'recording_delete' => ['id' => 'The recordingID must be specified.'],
        'recording_protect' => ['id' => 'The recordingID must be specified.'],
        'recording_unprotect' => ['id' => 'The recordingID must be specified.'],
        'recording_edit' => ['id' => 'The recordingID must be specified.',
            'meta' => 'A meta parameter should be included'],
        'recording_import' => ['id' => 'The recordingID must be specified.'],
        'recording_ready' => [
            'signed_parameters' => 'A JWT encoded string must be included as [signed_parameters].'
          ],
        'live_session_events' => [
            'signed_parameters' => 'A JWT encoded string must be included as [signed_parameters].'
          ]
      ];
}

function bigbluebuttonbn_broker_recording_is_imported($recordings, $recordingid) {
    return (isset($recordings[$recordingid]) && isset($recordings[$recordingid]['imported']));
}

blindsidenetworks / moodle-mod_bigbluebuttonbn

Push — master ( f92a9e...10847d )

bbb_broker.php ➔ bigbluebuttonbn_broker_required_parameters() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
