aboutsummaryrefslogtreecommitdiffhomepage
path: root/shared
diff options
context:
space:
mode:
authorFlorent <florent.git@zeteo.me>2022-08-10 09:53:39 +0200
committerGitHub <noreply@github.com>2022-08-10 09:53:39 +0200
commit2a491182e483b97afb1b65c908b23cb48d591807 (patch)
treeec13503216ad72a3ea8f1ce3b659899f8167fb47 /shared
parent06ac128958c489efe1008eeca1df683819bd2f18 (diff)
downloadPeerTube-2a491182e483b97afb1b65c908b23cb48d591807.tar.gz
PeerTube-2a491182e483b97afb1b65c908b23cb48d591807.tar.zst
PeerTube-2a491182e483b97afb1b65c908b23cb48d591807.zip
Channel sync (#5135)
* Add external channel URL for channel update / creation (#754) * Disallow synchronisation if user has no video quota (#754) * More constraints serverside (#754) * Disable sync if server configuration does not allow HTTP import (#754) * Working version synchronizing videos with a job (#754) TODO: refactoring, too much code duplication * More logs and try/catch (#754) * Fix eslint error (#754) * WIP: support synchronization time change (#754) * New frontend #754 * WIP: Create sync front (#754) * Enhance UI, sync creation form (#754) * Warning message when HTTP upload is disallowed * More consistent names (#754) * Binding Front with API (#754) * Add a /me API (#754) * Improve list UI (#754) * Implement creation and deletion routes (#754) * Lint (#754) * Lint again (#754) * WIP: UI for triggering import existing videos (#754) * Implement jobs for syncing and importing channels * Don't sync videos before sync creation + avoid concurrency issue (#754) * Cleanup (#754) * Cleanup: OpenAPI + API rework (#754) * Remove dead code (#754) * Eslint (#754) * Revert the mess with whitespaces in constants.ts (#754) * Some fixes after rebase (#754) * Several fixes after PR remarks (#754) * Front + API: Rename video-channels-sync to video-channel-syncs (#754) * Allow enabling channel sync through UI (#754) * getChannelInfo (#754) * Minor fixes: openapi + model + sql (#754) * Simplified API validators (#754) * Rename MChannelSync to MChannelSyncChannel (#754) * Add command for VideoChannelSync (#754) * Use synchronization.enabled config (#754) * Check parameters test + some fixes (#754) * Fix conflict mistake (#754) * Restrict access to video channel sync list API (#754) * Start adding unit test for synchronization (#754) * Continue testing (#754) * Tests finished + convertion of job to scheduler (#754) * Add lastSyncAt field (#754) * Fix externalRemoteUrl sort + creation date not well formatted (#754) * Small fix (#754) * Factorize addYoutubeDLImport and buildVideo (#754) * Check duplicates on channel not on users (#754) * factorize thumbnail generation (#754) * Fetch error should return status 400 (#754) * Separate video-channel-import and video-channel-sync-latest (#754) * Bump DB migration version after rebase (#754) * Prettier states in UI table (#754) * Add DefaultScope in VideoChannelSyncModel (#754) * Fix audit logs (#754) * Ensure user can upload when importing channel + minor fixes (#754) * Mark synchronization as failed on exception + typos (#754) * Change REST API for importing videos into channel (#754) * Add option for fully synchronize a chnanel (#754) * Return a whole sync object on creation to avoid tricks in Front (#754) * Various remarks (#754) * Single quotes by default (#754) * Rename synchronization to video_channel_synchronization * Add check.latest_videos_count and max_per_user options (#754) * Better channel rendering in list #754 * Allow sorting with channel name and state (#754) * Add missing tests for channel imports (#754) * Prefer using a parent job for channel sync * Styling * Client styling Co-authored-by: Chocobozzz <me@florianbigard.com>
Diffstat (limited to 'shared')
-rw-r--r--shared/models/server/custom-config.model.ts4
-rw-r--r--shared/models/server/debug.model.ts5
-rw-r--r--shared/models/server/job.model.ts31
-rw-r--r--shared/models/server/server-config.model.ts3
-rw-r--r--shared/models/videos/channel-sync/index.ts3
-rw-r--r--shared/models/videos/channel-sync/video-channel-sync-create.model.ts4
-rw-r--r--shared/models/videos/channel-sync/video-channel-sync-state.enum.ts6
-rw-r--r--shared/models/videos/channel-sync/video-channel-sync.model.ts14
-rw-r--r--shared/models/videos/index.ts1
-rw-r--r--shared/server-commands/server/config-command.ts36
-rw-r--r--shared/server-commands/server/server.ts3
-rw-r--r--shared/server-commands/server/servers.ts21
-rw-r--r--shared/server-commands/videos/channel-syncs-command.ts55
-rw-r--r--shared/server-commands/videos/channels-command.ts18
-rw-r--r--shared/server-commands/videos/index.ts1
15 files changed, 198 insertions, 7 deletions
diff --git a/shared/models/server/custom-config.model.ts b/shared/models/server/custom-config.model.ts
index bb9c7cef1..7d9d570b1 100644
--- a/shared/models/server/custom-config.model.ts
+++ b/shared/models/server/custom-config.model.ts
@@ -165,6 +165,10 @@ export interface CustomConfig {
165 enabled: boolean 165 enabled: boolean
166 } 166 }
167 } 167 }
168 videoChannelSynchronization: {
169 enabled: boolean
170 maxPerUser: number
171 }
168 } 172 }
169 173
170 trending: { 174 trending: {
diff --git a/shared/models/server/debug.model.ts b/shared/models/server/debug.model.ts
index 223d23362..1c4597b8b 100644
--- a/shared/models/server/debug.model.ts
+++ b/shared/models/server/debug.model.ts
@@ -4,5 +4,8 @@ export interface Debug {
4} 4}
5 5
6export interface SendDebugCommand { 6export interface SendDebugCommand {
7 command: 'remove-dandling-resumable-uploads' | 'process-video-views-buffer' | 'process-video-viewers' 7 command: 'remove-dandling-resumable-uploads'
8 | 'process-video-views-buffer'
9 | 'process-video-viewers'
10 | 'process-video-channel-sync-latest'
8} 11}
diff --git a/shared/models/server/job.model.ts b/shared/models/server/job.model.ts
index 8c8f64de9..137da367c 100644
--- a/shared/models/server/job.model.ts
+++ b/shared/models/server/job.model.ts
@@ -25,6 +25,8 @@ export type JobType =
25 | 'manage-video-torrent' 25 | 'manage-video-torrent'
26 | 'move-to-object-storage' 26 | 'move-to-object-storage'
27 | 'video-studio-edition' 27 | 'video-studio-edition'
28 | 'video-channel-import'
29 | 'after-video-channel-import'
28 | 'notify' 30 | 'notify'
29 | 'federate-video' 31 | 'federate-video'
30 32
@@ -82,20 +84,32 @@ export type VideoFileImportPayload = {
82 filePath: string 84 filePath: string
83} 85}
84 86
87// ---------------------------------------------------------------------------
88
85export type VideoImportTorrentPayloadType = 'magnet-uri' | 'torrent-file' 89export type VideoImportTorrentPayloadType = 'magnet-uri' | 'torrent-file'
86export type VideoImportYoutubeDLPayloadType = 'youtube-dl' 90export type VideoImportYoutubeDLPayloadType = 'youtube-dl'
87 91
88export type VideoImportYoutubeDLPayload = { 92export interface VideoImportYoutubeDLPayload {
89 type: VideoImportYoutubeDLPayloadType 93 type: VideoImportYoutubeDLPayloadType
90 videoImportId: number 94 videoImportId: number
91 95
92 fileExt?: string 96 fileExt?: string
93} 97}
94export type VideoImportTorrentPayload = { 98
99export interface VideoImportTorrentPayload {
95 type: VideoImportTorrentPayloadType 100 type: VideoImportTorrentPayloadType
96 videoImportId: number 101 videoImportId: number
97} 102}
98export type VideoImportPayload = VideoImportYoutubeDLPayload | VideoImportTorrentPayload 103
104export type VideoImportPayload = (VideoImportYoutubeDLPayload | VideoImportTorrentPayload) & {
105 preventException: boolean
106}
107
108export interface VideoImportPreventExceptionResult {
109 resultType: 'success' | 'error'
110}
111
112// ---------------------------------------------------------------------------
99 113
100export type VideoRedundancyPayload = { 114export type VideoRedundancyPayload = {
101 videoId: number 115 videoId: number
@@ -219,6 +233,17 @@ export interface VideoStudioEditionPayload {
219 233
220// --------------------------------------------------------------------------- 234// ---------------------------------------------------------------------------
221 235
236export interface VideoChannelImportPayload {
237 externalChannelUrl: string
238 videoChannelId: number
239}
240
241export interface AfterVideoChannelImportPayload {
242 channelSyncId: number
243}
244
245// ---------------------------------------------------------------------------
246
222export type NotifyPayload = 247export type NotifyPayload =
223 { 248 {
224 action: 'new-video' 249 action: 'new-video'
diff --git a/shared/models/server/server-config.model.ts b/shared/models/server/server-config.model.ts
index 67ad809f7..3b6d0597c 100644
--- a/shared/models/server/server-config.model.ts
+++ b/shared/models/server/server-config.model.ts
@@ -188,6 +188,9 @@ export interface ServerConfig {
188 enabled: boolean 188 enabled: boolean
189 } 189 }
190 } 190 }
191 videoChannelSynchronization: {
192 enabled: boolean
193 }
191 } 194 }
192 195
193 autoBlacklist: { 196 autoBlacklist: {
diff --git a/shared/models/videos/channel-sync/index.ts b/shared/models/videos/channel-sync/index.ts
new file mode 100644
index 000000000..7d25aaac3
--- /dev/null
+++ b/shared/models/videos/channel-sync/index.ts
@@ -0,0 +1,3 @@
1export * from './video-channel-sync-state.enum'
2export * from './video-channel-sync.model'
3export * from './video-channel-sync-create.model'
diff --git a/shared/models/videos/channel-sync/video-channel-sync-create.model.ts b/shared/models/videos/channel-sync/video-channel-sync-create.model.ts
new file mode 100644
index 000000000..753a8ee4c
--- /dev/null
+++ b/shared/models/videos/channel-sync/video-channel-sync-create.model.ts
@@ -0,0 +1,4 @@
1export interface VideoChannelSyncCreate {
2 externalChannelUrl: string
3 videoChannelId: number
4}
diff --git a/shared/models/videos/channel-sync/video-channel-sync-state.enum.ts b/shared/models/videos/channel-sync/video-channel-sync-state.enum.ts
new file mode 100644
index 000000000..3e9f5ddc2
--- /dev/null
+++ b/shared/models/videos/channel-sync/video-channel-sync-state.enum.ts
@@ -0,0 +1,6 @@
1export const enum VideoChannelSyncState {
2 WAITING_FIRST_RUN = 1,
3 PROCESSING = 2,
4 SYNCED = 3,
5 FAILED = 4
6}
diff --git a/shared/models/videos/channel-sync/video-channel-sync.model.ts b/shared/models/videos/channel-sync/video-channel-sync.model.ts
new file mode 100644
index 000000000..73ac0615b
--- /dev/null
+++ b/shared/models/videos/channel-sync/video-channel-sync.model.ts
@@ -0,0 +1,14 @@
1import { VideoChannelSummary } from '../channel/video-channel.model'
2import { VideoConstant } from '../video-constant.model'
3import { VideoChannelSyncState } from './video-channel-sync-state.enum'
4
5export interface VideoChannelSync {
6 id: number
7
8 externalChannelUrl: string
9
10 createdAt: string
11 channel: VideoChannelSummary
12 state: VideoConstant<VideoChannelSyncState>
13 lastSyncAt: string
14}
diff --git a/shared/models/videos/index.ts b/shared/models/videos/index.ts
index 05497bda1..f8e6976d3 100644
--- a/shared/models/videos/index.ts
+++ b/shared/models/videos/index.ts
@@ -11,6 +11,7 @@ export * from './playlist'
11export * from './rate' 11export * from './rate'
12export * from './stats' 12export * from './stats'
13export * from './transcoding' 13export * from './transcoding'
14export * from './channel-sync'
14 15
15export * from './nsfw-policy.type' 16export * from './nsfw-policy.type'
16 17
diff --git a/shared/server-commands/server/config-command.ts b/shared/server-commands/server/config-command.ts
index 8ab750983..1c2315ed1 100644
--- a/shared/server-commands/server/config-command.ts
+++ b/shared/server-commands/server/config-command.ts
@@ -18,17 +18,25 @@ export class ConfigCommand extends AbstractCommand {
18 } 18 }
19 } 19 }
20 20
21 disableImports () {
22 return this.setImportsEnabled(false)
23 }
24
21 enableImports () { 25 enableImports () {
26 return this.setImportsEnabled(true)
27 }
28
29 private setImportsEnabled (enabled: boolean) {
22 return this.updateExistingSubConfig({ 30 return this.updateExistingSubConfig({
23 newConfig: { 31 newConfig: {
24 import: { 32 import: {
25 videos: { 33 videos: {
26 http: { 34 http: {
27 enabled: true 35 enabled
28 }, 36 },
29 37
30 torrent: { 38 torrent: {
31 enabled: true 39 enabled
32 } 40 }
33 } 41 }
34 } 42 }
@@ -36,6 +44,26 @@ export class ConfigCommand extends AbstractCommand {
36 }) 44 })
37 } 45 }
38 46
47 private setChannelSyncEnabled (enabled: boolean) {
48 return this.updateExistingSubConfig({
49 newConfig: {
50 import: {
51 videoChannelSynchronization: {
52 enabled
53 }
54 }
55 }
56 })
57 }
58
59 enableChannelSync () {
60 return this.setChannelSyncEnabled(true)
61 }
62
63 disableChannelSync () {
64 return this.setChannelSyncEnabled(false)
65 }
66
39 enableLive (options: { 67 enableLive (options: {
40 allowReplay?: boolean 68 allowReplay?: boolean
41 transcoding?: boolean 69 transcoding?: boolean
@@ -356,6 +384,10 @@ export class ConfigCommand extends AbstractCommand {
356 torrent: { 384 torrent: {
357 enabled: false 385 enabled: false
358 } 386 }
387 },
388 videoChannelSynchronization: {
389 enabled: false,
390 maxPerUser: 10
359 } 391 }
360 }, 392 },
361 trending: { 393 trending: {
diff --git a/shared/server-commands/server/server.ts b/shared/server-commands/server/server.ts
index 0ad818a11..7acbc978f 100644
--- a/shared/server-commands/server/server.ts
+++ b/shared/server-commands/server/server.ts
@@ -19,6 +19,7 @@ import {
19 CaptionsCommand, 19 CaptionsCommand,
20 ChangeOwnershipCommand, 20 ChangeOwnershipCommand,
21 ChannelsCommand, 21 ChannelsCommand,
22 ChannelSyncsCommand,
22 HistoryCommand, 23 HistoryCommand,
23 ImportsCommand, 24 ImportsCommand,
24 LiveCommand, 25 LiveCommand,
@@ -118,6 +119,7 @@ export class PeerTubeServer {
118 playlists?: PlaylistsCommand 119 playlists?: PlaylistsCommand
119 history?: HistoryCommand 120 history?: HistoryCommand
120 imports?: ImportsCommand 121 imports?: ImportsCommand
122 channelSyncs?: ChannelSyncsCommand
121 streamingPlaylists?: StreamingPlaylistsCommand 123 streamingPlaylists?: StreamingPlaylistsCommand
122 channels?: ChannelsCommand 124 channels?: ChannelsCommand
123 comments?: CommentsCommand 125 comments?: CommentsCommand
@@ -390,6 +392,7 @@ export class PeerTubeServer {
390 this.playlists = new PlaylistsCommand(this) 392 this.playlists = new PlaylistsCommand(this)
391 this.history = new HistoryCommand(this) 393 this.history = new HistoryCommand(this)
392 this.imports = new ImportsCommand(this) 394 this.imports = new ImportsCommand(this)
395 this.channelSyncs = new ChannelSyncsCommand(this)
393 this.streamingPlaylists = new StreamingPlaylistsCommand(this) 396 this.streamingPlaylists = new StreamingPlaylistsCommand(this)
394 this.channels = new ChannelsCommand(this) 397 this.channels = new ChannelsCommand(this)
395 this.comments = new CommentsCommand(this) 398 this.comments = new CommentsCommand(this)
diff --git a/shared/server-commands/server/servers.ts b/shared/server-commands/server/servers.ts
index 0faee3a8d..29f01774d 100644
--- a/shared/server-commands/server/servers.ts
+++ b/shared/server-commands/server/servers.ts
@@ -39,11 +39,30 @@ async function cleanupTests (servers: PeerTubeServer[]) {
39 return Promise.all(p) 39 return Promise.all(p)
40} 40}
41 41
42function getServerImportConfig (mode: 'youtube-dl' | 'yt-dlp') {
43 return {
44 import: {
45 videos: {
46 http: {
47 youtube_dl_release: {
48 url: mode === 'youtube-dl'
49 ? 'https://yt-dl.org/downloads/latest/youtube-dl'
50 : 'https://api.github.com/repos/yt-dlp/yt-dlp/releases',
51
52 name: mode
53 }
54 }
55 }
56 }
57 }
58}
59
42// --------------------------------------------------------------------------- 60// ---------------------------------------------------------------------------
43 61
44export { 62export {
45 createSingleServer, 63 createSingleServer,
46 createMultipleServers, 64 createMultipleServers,
47 cleanupTests, 65 cleanupTests,
48 killallServers 66 killallServers,
67 getServerImportConfig
49} 68}
diff --git a/shared/server-commands/videos/channel-syncs-command.ts b/shared/server-commands/videos/channel-syncs-command.ts
new file mode 100644
index 000000000..de4a160ec
--- /dev/null
+++ b/shared/server-commands/videos/channel-syncs-command.ts
@@ -0,0 +1,55 @@
1import { HttpStatusCode, ResultList, VideoChannelSync, VideoChannelSyncCreate } from '@shared/models'
2import { pick } from '@shared/core-utils'
3import { unwrapBody } from '../requests'
4import { AbstractCommand, OverrideCommandOptions } from '../shared'
5
6export class ChannelSyncsCommand extends AbstractCommand {
7 private static readonly API_PATH = '/api/v1/video-channel-syncs'
8
9 listByAccount (options: OverrideCommandOptions & {
10 accountName: string
11 start?: number
12 count?: number
13 sort?: string
14 }) {
15 const { accountName, sort = 'createdAt' } = options
16
17 const path = `/api/v1/accounts/${accountName}/video-channel-syncs`
18
19 return this.getRequestBody<ResultList<VideoChannelSync>>({
20 ...options,
21
22 path,
23 query: { sort, ...pick(options, [ 'start', 'count' ]) },
24 implicitToken: true,
25 defaultExpectedStatus: HttpStatusCode.OK_200
26 })
27 }
28
29 async create (options: OverrideCommandOptions & {
30 attributes: VideoChannelSyncCreate
31 }) {
32 return unwrapBody<{ videoChannelSync: VideoChannelSync }>(this.postBodyRequest({
33 ...options,
34
35 path: ChannelSyncsCommand.API_PATH,
36 fields: options.attributes,
37 implicitToken: true,
38 defaultExpectedStatus: HttpStatusCode.OK_200
39 }))
40 }
41
42 delete (options: OverrideCommandOptions & {
43 channelSyncId: number
44 }) {
45 const path = `${ChannelSyncsCommand.API_PATH}/${options.channelSyncId}`
46
47 return this.deleteRequest({
48 ...options,
49
50 path,
51 implicitToken: true,
52 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
53 })
54 }
55}
diff --git a/shared/server-commands/videos/channels-command.ts b/shared/server-commands/videos/channels-command.ts
index 8ab124658..a688a120f 100644
--- a/shared/server-commands/videos/channels-command.ts
+++ b/shared/server-commands/videos/channels-command.ts
@@ -181,4 +181,22 @@ export class ChannelsCommand extends AbstractCommand {
181 defaultExpectedStatus: HttpStatusCode.OK_200 181 defaultExpectedStatus: HttpStatusCode.OK_200
182 }) 182 })
183 } 183 }
184
185 importVideos (options: OverrideCommandOptions & {
186 channelName: string
187 externalChannelUrl: string
188 }) {
189 const { channelName, externalChannelUrl } = options
190
191 const path = `/api/v1/video-channels/${channelName}/import-videos`
192
193 return this.postBodyRequest({
194 ...options,
195
196 path,
197 fields: { externalChannelUrl },
198 implicitToken: true,
199 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
200 })
201 }
184} 202}
diff --git a/shared/server-commands/videos/index.ts b/shared/server-commands/videos/index.ts
index b861731fb..b4d6fa37b 100644
--- a/shared/server-commands/videos/index.ts
+++ b/shared/server-commands/videos/index.ts
@@ -3,6 +3,7 @@ export * from './captions-command'
3export * from './change-ownership-command' 3export * from './change-ownership-command'
4export * from './channels' 4export * from './channels'
5export * from './channels-command' 5export * from './channels-command'
6export * from './channel-syncs-command'
6export * from './comments-command' 7export * from './comments-command'
7export * from './history-command' 8export * from './history-command'
8export * from './imports-command' 9export * from './imports-command'