Workflow configuration panel during upload (#390)

* introducing upload workflow config panel in upload page * automated tests * version bump * fixing behat test for autocomplete feature * fix mismatched types * parameters list completion * new method to get workflow isntance * param list docs completion * adjust the sequece where to init an apibridge instance to cover wfconfig helper class as well * using the local opencast for the unit test * temporarily using oc-16-support branch from tool_opencast plugin * remove api version to fix php unit test --------- Co-authored-by: Thomas Niedermaier <[email protected]>
Opencast-Moodle · Dec 3, 2024 · 2ecc0a4 · 2ecc0a4
1 parent e63e019
commit 2ecc0a4
Show file tree

Hide file tree

Showing 18 changed files with 837 additions and 47 deletions.
diff --git a/.github/workflows/moodle-ci.yml b/.github/workflows/moodle-ci.yml
@@ -12,5 +12,5 @@ jobs:
     with:
       requires-tool-plugin: true
       requires-mod-plugin: true
-      branch-tool-plugin: master
+      branch-tool-plugin: oc-16-support
       branch-mod-plugin: master
diff --git a/addvideo.php b/addvideo.php
@@ -28,6 +28,8 @@
 use block_opencast\local\upload_helper;
 use core\output\notification;
 use tool_opencast\local\settings_api;
+use block_opencast\local\workflowconfiguration_helper;
+
 require_once('../../config.php');
 
 global $PAGE, $OUTPUT, $CFG, $USER, $SITE, $DB;
@@ -268,8 +270,15 @@
             json_encode($data->scheduledvisibilitygroups) : null;
     }
 
+    // Prepare user defined workflow configurations if enabled and exist.
+    $workflowconfiguration = null;
+    $wfconfighelper = workflowconfiguration_helper::get_instance($ocinstanceid);
+    if ($configpaneldata = $wfconfighelper->get_userdefined_configuration_data($data)) {
+        $workflowconfiguration = json_encode($configpaneldata);
+    }
+
     // Update all upload jobs.
-    upload_helper::save_upload_jobs($ocinstanceid, $courseid, $options, $visibility);
+    upload_helper::save_upload_jobs($ocinstanceid, $courseid, $options, $visibility, $workflowconfiguration);
     redirect($redirecturl, get_string('uploadjobssaved', 'block_opencast'), null, notification::NOTIFY_SUCCESS);
 }
 

diff --git a/batchupload.php b/batchupload.php
@@ -29,6 +29,8 @@
 use block_opencast\local\upload_helper;
 use core\output\notification;
 use tool_opencast\local\settings_api;
+use block_opencast\local\workflowconfiguration_helper;
+
 require_once('../../config.php');
 
 global $PAGE, $OUTPUT, $CFG, $USER, $SITE, $DB;
@@ -243,6 +245,13 @@
             json_encode($data->scheduledvisibilitygroups) : null;
     }
 
+    // Prepare user defined workflow configurations if enabled and exist.
+    $workflowconfiguration = null;
+    $wfconfighelper = workflowconfiguration_helper::get_instance($ocinstanceid);
+    if ($configpaneldata = $wfconfighelper->get_userdefined_configuration_data($data)) {
+        $workflowconfiguration = json_encode($configpaneldata);
+    }
+
     $error = null;
     $totalfiles = count($batchuploadedfiles);
     // Loop through the files and proceed with the upload and cleanup records.
@@ -284,7 +293,7 @@
                 $options->presenter = $newfile->get_itemid();
 
                 // Save the upload job.
-                upload_helper::save_upload_jobs($ocinstanceid, $courseid, $options, $visibility);
+                upload_helper::save_upload_jobs($ocinstanceid, $courseid, $options, $visibility, $workflowconfiguration);
             } catch (moodle_exception $e) {
                 $errorcount++;
             }

diff --git a/classes/local/addvideo_form.php b/classes/local/addvideo_form.php
@@ -61,6 +61,7 @@ public function definition() {
         $ocinstanceid = $this->_customdata['ocinstanceid'];
         $apibridge = apibridge::get_instance($ocinstanceid);
         $eventdefaults = $this->_customdata['eventdefaults'];
+        $wfconfighelper = workflowconfiguration_helper::get_instance($ocinstanceid);
 
         $usechunkupload = class_exists('\local_chunkupload\chunkupload_form_element')
             && get_config('block_opencast', 'enablechunkupload_' . $ocinstanceid);
@@ -309,6 +310,22 @@ public function definition() {
             }
         }
 
+        // Offering workflow configuration panel settings.
+        if ($wfconfighelper->can_provide_configuration_panel()) {
+            $mform->closeHeaderBefore('configurationpanel_header');
+            $mform->addElement('header', 'configurationpanel_header', get_string('configurationpanel_header', 'block_opencast'));
+            $mform->setExpanded('configurationpanel_header', true);
+
+            $configpanelexplanation = html_writer::tag('p', get_string('configurationpanelheader_explanation', 'block_opencast'));
+            $mform->addElement('html', $configpanelexplanation);
+
+            $renderer->render_configuration_panel_form_elements(
+                $mform,
+                $wfconfighelper->get_upload_workflow_configuration_panel(),
+                $wfconfighelper->get_allowed_upload_configurations()
+            );
+        }
+
         $mform->closeHeaderBefore('upload_filepicker');
 
         $mform->addElement('header', 'upload_filepicker', get_string('upload', 'block_opencast'));

diff --git a/classes/local/apibridge.php b/classes/local/apibridge.php
@@ -253,12 +253,13 @@ public function ingest_add_attachment($mediapackage, $flavor, $file) {
      * Ingests a mediapackage.
      * @param string $mediapackage Mediapackage
      * @param string $uploadworkflow workflow definition is to start after ingest
+     * @param array $workflowconfiguration workflow configuration as array
      * @return string Workflow instance that was started
      * @throws dml_exception
      * @throws moodle_exception
      * @throws opencast_connection_exception
      */
-    public function ingest($mediapackage, $uploadworkflow = '') {
+    public function ingest($mediapackage, $uploadworkflow = '', $workflowconfiguration = []) {
         $ingestapi = $this->get_ingest_api();
 
         if (empty($uploadworkflow)) {
@@ -268,9 +269,9 @@ public function ingest($mediapackage, $uploadworkflow = '') {
         $uploadtimeout = get_config('block_opencast', 'uploadtimeout');
         if ($uploadtimeout !== false) {
             $timeout = intval($uploadtimeout);
-            $response = $ingestapi->setRequestTimeout($timeout)->ingest($mediapackage, $uploadworkflow);
+            $response = $ingestapi->setRequestTimeout($timeout)->ingest($mediapackage, $uploadworkflow, '', $workflowconfiguration);
         } else {
-            $response = $ingestapi->ingest($mediapackage, $uploadworkflow);
+            $response = $ingestapi->ingest($mediapackage, $uploadworkflow, '', $workflowconfiguration);
         }
 
         $code = $response['code'];
@@ -1167,6 +1168,7 @@ public function create_event($job) {
         global $DB;
 
         $event = new event();
+        $wfconfighelper = workflowconfiguration_helper::get_instance($this->ocinstanceid);
 
         // Get initial visibility object.
         $initialvisibility = visibility_helper::get_initial_visibility($job);
@@ -1216,7 +1218,8 @@ public function create_event($job) {
 
         $acl = $event->get_json_acl();
         $metadata = $event->get_meta_data();
-        $processing = $event->get_processing($this->ocinstanceid);
+        $processingdata = $wfconfighelper->get_workflow_processing_data($job->workflowconfiguration);
+        $processing = $processingdata['processing_json'];
         $scheduling = '';
         $presenter = null;
         $presentation = null;
@@ -1883,6 +1886,26 @@ public function get_workflow_definition($id) {
         return false;
     }
 
+    /**
+     * Retrieves a workflow instance from Opencast.
+     * @param string $id Workflow instance id
+     * @param bool $withoperations flag to get instance with operations
+     * @param bool $withconfiguration flag to get instance with configurations
+     * @return false|mixed Workflow instance or false if not successful
+     */
+    public function get_workflow_instance($id, $withoperations = false, $withconfiguration = true) {
+        $response = $this->api->opencastapi->workflowsApi->get(
+            $id,
+            $withoperations,
+            $withconfiguration
+        );
+        if ($response['code'] === 200) {
+            return $response['body'];
+        }
+
+        return false;
+    }
+
     /**
      * Helperfunction to get the list of available workflows to be used in the plugin's settings.
      *

diff --git a/classes/local/batchupload_form.php b/classes/local/batchupload_form.php
@@ -59,6 +59,7 @@ public function definition() {
         $ocinstanceid = $this->_customdata['ocinstanceid'];
         $apibridge = apibridge::get_instance($ocinstanceid);
         $eventdefaults = $this->_customdata['eventdefaults'];
+        $wfconfighelper = new workflowconfiguration_helper($ocinstanceid);
 
         $mform = $this->_form;
 
@@ -286,6 +287,22 @@ public function definition() {
             }
         }
 
+        // Offering workflow configuration panel settings.
+        if ($wfconfighelper->can_provide_configuration_panel()) {
+            $mform->closeHeaderBefore('configurationpanel_header');
+            $mform->addElement('header', 'configurationpanel_header', get_string('configurationpanel_header', 'block_opencast'));
+            $mform->setExpanded('configurationpanel_header', true);
+
+            $configpanelexplanation = html_writer::tag('p', get_string('configurationpanelheader_explanation', 'block_opencast'));
+            $mform->addElement('html', $configpanelexplanation);
+
+            $renderer->render_configuration_panel_form_elements(
+                $mform,
+                $wfconfighelper->get_upload_workflow_configuration_panel(),
+                $wfconfighelper->get_allowed_upload_configurations()
+            );
+        }
+
         // Batch Upload section.
         $mform->closeHeaderBefore('batchupload_form_header');
 

diff --git a/classes/local/ingest_uploader.php b/classes/local/ingest_uploader.php
@@ -74,6 +74,7 @@ class ingest_uploader {
     public static function create_event($job) {
         global $DB;
         $apibridge = apibridge::get_instance($job->ocinstanceid);
+        $wfconfighelper = workflowconfiguration_helper::get_instance($job->ocinstanceid);
 
         switch ($job->status) {
             case self::STATUS_INGEST_CREATING_MEDIA_PACKAGE:
@@ -216,7 +217,10 @@ public static function create_event($job) {
                 }
             case self::STATUS_INGEST_INGESTING:
                 try {
-                    $workflow = $apibridge->ingest($job->mediapackage);
+                    // Prepare workflow configuration beforehand.
+                    $processingdata = $wfconfighelper->get_workflow_processing_data($job->workflowconfiguration);
+                    $workflowconfiguration = $processingdata['configuration'];
+                    $workflow = $apibridge->ingest($job->mediapackage, '', $workflowconfiguration);
                     mtrace('... video uploaded');
                     // Move on to next status.
                     self::update_status_with_mediapackage($job, upload_helper::STATUS_UPLOADED);
@@ -228,6 +232,8 @@ public static function create_event($job) {
                     $event = new stdClass();
                     $event->identifier = $values[array_search('MP:MEDIAPACKAGE',
                         array_column($values, 'tag'))]['attributes']['ID'];
+                    $event->workflowid = $values[array_search('MP:WORKFLOW',
+                        array_column($values, 'tag'))]['attributes']['ID'];
 
                     return $event;
                 } catch (opencast_connection_exception $e) {

diff --git a/classes/local/upload_helper.php b/classes/local/upload_helper.php
@@ -153,8 +153,10 @@ public static function get_upload_jobs($ocinstanceid, $courseid) {
      * @param int $courseid Course id
      * @param object $options Options
      * @param object $visibility Visibility object
+     * @param string $workflowconfiguration Workflow configuration
      */
-    public static function save_upload_jobs($ocinstanceid, $courseid, $options, $visibility = null) {
+    public static function save_upload_jobs($ocinstanceid, $courseid, $options, $visibility = null,
+                                            $workflowconfiguration = null) {
         global $DB, $USER;
 
         // Find the current files for the jobs.
@@ -224,6 +226,12 @@ public static function save_upload_jobs($ocinstanceid, $courseid, $options, $vis
         $job->timecreated = time();
         $job->timemodified = $job->timecreated;
         $job->ocinstanceid = $ocinstanceid;
+
+        // Add workflow processing data to the uploadjob as json string.
+        if (!empty($workflowconfiguration)) {
+            $job->workflowconfiguration = $workflowconfiguration;
+        }
+
         $uploadjobid = $DB->insert_record('block_opencast_uploadjob', $job);
 
         $options->uploadjobid = $uploadjobid;
@@ -605,6 +613,7 @@ protected function process_upload_job($job) {
                 if ($event) {
                     $stepsuccessful = true;
                     $job->opencasteventid = $event->identifier;
+                    $job->workflowid = (int) $event->workflowid;
                     $DB->update_record('block_opencast_uploadjob', $job);
                 }
                 break;