Completely remove subtiltes workflow, Correctly update workflows if tags changed (#1215)

* Completely remove subtiltes workflow

* remove non existent workflows

* rename migration

Author: tgloeggl

INSTALL.md

@@ -72,7 +72,7 @@ org.opencastproject.userdirectory.studip.cache.expiration=1
 
 Make sure to change the token and add that token to the Opencast config in Stud.IP. Furthermore configure the Opencast-Plugin in Stud.IP to have the `nobody` role for it to work.
 
-6. Recommended for Opencast Version >= 17, edit `/etc/opencast/custom.properties` and enable: 
+6. Recommended for Opencast Version >= 17, edit `/etc/opencast/custom.properties` and enable:
 
 ```
 # Allow episode ID based access control via roles.
@@ -121,9 +121,6 @@ You can configure which workflow is used for different actions. They can be edit
 | upload           | Workflow run after uploading a video                         | upload                |
 | studio           | Workflow run after creating a video OC Studio                | upload                |
 | delete           | Workflow run when a video shall be deleted permanently       | delete                |
-| subtiltes        | Workflow run after a subtitle has been added or removed      | archive               |
-
-The subtitles-Workflow needs to make sure that the changes are published, otherwise the subtitles will not be visible.
 
 ## Credentials for Opencast
 

lib/Models/Workflow.php

@@ -32,13 +32,14 @@ public static function updateWorkflowsByConfigId($config_id) {
 
             foreach ($wf_defs as $wf_def) {
                 $found = false;
-                foreach ($db_workflows as $db_workflow) {
+                foreach ($db_workflows as $key => $db_workflow) {
                     if ($db_workflow['name'] === $wf_def['id'] && $db_workflow['tag'] === $wf_def['tag']) {
                         $entry = self::findOneBySql('config_id = ? AND name = ? AND tag = ?', [$config_id, $wf_def['id'], $wf_def['tag']]);
                         $entry->setValue('displayname', $wf_def['title']);
                         $entry->store();
 
                         $found = true;
+                        unset($db_workflows[$key]);
                         break;
                     }
                 }
@@ -60,6 +61,11 @@ public static function updateWorkflowsByConfigId($config_id) {
             }
         } catch (\Throwable $th) {
         }
+
+        // the remaining entries or workflow - tag combinations that are not there anymore and need to be deleted from Stud.IP
+        foreach ($db_workflows as $db_workflow) {
+            $db_workflow->delete();
+        }
     }
 
     public function sanitizeSettings($event)

lib/Models/WorkflowConfig.php

@@ -61,10 +61,6 @@ public static function createAndUpdateByConfigId($config_id, $workflows = null)
                 case 'studio';
                     $type = 'upload';
                     break;
-
-                case 'subtitles';
-                    $type = 'archive';
-                    break;
             }
 
             $workflow_id = isset($workflows[$entry->id])

migrations/105_remove_subtitles_workflow.php

@@ -0,0 +1,26 @@
+<?php
+
+class RemoveSubtitlesWorkflow extends Migration
+{
+    public function description()
+    {
+        return 'Remove "editor" from list of configurable workflows';
+    }
+
+    public function up()
+    {
+        $db = DBManager::get();
+
+        $db->exec("ALTER TABLE `oc_workflow_config`
+            MODIFY `used_for` enum('schedule','upload','studio','delete') CHARACTER SET latin1 COLLATE latin1_bin
+        ");
+
+        $db->exec("DELETE FROM `oc_workflow_config` WHERE `used_for` NOT IN ('schedule','upload','studio','delete')");
+
+        SimpleOrMap::expireTableScheme();
+    }
+
+    public function down()
+    {
+    }
+}

tools/ansible-testsystem/studip-demo/roles/cleaner/templates/oc.sql

@@ -162,6 +162,5 @@ REPLACE INTO `oc_workflow_config` (`id`, `config_id`, `used_for`, `workflow_id`)
 (2,	1,	'upload',	6),
 (3,	1,	'studio',	6),
 (4,	1,	'delete',	1),
-(5,	1,	'subtitles',	9);
 
 SET FOREIGN_KEY_CHECKS=1;

vueapp/components/Config/WorkflowOptions.vue

@@ -43,7 +43,6 @@ export default {
                                 (
                                     wf['tag'] === wf_conf['used_for']
                                     || wf['tag'] === 'upload' && wf_conf['used_for'] === 'studio'
-                                    || wf['tag'] === 'archive' && wf_conf['used_for'] === 'subtitles'
                                 )
                             ) {
                                 options.push({