2022090700 release code. (#191)

LICENSE.txt

@@ -672,3 +672,5 @@ may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
 <http://www.gnu.org/philosophy/why-not-lgpl.html>.
+
+END OF TERMS AND CONDITIONS

SSO.php

@@ -24,11 +24,7 @@
 
 // This can't be defined Moodle internal because it is called from Panopto to authorize login.
 
-global $CFG, $USER;
-
-if (empty($CFG)) {
-    require_once(dirname(__FILE__) . '/../../config.php');
-}
+require_once(dirname(__FILE__) . '/../../config.php');
 require_once($CFG->libdir . '/weblib.php');
 require_once(dirname(__FILE__) . '/lib/block_panopto_lib.php');
 
@@ -37,7 +33,7 @@
 $configuredserverarray = panopto_get_configured_panopto_servers();
 
 $callbackverified = false;
-foreach($configuredserverarray as  $possibleserver) {
+foreach ($configuredserverarray as $possibleserver) {
     if (strcasecmp($possibleserver, $servername) == 0) {
         $callbackhost = parse_url($callbackurl, PHP_URL_HOST);
 
@@ -49,7 +45,7 @@
 }
 
 if ($callbackverified) {
-    if (strpos($callbackurl, 'http%') !== false 
+    if (strpos($callbackurl, 'http%') !== false
      || strpos($callbackurl, 'https%') !== false) {
         $callbackurl = urldecode($callbackurl);
     }
@@ -74,7 +70,7 @@
         return;
     }
 
-    // No course ID (0).  Don't autologin guests (false).
+    // No course ID (0). Don't autologin guests (false).
     require_login(0, false);
 
     // Reproduce canonically-ordered incoming auth payload.
@@ -105,18 +101,39 @@
                 \core\task\manager::queue_adhoc_task($ssosynctask);
             break;
         }
+
+        // Strip ReturnUrl so we can append it on the end
+        parse_str(parse_url($callbackurl, PHP_URL_QUERY), $params);
+        $returnurl = isset($params['ReturnUrl']) ? $params['ReturnUrl'] : "";
+
+        // Handle fragment with hash.
+        $fragment = "#";
+        if (strpos($callbackurl, "#") !== false) {
+            $fragment .= strtok(explode("#", $callbackurl)[1], '&');
+        } else {
+            $fragment = "";
+        }
+
+        // Strip ReturnUrl from original URL and clean if necessary.
+        // This is constant LoginPageRedirectParamKey = "ReturnUrl" so it should always arrive in this format.
+        $url = preg_replace('/&?ReturnUrl=[^&]*/', '', $callbackurl);
+        $url = str_replace('?&', '?', $url);
+        $url = rtrim($url, '?');
+
         // Generate canonically-ordered auth payload string.
         $responseparams = 'serverName=' . $servername . '&externalUserKey=' . $userkey . '&expiration=' . $expiration;
         // Sign payload with shared key and hash.
         $responseauthcode = panopto_generate_auth_code($responseparams);
 
-        // Encode user key in case the backslash causes a sequence to be interpreted as an escape sequence
+        // Encode user key in case the backslash causes a sequence to be interpreted as an escape sequence.
         // (e.g. in the case of usernames that begin with digits).
         // Maintain the original canonical string to avoid signature mismatch.
-        $responseparamsencoded = 'serverName=' . $servername . '&externalUserKey=' . urlencode($userkey) . '&expiration=' . $expiration;
+        $responseparamsencoded =
+            'serverName=' . $servername . '&externalUserKey=' . urlencode($userkey) . '&expiration=' . $expiration;
 
-        $separator = (strpos($callbackurl, '?') ? '&' : '?');
-        $redirecturl = $callbackurl . $separator . $responseparamsencoded . '&authCode=' . $responseauthcode;
+        $fullreturnurl = !empty($returnurl) ? '&ReturnUrl=' . $returnurl . $fragment : "";
+        $separator = (strpos($url, '?') ? '&' : '?');
+        $redirecturl = $url . $separator . $responseparamsencoded . '&authCode=' . $responseauthcode . $fullreturnurl;
 
         // Redirect to Panopto Focus login page.
         redirect($redirecturl);

block_panopto.php

@@ -99,22 +99,21 @@ public function instance_config_save($data, $nolongerused = false) {
             $publisherroles,
             $creatorroles
         );
-        
+
         if (!empty($data->course)) {
 
             // Only perform this chunk if we are remapping to a new folder.
             $panoptodata = new \panopto_data($this->page->course->id);
-            
+
             if (strcasecmp($panoptodata->sessiongroupid, $data->course) != 0) {
                 $oldsessionid = null;
                 if (!empty($panoptodata->sessiongroupid)) {
                     $oldsessionid = $panoptodata->sessiongroupid;
                     $panoptodata->unprovision_course();
                 }
-
-
-                // Manually overwrite the sessiongroupid on this Panopto_Data instance so we can test provision the attempted new mapping. If the provision fails do not allow it.
-                //  Provision could fail if the user attempts to provision a personal folder.
+                // Manually overwrite the sessiongroupid on this Panopto_Data instance,
+                // so we can test provision the attempted new mapping.
+                // If the provision fails do not allow it. Provision could fail if the user attempts to provision a personal folder.
                 $panoptodata->sessiongroupid = $data->course;
 
                 $provisioninginfo = $panoptodata->get_provisioning_info();
@@ -142,7 +141,7 @@ public function cron() {
      * Generate HTML for block contents.
      */
     public function get_content() {
-        global $COURSE, $PAGE;
+        global $COURSE;
 
         if ($this->content !== null) {
             return $this->content;
@@ -157,7 +156,7 @@ public function get_content() {
 
         $params = array('id' => self::CONTENTID, 'courseid' => $COURSE->id);
 
-        $PAGE->requires->yui_module('moodle-block_panopto-asyncload',
+        $this->page->requires->yui_module('moodle-block_panopto-asyncload',
                                     'M.block_panopto.asyncload.init',
                                     array($params),
                                     null,
@@ -193,7 +192,7 @@ public function get_content() {
                         'var showAllToggle = document.getElementById("showAllToggle");' .
                         'var hiddenLecturesDiv = document.getElementById("hiddenLecturesDiv");' .
 
-                        'if(hiddenLecturesDiv.style.display == "block") {' .
+                        'if (hiddenLecturesDiv.style.display == "block") {' .
                             'hiddenLecturesDiv.style.display = "none";' .
                             'showAllToggle.innerHTML = "' . get_string('show_all', 'block_panopto') . '";' .
                         '} else {' .
@@ -211,13 +210,13 @@ public function get_content() {
      * @return array
      */
     public function applicable_formats() {
-        // Since block is dealing with courses and enrolments the only possible.
+        // Since block is dealing with courses and enrollment's the only possible.
         // place where Panopto block can be used is the course.
         return array('course-view' => true);
     }
 
     /**
-     * allow more than one instance of the block on a page
+     * Allow more than one instance of the block on a page
      *
      * @return boolean
      */

build_category_structure.php

@@ -15,7 +15,7 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * the code used to build the Moodle category structure on Panopto
+ * The code used to build the Moodle category structure on Panopto
  *
  * @package block_panopto
  * @copyright  Panopto 2009 - 2017
@@ -67,7 +67,10 @@
 require_login();
 
 /**
- * The category structure process workhorse funciton
+ * The category structure process workhorse function
+ *
+ * @param string $selectedserver server name
+ * @param string $selectedkey selected key
  */
 function build_category_structure($selectedserver, $selectedkey) {
     global $DB;
@@ -124,7 +127,7 @@ function build_category_structure($selectedserver, $selectedkey) {
 
         echo "<a href='$returnurl'>" . get_string('back_to_config', 'block_panopto') . '</a>';
     } else {
-       $mform->display(); 
+        $mform->display();
     }
 
     echo $OUTPUT->footer();

classes/admin/trim_configtext.php

@@ -15,16 +15,14 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * a new admin setting that trims any input.
+ * A new admin setting that trims any input.
  *
  * @package block_panopto
  * @copyright Panopto 2009 - 2016 /With contributions from Spenser Jones ([email protected]),
  * Skylar Kelty <[email protected]>
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-defined('MOODLE_INTERNAL') || die();
-
 /**
  * Text input that trims any extra whitespace.
  * @copyright Panopto 2016
@@ -49,7 +47,7 @@ public function __construct($name, $visiblename, $description, $defaultsetting,
     }
 
     /**
-     * write data to storage
+     * Write data to storage
      *
      * @param string $data the data being written.
      */
@@ -59,7 +57,7 @@ public function write_setting($data) {
             $data = 0;
         }
 
-        // ...$data is a string.
+        // The ...$data is a string.
         $trimmeddata = trim($data);
         $validated = $this->validate($trimmeddata);
         if ($validated !== true) {

classes/categorytasks.php

@@ -15,7 +15,7 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * adds category tasks to the Panopto plugin
+ * Adds category tasks to the Panopto plugin
  *
  * @package block_panopto
  * @copyright Panopto 2009 - 2018
@@ -38,13 +38,14 @@
  * When a category is moved or updated: course_category_updated is called
  */
 class block_panopto_categorytasks {
+
     /**
      * Called when a category has been created
      *
-     * @param \core\event\course_category_updated $event
+     * @param \core\event\course_category_created $event
      */
     public static function coursecategorycreated(\core\event\course_category_created $event) {
-        
+
         if (!\panopto_data::is_main_block_configured() ||
             !\panopto_data::has_minimum_version()) {
             return;

classes/panopto_build_category_structure_form.php

@@ -13,15 +13,18 @@
 //
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->libdir . '/formslib.php');
+
 /**
- * the form wrapper used to build the Moodle category structure on Panopto
+ * The form wrapper used to build the Moodle category structure on Panopto
  *
  * @package block_panopto
  * @copyright  Panopto 2020
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-require_once($CFG->libdir . '/formslib.php');
-
 class panopto_build_category_structure_form extends moodleform {
 
     /**

classes/panopto_provision_form.php

@@ -13,15 +13,18 @@
 //
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->libdir . '/formslib.php');
+
 /**
  * Create form for server selection for bulk course provisioning
  *
  * @package block_panopto
  * @copyright  Panopto 2020
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-require_once($CFG->libdir . '/formslib.php');
-
 class panopto_provision_form extends moodleform {
 
     /**

classes/panopto_rename_all_folders_form.php

@@ -14,15 +14,17 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->libdir . '/formslib.php');
+
 /**
  * Form to update all currently mapped Panopto folder names to match their mapped course name
  *
  * @package block_panopto
  * @copyright  Panopto 2020
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-require_once($CFG->libdir . '/formslib.php');
-
 class panopto_rename_all_folders_form extends moodleform {
 
     /**

classes/panopto_unprovision_course_form.php

@@ -13,6 +13,7 @@
 //
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
 /**
  * Create form for server selection.
  *

classes/panopto_unprovision_form.php

@@ -13,9 +13,11 @@
 //
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
 /**
  * Create form for course unprovision.
  *
+ * @package block_panopto
  * @copyright  Panopto 2020
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -39,8 +41,8 @@ public function definition() {
         global $DB;
 
         $mform = & $this->_form;
-        
-        // Get all categories with no children (all leaf nodes)
+
+        // Get all categories with no children (all leaf nodes).
         $coursesraw = $DB->get_records_sql(
             'SELECT id, shortname, fullname FROM {course} WHERE id IN (SELECT moodleid FROM {block_panopto_foldermap})'
         );

classes/panopto_upgrade_all_folders_form.php

@@ -14,15 +14,17 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->libdir . '/formslib.php');
+
 /**
  * Form for the Generation 1 to Generation 2 Panopto upgrade
  *
  * @package block_panopto
  * @copyright  Panopto 2020
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-require_once($CFG->libdir . '/formslib.php');
-
 class panopto_upgrade_all_folders_form extends moodleform {
 
     /**