view.php ➔ bigbluebuttonbn_view_message_box() - Code Metrics - Inspection of "CONTRIB-7538" - blindsidenetworks/moodle-mod_bigbluebuttonbn - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#85)

by Jesus

created 2018-12-03 21:52 UTC

view.php ➔ bigbluebuttonbn_view_message_box() A

↳ Parent: Project

Complexity

Conditions	4
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
nc	2
nop	4
dl	0
loc	9
rs	9.9666
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/>.

/**
 * View a BigBlueButton room.
 *
 * @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)
 * @author    Fred Dixon  (ffdixon [at] blindsidenetworks [dt] com)
 */

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

$id = required_param('id', PARAM_INT);
$bn = optional_param('bn', 0, PARAM_INT);
$group = optional_param('group', 0, PARAM_INT);

$viewinstance = bigbluebuttonbn_view_validator($id, $bn);
if (!$viewinstance) {
    print_error(get_string('view_error_url_missing_parameters', 'bigbluebuttonbn'));
}

$cm = $viewinstance['cm'];
$course = $viewinstance['course'];
$bigbluebuttonbn = $viewinstance['bigbluebuttonbn'];
$context = context_module::instance($cm->id);

require_login($course, true, $cm);

bigbluebuttonbn_event_log(\mod_bigbluebuttonbn\event\events::$events['view'], $bigbluebuttonbn);

// Additional info related to the course.
$bbbsession['course'] = $course;
$bbbsession['coursename'] = $course->fullname;
$bbbsession['cm'] = $cm;
$bbbsession['bigbluebuttonbn'] = $bigbluebuttonbn;
bigbluebuttonbn_view_bbbsession_set($context, $bbbsession);

// Validates if the BigBlueButton server is working.
$serverversion = bigbluebuttonbn_get_server_version();
if (is_null($serverversion)) {

    if ($bbbsession['administrator']) {
        print_error('view_error_unable_join', 'bigbluebuttonbn',
            $CFG->wwwroot.'/admin/settings.php?section=modsettingbigbluebuttonbn');
        exit;
    }
    if ($bbbsession['moderator']) {
        print_error('view_error_unable_join_teacher', 'bigbluebuttonbn',
            $CFG->wwwroot.'/course/view.php?id='.$bigbluebuttonbn->course);
        exit;
    }
    print_error('view_error_unable_join_student', 'bigbluebuttonbn',
        $CFG->wwwroot.'/course/view.php?id='.$bigbluebuttonbn->course);
    exit;
}
$bbbsession['serverversion'] = (string) $serverversion;

// Mark viewed by user (if required).
$completion = new completion_info($course);
$completion->set_module_viewed($cm);

// Print the page header.
$PAGE->set_context($context);
$PAGE->set_url($CFG->wwwroot.'/mod/bigbluebuttonbn/view.php', array('id' => $cm->id));
$PAGE->set_title(format_string($bigbluebuttonbn->name));
$PAGE->set_cacheable(false);
$PAGE->set_heading($course->fullname);
$PAGE->set_pagelayout('incourse');

// Validate if the user is in a role allowed to join.
if (!has_capability('moodle/category:manage', $context) && !has_capability('mod/bigbluebuttonbn:join', $context)) {
    echo $OUTPUT->header();
    if (isguestuser()) {
        echo $OUTPUT->confirm('<p>'.get_string('view_noguests', 'bigbluebuttonbn').'</p>'.get_string('liketologin'),
            get_login_url(), $CFG->wwwroot.'/course/view.php?id='.$course->id);
    } else {
        echo $OUTPUT->confirm('<p>'.get_string('view_nojoin', 'bigbluebuttonbn').'</p>'.get_string('liketologin'),
            get_login_url(), $CFG->wwwroot.'/course/view.php?id='.$course->id);
    }
    echo $OUTPUT->footer();
    exit;
}

// Operation URLs.
$bbbsession['bigbluebuttonbnURL'] = $CFG->wwwroot . '/mod/bigbluebuttonbn/view.php?id=' . $bbbsession['cm']->id;
$bbbsession['logoutURL'] = $CFG->wwwroot . '/mod/bigbluebuttonbn/bbb_view.php?action=logout&id='.$id .
    '&bn=' . $bbbsession['bigbluebuttonbn']->id;
$bbbsession['recordingReadyURL'] = $CFG->wwwroot . '/mod/bigbluebuttonbn/bbb_broker.php?action=recording_' .
    'ready&bigbluebuttonbn=' . $bbbsession['bigbluebuttonbn']->id;
$bbbsession['meetingEventsURL'] = $CFG->wwwroot . '/mod/bigbluebuttonbn/bbb_broker.php?action=meeting' .
    '_events&bigbluebuttonbn=' . $bbbsession['bigbluebuttonbn']->id;
$bbbsession['joinURL'] = $CFG->wwwroot . '/mod/bigbluebuttonbn/bbb_view.php?action=join&id=' . $id .
    '&bn=' . $bbbsession['bigbluebuttonbn']->id;

// Output starts.
echo $OUTPUT->header();

bigbluebuttonbn_view_groups($bbbsession);

bigbluebuttonbn_view_render($bbbsession, bigbluebuttonbn_view_get_activity_status($bbbsession));

// Output finishes.
echo $OUTPUT->footer();

// Shows version as a comment.
echo '<!-- '.$bbbsession['originTag'].' -->'."\n";

// Initialize session variable used across views.
$SESSION->bigbluebuttonbn_bbbsession = $bbbsession;

/**
 * Displays the view for groups.
 *
 * @param array $bbbsession
 * @return void
 */
function bigbluebuttonbn_view_groups(&$bbbsession) {
    global $CFG;
    // Find out current group mode.
    $groupmode = groups_get_activity_groupmode($bbbsession['cm']);
    if ($groupmode == NOGROUPS) {
        // No groups mode.
        return;
    }
    // Separate or visible group mode.
    $groups = groups_get_activity_allowed_groups($bbbsession['cm']);
    if (empty($groups)) {
        // No groups in this course.
        bigbluebuttonbn_view_message_box($bbbsession, get_string('view_groups_nogroups_warning', 'bigbluebuttonbn'), 'info', true);
        return;
    }
    $bbbsession['group'] = groups_get_activity_group($bbbsession['cm'], true);
    $groupname = get_string('allparticipants');
    if ($bbbsession['group'] != 0) {
        $groupname = groups_get_group_name($bbbsession['group']);
    }
    // Assign group default values.
    $bbbsession['meetingid'] .= '['.$bbbsession['group'].']';
    $bbbsession['meetingname'] .= ' ('.$groupname.')';
    if (count($groups) == 0) {
        // Only the All participants group exists.
        bigbluebuttonbn_view_message_box($bbbsession, get_string('view_groups_notenrolled_warning', 'bigbluebuttonbn'), 'info');
        return;
    }
    $context = context_module::instance($bbbsession['cm']->id);
    if (has_capability('moodle/site:accessallgroups', $context)) {
        bigbluebuttonbn_view_message_box($bbbsession, get_string('view_groups_selection_warning', 'bigbluebuttonbn'));
    }
    $urltoroot = $CFG->wwwroot.'/mod/bigbluebuttonbn/view.php?id='.$bbbsession['cm']->id;
    groups_print_activity_menu($bbbsession['cm'], $urltoroot);
    echo '<br><br>';
}

/**
 * Displays the view for messages.
 *
 * @param array $bbbsession
 * @param string $message
 * @param string $type
 * @param boolean $onlymoderator
 * @return void
 */
function bigbluebuttonbn_view_message_box(&$bbbsession, $message, $type = 'warning', $onlymoderator = false) {
    global $OUTPUT;
    if ($onlymoderator && !$bbbsession['moderator'] && !$bbbsession['administrator']) {
        return;
    }
    echo $OUTPUT->box_start('generalbox boxaligncenter');
    echo '<br><div class="alert alert-' . $type . '">' . $message . '</div>';
    echo $OUTPUT->box_end();
}

/**
 * Displays the general view.
 *
 * @param array $bbbsession
 * @param string $activity
 * @return void
 */
function bigbluebuttonbn_view_render(&$bbbsession, $activity) {
    global $OUTPUT, $PAGE;
    $type = null;
    if (isset($bbbsession['bigbluebuttonbn']->type)) {
        $type = $bbbsession['bigbluebuttonbn']->type;
    }
    $typeprofiles = bigbluebuttonbn_get_instance_type_profiles();
    $enabledfeatures = bigbluebuttonbn_get_enabled_features($typeprofiles, $type);
    $pinginterval = (int)\mod_bigbluebuttonbn\locallib\config::get('waitformoderator_ping_interval') * 1000;
    // JavaScript for locales.
    $PAGE->requires->strings_for_js(array_keys(bigbluebuttonbn_get_strings_for_js()), 'bigbluebuttonbn');
    // JavaScript variables.
    $jsvars = array('activity' => $activity, 'ping_interval' => $pinginterval,
        'locale' => bigbluebuttonbn_get_localcode(), 'profile_features' => $typeprofiles[0]['features']);
    $output  = '';
    // Renders warning messages when configured.
    $output .= bigbluebuttonbn_view_warning_default_server($bbbsession);
    $output .= bigbluebuttonbn_view_warning_general($bbbsession);

    // Renders the rest of the page.
    $output .= $OUTPUT->heading($bbbsession['meetingname'], 3);
    // Renders the completed description.
    $desc = file_rewrite_pluginfile_urls($bbbsession['meetingdescription'], 'pluginfile.php',
        $bbbsession['context']->id, 'mod_bigbluebuttonbn', 'intro', null);
    $output .= $OUTPUT->heading($desc, 5);

    if ($enabledfeatures['showroom']) {
        $output .= bigbluebuttonbn_view_render_room($bbbsession, $activity, $jsvars);
        $PAGE->requires->yui_module('moodle-mod_bigbluebuttonbn-rooms',
            'M.mod_bigbluebuttonbn.rooms.init', array($jsvars));
    }
    if ($enabledfeatures['showrecordings']) {
        $output .= html_writer::start_tag('div', array('id' => 'bigbluebuttonbn_view_recordings'));
        $output .= bigbluebuttonbn_view_render_recording_section($bbbsession, $type, $enabledfeatures, $jsvars);
        $output .= html_writer::end_tag('div');
        $PAGE->requires->yui_module('moodle-mod_bigbluebuttonbn-recordings',
                'M.mod_bigbluebuttonbn.recordings.init', array($jsvars));
    } else if ($type == BIGBLUEBUTTONBN_TYPE_RECORDING_ONLY) {
        $recordingsdisabled = get_string('view_message_recordings_disabled', 'bigbluebuttonbn');
        $output .= bigbluebuttonbn_render_warning($recordingsdisabled, 'danger');
    }
    echo $output.html_writer::empty_tag('br').html_writer::empty_tag('br').html_writer::empty_tag('br');
    $PAGE->requires->yui_module('moodle-mod_bigbluebuttonbn-broker', 'M.mod_bigbluebuttonbn.broker.init', array($jsvars));
}

/**
 * Renders the view for recordings.
 *
 * @param array $bbbsession
 * @param integer $type
 * @param array $enabledfeatures
 * @param array $jsvars
 * @return string
 */
function bigbluebuttonbn_view_render_recording_section(&$bbbsession, $type, $enabledfeatures, &$jsvars) {
    if ($type == BIGBLUEBUTTONBN_TYPE_ROOM_ONLY) {
        return '';
    }
    $output = '';
    if ($type == BIGBLUEBUTTONBN_TYPE_ALL && $bbbsession['record']) {
        $output .= html_writer::start_tag('div', array('id' => 'bigbluebuttonbn_view_recordings_header'));
        $output .= html_writer::tag('h4', get_string('view_section_title_recordings', 'bigbluebuttonbn'));
        $output .= html_writer::end_tag('div');
    }
    if ($type == BIGBLUEBUTTONBN_TYPE_RECORDING_ONLY || $bbbsession['record']) {
        $output .= html_writer::start_tag('div', array('id' => 'bigbluebuttonbn_view_recordings_content'));
        $output .= bigbluebuttonbn_view_render_recordings($bbbsession, $enabledfeatures, $jsvars);
        $output .= html_writer::end_tag('div');
        $output .= html_writer::start_tag('div', array('id' => 'bigbluebuttonbn_view_recordings_footer'));
        $output .= bigbluebuttonbn_view_render_imported($bbbsession, $enabledfeatures);
        $output .= html_writer::end_tag('div');
    }
    return $output;
}

/**
 * Evaluates if the warning box should be shown.
 *
 * @param array $bbbsession
 *
 * @return boolean
 */
function bigbluebuttonbn_view_warning_shown($bbbsession) {
    if (is_siteadmin($bbbsession['userID'])) {
        return true;
    }
    $generalwarningroles = explode(',', \mod_bigbluebuttonbn\locallib\config::get('general_warning_roles'));
    $userroles = bigbluebuttonbn_get_user_roles($bbbsession['context'], $bbbsession['userID']);
    foreach ($userroles as $userrole) {
        if (in_array($userrole->shortname, $generalwarningroles)) {
            return true;
        }
    }
    return false;
}

/**
 * Renders the view for room.
 *
 * @param array $bbbsession
 * @param string $activity
 * @param array $jsvars
 *
 * @return string
 */
function bigbluebuttonbn_view_render_room(&$bbbsession, $activity, &$jsvars) {
    global $OUTPUT;
    // JavaScript variables for room.
    $openingtime = '';
    if ($bbbsession['openingtime']) {
        $openingtime = get_string('mod_form_field_openingtime', 'bigbluebuttonbn').': '.
            userdate($bbbsession['openingtime']);
    }
    $closingtime = '';
    if ($bbbsession['closingtime']) {
        $closingtime = get_string('mod_form_field_closingtime', 'bigbluebuttonbn').': '.
            userdate($bbbsession['closingtime']);
    }
    $jsvars += array(
        'meetingid' => $bbbsession['meetingid'],
        'bigbluebuttonbnid' => $bbbsession['bigbluebuttonbn']->id,
        'userlimit' => $bbbsession['userlimit'],
        'opening' => $openingtime,
        'closing' => $closingtime,
    );
    // Main box.
    $output  = $OUTPUT->box_start('generalbox boxaligncenter', 'bigbluebuttonbn_view_message_box');
    $output .= '<br><span id="status_bar"></span>';
    $output .= '<br><span id="control_panel"></span>';
    $output .= $OUTPUT->box_end();
    // Action button box.
    $output .= $OUTPUT->box_start('generalbox boxaligncenter', 'bigbluebuttonbn_view_action_button_box');
    $output .= '<br><br><span id="join_button"></span>&nbsp;<span id="end_button"></span>'."\n";
    $output .= $OUTPUT->box_end();
    if ($activity == 'ended') {
        $output .= bigbluebuttonbn_view_ended($bbbsession);
    }
    return $output;
}

/**
 * Renders the view for recordings.
 *
 * @param array $bbbsession
 * @param array $enabledfeatures
 * @param array $jsvars
 *
 * @return string
 */
function bigbluebuttonbn_view_render_recordings(&$bbbsession, $enabledfeatures, &$jsvars) {
    $bigbluebuttonbnid = null;
    if ($enabledfeatures['showroom']) {
        $bigbluebuttonbnid = $bbbsession['bigbluebuttonbn']->id;
    }
    // Get recordings.
    $recordings = bigbluebuttonbn_get_recordings(
        $bbbsession['course']->id, $bigbluebuttonbnid, $enabledfeatures['showroom'],
        $bbbsession['bigbluebuttonbn']->recordings_deleted
      );
    if ($enabledfeatures['importrecordings']) {
        // Get recording links.
        $recordingsimported = bigbluebuttonbn_get_recordings_imported_array(
            $bbbsession['course']->id, $bigbluebuttonbnid, $enabledfeatures['showroom']
          );
        /* Perform aritmetic addition instead of merge so the imported recordings corresponding to existent
         * recordings are not included. */
        if ($bbbsession['bigbluebuttonbn']->recordings_imported) {
            $recordings = $recordingsimported;
        } else {
            $recordings += $recordingsimported;
        }
    }
    if (empty($recordings) || array_key_exists('messageKey', $recordings)) {
        // There are no recordings to be shown.
        return html_writer::div(get_string('view_message_norecordings', 'bigbluebuttonbn'), '',
            array('id' => 'bigbluebuttonbn_recordings_table'));
    }
    // There are recordings for this meeting.
    // JavaScript variables for recordings.
    $jsvars += array(
            'recordings_html' => $bbbsession['bigbluebuttonbn']->recordings_html == '1',
          );
    // If there are meetings with recordings load the data to the table.
    if ($bbbsession['bigbluebuttonbn']->recordings_html) {
        // Render a plain html table.
        return bigbluebuttonbn_output_recording_table($bbbsession, $recordings)."\n";
    }
    // JavaScript variables for recordings with YUI.
    $jsvars += array(
            'columns' => bigbluebuttonbn_get_recording_columns($bbbsession),
            'data' => bigbluebuttonbn_get_recording_data($bbbsession, $recordings),
          );
    // Render a YUI table.
    return html_writer::div('', '', array('id' => 'bigbluebuttonbn_recordings_table'));
}

/**
 * Renders the view for importing recordings.
 *
 * @param array $bbbsession
 * @param array $enabledfeatures
 *
 * @return string
 */
function bigbluebuttonbn_view_render_imported($bbbsession, $enabledfeatures) {
    global $CFG;
    if (!$enabledfeatures['importrecordings'] || !$bbbsession['importrecordings']) {
        return '';
    }
    $button = html_writer::tag('input', '',
        array('type' => 'button',
              'value' => get_string('view_recording_button_import', 'bigbluebuttonbn'),
              'class' => 'btn btn-secondary',
              'onclick' => 'window.location=\''.$CFG->wwwroot.'/mod/bigbluebuttonbn/import_view.php?bn='.
                  $bbbsession['bigbluebuttonbn']->id.'\''));
    $output  = html_writer::empty_tag('br');
    $output .= html_writer::tag('span', $button, array('id' => 'import_recording_links_button'));
    $output .= html_writer::tag('span', '', array('id' => 'import_recording_links_table'));
    return $output;
}

/**
 * Renders the content for ended meeting.
 *
 * @param array $bbbsession
 *
 * @return string
 */
function bigbluebuttonbn_view_ended(&$bbbsession) {
    global $OUTPUT;
    if (!is_null($bbbsession['presentation']['url'])) {
        $attributes = array('title' => $bbbsession['presentation']['name']);
        $icon = new pix_icon($bbbsession['presentation']['icon'], $bbbsession['presentation']['mimetype_description']);
        return '<h4>'.get_string('view_section_title_presentation', 'bigbluebuttonbn').'</h4>'.
                $OUTPUT->action_icon($bbbsession['presentation']['url'], $icon, null, array(), false).
                $OUTPUT->action_link($bbbsession['presentation']['url'],
                $bbbsession['presentation']['name'], null, $attributes).'<br><br>';
    }
    return '';
}

/**
 * Renders a default server warning message when using test-install.
 *
 * @param array $bbbsession
 *
 * @return string
 */
function bigbluebuttonbn_view_warning_default_server(&$bbbsession) {
    if (!is_siteadmin($bbbsession['userID'])) {
        return '';
    }
    if (BIGBLUEBUTTONBN_DEFAULT_SERVER_URL != \mod_bigbluebuttonbn\locallib\config::get('server_url')) {
        return '';
    }
    return bigbluebuttonbn_render_warning(get_string('view_warning_default_server', 'bigbluebuttonbn'), 'warning');
}

/**
 * Renders a general warning message when it is configured.
 *
 * @param array $bbbsession
 *
 * @return string
 */
function bigbluebuttonbn_view_warning_general(&$bbbsession) {
    if (!bigbluebuttonbn_view_warning_shown($bbbsession)) {
        return '';
    }
    return bigbluebuttonbn_render_warning(
        (string)\mod_bigbluebuttonbn\locallib\config::get('general_warning_message'),
        (string)\mod_bigbluebuttonbn\locallib\config::get('general_warning_box_type'),
        (string)\mod_bigbluebuttonbn\locallib\config::get('general_warning_button_href'),
        (string)\mod_bigbluebuttonbn\locallib\config::get('general_warning_button_text'),
        (string)\mod_bigbluebuttonbn\locallib\config::get('general_warning_button_class')
      );
}


1		<?php
2		// This file is part of Moodle - http://moodle.org/
3		//
4		// Moodle is free software: you can redistribute it and/or modify
5		// it under the terms of the GNU General Public License as published by
6		// the Free Software Foundation, either version 3 of the License, or
7		// (at your option) any later version.
8		//
9		// Moodle is distributed in the hope that it will be useful,
10		// but WITHOUT ANY WARRANTY; without even the implied warranty of
11		// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12		// GNU General Public License for more details.
13		//
14		// You should have received a copy of the GNU General Public License
15		// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17		/**
18		* View a BigBlueButton room.
19		*
20		* @package mod_bigbluebuttonbn
21		* @copyright 2010 onwards, Blindside Networks Inc
22		* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23		* @author Jesus Federico (jesus [at] blindsidenetworks [dt] com)
24		* @author Fred Dixon (ffdixon [at] blindsidenetworks [dt] com)
25		*/
26
27		require_once(dirname(dirname(dirname(__FILE__))).'/config.php');
28		require_once(dirname(__FILE__).'/locallib.php');
29
30		$id = required_param('id', PARAM_INT);
31		$bn = optional_param('bn', 0, PARAM_INT);
32		$group = optional_param('group', 0, PARAM_INT);
33
34		$viewinstance = bigbluebuttonbn_view_validator($id, $bn);
35		if (!$viewinstance) {
36		print_error(get_string('view_error_url_missing_parameters', 'bigbluebuttonbn'));
37		}
38
39		$cm = $viewinstance['cm'];
40		$course = $viewinstance['course'];
41		$bigbluebuttonbn = $viewinstance['bigbluebuttonbn'];
42		$context = context_module::instance($cm->id);
43
44		require_login($course, true, $cm);
45
46		bigbluebuttonbn_event_log(\mod_bigbluebuttonbn\event\events::$events['view'], $bigbluebuttonbn);
47
48		// Additional info related to the course.
49		$bbbsession['course'] = $course;
50		$bbbsession['coursename'] = $course->fullname;
51		$bbbsession['cm'] = $cm;
52		$bbbsession['bigbluebuttonbn'] = $bigbluebuttonbn;
53		bigbluebuttonbn_view_bbbsession_set($context, $bbbsession);
54
55		// Validates if the BigBlueButton server is working.
56		$serverversion = bigbluebuttonbn_get_server_version();
57	View Code Duplication	if (is_null($serverversion)) {
		0 ignored issues – show Duplication introduced 2018-12-03 16:11 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
58		if ($bbbsession['administrator']) {
59		print_error('view_error_unable_join', 'bigbluebuttonbn',
60		$CFG->wwwroot.'/admin/settings.php?section=modsettingbigbluebuttonbn');
61		exit;
62		}
63		if ($bbbsession['moderator']) {
64		print_error('view_error_unable_join_teacher', 'bigbluebuttonbn',
65		$CFG->wwwroot.'/course/view.php?id='.$bigbluebuttonbn->course);
66		exit;
67		}
68		print_error('view_error_unable_join_student', 'bigbluebuttonbn',
69		$CFG->wwwroot.'/course/view.php?id='.$bigbluebuttonbn->course);
70		exit;
71		}
72		$bbbsession['serverversion'] = (string) $serverversion;
73
74		// Mark viewed by user (if required).
75		$completion = new completion_info($course);
76		$completion->set_module_viewed($cm);
77
78		// Print the page header.
79		$PAGE->set_context($context);
80		$PAGE->set_url($CFG->wwwroot.'/mod/bigbluebuttonbn/view.php', array('id' => $cm->id));
81		$PAGE->set_title(format_string($bigbluebuttonbn->name));
82		$PAGE->set_cacheable(false);
83		$PAGE->set_heading($course->fullname);
84		$PAGE->set_pagelayout('incourse');
85
86		// Validate if the user is in a role allowed to join.
87		if (!has_capability('moodle/category:manage', $context) && !has_capability('mod/bigbluebuttonbn:join', $context)) {
88		echo $OUTPUT->header();
89		if (isguestuser()) {
90		echo $OUTPUT->confirm('<p>'.get_string('view_noguests', 'bigbluebuttonbn').'</p>'.get_string('liketologin'),
91		get_login_url(), $CFG->wwwroot.'/course/view.php?id='.$course->id);
92		} else {
93		echo $OUTPUT->confirm('<p>'.get_string('view_nojoin', 'bigbluebuttonbn').'</p>'.get_string('liketologin'),
94		get_login_url(), $CFG->wwwroot.'/course/view.php?id='.$course->id);
95		}
96		echo $OUTPUT->footer();
97		exit;
98		}
99
100		// Operation URLs.
101		$bbbsession['bigbluebuttonbnURL'] = $CFG->wwwroot . '/mod/bigbluebuttonbn/view.php?id=' . $bbbsession['cm']->id;
102		$bbbsession['logoutURL'] = $CFG->wwwroot . '/mod/bigbluebuttonbn/bbb_view.php?action=logout&id='.$id .
103		'&bn=' . $bbbsession['bigbluebuttonbn']->id;
104		$bbbsession['recordingReadyURL'] = $CFG->wwwroot . '/mod/bigbluebuttonbn/bbb_broker.php?action=recording_' .
105		'ready&bigbluebuttonbn=' . $bbbsession['bigbluebuttonbn']->id;
106		$bbbsession['meetingEventsURL'] = $CFG->wwwroot . '/mod/bigbluebuttonbn/bbb_broker.php?action=meeting' .
107		'_events&bigbluebuttonbn=' . $bbbsession['bigbluebuttonbn']->id;
108		$bbbsession['joinURL'] = $CFG->wwwroot . '/mod/bigbluebuttonbn/bbb_view.php?action=join&id=' . $id .
109		'&bn=' . $bbbsession['bigbluebuttonbn']->id;
110
111		// Output starts.
112		echo $OUTPUT->header();
113
114		bigbluebuttonbn_view_groups($bbbsession);
115
116		bigbluebuttonbn_view_render($bbbsession, bigbluebuttonbn_view_get_activity_status($bbbsession));
117
118		// Output finishes.
119		echo $OUTPUT->footer();
120
121		// Shows version as a comment.
122		echo '<!-- '.$bbbsession['originTag'].' -->'."\n";
123
124		// Initialize session variable used across views.
125		$SESSION->bigbluebuttonbn_bbbsession = $bbbsession;
126
127		/**
128		* Displays the view for groups.
129		*
130		* @param array $bbbsession
131		* @return void
132		*/
133		function bigbluebuttonbn_view_groups(&$bbbsession) {
134		global $CFG;
135		// Find out current group mode.
136		$groupmode = groups_get_activity_groupmode($bbbsession['cm']);
137		if ($groupmode == NOGROUPS) {
138		// No groups mode.
139		return;
140		}
141		// Separate or visible group mode.
142		$groups = groups_get_activity_allowed_groups($bbbsession['cm']);
143		if (empty($groups)) {
144		// No groups in this course.
145		bigbluebuttonbn_view_message_box($bbbsession, get_string('view_groups_nogroups_warning', 'bigbluebuttonbn'), 'info', true);
146		return;
147		}
148		$bbbsession['group'] = groups_get_activity_group($bbbsession['cm'], true);
149		$groupname = get_string('allparticipants');
150		if ($bbbsession['group'] != 0) {
151		$groupname = groups_get_group_name($bbbsession['group']);
152		}
153		// Assign group default values.
154		$bbbsession['meetingid'] .= '['.$bbbsession['group'].']';
155		$bbbsession['meetingname'] .= ' ('.$groupname.')';
156		if (count($groups) == 0) {
157		// Only the All participants group exists.
158		bigbluebuttonbn_view_message_box($bbbsession, get_string('view_groups_notenrolled_warning', 'bigbluebuttonbn'), 'info');
159		return;
160		}
161		$context = context_module::instance($bbbsession['cm']->id);
162		if (has_capability('moodle/site:accessallgroups', $context)) {
163		bigbluebuttonbn_view_message_box($bbbsession, get_string('view_groups_selection_warning', 'bigbluebuttonbn'));
164		}
165		$urltoroot = $CFG->wwwroot.'/mod/bigbluebuttonbn/view.php?id='.$bbbsession['cm']->id;
166		groups_print_activity_menu($bbbsession['cm'], $urltoroot);
167		echo '<br><br>';
168		}
169
170		/**
171		* Displays the view for messages.
172		*
173		* @param array $bbbsession
174		* @param string $message
175		* @param string $type
176		* @param boolean $onlymoderator
177		* @return void
178		*/
179		function bigbluebuttonbn_view_message_box(&$bbbsession, $message, $type = 'warning', $onlymoderator = false) {
180		global $OUTPUT;
181		if ($onlymoderator && !$bbbsession['moderator'] && !$bbbsession['administrator']) {
182		return;
183		}
184		echo $OUTPUT->box_start('generalbox boxaligncenter');
185		echo '<br><div class="alert alert-' . $type . '">' . $message . '</div>';
186		echo $OUTPUT->box_end();
187		}
188
189		/**
190		* Displays the general view.
191		*
192		* @param array $bbbsession
193		* @param string $activity
194		* @return void
195		*/
196		function bigbluebuttonbn_view_render(&$bbbsession, $activity) {
197		global $OUTPUT, $PAGE;
198		$type = null;
199		if (isset($bbbsession['bigbluebuttonbn']->type)) {
200		$type = $bbbsession['bigbluebuttonbn']->type;
201		}
202		$typeprofiles = bigbluebuttonbn_get_instance_type_profiles();
203		$enabledfeatures = bigbluebuttonbn_get_enabled_features($typeprofiles, $type);
204		$pinginterval = (int)\mod_bigbluebuttonbn\locallib\config::get('waitformoderator_ping_interval') * 1000;
205		// JavaScript for locales.
206		$PAGE->requires->strings_for_js(array_keys(bigbluebuttonbn_get_strings_for_js()), 'bigbluebuttonbn');
207		// JavaScript variables.
208		$jsvars = array('activity' => $activity, 'ping_interval' => $pinginterval,
209		'locale' => bigbluebuttonbn_get_localcode(), 'profile_features' => $typeprofiles[0]['features']);
210		$output = '';
211		// Renders warning messages when configured.
212		$output .= bigbluebuttonbn_view_warning_default_server($bbbsession);
213		$output .= bigbluebuttonbn_view_warning_general($bbbsession);
214
215		// Renders the rest of the page.
216		$output .= $OUTPUT->heading($bbbsession['meetingname'], 3);
217		// Renders the completed description.
218		$desc = file_rewrite_pluginfile_urls($bbbsession['meetingdescription'], 'pluginfile.php',
219		$bbbsession['context']->id, 'mod_bigbluebuttonbn', 'intro', null);
220		$output .= $OUTPUT->heading($desc, 5);
221
222		if ($enabledfeatures['showroom']) {
223		$output .= bigbluebuttonbn_view_render_room($bbbsession, $activity, $jsvars);
224		$PAGE->requires->yui_module('moodle-mod_bigbluebuttonbn-rooms',
225		'M.mod_bigbluebuttonbn.rooms.init', array($jsvars));
226		}
227		if ($enabledfeatures['showrecordings']) {
228		$output .= html_writer::start_tag('div', array('id' => 'bigbluebuttonbn_view_recordings'));
229		$output .= bigbluebuttonbn_view_render_recording_section($bbbsession, $type, $enabledfeatures, $jsvars);
230		$output .= html_writer::end_tag('div');
231		$PAGE->requires->yui_module('moodle-mod_bigbluebuttonbn-recordings',
232		'M.mod_bigbluebuttonbn.recordings.init', array($jsvars));
233		} else if ($type == BIGBLUEBUTTONBN_TYPE_RECORDING_ONLY) {
234		$recordingsdisabled = get_string('view_message_recordings_disabled', 'bigbluebuttonbn');
235		$output .= bigbluebuttonbn_render_warning($recordingsdisabled, 'danger');
236		}
237		echo $output.html_writer::empty_tag('br').html_writer::empty_tag('br').html_writer::empty_tag('br');
238		$PAGE->requires->yui_module('moodle-mod_bigbluebuttonbn-broker', 'M.mod_bigbluebuttonbn.broker.init', array($jsvars));
239		}
240
241		/**
242		* Renders the view for recordings.
243		*
244		* @param array $bbbsession
245		* @param integer $type
246		* @param array $enabledfeatures
247		* @param array $jsvars
248		* @return string
249		*/
250		function bigbluebuttonbn_view_render_recording_section(&$bbbsession, $type, $enabledfeatures, &$jsvars) {
251		if ($type == BIGBLUEBUTTONBN_TYPE_ROOM_ONLY) {
252		return '';
253		}
254		$output = '';
255		if ($type == BIGBLUEBUTTONBN_TYPE_ALL && $bbbsession['record']) {
256		$output .= html_writer::start_tag('div', array('id' => 'bigbluebuttonbn_view_recordings_header'));
257		$output .= html_writer::tag('h4', get_string('view_section_title_recordings', 'bigbluebuttonbn'));
258		$output .= html_writer::end_tag('div');
259		}
260		if ($type == BIGBLUEBUTTONBN_TYPE_RECORDING_ONLY \|\| $bbbsession['record']) {
261		$output .= html_writer::start_tag('div', array('id' => 'bigbluebuttonbn_view_recordings_content'));
262		$output .= bigbluebuttonbn_view_render_recordings($bbbsession, $enabledfeatures, $jsvars);
263		$output .= html_writer::end_tag('div');
264		$output .= html_writer::start_tag('div', array('id' => 'bigbluebuttonbn_view_recordings_footer'));
265		$output .= bigbluebuttonbn_view_render_imported($bbbsession, $enabledfeatures);
266		$output .= html_writer::end_tag('div');
267		}
268		return $output;
269		}
270
271		/**
272		* Evaluates if the warning box should be shown.
273		*
274		* @param array $bbbsession
275		*
276		* @return boolean
277		*/
278		function bigbluebuttonbn_view_warning_shown($bbbsession) {
279		if (is_siteadmin($bbbsession['userID'])) {
280		return true;
281		}
282		$generalwarningroles = explode(',', \mod_bigbluebuttonbn\locallib\config::get('general_warning_roles'));
283		$userroles = bigbluebuttonbn_get_user_roles($bbbsession['context'], $bbbsession['userID']);
284		foreach ($userroles as $userrole) {
285		if (in_array($userrole->shortname, $generalwarningroles)) {
286		return true;
287		}
288		}
289		return false;
290		}
291
292		/**
293		* Renders the view for room.
294		*
295		* @param array $bbbsession
296		* @param string $activity
297		* @param array $jsvars
298		*
299		* @return string
300		*/
301		function bigbluebuttonbn_view_render_room(&$bbbsession, $activity, &$jsvars) {
302		global $OUTPUT;
303		// JavaScript variables for room.
304		$openingtime = '';
305		if ($bbbsession['openingtime']) {
306		$openingtime = get_string('mod_form_field_openingtime', 'bigbluebuttonbn').': '.
307		userdate($bbbsession['openingtime']);
308		}
309		$closingtime = '';
310		if ($bbbsession['closingtime']) {
311		$closingtime = get_string('mod_form_field_closingtime', 'bigbluebuttonbn').': '.
312		userdate($bbbsession['closingtime']);
313		}
314		$jsvars += array(
315		'meetingid' => $bbbsession['meetingid'],
316		'bigbluebuttonbnid' => $bbbsession['bigbluebuttonbn']->id,
317		'userlimit' => $bbbsession['userlimit'],
318		'opening' => $openingtime,
319		'closing' => $closingtime,
320		);
321		// Main box.
322		$output = $OUTPUT->box_start('generalbox boxaligncenter', 'bigbluebuttonbn_view_message_box');
323		$output .= '<br><span id="status_bar"></span>';
324		$output .= '<br><span id="control_panel"></span>';
325		$output .= $OUTPUT->box_end();
326		// Action button box.
327		$output .= $OUTPUT->box_start('generalbox boxaligncenter', 'bigbluebuttonbn_view_action_button_box');
328		$output .= '<br><br><span id="join_button"></span> <span id="end_button"></span>'."\n";
329		$output .= $OUTPUT->box_end();
330		if ($activity == 'ended') {
331		$output .= bigbluebuttonbn_view_ended($bbbsession);
332		}
333		return $output;
334		}
335
336		/**
337		* Renders the view for recordings.
338		*
339		* @param array $bbbsession
340		* @param array $enabledfeatures
341		* @param array $jsvars
342		*
343		* @return string
344		*/
345		function bigbluebuttonbn_view_render_recordings(&$bbbsession, $enabledfeatures, &$jsvars) {
346		$bigbluebuttonbnid = null;
347		if ($enabledfeatures['showroom']) {
348		$bigbluebuttonbnid = $bbbsession['bigbluebuttonbn']->id;
349		}
350		// Get recordings.
351		$recordings = bigbluebuttonbn_get_recordings(
352		$bbbsession['course']->id, $bigbluebuttonbnid, $enabledfeatures['showroom'],
353		$bbbsession['bigbluebuttonbn']->recordings_deleted
354		);
355		if ($enabledfeatures['importrecordings']) {
356		// Get recording links.
357		$recordingsimported = bigbluebuttonbn_get_recordings_imported_array(
358		$bbbsession['course']->id, $bigbluebuttonbnid, $enabledfeatures['showroom']
359		);
360		/* Perform aritmetic addition instead of merge so the imported recordings corresponding to existent
361		* recordings are not included. */
362		if ($bbbsession['bigbluebuttonbn']->recordings_imported) {
363		$recordings = $recordingsimported;
364		} else {
365		$recordings += $recordingsimported;
366		}
367		}
368		if (empty($recordings) \|\| array_key_exists('messageKey', $recordings)) {
369		// There are no recordings to be shown.
370		return html_writer::div(get_string('view_message_norecordings', 'bigbluebuttonbn'), '',
371		array('id' => 'bigbluebuttonbn_recordings_table'));
372		}
373		// There are recordings for this meeting.
374		// JavaScript variables for recordings.
375		$jsvars += array(
376		'recordings_html' => $bbbsession['bigbluebuttonbn']->recordings_html == '1',
377		);
378		// If there are meetings with recordings load the data to the table.
379		if ($bbbsession['bigbluebuttonbn']->recordings_html) {
380		// Render a plain html table.
381		return bigbluebuttonbn_output_recording_table($bbbsession, $recordings)."\n";
382		}
383		// JavaScript variables for recordings with YUI.
384		$jsvars += array(
385		'columns' => bigbluebuttonbn_get_recording_columns($bbbsession),
386		'data' => bigbluebuttonbn_get_recording_data($bbbsession, $recordings),
387		);
388		// Render a YUI table.
389		return html_writer::div('', '', array('id' => 'bigbluebuttonbn_recordings_table'));
390		}
391
392		/**
393		* Renders the view for importing recordings.
394		*
395		* @param array $bbbsession
396		* @param array $enabledfeatures
397		*
398		* @return string
399		*/
400		function bigbluebuttonbn_view_render_imported($bbbsession, $enabledfeatures) {
401		global $CFG;
402		if (!$enabledfeatures['importrecordings'] \|\| !$bbbsession['importrecordings']) {
403		return '';
404		}
405		$button = html_writer::tag('input', '',
406		array('type' => 'button',
407		'value' => get_string('view_recording_button_import', 'bigbluebuttonbn'),
408		'class' => 'btn btn-secondary',
409		'onclick' => 'window.location=\''.$CFG->wwwroot.'/mod/bigbluebuttonbn/import_view.php?bn='.
410		$bbbsession['bigbluebuttonbn']->id.'\''));
411		$output = html_writer::empty_tag('br');
412		$output .= html_writer::tag('span', $button, array('id' => 'import_recording_links_button'));
413		$output .= html_writer::tag('span', '', array('id' => 'import_recording_links_table'));
414		return $output;
415		}
416
417		/**
418		* Renders the content for ended meeting.
419		*
420		* @param array $bbbsession
421		*
422		* @return string
423		*/
424		function bigbluebuttonbn_view_ended(&$bbbsession) {
425		global $OUTPUT;
426		if (!is_null($bbbsession['presentation']['url'])) {
427		$attributes = array('title' => $bbbsession['presentation']['name']);
428		$icon = new pix_icon($bbbsession['presentation']['icon'], $bbbsession['presentation']['mimetype_description']);
429		return '<h4>'.get_string('view_section_title_presentation', 'bigbluebuttonbn').'</h4>'.
430		$OUTPUT->action_icon($bbbsession['presentation']['url'], $icon, null, array(), false).
431		$OUTPUT->action_link($bbbsession['presentation']['url'],
432		$bbbsession['presentation']['name'], null, $attributes).'<br><br>';
433		}
434		return '';
435		}
436
437		/**
438		* Renders a default server warning message when using test-install.
439		*
440		* @param array $bbbsession
441		*
442		* @return string
443		*/
444		function bigbluebuttonbn_view_warning_default_server(&$bbbsession) {
445		if (!is_siteadmin($bbbsession['userID'])) {
446		return '';
447		}
448		if (BIGBLUEBUTTONBN_DEFAULT_SERVER_URL != \mod_bigbluebuttonbn\locallib\config::get('server_url')) {
449		return '';
450		}
451		return bigbluebuttonbn_render_warning(get_string('view_warning_default_server', 'bigbluebuttonbn'), 'warning');
452		}
453
454		/**
455		* Renders a general warning message when it is configured.
456		*
457		* @param array $bbbsession
458		*
459		* @return string
460		*/
461		function bigbluebuttonbn_view_warning_general(&$bbbsession) {
462		if (!bigbluebuttonbn_view_warning_shown($bbbsession)) {
463		return '';
464		}
465		return bigbluebuttonbn_render_warning(
466		(string)\mod_bigbluebuttonbn\locallib\config::get('general_warning_message'),
467		(string)\mod_bigbluebuttonbn\locallib\config::get('general_warning_box_type'),
468		(string)\mod_bigbluebuttonbn\locallib\config::get('general_warning_button_href'),
469		(string)\mod_bigbluebuttonbn\locallib\config::get('general_warning_button_text'),
470		(string)\mod_bigbluebuttonbn\locallib\config::get('general_warning_button_class')
471		);
472		}
473

blindsidenetworks / moodle-mod_bigbluebuttonbn

Pull Request — master (#85)

view.php ➔ bigbluebuttonbn_view_message_box() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like