Merge pull request #230 from catalyst/issue199-MOODLE_403_STABLE-custom-field-visibility

Issue #199: Custom field visibility (#213)

Author: golenkovm

classes/customfield_form.php

@@ -74,6 +74,18 @@ public function definition() {
         $mform->addElement('checkbox', 'showinsummary', get_string('setting:showinsummary', 'facetoface'));
         $mform->setDefault('showinsummary', true);
 
+        // Field data visibility.
+        $visibilityoptions = [
+                MDL_F2F_FIELD_VISIBLETOALL => get_string('customfield_visibletoall', 'facetoface'),
+                MDL_F2F_FIELD_VISIBLETOTEACHERS => get_string('customfield_visibletoteachers', 'facetoface'),
+                MDL_F2F_FIELD_NOTVISIBLE => get_string('customfield_notvisible', 'facetoface')
+        ];
+        $mform->addElement('select', 'visibleto',
+                get_string('customfield_visibility', 'facetoface'),
+                $visibilityoptions);
+        $mform->addHelpButton(
+                'visibleto', 'customfield_visibility', 'facetoface');
+
         $this->add_action_buttons();
     }
 

customfield.php

@@ -139,6 +139,7 @@
     $todb->required = $fromform->required;
     $todb->isfilter = $fromform->isfilter;
     $todb->showinsummary = $fromform->showinsummary;
+    $todb->visibleto = $fromform->visibleto;
 
     if ($field != null) {
         $todb->id = $field->id;
@@ -165,6 +166,7 @@
     $toform->required = ($field->required == 1);
     $toform->isfilter = ($field->isfilter == 1);
     $toform->showinsummary = ($field->showinsummary == 1);
+    $toform->visibleto = $field->visibleto;
 
     $mform->set_data($toform);
 }

db/install.xml

@@ -134,6 +134,7 @@
         <FIELD NAME="defaultvalue" TYPE="char" LENGTH="255" NOTNULL="false" SEQUENCE="false"/>
         <FIELD NAME="isfilter" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="1" SEQUENCE="false" COMMENT="Whether or not this field is a filter on the Training Calendar"/>
         <FIELD NAME="showinsummary" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="1" SEQUENCE="false" COMMENT="Whether or not to show this field in attendance exports and lists of sessions"/>
+        <FIELD NAME="visibleto" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="1" SEQUENCE="false" COMMENT="Whether or not to show this field in lists of sessions"/>
       </FIELDS>
       <KEYS>
         <KEY NAME="primary" TYPE="primary" FIELDS="id"/>

db/upgrade.php

@@ -859,5 +859,37 @@ function xmldb_facetoface_upgrade($oldversion=0) {
         upgrade_mod_savepoint(true, 2023100200, 'facetoface');
     }
 
+    if ($oldversion < 2025072400) {
+
+        // Define field visibleto to be added to facetoface_session_field
+        $table = new xmldb_table('facetoface_session_field');
+        $field = new xmldb_field(
+            'visibleto',
+            XMLDB_TYPE_INTEGER,
+            '1',
+            null,
+            XMLDB_NOTNULL,
+            null,
+            MDL_F2F_FIELD_VISIBLETOALL,
+            'showinsummary'
+        );
+
+        // Conditionally launch add field visibleto.
+        if (!$dbman->field_exists($table, $field)) {
+            $dbman->add_field($table, $field);
+
+            // Get all existing records and set visibleto based on showinsummary value.
+            $recordset = $DB->get_recordset('facetoface_session_field');
+            foreach ($recordset as $record) {
+                $record->visibleto = empty($record->showinsummary) ? MDL_F2F_FIELD_NOTVISIBLE : MDL_F2F_FIELD_VISIBLETOALL;
+                $DB->update_record('facetoface_session_field', $record);
+            }
+            $recordset->close;
+        }
+
+        // Face-to-face savepoint reached
+        upgrade_mod_savepoint(true, 2025072400, 'facetoface');
+    }
+
     return $result;
 }

lang/en/facetoface.php

@@ -575,7 +575,7 @@
 $string['setting:hidediscount_caption'] = 'Hide discount:';
 $string['setting:isfilter'] = 'Display as a filter';
 $string['setting:possiblevalues'] = 'List of possible values';
-$string['setting:showinsummary'] = 'Show in exports and lists';
+$string['setting:showinsummary'] = 'Show in exports';
 $string['setting:sessionroles'] = 'Users assigned to the selected roles in a course can be tracked with each Face-to-Face session';
 $string['setting:sessionroles_caption'] = 'Session roles:';
 $string['setting:type'] = 'Field type';
@@ -838,3 +838,8 @@
 $string['addtoallsessions'] = 'Add users to all (upcoming) sessions';
 $string['addtoallsessions_help'] = 'Use this option if you want to add users to all upcoming Face-to-Face sessions. When this uption is toggled, the selected users will be added to this session and all other future sessions in the activity.';
 $string['caseinsensitive'] = 'Case insensitive';
+$string['customfield_notvisible'] = 'Nobody';
+$string['customfield_visibility'] = 'Visible to';
+$string['customfield_visibility_help'] = 'This setting determines who can view the custom field name and value in the list sessions in the module page or when signing up for a session.';
+$string['customfield_visibletoall'] = 'Everyone';
+$string['customfield_visibletoteachers'] = 'Teachers';

lib.php

@@ -89,6 +89,10 @@
 define('MDL_F2F_STATUS_PARTIALLY_ATTENDED', 90);
 define('MDL_F2F_STATUS_FULLY_ATTENDED',     100);
 
+define('MDL_F2F_FIELD_VISIBLETOALL',      2);
+define('MDL_F2F_FIELD_VISIBLETOTEACHERS', 1);
+define('MDL_F2F_FIELD_NOTVISIBLE',        0);
+
 /**
  * Returns the list of possible facetoface status.
  * @return array $string Human readable code
@@ -3640,7 +3644,11 @@ function facetoface_print_session($session, $showcapacity, $calendaroutput=false
 
     $customfields = facetoface_get_session_customfields();
     $customdata = $DB->get_records('facetoface_session_data', ['sessionid' => $session->id], '', 'fieldid, data');
+    $editsessions = has_capability('mod/facetoface:editsessions', context_system::instance());
     foreach ($customfields as $field) {
+        if (!facetoface_can_view_field($field->visibleto, $editsessions)) {
+            continue;
+        }
         $data = '';
         if (!empty($customdata[$field->id])) {
             if (CUSTOMFIELD_TYPE_MULTISELECT == $field->type) {
@@ -4324,6 +4332,23 @@ function facetoface_cancellation_allowed(stdClass $session): bool {
     return $timenow <= ($sessionstart - $cancelrestriction);
 }
 
+/**
+ * The current user can view custom fields.
+ *
+ * @param int $visibility whether field can be seen by all, teachers, or none
+ * @param bool $editsessions id of the question to test edit permission
+ * @return bool true if the current user can view custom fields, false otherwise
+ */
+function facetoface_can_view_field(int $visibility, bool $editsessions): bool {
+    if ($visibility == MDL_F2F_FIELD_VISIBLETOALL) {
+        return true;
+    } else if ($visibility == MDL_F2F_FIELD_VISIBLETOTEACHERS) {
+        return $editsessions;
+    } else {
+        return false;
+    }
+}
+
 /*
  * facetoface assignment candidates
  */

renderer.php

@@ -45,7 +45,7 @@ public function print_session_list_table(
 
         $tableheader = [];
         foreach ($customfields as $field) {
-            if (!empty($field->showinsummary)) {
+            if (facetoface_can_view_field($field->visibleto, $editsessions)) {
                 $tableheader[] = format_string($field->name);
             }
         }
@@ -82,7 +82,7 @@ public function print_session_list_table(
             // Custom fields.
             $customdata = $session->customfielddata;
             foreach ($customfields as $field) {
-                if (empty($field->showinsummary)) {
+                if (!facetoface_can_view_field($field->visibleto, $editsessions)) {
                     continue;
                 }
 

tests/session_test.php

@@ -418,4 +418,160 @@ public function test_cancellation_allowed(
         $result = facetoface_cancellation_allowed($session);
         $this->assertEquals($expected, $result);
     }
+
+    /**
+     * Data provider for test_field_visibility
+     *
+     * @return array
+     */
+    public static function field_visibility_provider(): array {
+        return [
+            'visible to all, not teacher' => [
+                'visibility' => MDL_F2F_FIELD_VISIBLETOALL,
+                'isteacher' => false,
+                'expected' => true,
+            ],
+            'visible to all, is teacher' => [
+                'visibility' => MDL_F2F_FIELD_VISIBLETOALL,
+                'isteacher' => true,
+                'expected' => true,
+            ],
+            'visible to teachers only, not teacher' => [
+                'visibility' => MDL_F2F_FIELD_VISIBLETOTEACHERS,
+                'isteacher' => false,
+                'expected' => false,
+            ],
+            'visible to teachers only, is teacher' => [
+                'visibility' => MDL_F2F_FIELD_VISIBLETOTEACHERS,
+                'isteacher' => true,
+                'expected' => true,
+            ],
+            'not visible, not teacher' => [
+                'visibility' => MDL_F2F_FIELD_NOTVISIBLE,
+                'isteacher' => false,
+                'expected' => false,
+            ],
+            'not visible, is teacher' => [
+                'visibility' => MDL_F2F_FIELD_NOTVISIBLE,
+                'isteacher' => true,
+                'expected' => false,
+            ],
+        ];
+    }
+
+    /**
+     * Test field visibility for different user roles and visibility settings.
+     *
+     * @dataProvider field_visibility_provider
+     */
+    public function test_field_visibility_helper(
+        int $visibility,
+        bool $isteacher,
+        bool $expected
+    ): void {
+        global $DB, $CFG;
+        require_once($CFG->dirroot . '/mod/facetoface/lib.php');
+
+        // Setup course and participants.
+        $generator = $this->getDataGenerator()->get_plugin_generator('mod_facetoface');
+        $course = $this->getDataGenerator()->create_course();
+        $teacher = $this->getDataGenerator()->create_and_enrol($course, 'editingteacher');
+        $student = $this->getDataGenerator()->create_and_enrol($course, 'student');
+        $facetoface = $generator->create_instance(['course' => $course->id]);
+
+        // Create custom field.
+        $customfield = (object)[
+            'name' => 'Test Field',
+            'shortname' => 'testfield',
+            'type' => 0,
+            'possiblevalues' => '',
+            'required' => 0,
+            'defaultvalue' => '',
+            'isfilter' => 0,
+            'showinsummary' => 1,
+            'visibleto' => $visibility,
+        ];
+        $DB->insert_record('facetoface_session_field', $customfield);
+
+        // Test visibility.
+        $this->setUser($isteacher ? $teacher : $student);
+        $canedit = has_capability('mod/facetoface:editsessions', \context_course::instance($course->id));
+        $result = facetoface_can_view_field($visibility, $canedit);
+        $this->assertEquals($expected, $result);
+    }
+
+    /**
+     * Test field visibility for different user roles and visibility settings.
+     *
+     * @dataProvider field_visibility_provider
+     */
+    public function test_field_visibility(int $visibility, bool $isteacher, bool $expected): void {
+        global $DB, $PAGE;
+        $this->resetAfterTest();
+
+        // Setup course and participants.
+        $course = $this->getDataGenerator()->create_course();
+        if ($isteacher) {
+            $user = $this->getDataGenerator()->create_and_enrol($course, 'editingteacher');
+        } else {
+            $user = $this->getDataGenerator()->create_and_enrol($course, 'student');
+        }
+        $generator = $this->getDataGenerator()->get_plugin_generator('mod_facetoface');
+        $facetoface = $generator->create_instance(['course' => $course->id]);
+
+        // Create custom field.
+        $field = new \stdClass();
+        $field->name = 'Test Field';
+        $field->shortname = 'testfield';
+        $field->type = 0;
+        $field->required = 0;
+        $field->isfilter = 1;
+        $field->showinsummary = 1;
+        $field->visibleto = $visibility;
+        $field->id = $DB->insert_record('facetoface_session_field', $field);
+
+        // Create a session.
+        $session = $generator->create_session([
+            'facetoface' => $facetoface->id,
+            'capacity' => 10,
+            'sessiondates' => [
+                [
+                    'timestart' => time() + DAYSECS,
+                    'timefinish' => time() + DAYSECS + HOURSECS,
+                ],
+            ],
+        ]);
+
+        // Add data for the custom field.
+        $data = new \stdClass();
+        $data->sessionid = $session->id;
+        $data->fieldid = $field->id;
+        $data->data = "Test value";
+        $DB->insert_record('facetoface_session_data', $data);
+
+        // Set up session data as expected by renderer.
+        $customfields = $DB->get_records('facetoface_session_field');
+        $session->customfielddata = $DB->get_records(
+            'facetoface_session_data',
+            ['sessionid' => $session->id],
+            '',
+            'fieldid,data'
+        );
+        // Add bookedsession property required by renderer but not added by generator.
+        $session->bookedsession = null;
+        $sessions = [$session];
+        $renderer = $PAGE->get_renderer('mod_facetoface');
+
+        // Test visibility.
+        $this->setUser($user);
+        $canedit = has_capability('mod/facetoface:editsessions', \context_course::instance($course->id));
+        $output = $renderer->print_session_list_table($customfields, $sessions, false, $canedit);
+        if ($expected) {
+            $this->assertStringContainsString('Test Field', $output);
+            $this->assertStringContainsString('Test value', $output);
+        } else {
+            $this->assertStringNotContainsString('Test Field', $output);
+            $this->assertStringNotContainsString('Test value', $output);
+        }
+    }
 }

version.php

@@ -30,8 +30,8 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version   = 2025071800;
-$plugin->release   = 2025071800;
+$plugin->version   = 2025072400;
+$plugin->release   = 2025072400;
 $plugin->requires  = 2023100900;  // Requires 4.3.
 $plugin->component = 'mod_facetoface';
 $plugin->maturity  = MATURITY_STABLE;