Issue #68: CMS name is derived from the CMS type config

Author: jaypha

classes/form/cms_types_form.php

@@ -61,6 +61,11 @@ protected function definition() {
 
         $this->add_datasource_select_element();
 
+        $mform->addElement('header', 'instance_heading', get_string('instance:header', 'mod_cms'));
+
+        $mform->addElement('text', 'title_mustache', get_string('instance:name', 'mod_cms'));
+        $mform->addRule('title_mustache', get_string('required'), 'required', null, 'client');
+
         $mform->addElement(
             'textarea',
             'mustache',
@@ -92,6 +97,25 @@ protected function definition() {
         $this->add_action_buttons();
     }
 
+    /**
+     * Extra validataion on the data.
+     *
+     * @param \stdClass $data
+     * @param array $files
+     * @param array $errors
+     * @return array
+     */
+    public function extra_validation($data, $files, array &$errors) {
+        $errors = parent::extra_validation($data, $files, $errors);
+
+        $valid = renderer::validate_template($data->title_mustache);
+        if ($valid !== true) {
+            $errors['title_mustache'] = $valid;
+        }
+
+        return $errors;
+    }
+
     /**
      * Put together the datasource selection mechanism using checkboxes.
      */

classes/local/datasource/roles.php

@@ -45,6 +45,8 @@ public static function get_displayname(): string {
      * @return \stdClass
      */
     public function get_data(): \stdClass {
+        global $CFG;
+
         $data = new \stdClass();
 
         $showuser = 'all'; // List user under each first role.
@@ -86,6 +88,8 @@ public function get_data(): \stdClass {
                 (object) ['shortname' => 'editingteacher', 'name' => '', 'coursealias' => ''],
             ];
         } else {
+            require_once($CFG->dirroot .'/user/lib.php');
+
             $context = \context_course::instance($this->cms->get('course'));
 
             $rolesincontext = get_all_roles($context);

classes/local/lib.php

@@ -90,17 +90,21 @@ public static function get_course_content_items(content_item $defaultmoduleconte
      */
     public static function add_instance(\stdClass $instancedata, $mform = null): int {
         $cms = new cms();
-        $cms->set('name', $instancedata->name);
         $cms->set('typeid', $instancedata->typeid);
         $cms->set('intro', '');
         $cms->set('course', $instancedata->course);
+        $cms->set('name', '');
         $cms->save();
 
         $instancedata->id = $cms->get('id');
         foreach (dsbase::get_datasources($cms) as $ds) {
             $ds->update_instance($instancedata, true);
         }
 
+        $renderer = new renderer($cms);
+        $cms->set('name', $renderer->get_name());
+        $cms->save();
+
         return $cms->get('id');
     }
 
@@ -114,20 +118,37 @@ public static function add_instance(\stdClass $instancedata, $mform = null): int
     public static function update_instance(\stdClass $instancedata, $mform): bool {
         $cm = get_coursemodule_from_id('cms', $instancedata->coursemodule, 0, false, MUST_EXIST);
         $cms = new cms($cm->instance);
-        $cms->set('name', $instancedata->name);
         $cms->set('typeid', $instancedata->typeid);
         $cms->set('intro', '');
         $cms->set('course', $instancedata->course);
-        $cms->save();
 
         $instancedata->id = $cm->instance;
         foreach (dsbase::get_datasources($cms) as $ds) {
             $ds->update_instance($instancedata, false);
         }
 
+        $renderer = new renderer($cms);
+        $cms->set('name', $renderer->get_name());
+        $cms->save();
+
         return true;
     }
 
+    /**
+     * Rest the name field of cms instances.
+     *
+     * @param int $typeid
+     * @throws \coding_exception
+     */
+    public static function reset_cms_names(int $typeid) {
+        $records = cms::get_records(['typeid' => $typeid]);
+        foreach ($records as $cms) {
+            $renderer = new renderer($cms);
+            $cms->set('name', $renderer->get_name());
+            $cms->save();
+        }
+    }
+
     /**
      * Removes an instance of an activity.
      *

classes/local/model/cms_types.php

@@ -67,6 +67,10 @@ protected static function define_properties(): array {
                 'type' => PARAM_INT,
                 'default' => 1
             ],
+            'title_mustache' => [
+                'type' => PARAM_TEXT,
+                'default' => ''
+            ],
             'mustache' => [
                 'type' => PARAM_RAW,
                 'default' => '{{{debug}}}'

classes/local/renderer.php

@@ -50,8 +50,6 @@ public function __construct($cms) {
      * @return \stdClass
      */
     public function get_data(): \stdClass {
-        global $CFG, $SITE;
-
         $data = new \stdClass();
         $data->name = $this->cms->get('name');
 
@@ -127,6 +125,28 @@ public function get_html(): string {
         return $content;
     }
 
+    /**
+     * Renders the template label with the data and returns the result.
+     *
+     * @return string
+     */
+    public function get_name(): string {
+        $labelcache = \cache::make('mod_cms', 'cms_name');
+
+        $labelhash = $this->cms->get_content_hash();
+        $label = $labelcache->get($labelhash);
+
+        if ($label === false) {
+            $data = $this->get_data();
+            $mustache = self::get_mustache();
+            $template = $this->cms->get_type()->get('title_mustache');
+            $label = $mustache->render($template, $data);
+            $labelcache->set($labelhash, $label);
+        }
+
+        return $label;
+    }
+
     /**
      * Get a Mustache engine suitable for use with this renderer.
      *
@@ -139,4 +159,20 @@ public static function get_mustache(): \Mustache_Engine {
         ]);
         return $mustache;
     }
+
+    /**
+     * Test the mustaceh template to see ifi it is valid.
+     *
+     * @param string $template
+     * @return bool|string Returns true if no error occurred or an error message.
+     */
+    public static function validate_template(string $template) {
+        $engine = self::get_mustache();
+        try {
+            $engine->render($template);
+            return true;
+        } catch (\Throwable $e) {
+            return $e->getMessage();
+        }
+    }
 }

classes/manage_content_types.php

@@ -20,6 +20,7 @@
 use mod_cms\form\cms_types_form;
 use mod_cms\form\cms_types_import_form;
 use mod_cms\local\datasource\base as dsbase;
+use mod_cms\local\lib;
 use mod_cms\local\model\cms_types;
 use mod_cms\local\table\content_types_list;
 
@@ -353,6 +354,7 @@ public function update(int $id, \stdClass $data) {
         $cleandata = cms_types::clean_record($data);
         $instance->from_record($cleandata);
         $instance->update();
+        lib::reset_cms_names($id);
 
         // Do post update actions for data sources.
         foreach (dsbase::get_datasources($instance) as $ds) {

db/caches.php

@@ -32,4 +32,11 @@
         'staticacceleration' => false,
         'canuselocalstore' => true,
     ],
+    'cms_name' => [
+        'mode' => cache_store::MODE_APPLICATION,
+        'simplekeys' => true,
+        'simpledata' => true,
+        'staticacceleration' => false,
+        'canuselocalstore' => true,
+    ],
 ];

db/install.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<XMLDB PATH="mod/cms/db" VERSION="20230524" COMMENT="XMLDB file for mod_cms."
+<XMLDB PATH="mod/cms/db" VERSION="20230809" COMMENT="XMLDB file for mod_cms."
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="../../../lib/xmldb/xmldb.xsd"
 >
@@ -29,6 +29,7 @@
         <FIELD NAME="description" TYPE="text" NOTNULL="false" SEQUENCE="false" COMMENT="Description of the custom content type."/>
         <FIELD NAME="descriptionformat" TYPE="int" LENGTH="4" NOTNULL="false" DEFAULT="0" SEQUENCE="false" COMMENT="The format of the description field of the custom content type."/>
         <FIELD NAME="datasources" TYPE="text" NOTNULL="false" SEQUENCE="false" COMMENT="Datasources used by this cms type, comma separated."/>
+        <FIELD NAME="title_mustache" TYPE="text" NOTNULL="false" SEQUENCE="false" COMMENT="The name of this custom content type instance."/>
         <FIELD NAME="mustache" TYPE="text" NOTNULL="false" SEQUENCE="false" COMMENT="Mustache template for the content."/>
         <FIELD NAME="customdata" TYPE="text" NOTNULL="false" SEQUENCE="false" COMMENT="Custom data, in JSON format."/>
         <FIELD NAME="isvisible" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="1" SEQUENCE="false" COMMENT="Is this visible in the activity list."/>

db/upgrade.php

@@ -148,5 +148,24 @@ function xmldb_cms_upgrade($oldversion) {
         upgrade_mod_savepoint(true, 2023080400, 'cms');
     }
 
+    if ($oldversion < 2023080900) {
+        $table = new xmldb_table('cms_types');
+        $field = new xmldb_field('title_mustache', XMLDB_TYPE_TEXT, null, null, false, null, null, 'datasources');
+
+        // Conditionally launch add field.
+        if (!$dbman->field_exists($table, $field)) {
+            $dbman->add_field($table, $field);
+        }
+
+        upgrade_mod_savepoint(true, 2023080900, 'cms');
+    }
+
+    if ($oldversion < 2023081401) {
+        // Make sure title_mustache is set to something by default.
+        $DB->execute("UPDATE {cms_types} SET title_mustache = name WHERE title_mustache='' OR title_mustache IS NULL");
+
+        upgrade_mod_savepoint(true, 2023081401, 'cms');
+    }
+
     return true;
 }

lang/en/cms.php

@@ -41,9 +41,6 @@
 $string['settings'] = 'Custom content type settings';
 $string['table:name'] = 'Custom content type';
 $string['pluginadministration'] = 'Plugin administration';
-$string['mustache'] = 'Mustache template';
-$string['mustache_help'] = 'The above content will need to be a valid {$a}. Sample variables that are available for use in this template are given below.';
-$string['mustache_template'] = 'mustache template';
 $string['preview'] = 'Preview (click "{$a}" to update)';
 $string['customfield_manage_heading'] = 'Manage custom fields for content type "{$a}"';
 $string['manage_types_return'] = 'Return to manage types';
@@ -58,6 +55,13 @@
 $string['cachedef_cms_content'] = 'CMS content';
 $string['visibility_updated'] = 'Visibility updated';
 
+// Template form section.
+$string['instance:header'] = 'Activity fields';
+$string['instance:name'] = 'Name';
+$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}. Sample variables that are available for use in these templates are given below.';
+$string['mustache_template'] = 'mustache templates';
+
 // Event strings.
 $string['event:cms_type_created'] = 'Custom content type created';
 $string['event_cms_type_created_desc'] = 'The user with ID: {$a->userid} has created a custom content type with ID: {$a->typeid}';

mod_form.php

@@ -64,16 +64,10 @@ public function __construct($current, $section, $cm, $course) {
     protected function definition() {
         $mform = $this->_form;
 
-        // Adding the standard "name" field.
-        $mform->addElement('text', 'name', get_string('name'), array('size' => '64'));
-        $mform->setType('name', PARAM_TEXT);
-        $mform->addRule('name', null, 'required', null, 'client');
-        $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
-
         $mform->addElement('hidden', 'typeid', $this->typeid);
         $mform->setType('typeid', PARAM_INT);
 
-        // Add form elements for datas ources.
+        // Add form elements for data sources.
         foreach (dsbase::get_datasources($this->cms) as $ds) {
             $ds->instance_form_definition($this, $mform);
         }

tests/cms_instance_test.php

@@ -65,7 +65,7 @@ public function test_add_instance() {
         $this->assertEquals(1, $count);
 
         $cms = new cms($cmsid);
-        $this->assertEquals('Some module', $cms->get('name'));
+        $this->assertEquals('Field A', $cms->get('name'));
         $this->assertEquals($cmstype->get('id'), $cms->get('typeid'));
 
         $ds = new dsfields($cms);
@@ -93,12 +93,13 @@ public function test_update_instance() {
         $cmsid = $moduleinfo->instance;
 
         // Modify some fields and update.
-        $moduleinfo->name = 'New name';
+        $cmstype->set('title_mustache', '{{fields.bfield}}');
+        $cmstype->save();
         $moduleinfo->customfield_bfield = 'Field B';
         update_module($moduleinfo);
 
         $cms = new cms($cmsid);
-        $this->assertEquals('New name', $cms->get('name'));
+        $this->assertEquals('Field B', $cms->get('name'));
         $this->assertEquals($cmstype->get('id'), $cms->get('typeid'));
 
         $ds = new dsfields($cms);