INT-17780: Add a checkbox in collaborate to hide the duration

Author: fabianbatioja

classes/renderables/meetingstatus.php

@@ -100,7 +100,9 @@ public function __construct($times,
         /** @var mod_collaborate_renderer $output */
         $output = $PAGE->get_renderer('mod_collaborate');
         // This should be migrated to a renderable and template at some point.
-        $this->meetingtimes = $output->meeting_times($times);
+        if (empty($collaborate->hideduration)) {
+            $this->meetingtimes = $output->meeting_times($times);
+        }
 
         $params = ['action' => 'forward', 'id' => $cm->id, 'sesskey' => sesskey()];
         $this->fwdurl = new \moodle_url('view.php', $params);

db/install.xml

@@ -31,6 +31,7 @@
         <FIELD NAME="candownloadrecordings" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="1" SEQUENCE="false"/>
         <FIELD NAME="largesessionenable" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
         <FIELD NAME="canenablelargesession" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="1" SEQUENCE="false"/>
+        <FIELD NAME="hideduration" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
       </FIELDS>
       <KEYS>
         <KEY NAME="primary" TYPE="primary" FIELDS="id"/>
@@ -115,4 +116,4 @@
       </KEYS>
     </TABLE>
   </TABLES>
-</XMLDB>
+</XMLDB>

db/upgrade.php

@@ -447,5 +447,18 @@ function xmldb_collaborate_upgrade($oldversion) {
         upgrade_mod_savepoint(true, 2021111105, 'collaborate');
     }
 
+    if ($oldversion < 2022020301) {
+
+        // Define field completionlaunch to be added to collaborate.
+        $table = new xmldb_table('collaborate');
+        $field = new xmldb_field('hideduration', XMLDB_TYPE_INTEGER, '1', null, XMLDB_NOTNULL, null, '0');
+        if (!$dbman->field_exists($table, $field)) {
+            $dbman->add_field($table, $field);
+        }
+
+        // Collaborate savepoint reached.
+        upgrade_mod_savepoint(true, 2022020301, 'collaborate');
+    }
+
     return true;
 }

lang/en/collaborate.php

@@ -74,6 +74,7 @@
 $string['deleterecordingconfirmation'] = 'Are you sure you want to delete the recording entitled "{$a}"?';
 $string['downloadrec'] = 'Download recording';
 $string['duration'] = 'Duration';
+$string['hideduration'] = 'Hide duration view';
 $string['ends'] = 'Ends - {$a}';
 $string['error:apicallfailed'] = 'API call failed ( {$a} )';
 $string['error:apifailure'] = 'An error occurred whilst talking to the collaborate server - please try again later. If the problem persists, please contact support.';

lib.php

@@ -158,6 +158,8 @@ function collaborate_update_instance(stdClass $collaborate, mod_collaborate_mod_
     $collaborate->timestart = $data->timestart;
     $collaborate->timeend = $data->timeend;
     $collaborate->intro = local::entitydecode($collaborate->intro);
+    $hideduration = isset($collaborate->hideduration) && boolval($collaborate->hideduration);
+    $collaborate->hideduration = $hideduration ?: 0;
     $cansharevideo = isset($collaborate->cansharevideo) && boolval($collaborate->cansharevideo);
     $collaborate->cansharevideo = $cansharevideo ?: 0;
     $canpostmessages = isset($collaborate->canpostmessages) && boolval($collaborate->canpostmessages);
@@ -382,11 +384,15 @@ function collaborate_pluginfile($course, $cm, $context, $filearea, array $args,
  * @param cm_info $cm
  */
 function collaborate_cm_info_view(cm_info $cm) {
-    global $PAGE;
+    global $PAGE, $DB;
     $renderer = $PAGE->get_renderer('mod_collaborate');
-    $times = local::get_times($cm->instance);
-    $o = html_writer::tag('span', $renderer->meeting_times($times), ['class' => 'label label-info']);
-    $cm->set_after_link($o);
+
+    $hideduration = $DB->get_field('collaborate', 'hideduration', array('id' => $cm->instance));
+    if (empty($hideduration)) {
+        $times = local::get_times($cm->instance);
+        $o = html_writer::tag('span', $renderer->meeting_times($times), ['class' => 'label label-info']);
+        $cm->set_after_link($o);
+    }
 }
 
 /**
@@ -501,4 +507,4 @@ function collaborate_get_recent_mod_activity(&$activities, &$index, $timestart,
         $activities[$index++]   = $activity;
     }
 
-}
+}

mod_form.php

@@ -108,6 +108,10 @@ public function definition() {
         $mform->addElement('select', 'duration', get_string('duration', 'mod_collaborate'), $options);
         $mform->setDefault('duration', HOURSECS);
 
+        $mform->addElement('advcheckbox', 'hideduration',
+            get_string('hideduration', 'mod_collaborate'), '', array('group' => 1), array(0, 1));
+        $mform->setDefault('hideduration', get_config('collaborate', 'hideduration'));
+
         // Guest access enabled yes / no.
         $mform->addElement('checkbox', 'guestaccessenabled',
                 get_string('guestaccessenabled', 'mod_collaborate'), '', array('group' => 1), array(0, 1));

settings.php

@@ -260,6 +260,13 @@
     $setting = new \admin_setting_configcheckbox($name, $title, '', $default, $checked, $unchecked);
     $settings->add($setting);
 
+    $name = 'collaborate/hideduration';
+    $title = new lang_string('hideduration', 'collaborate');
+    $description = new lang_string('hideduration', 'collaborate');
+    $default = $unchecked;
+    $setting = new \admin_setting_configcheckbox($name, $title, '', $default, $checked, $unchecked);
+    $settings->add($setting);
+
     // Performance settings.
     $name = 'collaborate/performancesettings';
     $setting = new \admin_setting_heading($name, get_string('performancesettings', 'mod_collaborate'), '');

templates/meetingstatus.mustache

@@ -34,8 +34,9 @@
 
 <div class="tab-pane active" id="maininfo" role="tabpanel">
     <div class = "path-mod-collaborate__meetingstatus">
-        <div class = "path-mod-collaborate__meetingstatus_times">{{{meetingtimes}}}</div>
-
+        {{#meetingtimes}}
+            <div class = "path-mod-collaborate__meetingstatus_times">{{{meetingtimes}}}</div>
+        {{/meetingtimes}}
         {{#statusunrestored}}
             {{> core/notification_info}}
         {{/statusunrestored}}

tests/behat/collaborate.feature

@@ -361,4 +361,32 @@ Feature: Collaborate instances can be created by teachers and joined by students
     And I set the following fields to these values:
       | Collaborate guest role | Presenter |
     And I click on "Save and display" "button"
-    Then I should see "In large scale sessions, guests must be participants"
+    Then I should see "In large scale sessions, guests must be participants"
+
+  Scenario: Collaborate instance with hide duration view configuration enable does not show the duration.
+    Given I log in as "teacher1"
+    And the following "activity" exists:
+      | activity                 | collaborate         |
+      | course                   | C1                  |
+      | section                  | 1                   |
+      | name                     | Test collab         |
+      | hideduration             | 1                   |
+      | duration                 | 9999                |
+    And I am on "Course 1" course homepage with editing mode on
+    And I should not see "(Duration of course)"
+    And I follow "Test collab"
+    And I should not see "(Duration of course)"
+
+  Scenario: Collaborate instance with hide duration view configuration disable show the duration.
+    Given I log in as "teacher1"
+    And the following "activity" exists:
+      | activity                 | collaborate         |
+      | course                   | C1                  |
+      | section                  | 1                   |
+      | name                     | Test collab         |
+      | hideduration             | 0                   |
+      | duration                 | 9999                |
+    And I am on "Course 1" course homepage with editing mode on
+    And I should see "(Duration of course)"
+    And I follow "Test collab"
+    And I should see "(Duration of course)"

version.php

@@ -25,7 +25,7 @@
 defined('MOODLE_INTERNAL') || die();
 
 $plugin->component = 'mod_collaborate';
-$plugin->version = 2022020100;
+$plugin->version = 2022020301;
 $plugin->release = '3.11.3';
 $plugin->requires = 2021051700;
 $plugin->maturity = MATURITY_STABLE;