From 5e3d29ab218f2e7fcfb59f64777d901625dc5a49 Mon Sep 17 00:00:00 2001
From: lutangar <johan.dufour@gmail.com>
Date: Fri, 17 Dec 2021 16:41:01 +0100
Subject: [PATCH] Add video caption created and deleted hooks

---
 server/controllers/api/videos/captions.ts          |  5 +++++
 server/tests/fixtures/peertube-plugin-test/main.js |  3 +++
 server/tests/plugins/action-hooks.ts               | 14 ++++++++++++++
 shared/models/plugins/server/server-hook.model.ts  |  5 +++++
 4 files changed, 27 insertions(+)

diff --git a/server/controllers/api/videos/captions.ts b/server/controllers/api/videos/captions.ts
index 2d2213327..c0e60848b 100644
--- a/server/controllers/api/videos/captions.ts
+++ b/server/controllers/api/videos/captions.ts
@@ -12,6 +12,7 @@ import { federateVideoIfNeeded } from '../../../lib/activitypub/videos'
 import { asyncMiddleware, asyncRetryTransactionMiddleware, authenticate } from '../../../middlewares'
 import { addVideoCaptionValidator, deleteVideoCaptionValidator, listVideoCaptionsValidator } from '../../../middlewares/validators'
 import { VideoCaptionModel } from '../../../models/video/video-caption'
+import { Hooks } from '@server/lib/plugins/hooks'
 
 const reqVideoCaptionAdd = createReqFiles(
   [ 'captionfile' ],
@@ -75,6 +76,8 @@ async function addVideoCaption (req: express.Request, res: express.Response) {
     await federateVideoIfNeeded(video, false, t)
   })
 
+  Hooks.runAction('action:api.video-caption.created', { caption: videoCaption, req, res })
+
   return res.status(HttpStatusCode.NO_CONTENT_204).end()
 }
 
@@ -91,5 +94,7 @@ async function deleteVideoCaption (req: express.Request, res: express.Response)
 
   logger.info('Video caption %s of video %s deleted.', videoCaption.language, video.uuid)
 
+  Hooks.runAction('action:api.video-caption.deleted', { caption: videoCaption, req, res })
+
   return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
 }
diff --git a/server/tests/fixtures/peertube-plugin-test/main.js b/server/tests/fixtures/peertube-plugin-test/main.js
index 04e059848..90951d611 100644
--- a/server/tests/fixtures/peertube-plugin-test/main.js
+++ b/server/tests/fixtures/peertube-plugin-test/main.js
@@ -13,6 +13,9 @@ async function register ({ registerHook, registerSetting, settingsManager, stora
     'action:api.video-comment-reply.created',
     'action:api.video-comment.deleted',
 
+    'action:api.video-caption.created',
+    'action:api.video-caption.deleted',
+
     'action:api.user.blocked',
     'action:api.user.unblocked',
     'action:api.user.registered',
diff --git a/server/tests/plugins/action-hooks.ts b/server/tests/plugins/action-hooks.ts
index 686926c17..8788a9644 100644
--- a/server/tests/plugins/action-hooks.ts
+++ b/server/tests/plugins/action-hooks.ts
@@ -103,6 +103,20 @@ describe('Test plugin action hooks', function () {
     })
   })
 
+  describe('Captions hooks', function () {
+    it('Should run action:api.video-caption.created', async function () {
+      await servers[0].captions.add({ videoId: videoUUID, language: 'en', fixture: 'subtitle-good.srt' })
+
+      await checkHook('action:api.video-caption.created')
+    })
+
+    it('Should run action:api.video-caption.deleted', async function () {
+      await servers[0].captions.delete({ videoId: videoUUID, language: 'en' })
+
+      await checkHook('action:api.video-caption.deleted')
+    })
+  })
+
   describe('Users hooks', function () {
     let userId: number
 
diff --git a/shared/models/plugins/server/server-hook.model.ts b/shared/models/plugins/server/server-hook.model.ts
index 056c41a7f..bd2b27da5 100644
--- a/shared/models/plugins/server/server-hook.model.ts
+++ b/shared/models/plugins/server/server-hook.model.ts
@@ -115,6 +115,11 @@ export const serverActionHookObject = {
   // Fired when a comment (thread or reply) is deleted
   'action:api.video-comment.deleted': true,
 
+  // Fired when a caption is created
+  'action:api.video-caption.created': true,
+  // Fired when a caption is deleted
+  'action:api.video-caption.deleted': true,
+
   // Fired when a user is blocked (banned)
   'action:api.user.blocked': true,
   // Fired when a user is unblocked (unbanned)
-- 
2.41.0