blindsidenetworks / moodle-mod_bigbluebuttonbn

locallib.php

Spacing +64 added lines, -64 removed lines

@@ -28,7 +28,7 @@ 
 
 global $CFG;
 
-require_once(dirname(__FILE__).'/lib.php');
+require_once(dirname(__FILE__) . '/lib.php');
 
 /** @var BIGBLUEBUTTONBN_UPDATE_CACHE boolean set to true indicates that cache has to be updated */
 const BIGBLUEBUTTONBN_UPDATE_CACHE = true;
@@ -106,7 +106,7 @@ 
               'logoutURL' => $logouturl,
             ];
     // Choose between Adobe Flash or HTML5 Client.
-    if ( $clienttype == BIGBLUEBUTTON_CLIENTTYPE_HTML5 ) {
+    if ($clienttype == BIGBLUEBUTTON_CLIENTTYPE_HTML5) {
         $data['joinViaHtml5'] = 'true';
     }
     if (!is_null($configtoken)) {
@@ -134,8 +134,8 @@ 
     $data = null;
     if (!is_null($pname) && !is_null($purl)) {
         $method = 'POST';
-        $data = "<?xml version='1.0' encoding='UTF-8'?><modules><module name='presentation'><document url='".
-            $purl."' /></module></modules>";
+        $data = "<?xml version='1.0' encoding='UTF-8'?><modules><module name='presentation'><document url='" .
+            $purl . "' /></module></modules>";
     }
     $xml = bigbluebuttonbn_wrap_xml_load_file($createmeetingurl, $method, $data);
     if ($xml) {
@@ -257,7 +257,7 @@ 
             if (isset($recordingxml->breakoutRooms->breakoutRoom)) {
                 foreach ($recordingxml->breakoutRooms->breakoutRoom as $breakoutroom) {
                     $url = \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url('getRecordings',
-                        ['recordID' => implode(',', (array) $breakoutroom)]);
+                        ['recordID' => implode(',', (array)$breakoutroom)]);
                     $xml = bigbluebuttonbn_wrap_xml_load_file($url);
                     if ($xml && $xml->returncode == 'SUCCESS' && isset($xml->recordings)) {
                         // If there were meetings already created.
@@ -312,7 +312,7 @@ 
         // Override imported flag with actual ID.
         $recording['imported'] = $recordimported->id;
         if (isset($recordimported->protected)) {
-            $recording['protected'] = (string) $recordimported->protected;
+            $recording['protected'] = (string)$recordimported->protected;
         }
         $recordsimportedarray[$recording['recordID']] = $recording;
     }
@@ -342,21 +342,21 @@ 
     // Add formats.
     $playbackarray = array();
     foreach ($recording->playback->format as $format) {
-        $playbackarray[(string) $format->type] = array('type' => (string) $format->type,
-            'url' => trim((string) $format->url), 'length' => (string) $format->length);
+        $playbackarray[(string)$format->type] = array('type' => (string)$format->type,
+            'url' => trim((string)$format->url), 'length' => (string)$format->length);
         // Add preview per format when existing.
         if ($format->preview) {
-            $playbackarray[(string) $format->type]['preview'] = bigbluebuttonbn_get_recording_preview_images($format->preview);
+            $playbackarray[(string)$format->type]['preview'] = bigbluebuttonbn_get_recording_preview_images($format->preview);
         }
     }
     // Add the metadata to the recordings array.
     $metadataarray = bigbluebuttonbn_get_recording_array_meta(get_object_vars($recording->metadata));
-    $recordingarray = array('recordID' => (string) $recording->recordID,
-        'meetingID' => (string) $recording->meetingID, 'meetingName' => (string) $recording->name,
-        'published' => (string) $recording->published, 'startTime' => (string) $recording->startTime,
-        'endTime' => (string) $recording->endTime, 'playbacks' => $playbackarray);
+    $recordingarray = array('recordID' => (string)$recording->recordID,
+        'meetingID' => (string)$recording->meetingID, 'meetingName' => (string)$recording->name,
+        'published' => (string)$recording->published, 'startTime' => (string)$recording->startTime,
+        'endTime' => (string)$recording->endTime, 'playbacks' => $playbackarray);
     if (isset($recording->protected)) {
-        $recordingarray['protected'] = (string) $recording->protected;
+        $recordingarray['protected'] = (string)$recording->protected;
     }
     return $recordingarray + $metadataarray;
 }
@@ -371,9 +371,9 @@ 
 function bigbluebuttonbn_get_recording_preview_images($preview) {
     $imagesarray = array();
     foreach ($preview->images->image as $image) {
-        $imagearray = array('url' => trim((string) $image));
+        $imagearray = array('url' => trim((string)$image));
         foreach ($image->attributes() as $attkey => $attvalue) {
-            $imagearray[$attkey] = (string) $attvalue;
+            $imagearray[$attkey] = (string)$attvalue;
         }
         array_push($imagesarray, $imagearray);
     }
@@ -393,7 +393,7 @@ 
         if (is_object($value)) {
             $value = '';
         }
-        $metadataarray['meta_'.$key] = $value;
+        $metadataarray['meta_' . $key] = $value;
     }
     return $metadataarray;
 }
@@ -465,7 +465,7 @@ 
     $ids = explode(',', $recordids);
     foreach ($ids as $id) {
         $xml = bigbluebuttonbn_wrap_xml_load_file(
-            \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url('updateRecordings', ['recordID' => $id] + (array) $params)
+            \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url('updateRecordings', ['recordID' => $id] + (array)$params)
           );
         if ($xml && $xml->returncode != 'SUCCESS') {
             return false;
@@ -530,7 +530,7 @@ 
             return $xml;
         } catch (Exception $e) {
             libxml_use_internal_errors($previous);
-            $error = 'Caught exception: '.$e->getMessage();
+            $error = 'Caught exception: ' . $e->getMessage();
             debugging($error, DEBUG_DEVELOPER);
             return null;
         }
@@ -541,7 +541,7 @@ 
         $response = simplexml_load_file($url, 'SimpleXMLElement', LIBXML_NOCDATA | LIBXML_NOBLANKS);
         return $response;
     } catch (Exception $e) {
-        $error = 'Caught exception: '.$e->getMessage();
+        $error = 'Caught exception: ' . $e->getMessage();
         debugging($error, DEBUG_DEVELOPER);
         libxml_use_internal_errors($previous);
         return null;
@@ -567,8 +567,8 @@ 
         }
         $options = array();
         $options['CURLOPT_HTTPHEADER'] = array(
-                 'Content-Type: '.$contenttype,
-                 'Content-Length: '.strlen($data),
+                 'Content-Type: ' . $contenttype,
+                 'Content-Length: ' . strlen($data),
                  'Content-Language: en-US',
                );
 
@@ -589,7 +589,7 @@ 
  * @return void
  */
 function bigbluebuttonbn_end_meeting_if_running($bigbluebuttonbn) {
-    $meetingid = $bigbluebuttonbn->meetingid.'-'.$bigbluebuttonbn->course.'-'.$bigbluebuttonbn->id;
+    $meetingid = $bigbluebuttonbn->meetingid . '-' . $bigbluebuttonbn->course . '-' . $bigbluebuttonbn->id;
     if (bigbluebuttonbn_is_meeting_running($meetingid)) {
         bigbluebuttonbn_end_meeting($meetingid, $bigbluebuttonbn->moderatorpass);
     }
@@ -609,9 +609,9 @@ 
     if ($userroles) {
         $where = '';
         foreach ($userroles as $userrole) {
-            $where .= (empty($where) ? ' WHERE' : ' OR').' id=' . $userrole->roleid;
+            $where .= (empty($where) ? ' WHERE' : ' OR') . ' id=' . $userrole->roleid;
         }
-        $userroles = $DB->get_records_sql('SELECT * FROM {role}'.$where);
+        $userroles = $DB->get_records_sql('SELECT * FROM {role}' . $where);
     }
     return $userroles;
 }
@@ -634,7 +634,7 @@ 
  * @return array $users
  */
 function bigbluebuttonbn_get_users(context $context = null) {
-    $users = (array) get_enrolled_users($context, '', 0, 'u.*', null, 0, 0, true);
+    $users = (array)get_enrolled_users($context, '', 0, 'u.*', null, 0, 0, true);
     foreach ($users as $key => $value) {
         $users[$key] = fullname($value);
     }
@@ -649,7 +649,7 @@ 
  * @return array $users
  */
 function bigbluebuttonbn_get_users_select(context $context = null) {
-    $users = (array) get_enrolled_users($context, '', 0, 'u.*', null, 0, 0, true);
+    $users = (array)get_enrolled_users($context, '', 0, 'u.*', null, 0, 0, true);
     foreach ($users as $key => $value) {
         $users[$key] = array('id' => $value->id, 'name' => fullname($value));
     }
@@ -664,7 +664,7 @@ 
  * @return array $roles
  */
 function bigbluebuttonbn_get_roles(context $context = null) {
-    $roles = (array) role_get_names($context);
+    $roles = (array)role_get_names($context);
     foreach ($roles as $key => $value) {
         $roles[$key] = $value->localname;
     }
@@ -679,7 +679,7 @@ 
  * @return array $users
  */
 function bigbluebuttonbn_get_roles_select(context $context = null) {
-    $roles = (array) role_get_names($context);
+    $roles = (array)role_get_names($context);
     foreach ($roles as $key => $value) {
         $roles[$key] = array('id' => $value->id, 'name' => $value->localname);
     }
@@ -694,7 +694,7 @@ 
  * @return object $role
  */
 function bigbluebuttonbn_get_role($id) {
-    $roles = (array) role_get_names();
+    $roles = (array)role_get_names();
     if (is_numeric($id) && isset($roles[$id])) {
         return (object)$roles[$id];
     }
@@ -851,7 +851,7 @@ 
     if (!isguestuser()) {
         $userroles = bigbluebuttonbn_get_user_roles($context, $userid);
     }
-    return bigbluebuttonbn_is_moderator_validator($participantlist, $userid , $userroles);
+    return bigbluebuttonbn_is_moderator_validator($participantlist, $userid, $userroles);
 }
 
 /**
@@ -1051,7 +1051,7 @@ 
 function bigbluebuttonbn_generate_nonce() {
     $mt = microtime();
     $rand = mt_rand();
-    return md5($mt.$rand);
+    return md5($mt . $rand);
 }
 
 /**
@@ -1141,10 +1141,10 @@ 
     $now = time();
     if (!$updatecache && isset($result) && $now < ($result['creation_time'] + $cachettl)) {
         // Use the value in the cache.
-        return (array) json_decode($result['meeting_info']);
+        return (array)json_decode($result['meeting_info']);
     }
     // Ping again and refresh the cache.
-    $meetinginfo = (array) bigbluebuttonbn_wrap_xml_load_file(
+    $meetinginfo = (array)bigbluebuttonbn_wrap_xml_load_file(
         \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url('getMeetingInfo', ['meetingID' => $meetingid])
       );
     $cache->set($meetingid, array('creation_time' => time(), 'meeting_info' => json_encode($meetinginfo)));
@@ -1255,7 +1255,7 @@ 
  * @return object
  */
 function bigbluebuttonbn_set_config_xml($meetingid, $configxml) {
-    $urldefaultconfig = \mod_bigbluebuttonbn\locallib\config::get('server_url').'api/setConfigXML?';
+    $urldefaultconfig = \mod_bigbluebuttonbn\locallib\config::get('server_url') . 'api/setConfigXML?';
     $configxmlparams = bigbluebuttonbn_set_config_xml_params($meetingid, $configxml);
     $xml = bigbluebuttonbn_wrap_xml_load_file($urldefaultconfig, 'POST',
         $configxmlparams, 'application/x-www-form-urlencoded');
@@ -1271,8 +1271,8 @@ 
  * @return string
  */
 function bigbluebuttonbn_set_config_xml_params($meetingid, $configxml) {
-    $params = 'configXML='.urlencode($configxml).'&meetingID='.urlencode($meetingid);
-    $configxmlparams = $params.'&checksum='.sha1('setConfigXML'.$params.\mod_bigbluebuttonbn\locallib\config::get('shared_secret'));
+    $params = 'configXML=' . urlencode($configxml) . '&meetingID=' . urlencode($meetingid);
+    $configxmlparams = $params . '&checksum=' . sha1('setConfigXML' . $params . \mod_bigbluebuttonbn\locallib\config::get('shared_secret'));
     return $configxmlparams;
 }
 
@@ -1286,7 +1286,7 @@ 
  */
 function bigbluebuttonbn_set_config_xml_array($meetingid, $configxml) {
     $configxml = bigbluebuttonbn_setConfigXML($meetingid, $configxml);
-    $configxmlarray = (array) $configxml;
+    $configxmlarray = (array)$configxml;
     if ($configxmlarray['returncode'] != 'SUCCESS') {
         debugging('BigBlueButton was not able to set the custom config.xml file', DEBUG_DEVELOPER);
         return '';
@@ -1380,7 +1380,7 @@ 
     global $USER;
     $starttime = $starttime - ($starttime % 1000);
     // Set formatted date.
-    $dateformat = get_string('strftimerecentfull', 'langconfig').' %Z';
+    $dateformat = get_string('strftimerecentfull', 'langconfig') . ' %Z';
     return userdate($starttime / 1000, $dateformat, usertimezone($USER->timezone));
 }
 
@@ -1496,7 +1496,7 @@ 
  * @return string
  */
 function bigbluebuttonbn_get_recording_data_row_preview($recording) {
-    $options = array('id' => 'preview-'.$recording['recordID']);
+    $options = array('id' => 'preview-' . $recording['recordID']);
     if ($recording['published'] === 'false') {
         $options['hidden'] = 'hidden';
     }
@@ -1558,7 +1558,7 @@ 
     if ($recording['published'] === 'false') {
         $visibility = 'hidden ';
     }
-    $id = 'playbacks-'.$recording['recordID'];
+    $id = 'playbacks-' . $recording['recordID'];
     $recordingtypes = html_writer::start_tag('div', array('id' => $id, 'data-imported' => $dataimported,
           'data-meetingid' => $recording['meetingID'], 'data-recordingid' => $recording['recordID'],
           'title' => $title, $visibility => $visibility));
@@ -1583,11 +1583,11 @@ 
     if (!bigbluebuttonbn_include_recording_data_row_type($recording, $bbbsession, $playback)) {
         return '';
     }
-    $text = get_string('view_recording_format_'.$playback['type'], 'bigbluebuttonbn');
+    $text = get_string('view_recording_format_' . $playback['type'], 'bigbluebuttonbn');
     $href = $CFG->wwwroot . '/mod/bigbluebuttonbn/bbb_view.php?action=play&bn=' . $bbbsession['bigbluebuttonbn']->id .
-      '&mid='.$recording['meetingID'] . '&rid=' . $recording['recordID'] . '&rtype=' . $playback['type'];
+      '&mid=' . $recording['meetingID'] . '&rid=' . $recording['recordID'] . '&rtype=' . $playback['type'];
     if (!isset($recording['imported']) || !isset($recording['protected']) || $recording['protected'] === 'false') {
-        $href .= '&href='.urlencode(trim($playback['url']));
+        $href .= '&href=' . urlencode(trim($playback['url']));
     }
     $linkattributes = array(
         'id' => 'recording-play-' . $playback['type'] . '-' . $recording['recordID'],
@@ -1771,7 +1771,7 @@ 
             $linkattributes['class'] = 'disabled';
             unset($linkattributes['onclick']);
         }
-        $icon = new pix_icon('i/'.$data['tag'],
+        $icon = new pix_icon('i/' . $data['tag'],
             get_string('view_recording_list_actionbar_' . $data['action'], 'bigbluebuttonbn'),
             'moodle', $iconattributes);
         return $OUTPUT->action_icon('#', $icon, null, $linkattributes, false);
@@ -1883,7 +1883,7 @@ 
                 $groupid = explode(']', $groupid[1]);
                 if (isset($groupid[0])) {
                     foreach ($usergroups as $usergroup) {
-                        if($usergroup->id == $groupid[0]) {
+                        if ($usergroup->id == $groupid[0]) {
                             // Include recording if the user is in the same group.
                             $displayrow = true;
                         }
@@ -1913,7 +1913,7 @@ 
  */
 function bigbluebuttonbn_get_recording_table_row($bbbsession, $recording, $rowdata) {
     $row = new html_table_row();
-    $row->id = 'recording-tr-'.$recording['recordID'];
+    $row->id = 'recording-tr-' . $recording['recordID'];
     $row->attributes['data-imported'] = 'false';
     $texthead = '';
     $texttail = '';
@@ -1926,7 +1926,7 @@ 
     $rowdata->date_formatted = str_replace(' ', '&nbsp;', $rowdata->date_formatted);
     $row->cells = array();
     $row->cells[] = $texthead . $rowdata->recording . $texttail;
-    $row->cells[] = $texthead . $rowdata->meeting . $texttail;;
+    $row->cells[] = $texthead . $rowdata->meeting . $texttail; ;
     $row->cells[] = $texthead . $rowdata->activity . $texttail;
     $row->cells[] = $texthead . $rowdata->description . $texttail;
     if (bigbluebuttonbn_get_recording_data_preview_enabled($bbbsession)) {
@@ -1974,9 +1974,9 @@ 
 function bigbluebuttonbn_send_notification_recording_ready($bigbluebuttonbn) {
     $sender = get_admin();
     // Prepare message.
-    $messagetext = '<p>'.get_string('email_body_recording_ready_for', 'bigbluebuttonbn').
-        ' &quot;' . $bigbluebuttonbn->name . '&quot; '.
-        get_string('email_body_recording_ready_is_ready', 'bigbluebuttonbn').'.</p>';
+    $messagetext = '<p>' . get_string('email_body_recording_ready_for', 'bigbluebuttonbn') .
+        ' &quot;' . $bigbluebuttonbn->name . '&quot; ' .
+        get_string('email_body_recording_ready_is_ready', 'bigbluebuttonbn') . '.</p>';
     $context = context_course::instance($bigbluebuttonbn->course);
     \mod_bigbluebuttonbn\locallib\notifier::notification_send($context, $sender, $bigbluebuttonbn, $messagetext);
 }
@@ -2198,7 +2198,7 @@ 
     }
     // Prepare select for loading records based on existent bigbluebuttonbns.
     $sql = 'SELECT DISTINCT meetingid, bigbluebuttonbnid FROM {bigbluebuttonbn_logs} WHERE ';
-    $sql .= '(bigbluebuttonbnid='.implode(' OR bigbluebuttonbnid=', array_keys($bigbluebuttonbns)).')';
+    $sql .= '(bigbluebuttonbnid=' . implode(' OR bigbluebuttonbnid=', array_keys($bigbluebuttonbns)) . ')';
     // Include only Create events and exclude those with record not true.
     $sql .= ' AND log = ? AND meta LIKE ? AND meta LIKE ?';
     // Execute select for loading records based on existent bigbluebuttonbns.
@@ -2372,8 +2372,8 @@ 
 function bigbluebuttonbn_format_activity_time($time) {
     $activitytime = '';
     if ($time) {
-        $activitytime = calendar_day_representation($time).' '.
-          get_string('mod_form_field_notification_msg_at', 'bigbluebuttonbn').' '.
+        $activitytime = calendar_day_representation($time) . ' ' .
+          get_string('mod_form_field_notification_msg_at', 'bigbluebuttonbn') . ' ' .
           calendar_time_representation($time);
     }
     return $activitytime;
@@ -2841,7 +2841,7 @@ 
  *
  * @return string
  */
-function bigbluebuttonbn_render_warning($message, $type='info', $href='', $text='', $class='') {
+function bigbluebuttonbn_render_warning($message, $type = 'info', $href = '', $text = '', $class = '') {
     global $OUTPUT;
     $output = "\n";
     // Evaluates if config_warning is enabled.
@@ -2880,11 +2880,11 @@ 
     if ($class == '') {
         $class = 'btn btn-secondary';
     }
-    $output  = '  <form method="post" action="' . $href . '" class="form-inline">'."\n";
-    $output .= '      <button type="submit" class="' . $class . '"'."\n";
-    $output .= '          title="' . $title . '"'."\n";
-    $output .= '          >' . $text . '</button>'."\n";
-    $output .= '  </form>'."\n";
+    $output  = '  <form method="post" action="' . $href . '" class="form-inline">' . "\n";
+    $output .= '      <button type="submit" class="' . $class . '"' . "\n";
+    $output .= '          title="' . $title . '"' . "\n";
+    $output .= '          >' . $text . '</button>' . "\n";
+    $output .= '  </form>' . "\n";
     return $output;
 }
 
@@ -3049,7 +3049,7 @@ 
     $bbbsession['modPW'] = $bbbsession['bigbluebuttonbn']->moderatorpass;
     $bbbsession['viewerPW'] = $bbbsession['bigbluebuttonbn']->viewerpass;
     // Database info related to the activity.
-    $bbbsession['meetingid'] = $bbbsession['bigbluebuttonbn']->meetingid.'-'.$bbbsession['course']->id.'-'.
+    $bbbsession['meetingid'] = $bbbsession['bigbluebuttonbn']->meetingid . '-' . $bbbsession['course']->id . '-' .
         $bbbsession['bigbluebuttonbn']->id;
     $bbbsession['meetingname'] = $bbbsession['bigbluebuttonbn']->name;
     $bbbsession['meetingdescription'] = $bbbsession['bigbluebuttonbn']->intro;
@@ -3081,10 +3081,10 @@ 
     if ($bbbsession['bigbluebuttonbn']->record) {
         // Check if is enable record all from start.
         if ($bbbsession['recordallfromstart']) {
-            $bbbsession['welcome'] .= '<br><br>'.get_string('bbbrecordallfromstartwarning',
+            $bbbsession['welcome'] .= '<br><br>' . get_string('bbbrecordallfromstartwarning',
                     'bigbluebuttonbn');
         } else {
-            $bbbsession['welcome'] .= '<br><br>'.get_string('bbbrecordwarning', 'bigbluebuttonbn');
+            $bbbsession['welcome'] .= '<br><br>' . get_string('bbbrecordwarning', 'bigbluebuttonbn');
         }
     }
     $bbbsession['openingtime'] = $bbbsession['bigbluebuttonbn']->openingtime;
@@ -3099,7 +3099,7 @@ 
     $bbbsession['originServerName'] = $parsedurl['host'];
     $bbbsession['originServerUrl'] = $CFG->wwwroot;
     $bbbsession['originServerCommonName'] = '';
-    $bbbsession['originTag'] = 'moodle-mod_bigbluebuttonbn ('.get_config('mod_bigbluebuttonbn', 'version').')';
+    $bbbsession['originTag'] = 'moodle-mod_bigbluebuttonbn (' . get_config('mod_bigbluebuttonbn', 'version') . ')';
     $bbbsession['bnserver'] = bigbluebuttonbn_is_bn_server();
     // Setting for clienttype, assign flash if not enabled, or default if not editable.
     $bbbsession['clienttype'] = \mod_bigbluebuttonbn\locallib\config::get('clienttype_default');