Issue #93: Add support for customfield backup/restore

Author: jaypha

README.md

@@ -16,7 +16,7 @@ Using git submodule:
 git submodule add [email protected]:catalyst/moodle-mod_cms.git mod/cms
 ```
 
-OR you can download as a zip from github
+Or you can download as a zip from github
 
 https://github.com/catalyst/moodle-mod_cms/archive/refs/heads/main.zip
 

classes/customfield/cmsfield_handler.php

@@ -32,7 +32,7 @@ class cmsfield_handler extends handler {
     use cms_restore;
 
     /**
-     * Context that should be used for new categories created by this handler
+     * Context that should be used for new categories created by this handler.
      *
      * @return \context
      */
@@ -51,13 +51,18 @@ public function get_configuration_url(): \moodle_url {
     }
 
     /**
-     * Context that should be used for data stored for the given record
+     * Context that should be used for data stored for the given record.
+     * Uses the activity context.
      *
      * @param int $instanceid id of the instance or 0 if the instance is being created
      * @return \context
      */
     public function get_instance_context(int $instanceid = 0): \context {
-        return $this->get_configuration_context();
+        $modinfo = get_coursemodule_from_instance('cms', $instanceid);
+        if ($modinfo) {
+            return \context_module::instance($modinfo->id);
+        }
+        return \context_system::instance();
     }
 
     /**
@@ -70,11 +75,11 @@ public function can_configure(): bool {
     }
 
     /**
-     * The current user can edit given custom fields on the given instance
+     * The current user can edit given custom fields on the given instance.
      *
-     * Called to filter list of fields displayed on the instance edit form
+     * Called to filter list of fields displayed on the instance edit form.
      *
-     * Capability to edit/create instance is checked separately
+     * Capability to edit/create instance is checked separately.
      *
      * @param field_controller $field
      * @param int $instanceid id of the instance or 0 if the instance is being created
@@ -85,7 +90,7 @@ public function can_edit(field_controller $field, int $instanceid = 0): bool {
     }
 
     /**
-     * The current user can view the value of the custom field for a given custom field and instance
+     * The current user can view the value of the custom field for a given custom field and instance.
      *
      * Called to filter list of fields returned by methods get_instance_data(), get_instances_data(),
      * export_instance_data(), export_instance_data_object()

classes/customfield/cmsuserlist_handler.php

@@ -17,6 +17,7 @@
 namespace mod_cms\customfield;
 
 use core_customfield\{field_controller, handler};
+use mod_cms\local\model\cms;
 use mod_cms\local\model\cms_types;
 use mod_cms\local\datasource\userlist;
 
@@ -31,8 +32,11 @@
 class cmsuserlist_handler extends handler {
     use cms_restore;
 
+    /** @var cms The CMS for the fields. */
+    public $cms = null;
+
     /**
-     * Context that should be used for new categories created by this handler
+     * Context that should be used for new categories created by this handler.
      *
      * @return \context
      */
@@ -41,13 +45,20 @@ public function get_configuration_context(): \context {
     }
 
     /**
-     * Context that should be used for data stored for the given record
+     * Context that should be used for data stored for the given record.
+     * Uses the activity context.
      *
      * @param int $instanceid id of the instance or 0 if the instance is being created
      * @return \context
      */
     public function get_instance_context(int $instanceid = 0): \context {
-        return $this->get_configuration_context();
+        if (!is_null($this->cms)) {
+            $modinfo = get_coursemodule_from_instance('cms', $this->cms->get('id'));
+            if ($modinfo) {
+                return \context_module::instance($modinfo->id);
+            }
+        }
+        return \context_system::instance();
     }
 
     /**
@@ -78,11 +89,11 @@ public function can_configure(): bool {
     }
 
     /**
-     * The current user can edit given custom fields on the given instance
+     * The current user can edit given custom fields on the given instance.
      *
-     * Called to filter list of fields displayed on the instance edit form
+     * Called to filter list of fields displayed on the instance edit form.
      *
-     * Capability to edit/create instance is checked separately
+     * Capability to edit/create instance is checked separately.
      *
      * @param field_controller $field
      * @param int $instanceid id of the instance or 0 if the instance is being created
@@ -93,7 +104,7 @@ public function can_edit(field_controller $field, int $instanceid = 0): bool {
     }
 
     /**
-     * The current user can view the value of the custom field for a given custom field and instance
+     * The current user can view the value of the custom field for a given custom field and instance.
      *
      * Called to filter list of fields returned by methods get_instance_data(), get_instances_data(),
      * export_instance_data(), export_instance_data_object()

classes/local/datasource/fields.php

@@ -252,6 +252,10 @@ public function instance_backup_define_structure(\backup_nested_element $parent)
         $fields->add_child($field);
 
         $fieldsforbackup = $this->cfhandler->get_instance_data_for_backup($this->cms->get('id'));
+        // Backup annotations. Check for function existence for the sake of backward compatibility.
+        if (method_exists($this->cfhandler, 'backup_define_structure')) {
+            $this->cfhandler->backup_define_structure($this->cms->get('id'), $field);
+        }
         $field->set_source_array($fieldsforbackup);
     }
 

classes/local/datasource/restore/fields.php

@@ -55,7 +55,11 @@ public function process_restore_ds_fields(array $data) {
 
         // Add data to instance.
         $handler = cmsfield_handler::create($cms->get('typeid'));
-        $handler->cms_restore_instance_data_from_backup($this->stepslib->get_task(), $data, $cmsid);
+        $newid = $handler->cms_restore_instance_data_from_backup($this->stepslib->get_task(), $data, $cmsid);
+
+        if ($newid && method_exists($handler, 'restore_define_structure')) {
+            $handler->restore_define_structure($this->stepslib, $newid, $data['id']);
+        }
     }
 
     /**

classes/local/datasource/restore/userlist.php

@@ -80,7 +80,11 @@ public function process_restore_ds_userlist_field(array $data) {
         $cmsid = $this->stepslib->get_new_parentid('cms');
         $cms = new cms($cmsid);
         $handler = cmsuserlist_handler::create($cms->get('typeid'));
+        $handler->cms = $cms;
         $newid = $handler->cms_restore_instance_data_from_backup($this->stepslib->get_task(), $data, $rowid);
+        if ($newid && method_exists($handler, 'restore_define_structure')) {
+            $handler->restore_define_structure($this->stepslib, $newid, $data['id']);
+        }
 
         $this->stepslib->set_mapping('cms_userlist_field', $oldid, $newid, true, $handler->get_instance_context()->id);
     }

classes/local/datasource/userlist.php

@@ -67,6 +67,7 @@ public static function get_displayname(): string {
     public function __construct(cms $cms) {
         parent::__construct($cms);
         $this->cfhandler = cmsuserlist_handler::create($this->cms->get('typeid'));
+        $this->cfhandler->cms = $cms;
     }
 
     /**
@@ -541,6 +542,10 @@ function ($arr) {
                 )
             ];
             $fieldsforbackup = array_merge($fieldsforbackup, $this->cfhandler->get_instance_data_for_backup($id));
+            // Backup annotations. Check for function existence for the sake of backward compatibility.
+            if (method_exists($this->cfhandler, 'backup_define_structure')) {
+                $this->cfhandler->backup_define_structure($id, $field);
+            }
         }
         $row->set_source_array($instanceids);
         $field->set_source_array($fieldsforbackup);

classes/local/lib.php

@@ -96,14 +96,20 @@ public static function get_course_content_items(content_item $defaultmoduleconte
      * @return int The ID of the newly crated instance.
      */
     public static function add_instance(\stdClass $instancedata, $mform = null): int {
+        global $DB;
+
         $cms = new cms();
         $cms->set('typeid', $instancedata->typeid);
         $cms->set('intro', '');
         $cms->set('course', $instancedata->course);
         $cms->set('name', '');
         $cms->save();
-
         $instancedata->id = $cms->get('id');
+
+        // We must do this here before updating the datasources, otherwise customfield handler will not be able to find the right
+        // context.
+        $DB->set_field('course_modules', 'instance', $instancedata->id, ['id' => $instancedata->coursemodule]);
+
         foreach (dsbase::get_datasources($cms) as $ds) {
             $ds->update_instance($instancedata, true);
         }