WIP more tagging stuff

Author: matthewhilton

classes/check/tagging_status.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace tool_objectfs\check;
+
+use core\check\check;
+use core\check\result;
+use tool_objectfs\local\tag\tag_manager;
+
+class tagging_status extends check {
+	// TODO action link.
+
+	public function get_result(): result {
+		if(!tag_manager::is_tagging_enabled_and_supported()) {
+			return new result(result::NA, 'Not enabled or supported by fs'); // TODO lang. 
+		}
+
+		// Do a tag set test.
+        $config = \tool_objectfs\local\manager::get_objectfs_config();
+        $client = \tool_objectfs\local\manager::get_client($config);
+		$result = $client->test_set_object_tag();
+
+		if ($result->success) {
+			// TODO lang.
+			return new result(result::OK, 'tagging success', $result->details);
+		} else {
+			// TODO lang.
+			return new result(result::ERROR, 'tagging failed', $result->details);
+		}
+	}
+}

classes/local/manager.php

@@ -64,7 +64,7 @@ public static function get_objectfs_config() {
         $config->batchsize = 10000;
         $config->useproxy = 0;
         $config->deleteexternal = 0;
-		$config->enabletagging = false;
+        $config->enabletagging = false;
 
         $config->filesystem = '';
         $config->enablepresignedurls = 0;

classes/local/store/s3/client.php

@@ -403,8 +403,9 @@ public function test_set_object_tag() {
 				'Body' => 'test content'
 			]);
 
-			// Next try to tag it.
-			$res = $this->client->putObjectTagging([
+		    // Next try to tag it - this will throw an exception if cannot set
+			// (for example, because it does not have permissions to).
+			$this->client->putObjectTagging([
 				'Bucket' => $this->bucket,
 				'Key' => $key,
 				'Tagging' => [

classes/local/tag/file_type_source.php

@@ -1,18 +1,63 @@
 <?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\local\tag;
 
+/**
+ * File type tag source.
+ * Provides tag values for files based on their 'type' - these are categories (not necessarily equivalent to fileareas)
+ * that make it possible to apply different permissions to. For example, move backups to a cheaper storage class but not general files.
+ *
+ * @package   tool_objectfs
+ * @author    Matthew Hilton <[email protected]>
+ * @copyright Catalyst IT
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 class file_type_source implements tag_source {
-	public const TYPE_STANDARD = 'standard';
+    /**
+     * @var string Unknown/uncategorised
+     */
+	public const TYPE_UNCATEGORISED = 'uncategorised';
 
-	public const TYPE_BACKUP = 'backup';
+    /**
+     * @var string A course backup
+     */
+	public const TYPE_COURSE_BACKUP = 'course_backup';
 
+    /**
+     * Identifier used in tagging file. Is the 'key' of the tag.
+     * @return string
+     */
 	public static function get_identifier(): string {
 		return 'type';
 	}
 
+    /**
+     * Returns the tag value for the given file contenthash
+     * @param string $contenthash
+     * @return string|null the category of the file, one of TYPE_*
+     */
 	public function get_value_for_contenthash(string $contenthash): ?string {
-		// TODO implement types e.g. is backup, etc..
-		return self::TYPE_STANDARD;
+        global $DB;
+        // TODO are there other unknown course backup files ?
+        $iscoursebackup = $DB->record_exists('files', ['contenthash' => $contenthash, 'component' => 'backup', 'filearea' => 'course']);
+        if ($iscoursebackup) {
+            return self::TYPE_COURSE_BACKUP;
+        }
+
+		return self::TYPE_UNCATEGORISED;
 	}
 }