Issue #18: Add support to add an icon to a CMS type.

jaypha · jaypha · commit 05813c7d5493 · 2023-11-30T12:23:33.000+11:00
- Add ability to edit an icon file in CMS edit form
- Display icon on activity list.
- Include icon in import and export.
- Include icon in cache key.
diff --git a/classes/form/cms_types_form.php b/classes/form/cms_types_form.php
@@ -27,6 +27,7 @@
 use core\form\persistent as persistent_form;
 use mod_cms\local\datasource\base as dsbase;
 use mod_cms\local\renderer;
+use mod_cms\local\model\cms_types;
 
 /**
  * Form for manipulating the content types
@@ -39,7 +40,7 @@
 class cms_types_form extends persistent_form {
 
     /** The maximum amount of files allowed. */
-    const MAX_FILES = 50;
+    const MAX_FILES = 1;
 
     /** @var string Persistent class name. */
     protected static $persistentclass = 'mod_cms\\local\\model\\cms_types';
@@ -90,6 +91,22 @@ protected function definition() {
         $helptext .= \html_writer::tag('pre', implode(PHP_EOL, $renderer->get_variable_list()));
         $mform->addElement('static', 'mustache_help', '', $helptext);
 
+        $mform->addElement('static', 'iconfile_desc', get_string('icon'),
+            get_string('cms_type:icon_desc', 'mod_cms'));
+        $mform->addElement(
+            'filemanager',
+            'iconfile',
+            null,
+            null,
+            [
+                'subdirs' => 0,
+                'maxbytes' => $CFG->maxbytes,
+                'maxfiles' => 1,
+                'accepted_types' => ['web_image'],
+                'return_types' => FILE_INTERNAL | FILE_EXTERNAL,
+            ]
+        );
+
         // Add form elements for data sources.
         foreach (dsbase::get_datasources($cmstype) as $ds) {
             $ds->config_form_definition($mform);
@@ -154,6 +171,8 @@ public function add_action_buttons($cancel = true, $submitlabel=null) {
      * @return \stdClass
      */
     protected function get_default_data() {
+        global $CFG;
+
         $data = parent::get_default_data();
 
         if (is_string($data->datasources)) {
@@ -164,6 +183,23 @@ protected function get_default_data() {
             }
         }
 
+        // Set up a draft area for managing the type icon file.
+        $draftitemid = file_get_submitted_draft_itemid(cms_types::ICON_FILE_AREA);
+
+        file_prepare_draft_area(
+            $draftitemid,
+            \context_system::instance()->id,
+            'mod_cms',
+            cms_types::ICON_FILE_AREA,
+            $data->id,
+            [
+                'subdirs' => 0,
+                'maxbytes' => $CFG->maxbytes,
+                'maxfiles' => self::MAX_FILES,
+            ]
+        );
+        $data->iconfile = $draftitemid;
+
         // Get default data for data sources.
         foreach (dsbase::get_datasources($this->get_persistent()) as $ds) {
             $ds->config_form_default_data($data);
diff --git a/classes/local/lib.php b/classes/local/lib.php
@@ -18,6 +18,7 @@
 
 use core_course\local\entity\{content_item, string_title};
 use mod_cms\local\datasource\base as dsbase;
+use mod_cms\local\datasource\images as dsimages;
 use mod_cms\local\model\{cms, cms_types};
 
 
@@ -64,13 +65,19 @@ public static function get_course_content_items(content_item $defaultmoduleconte
         }
         $types = cms_types::get_records($filter);
         foreach ($types as $type) {
+            $iconurl = $type->get_type_icon();
+            if (!is_null($iconurl)) {
+                $icon = \html_writer::empty_tag('img', ['src' => $iconurl->out(), 'alt' => $type->get('name'), 'class' => 'icon']);
+            } else {
+                $icon = $defaultmodulecontentitem->get_icon();
+            }
             $linkurl->param('typeid', $type->get('id'));
             $items[] = new content_item(
                 $type->get('id'),
                 $defaultmodulecontentitem->get_name(),
                 new string_title($type->get('name')),
                 clone($linkurl),
-                $defaultmodulecontentitem->get_icon(),
+                $icon,
                 $type->get('description'),
                 $defaultmodulecontentitem->get_archetype(),
                 $defaultmodulecontentitem->get_component_name(),
@@ -204,7 +211,7 @@ public static function cm_info_view(\cm_info $cminfo) {
      */
     public static function pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, $options = []) {
         // Make sure the filearea is one of those used by the plugin.
-        if ($filearea !== 'cms_type_images') {
+        if (!in_array($filearea, [dsimages::FILE_AREA, cms_types::ICON_FILE_AREA])) {
             return false;
         }
 
diff --git a/classes/local/model/cms_types.php b/classes/local/model/cms_types.php
@@ -50,6 +50,9 @@ class cms_types extends persistent {
      */
     const TABLE = 'cms_types';
 
+    /** File area name used for storing images. */
+    const ICON_FILE_AREA = 'cms_types_icon';
+
     /**
      * Return the definition of the properties of this model.
      *
@@ -143,6 +146,52 @@ public function get_custom_data(string $name) {
         return $cdata->$name ?? null;
     }
 
+    /**
+     * Get the metadata for the icon, or null if no icon is stored.
+     *
+     * @return \stored_file|null
+     */
+    public function get_icon_metadata(): ?\stored_file {
+        $fs = get_file_storage();
+        $files = $fs->get_area_files(
+            \context_system::instance()->id,
+            'mod_cms',
+            self::ICON_FILE_AREA,
+            $this->get('id')
+        );
+        // There should be 0 or 1 files. We ignore the directory (.) entry.
+        foreach ($files as $file) {
+            if ($file->get_filename() !== '.') {
+                return $file;
+            }
+        }
+        return null;
+    }
+
+    /**
+     * Gets the URL for the type icon.
+     *
+     * @return \moodle_url|null
+     */
+    public function get_type_icon(): ?\moodle_url {
+        $file = $this->get_icon_metadata();
+
+        $url = null;
+        // There should only be at most one entry in the array.
+        if (!is_null($file)) {
+            $filename = $file->get_filename();
+            $url = \moodle_url::make_pluginfile_url(
+                \context_system::instance()->id,
+                'mod_cms',
+                self::ICON_FILE_AREA,
+                $this->get('id'),
+                '/',
+                $filename
+            );
+        }
+        return $url;
+    }
+
     /**
      * Validates idnumber parameter.
      *
@@ -261,6 +310,19 @@ public function get_for_export(): \stdClass {
         }
         unset($export->customdata);
 
+        $file = $this->get_icon_metadata();
+
+        // There should be at most one file.
+        if (!is_null($file)) {
+            $filename = $file->get_filename();
+            $obj = new \stdClass();
+            $obj->filename = $filename;
+            $obj->filesize = $file->get_filesize();
+            $obj->mimetype = $file->get_mimetype();
+            $obj->content = base64_encode($file->get_content());
+            $export->icon = $obj;
+        }
+
         $export->datasourcedefs = new \stdClass();
         foreach (dsbase::get_datasources($this) as $ds) {
             $name = $ds::get_shortname();
@@ -287,6 +349,20 @@ public function set_from_import(\stdClass $data) {
 
         $this->create();
 
+        if (isset($data->icon)) {
+            $fs = get_file_storage();
+            $filerecord = [
+                'component' => 'mod_cms',
+                'filearea' => self::ICON_FILE_AREA,
+                'itemid' => $this->get('id'),
+                'filename' => $data->icon->filename,
+                'filepath' => '/',
+                'contextid' => \context_system::instance()->id,
+                'mimetype' => $data->icon->mimetype,
+            ];
+            $fs->create_file_from_string($filerecord, base64_decode($data->icon->content));
+        }
+
         foreach ($data->datasourcedefs as $name => $data) {
             $ds = dsbase::get_datasource($name, $this);
             $ds->set_from_import($data);
@@ -301,7 +377,16 @@ public function set_from_import(\stdClass $data) {
      * @return string|null
      */
     public function get_cache_key(): ?string {
-        return hash(lib::HASH_ALGO, serialize($this->to_record()));
+        $data = $this->to_record();
+
+        $file = $this->get_icon_metadata();
+        if (!is_null($file)) {
+            $data->filename = $file->get_filename();
+            $data->filesize = $file->get_filesize();
+            $data->mimetype = $file->get_mimetype();
+        }
+
+        return hash(lib::HASH_ALGO, serialize($data));
     }
 
     /**
diff --git a/classes/local/renderer.php b/classes/local/renderer.php
@@ -52,6 +52,10 @@ public function __construct($cms) {
     public function get_data(): \stdClass {
         $data = new \stdClass();
         $data->name = $this->cms->get('name');
+        $data->icon = $this->cms->get_type()->get_type_icon();
+        if ($data->icon instanceof \moodle_url) {
+            $data->icon = $data->icon->out();
+        }
 
         foreach (dsbase::get_datasources($this->cms) as $ds) {
             $name = $ds::get_shortname();
diff --git a/classes/local/table/content_types_list.php b/classes/local/table/content_types_list.php
@@ -66,12 +66,14 @@ public function __construct(?int $id = null) {
 
         // Column definition.
         $this->define_columns([
+            'icon',
             'name',
             'numinstances',
             'actions',
         ]);
 
         $this->define_headers([
+            '',
             get_string('table:name', 'mod_cms'),
             get_string('table:numinstances', 'mod_cms'),
             get_string('actions'),
@@ -82,6 +84,21 @@ public function __construct(?int $id = null) {
         $this->setup();
     }
 
+    /**
+     * Display icon, if any.
+     *
+     * @param cms_types $type
+     *
+     * @return string
+     */
+    protected function col_icon(cms_types $type): string {
+        $iconurl = $type->get_type_icon();
+        if (is_null($iconurl)) {
+            return '';
+        }
+        return \html_writer::empty_tag('img', ['src' => $iconurl->out(), 'alt' => $type->get('name'), 'class' => 'icon']);
+    }
+
     /**
      * Display name column.
      *
diff --git a/classes/manage_content_types.php b/classes/manage_content_types.php
@@ -240,7 +240,7 @@ public static function get_base_url(): string {
      * @param int|null $id   If no ID is provided, that means we are creating a new one
      */
     protected function edit(string $action, ?int $id = null): void {
-        global $PAGE;
+        global $CFG, $PAGE;
 
         $PAGE->set_url(new \moodle_url(self::get_base_url(), ['action' => $action, 'id' => $id]));
         $instance = null;
@@ -261,9 +261,25 @@ protected function edit(string $action, ?int $id = null): void {
                 // Create new.
                 if (empty($data->id)) {
                     $instance = $this->create($data);
+                    $id = $instance->get('id');
                 } else { // Update existing.
                     $this->update($id, $data);
                 }
+
+                // Save the icon file.
+                file_save_draft_area_files(
+                    $data->iconfile,
+                    \context_system::instance()->id,
+                    'mod_cms',
+                    cms_types::ICON_FILE_AREA,
+                    $id,
+                    [
+                        'subdirs' => 0,
+                        'maxbytes' => $CFG->maxbytes,
+                        'maxfiles' => cms_types_form::MAX_FILES,
+                    ]
+                );
+
                 \core\notification::success(get_string('changessaved'));
             } catch (\Throwable $e) {
                 \core\notification::error($e->getMessage());
diff --git a/lang/en/cms.php b/lang/en/cms.php
@@ -72,6 +72,7 @@
 $string['mustache'] = 'Content';
 $string['mustache_help'] = 'The two fields above will form the content displayed in the activity. They both will need to be valid {$a}. Variables that are available for use in these templates are given below.';
 $string['mustache_template'] = 'mustache templates';
+$string['cms_type:icon_desc'] = 'This icon will be displayed in the activity chooser menu.';
 
 // Event strings.
 $string['event:cms_type_created'] = 'Custom content type created';
diff --git a/tests/cms_types_test.php b/tests/cms_types_test.php
@@ -19,6 +19,10 @@
 use mod_cms\form\cms_types_form;
 use mod_cms\local\model\cms_types;
 
+defined('MOODLE_INTERNAL') || die();
+
+require_once(__DIR__ . '/fixtures/test_import1_trait.php');
+
 /**
  * Unit tests for cms_types.
  *
@@ -28,6 +32,9 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class cms_types_test extends \advanced_testcase {
+    /** Test data for import/export. */
+    public const IMPORT_DATAFILE = __DIR__ . '/fixtures/type_data.json';
+
     /**
      * Set up before each test
      */
@@ -117,4 +124,33 @@ public function idnumber_validity_datasource(): array {
             ['test-exists', false],
         ];
     }
+
+    /**
+     * Tests the import/export functions.
+     *
+     * @covers \mod_cms\local\model\cms_types::get_for_export
+     * @covers \mod_cms\local\model\cms_types::get_from_import
+     * @covers \mod_cms\local\model\cms_types::get_cache_key
+     * @covers \mod_cms\local\model\cms_types::get_icon_metadata
+     */
+    public function test_import() {
+        $importdata = json_decode(file_get_contents(self::IMPORT_DATAFILE));
+        $cmstype = new cms_types();
+        $cmstype->set_from_import($importdata);
+        $cachekey = $cmstype->get_cache_key();
+        $exportdata = $cmstype->get_for_export();
+
+        $this->assertNotNull($cmstype->get_icon_metadata());
+        $this->assertEquals($importdata, $exportdata);
+
+        unset($importdata->icon);
+        $importdata->idnumber = 'diffname';
+        $cmstype = new cms_types();
+        $cmstype->set_from_import($importdata);
+        $exportdata = $cmstype->get_for_export();
+
+        $this->assertNull($cmstype->get_icon_metadata());
+        $this->assertNotEquals($cachekey,  $cmstype->get_cache_key());
+        $this->assertEquals($importdata, $exportdata);
+    }
 }
diff --git a/tests/fixtures/type_data.json b/tests/fixtures/type_data.json
@@ -0,0 +1,17 @@
+{
+  "name": "Some name",
+  "idnumber": "somename",
+  "description": "",
+  "descriptionformat": 1,
+  "title_mustache": "title",
+  "mustache": "{{debug}}",
+  "datasources": [""],
+  "isvisible": true,
+  "icon":  {
+    "filename": "x.png",
+    "filesize": "196",
+    "mimetype": "image\/png",
+    "content": "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAICAYAAADED76LAAAAAXNSR0IArs4c6QAAAH5JREFUKFOFz6ENwmAQhuGnCYIBcAzAAiWwAoqEiqZLYElFJYJRMCxQA0EicYyAQpEKBLmk4k9Dwrm7732T7zJ\/JkvyAk9cUyeAMQ5444y4rfDBPpY1lqh7s8EDc9wC2GCB3aDOFqMApr39wh0XzFDhmJYskWOCDi1OKfDz4S\/mihIlTY5RLwAAAABJRU5ErkJggg=="
+  },
+  "datasourcedefs": {}
+}
diff --git a/version.php b/version.php
