adding content license

Author: sei-npacheco

backup/moodle2/backup_crucible_stepslib.php

@@ -56,7 +56,8 @@ protected function define_structure() {
         $crucible = new backup_nested_element('crucible', ['id'], [
             'name', 'intro', 'introformat', 'eventtemplateid', 'vmapp',
             'clock', 'extendevent', 'timeopen', 'timeclose', 'grade',
-            'grademethod', 'timecreated', 'timemodified']);
+            'grademethod', 'timecreated', 'timemodified', 'contentlicense',
+            'showcontentlicense']);
 
         // Define sources.
         $crucible->set_source_table('crucible', ['id' => backup::VAR_ACTIVITYID]);

db/upgrade.php

@@ -537,6 +537,23 @@ function xmldb_crucible_upgrade($oldversion) {
         // Crucible savepoint reached.
         upgrade_mod_savepoint(true, 2021082301, 'crucible');
     }
+    if ($oldversion < 2025060403) {
+        // Define the table.
+        $table = new xmldb_table('crucible');
+        // Define field 'contentlicense'.
+        $field1 = new xmldb_field('contentlicense', XMLDB_TYPE_TEXT, 'medium', null, null, null, null, 'timemodified');
+        if (!$dbman->field_exists($table, $field1)) {
+            $dbman->add_field($table, $field1);
+        }
+
+        // Define field 'showcontentlicense'.
+        $field2 = new xmldb_field('showcontentlicense', XMLDB_TYPE_INTEGER, '1', null, XMLDB_NOTNULL, null, '0', 'contentlicense');
+        if (!$dbman->field_exists($table, $field2)) {
+            $dbman->add_field($table, $field2);
+        }
+        // Savepoint.
+        upgrade_mod_savepoint(true, 2025060403, 'crucible');
+    }
 
     return true;
 }

lang/en/crucible.php

@@ -68,6 +68,10 @@
 $string['configeventtemplate'] = 'Event Template GUID to be launched.';
 $string['configautocomplete'] = 'Display list of Event Templates in a dropdown or a searchable text box.';
 $string['configshowfailed'] = 'Show failed Events in the history table.';
+$string['contentlicense'] = 'Content License';
+$string['contentlicense_help'] = 'Select the appropriate content license associated with this content or lab from the dropdown menu.';
+$string['showcontentlicense'] = 'Display Content License to Students';
+$string['showcontentlicense_help'] = 'If checked, the content license text will be visible to students on the activity page.';
 
 // Activity settings
 $string['vmapp_help'] = 'This determines whether the VM app is emebeded in an iframe or whether a link to the player is displayed';

mod_form.php

@@ -42,6 +42,7 @@
 
 require_once($CFG->dirroot.'/course/moodleform_mod.php');
 require_once($CFG->dirroot.'/mod/crucible/locallib.php');
+require_once("$CFG->dirroot/lib/licenselib.php");
 
 /**
  * Form definition for creating or editing Crucible activity instances.
@@ -109,6 +110,22 @@ public function definition() {
         $mform->setDefault('eventtemplateid', null);
         $mform->addHelpButton('eventtemplateid', 'eventtemplate', 'crucible');
 
+        $licenses = license_manager::get_licenses();
+        if ($licenses) {
+            foreach ($licenses as $license) {
+                $license_options[$license->shortname] = $license->fullname;
+            }
+        } else {
+            debugging('No licenses found.', DEBUG_DEVELOPER);
+        }
+
+        $mform->addElement('select', 'contentlicense', get_string('contentlicense', 'crucible'), $license_options);
+        $mform->setType('contentlicense', PARAM_TEXT);
+        $mform->addHelpButton('contentlicense', 'contentlicense', 'crucible');
+        
+        $mform->addElement('checkbox', 'showcontentlicense', get_string('showcontentlicense', 'crucible'));
+        $mform->addHelpButton('showcontentlicense', 'showcontentlicense', 'crucible');
+
         $mform->addElement('header', 'optionssection', get_string('appearance'));
 
         $options = ['Display Link to Player', 'Embed VM App'];
@@ -225,6 +242,10 @@ public function data_postprocessing($data) {
         $data->intro = strip_tags($rawdescription); // Removes all HTML tags.
         $data->introformat = FORMAT_PLAIN;
 
+        if (!isset($data->showcontentlicense)) {
+            $data->showcontentlicense = 0; // Checkbox unchecked, set to 0.
+        }
+
         // TODO if grade method changed, update all grades.
     }
 

renderer.php

@@ -55,12 +55,18 @@ class mod_crucible_renderer extends plugin_renderer_base {
      * @param object $crucible Crucible activity instance.
      * @param string $duration Formatted duration string to display.
      */
-    public function display_detail($crucible, $duration) {
+    public function display_detail($crucible, $duration, $content_license = null) {
         $data = new stdClass();
         $data->name = $crucible->name;
         $data->intro = strip_tags($crucible->intro);
         $data->durationtext = get_string('durationtext', 'mod_crucible');
         $data->duration = $duration;
+
+        if ($content_license) {
+            $data->license_fullname = $content_license->fullname;
+            $data->license_source = $content_license->source;
+        }
+
         echo $this->render_from_template('mod_crucible/detail', $data);
     }
 

styles.css

@@ -41,4 +41,19 @@
   color: #00434e;
   background-color: #cce6ea;
   border-color: #b8dce2;
+}
+
+.license-info {
+  font-family: Arial, sans-serif; /* Modern font */
+  font-size: 14px;          /* Readable font size */
+  line-height: 1.5;         /* Better line spacing */
+}
+
+.license-info a {
+  color: #0073e6;           /* Link color */
+  text-decoration: none;    /* Remove underline */
+}
+
+.license-info a:hover {
+  text-decoration: underline; /* Underline on hover */
 }

templates/detail.mustache

@@ -37,7 +37,11 @@ DM20-0196
 }}
 
 <h1>{{name}}</h1>
-
+{{#license_fullname}}
+<div class="license-info">
+    <p><strong>License:</strong> <a href="{{license_source}}" target="_blank">{{license_fullname}}</a></p>
+</div>
+{{/license_fullname}}
 {{#duration}}
 <div class="notification-style notification-box">
 {{durationtext}}: {{duration}} hour(s)

version.php

@@ -42,10 +42,10 @@
 defined('MOODLE_INTERNAL') || die();
 
 // This is the version of the plugin.
-$plugin->version = 2025060400;
+$plugin->version = 2025060402;
 
 // This is the version of Moodle this plugin requires.
-$plugin->requires = 2022112801;
+$plugin->requires = 2025041401;
 
 // This is the component name of the plugin - it always starts with 'component_'.
 $plugin->component = 'mod_crucible';

view.php

@@ -44,6 +44,7 @@
 require_once("$CFG->dirroot/mod/crucible/lib.php");
 require_once("$CFG->dirroot/mod/crucible/locallib.php");
 require_once($CFG->libdir . '/completionlib.php');
+require_once("$CFG->dirroot/lib/licenselib.php");
 
 $id = optional_param('id', 0, PARAM_INT); // Course_module ID.
 $c = optional_param('c', 0, PARAM_INT);  // Instance ID - it should be named as the first character of the module.
@@ -265,7 +266,14 @@
 $renderer = $PAGE->get_renderer('mod_crucible');
 echo $renderer->header();
 
-$renderer->display_detail($crucible, $object->eventtemplate->durationHours);
+$license_info = null;
+
+if ($object->crucible->showcontentlicense) {
+    $license_id = $object->crucible->contentlicense;
+    $license_info = license_manager::get_license_by_shortname($license_id);
+}
+
+$renderer->display_detail($crucible, $object->eventtemplate->durationHours, $license_info);
 
 $formattempts = $object->get_all_attempts_for_form();