Merge pull request #482 from catalyst/issue481

Fix broken range requests

Author: Peterburnett

classes/check/proxy_range_request.php

@@ -0,0 +1,69 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace tool_objectfs\check;
+use core\check\check;
+use core\check\result;
+
+/**
+ * Status check for objectFS proxied range requests.
+ *
+ * @package    tool_objectfs
+ * @author     Peter Burnett <peterburnett@catalyst-au.net>
+ * @copyright  Catalyst IT
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class proxy_range_request extends check {
+    /**
+     * Link to ObjectFS settings page.
+     *
+     * @return \action_link|null
+     */
+    public function get_action_link(): ?\action_link {
+        $url = new \moodle_url('/admin/category.php', ['category' => 'tool_objectfs']);
+        return new \action_link($url, get_string('pluginname', 'tool_objectfs'));
+    }
+
+    /**
+     * Check for the success of a proxied range request, if the setting is enabled.
+     *
+     * @return result
+     */
+    public function get_result(): result {
+        $config = \tool_objectfs\local\manager::get_objectfs_config();
+        $client = \tool_objectfs\local\manager::get_client($config);
+
+        $signingsupport = false;
+        if (!empty($config->filesystem)) {
+            $signingsupport = (new $config->filesystem())->supports_presigned_urls();
+        }
+
+        $testconn = $client->test_connection();
+        $connstatus = $testconn->success;
+
+        if ($connstatus && $signingsupport) {
+            $range = $client->test_range_request(new $config->filesystem());
+
+            if ($range->result) {
+                return new result(result::OK, get_string('settings:presignedurl:testrangeok', 'tool_objectfs'));
+            } else {
+                return new result(result::WARNING, get_string('settings:presignedurl:testrangeerror', 'tool_objectfs'));
+            }
+        }
+
+        return new result(result::UNKNOWN, get_string('check:proxyrangerequestsdisabled', 'tool_objectfs'));
+    }
+}

classes/local/store/s3/client.php

@@ -751,7 +751,7 @@ public function proxy_range_request(\stored_file $file, $ranges) {
     public function curl_range_request_to_presigned_url($contenthash, $ranges, $headers) {
         try {
             $signedurl = $this->generate_presigned_url_s3($contenthash, $headers);
-            $url = $signedurl->url;
+            $url = $signedurl->url->out(false);
         } catch (\Exception $e) {
             throw new \coding_exception('Failed to generate pre-signed url: ' . $e->getMessage());
         }

lang/en/tool_objectfs.php

@@ -265,3 +265,6 @@
 $string['settings:notconfigured'] = 'Missing configuration.';
 $string['total_deleted_dirs'] = 'Total number of deleted directories: ';
 $string['backportfiletypesclass'] = 'Backport MDL-53240 is missing. Follow up https://github.com/catalyst/moodle-tool_objectfs#applying-core-patches';
+
+$string['check:proxyrangerequestsdisabled'] = 'The proxy range request setting is disabled.';
+$string['checkproxy_range_request'] = 'Pre-signed URL range request proxy';

lib.php

@@ -110,3 +110,18 @@ function tool_objectfs_pluginfile($course, $cm, context $context, $filearea, arr
     send_stored_file($file, $lifetime, 0, $forcedownload, $options);
     return true;
 }
+
+/**
+ * Get status checks for tool_objectfs.
+ *
+ * @return array
+ */
+function tool_objectfs_status_checks() {
+    if (get_config('tool_objectfs', 'proxyrangerequests')) {
+        return [
+            new tool_objectfs\check\proxy_range_request()
+        ];
+    }
+
+    return [];
+}

version.php

@@ -25,8 +25,8 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version   = 2021122301;      // The current plugin version (Date: YYYYMMDDXX).
-$plugin->release   = 2021122301;      // Same as version.
+$plugin->version   = 2021122302;      // The current plugin version (Date: YYYYMMDDXX).
+$plugin->release   = 2021122302;      // Same as version.
 $plugin->requires  = 2013111811;      // Requires Filesystem API.
 $plugin->component = "tool_objectfs";
 $plugin->maturity  = MATURITY_STABLE;