Merge pull request #114 from catalyst/113-userlist-regression-fix

Issue #113: Fix regression caused by previous commit.

Author: marcusboon

classes/local/datasource/base.php

@@ -388,7 +388,7 @@ public function get_config_cache_key(): ?string {
         // By default, all stored configs are expected to have a stored hash to be used as a key. If one is not stored, then an
         // exception will be thrown.
         // If a datasource doesn't use caching (either returning '' or null), then this method should be overridden.
-        $key = $cmstype->get_custom_data(self::get_shortname() . 'confighash');
+        $key = $cmstype->get_custom_data(static::get_shortname() . 'confighash');
         // We expect there to be something, so false, null, '', and 0 are all illigit.
         if (empty($key)) {
             throw new \moodle_exception('error:no_config_hash', 'mod_cms', '', $this->cms->get('id'));
@@ -405,7 +405,7 @@ public function update_config_cache_key() {
         $hash = hash(lib::HASH_ALGO, serialize($this->get_for_export()));
         // The config hash is stored with the CMS type.
         $cmstype = $this->cms->get_type();
-        $cmstype->set_custom_data(self::get_shortname() . 'confighash', $hash);
+        $cmstype->set_custom_data(static::get_shortname() . 'confighash', $hash);
         $cmstype->save();
     }
 

classes/local/datasource/userlist.php

@@ -50,15 +50,6 @@ class userlist extends base_mod_cms {
     /** @var cmsuserlist_handler Custom field handler. */
     protected $cfhandler;
 
-    /**
-     * The short name of the datasource type. Must be unique.
-     *
-     * @return string
-     */
-    public static function get_shortname(): string {
-        return 'list';
-    }
-
     /**
      * Get the display name.
      *

db/upgrade.php

@@ -299,5 +299,47 @@ function xmldb_cms_upgrade($oldversion) {
         upgrade_mod_savepoint(true, 2023111500, 'cms');
     }
 
+    if ($oldversion < 2023112100) {
+        // Update CMS types settings to upgrade list to userlist.
+        $like = $DB->sql_like('datasources', ':list');
+        $records = cms_types::get_records_select($like, ['list' => '%list%']);
+        foreach ($records as $record) {
+            $datasources = $record->get('datasources');
+            // Remove list.
+            $datasources = array_filter($datasources, function ($i) {
+                return $i !== 'list';
+            });
+            // Add userlist.
+            $datasources[] = 'userlist';
+            $record->set('datasources', $datasources);
+            // Convert config hash name.
+            $hash = $record->get_custom_data('listconfighash');
+            if ($hash !== null) {
+                $record->set_custom_data('listconfighash', null);
+                $record->set_custom_data('userlistconfighash', $hash);
+            }
+            $record->save();
+        }
+
+        // Update CMS instances.
+        $like = $DB->sql_like('datasources', ':userlist');
+        $cmstypeids = $DB->get_records_select_menu('cms_types', $like, ['userlist' => '%userlist%'], '', 'id,name');
+        if (count($cmstypeids) !== 0) {
+            [$insql, $inparams] = $DB->get_in_or_equal(array_keys($cmstypeids));
+            $records = cms::get_records_select("typeid $insql", $inparams);
+            foreach ($records as $record) {
+                // Convert config hash name.
+                $hash = $record->get_custom_data('listinstancehash');
+                if ($hash !== null) {
+                    $record->set_custom_data('listinstancehash', null);
+                    $record->set_custom_data('userlistinstancehash', $hash);
+                    $record->save();
+                }
+            }
+        }
+
+        upgrade_mod_savepoint(true, 2023112100, 'cms');
+    }
+
     return true;
 }

tests/datasource_userlist_test.php

@@ -50,7 +50,7 @@ protected function setUp(): void {
      * @covers \mod_cms\local\datasource\userlist::get_shortname
      */
     public function test_name() {
-        $this->assertEquals('list', dsuserlist::get_shortname());
+        $this->assertEquals('userlist', dsuserlist::get_shortname());
     }
 
     /**
@@ -91,7 +91,7 @@ public function test_import() {
         $cmstype = $manager->create((object) [
             'name' => 'name',
             'idnumber' => 'test-name',
-            'datasources' => 'list',
+            'datasources' => 'userlist',
         ]);
 
         $cms = $cmstype->get_sample_cms();
@@ -150,7 +150,7 @@ public function test_config_delete() {
         global $DB;
 
         $manager = new manage_content_types();
-        $cmstype = $manager->create((object) ['name' => 'Name', 'idnumber' => 'test-name', 'datasources' => 'list']);
+        $cmstype = $manager->create((object) ['name' => 'Name', 'idnumber' => 'test-name', 'datasources' => 'userlist']);
 
         // Test that stuff gets deleted even if not included in datasource list.
         $cmstype->set('datasources', []);
@@ -207,7 +207,6 @@ public function test_instance_delete() {
      */
     public function test_instance_form_validataion() {
         $cmstype = $this->import();
-        $cmstype->set('datasources', ['userlist']);
         $cmstype->save();
 
         $cms = new cms();
@@ -236,7 +235,6 @@ public function test_instance_form_validataion() {
      */
     public function test_update_instance() {
         $cmstype = $this->import();
-        $cmstype->set('datasources', ['userlist']);
         $cmstype->save();
 
         $cms = new cms();

tests/fixtures/test_import_1.yml

@@ -7,7 +7,7 @@ mustache: ''
 datasources:
   - fields
   - images
-  - list
+  - userlist
 datasourcedefs:
   fields:
     categories:
@@ -29,7 +29,7 @@ datasourcedefs:
         filesize: '196'
         mimetype: image/png
         content: iVBORw0KGgoAAAANSUhEUgAAAAgAAAAICAYAAADED76LAAAAAXNSR0IArs4c6QAAAH5JREFUKFOFz6ENwmAQhuGnCYIBcAzAAiWwAoqEiqZLYElFJYJRMCxQA0EicYyAQpEKBLmk4k9Dwrm7732T7zJ/JkvyAk9cUyeAMQ5444y4rfDBPpY1lqh7s8EDc9wC2GCB3aDOFqMApr39wh0XzFDhmJYskWOCDi1OKfDz4S/mihIlTY5RLwAAAABJRU5ErkJggg==
-  list:
+  userlist:
     columns:
       -
         name: Name

tests/renderer_test.php

@@ -53,7 +53,7 @@ public function test_get_data() {
         $cmstype = $manager->create((object) [
             'name' => 'somename',
             'idnumber' => 'test-somename',
-            'datasources' => 'fields,images,roles,list',
+            'datasources' => 'fields,images,roles,userlist',
         ]);
 
         $cms = $cmstype->get_sample_cms();

version.php

@@ -25,7 +25,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version = 2023111500;
+$plugin->version = 2023112100;
 $plugin->requires = 2020061500; // Moodle 3.9.0 and above.
 $plugin->supported = [39, 401]; // Moodle 3.9 to 4.1 inclusive.
 $plugin->component = 'mod_cms';