Make federation of unlisted videos an instance-level server preference

client/src/app/+admin/config/edit-custom-config/edit-custom-config.component.ts

@@ -137,6 +137,11 @@ export class EditCustomConfigComponent extends FormReactive implements OnInit, A
           css: null
         }
       },
+      federation: {
+        videos: {
+          federateUnlisted: true
+        }
+      },
       theme: {
         default: null
       },

client/src/app/core/server/server.service.ts

@@ -58,6 +58,11 @@ export class ServerService {
       registeredExternalAuths: [],
       registeredIdAndPassAuths: []
     },
+    federation: {
+      videos: {
+        federateUnlisted: true
+      }
+    },
     theme: {
       registered: [],
       default: 'default'

config/default.yaml

@@ -178,6 +178,10 @@ plugins:
     check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
     url: 'https://packages.joinpeertube.org'
 
+federation:
+  videos:
+    federate_unlisted: true
+
 cache:
   previews:
     size: 500 # Max number of previews you want to cache

config/production.yaml.example

@@ -179,6 +179,10 @@ plugins:
     check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
     url: 'https://packages.joinpeertube.org'
 
+federation:
+  videos:
+    federate_unlisted: true
+
 
 ###############################################################################
 #

server/controllers/api/config.ts

@@ -83,6 +83,11 @@ async function getConfig (req: express.Request, res: express.Response) {
       registeredExternalAuths: getExternalAuthsPlugins(),
       registeredIdAndPassAuths: getIdAndPassAuthPlugins()
     },
+    federation: {
+      videos: {
+        federateUnlisted: CONFIG.FEDERATION.VIDEOS.FEDERATE_UNLISTED
+      }
+    },
     theme: {
       registered: getRegisteredThemes(),
       default: defaultTheme
@@ -348,6 +353,11 @@ function customConfig (): CustomConfig {
     theme: {
       default: CONFIG.THEME.DEFAULT
     },
+    federation: {
+      videos: {
+        federateUnlisted: CONFIG.FEDERATION.VIDEOS.FEDERATE_UNLISTED
+      }
+    },
     services: {
       twitter: {
         username: CONFIG.SERVICES.TWITTER.USERNAME,

server/helpers/video.ts

@@ -15,7 +15,8 @@ import {
 import { Response } from 'express'
 import { DEFAULT_AUDIO_RESOLUTION } from '@server/initializers/constants'
 import { JobQueue } from '@server/lib/job-queue'
-import { VideoTranscodingPayload } from '@shared/models'
+import { VideoPrivacy, VideoTranscodingPayload } from '@shared/models'
+import { CONFIG } from "@server/initializers/config"
 
 type VideoFetchType = 'all' | 'only-video' | 'only-video-with-rights' | 'id' | 'none' | 'only-immutable-attributes'
 
@@ -96,12 +97,27 @@ function extractVideo (videoOrPlaylist: MVideo | MStreamingPlaylistVideo) {
     : videoOrPlaylist
 }
 
+function isPrivacyForFederation (privacy: VideoPrivacy) {
+  const castedPrivacy = parseInt(privacy + '', 10)
+
+  return castedPrivacy === VideoPrivacy.PUBLIC ||
+    (CONFIG.FEDERATION.VIDEOS.FEDERATE_UNLISTED === true && castedPrivacy === VideoPrivacy.UNLISTED)
+}
+
+function getPrivaciesForFederation () {
+  return (CONFIG.FEDERATION.VIDEOS.FEDERATE_UNLISTED === true)
+    ? [ { privacy: VideoPrivacy.PUBLIC }, { privacy: VideoPrivacy.UNLISTED } ]
+    : [ { privacy: VideoPrivacy.PUBLIC } ]
+}
+
 export {
   VideoFetchType,
   VideoFetchByUrlType,
   fetchVideo,
   getVideoWithAttributes,
   fetchVideoByUrl,
   addOptimizeOrMergeAudioJob,
-  extractVideo
+  extractVideo,
+  isPrivacyForFederation,
+  getPrivaciesForFederation
 }

server/initializers/checker-before-init.ts

@@ -34,7 +34,8 @@ function checkMissedConfig () {
     'history.videos.max_age', 'views.videos.remote.max_age',
     'rates_limit.login.window', 'rates_limit.login.max', 'rates_limit.ask_send_email.window', 'rates_limit.ask_send_email.max',
     'theme.default',
-    'remote_redundancy.videos.accept_from'
+    'remote_redundancy.videos.accept_from',
+    'federation.videos.federate_unlisted'
   ]
   const requiredAlternatives = [
     [ // set

server/initializers/config.ts

@@ -154,6 +154,11 @@ const CONFIG = {
       URL: config.get<string>('plugins.index.url')
     }
   },
+  FEDERATION: {
+    VIDEOS: {
+      get FEDERATE_UNLISTED () { return config.get<boolean>('federation.videos.federate_unlisted') }
+    }
+  },
   ADMIN: {
     get EMAIL () { return config.get<string>('admin.email') }
   },

server/models/video/video.ts

@@ -126,6 +126,7 @@ import { ModelCache } from '@server/models/model-cache'
 import { buildListQuery, BuildVideosQueryOptions, wrapForAPIResults } from './video-query-builder'
 import { buildNSFWFilter } from '@server/helpers/express-utils'
 import { getServerActor } from '@server/models/application/application'
+import { getPrivaciesForFederation, isPrivacyForFederation } from "@server/helpers/video"
 
 export enum ScopeNames {
   AVAILABLE_FOR_LIST_IDS = 'AVAILABLE_FOR_LIST_IDS',
@@ -864,10 +865,7 @@ export class VideoModel extends Model<VideoModel> {
         id: {
           [Op.in]: Sequelize.literal('(' + rawQuery + ')')
         },
-        [Op.or]: [
-          { privacy: VideoPrivacy.PUBLIC },
-          { privacy: VideoPrivacy.UNLISTED }
-        ]
+        [Op.or]: getPrivaciesForFederation()
       },
       include: [
         {
@@ -1582,12 +1580,6 @@ export class VideoModel extends Model<VideoModel> {
     return videos
   }
 
-  private static isPrivacyForFederation (privacy: VideoPrivacy) {
-    const castedPrivacy = parseInt(privacy + '', 10)
-
-    return castedPrivacy === VideoPrivacy.PUBLIC || castedPrivacy === VideoPrivacy.UNLISTED
-  }
-
   static getCategoryLabel (id: number) {
     return VIDEO_CATEGORIES[id] || 'Misc'
   }
@@ -1813,11 +1805,11 @@ export class VideoModel extends Model<VideoModel> {
   }
 
   hasPrivacyForFederation () {
-    return VideoModel.isPrivacyForFederation(this.privacy)
+    return isPrivacyForFederation(this.privacy)
   }
 
   isNewVideo (newPrivacy: VideoPrivacy) {
-    return this.hasPrivacyForFederation() === false && VideoModel.isPrivacyForFederation(newPrivacy) === true
+    return this.hasPrivacyForFederation() === false && isPrivacyForFederation(newPrivacy) === true
   }
 
   setAsRefreshed () {

server/tests/api/check-params/config.ts

@@ -47,6 +47,11 @@ describe('Test config API validators', function () {
         css: 'body { background-color: red; }'
       }
     },
+    federation: {
+      videos: {
+        federateUnlisted: false
+      }
+    },
     theme: {
       default: 'default'
     },

server/tests/api/server/config.ts

@@ -49,6 +49,8 @@ function checkInitialConfig (server: ServerInfo, data: CustomConfig) {
   expect(data.instance.customizations.css).to.be.empty
   expect(data.instance.customizations.javascript).to.be.empty
 
+  expect(data.federation.videos.federateUnlisted).to.be.true
+
   expect(data.services.twitter.username).to.equal('@Chocobozzz')
   expect(data.services.twitter.whitelisted).to.be.false
 
@@ -112,6 +114,8 @@ function checkUpdatedConfig (data: CustomConfig) {
   expect(data.instance.customizations.javascript).to.equal('alert("coucou")')
   expect(data.instance.customizations.css).to.equal('body { background-color: red; }')
 
+  expect(data.federation.videos.federateUnlisted).to.be.false
+
   expect(data.services.twitter.username).to.equal('@Kuja')
   expect(data.services.twitter.whitelisted).to.be.true
 
@@ -238,6 +242,11 @@ describe('Test config', function () {
           css: 'body { background-color: red; }'
         }
       },
+      federation: {
+        videos: {
+          federateUnlisted: false
+        }
+      },
       theme: {
         default: 'default'
       },

server/tests/api/videos/video-privacy.ts

@@ -6,24 +6,29 @@ import { VideoPrivacy } from '../../../../shared/models/videos/video-privacy.enu
 import {
   cleanupTests,
   flushAndRunMultipleServers,
+  getConfig,
+  getCustomConfig,
   getVideosList,
   getVideosListWithToken,
   ServerInfo,
   setAccessTokensToServers,
+  updateCustomConfig,
   uploadVideo
 } from '../../../../shared/extra-utils/index'
 import { doubleFollow } from '../../../../shared/extra-utils/server/follows'
 import { userLogin } from '../../../../shared/extra-utils/users/login'
 import { createUser } from '../../../../shared/extra-utils/users/users'
 import { getMyVideos, getVideo, getVideoWithToken, updateVideo } from '../../../../shared/extra-utils/videos/videos'
 import { waitJobs } from '../../../../shared/extra-utils/server/jobs'
-import { Video } from '@shared/models'
+import { ServerConfig, Video } from '../../../../shared/models'
+import { CustomConfig } from "../../../../shared/models/server"
 
 const expect = chai.expect
 
 describe('Test video privacy', function () {
   let servers: ServerInfo[] = []
   let anotherUserToken: string
+  let customConfig: CustomConfig
 
   let privateVideoId: number
   let privateVideoUUID: string
@@ -32,6 +37,7 @@ describe('Test video privacy', function () {
   let internalVideoUUID: string
 
   let unlistedVideoUUID: string
+  let nonFederatedUnlistedVideoUUID: string
 
   let now: number
 
@@ -46,6 +52,11 @@ describe('Test video privacy', function () {
 
     // Server 1 and server 2 follow each other
     await doubleFollow(servers[0], servers[1])
+
+    {
+      const res = await getCustomConfig(servers[1].url, servers[1].accessToken)
+      customConfig = res.body
+    }
   })
 
   it('Should upload a private and internal videos on server 1', async function () {
@@ -164,6 +175,45 @@ describe('Test video privacy', function () {
     }
   })
 
+  it('Should upload a non-federating unlisted video to server 2', async function () {
+    this.timeout(30000)
+
+    customConfig.federation.videos.federateUnlisted = false
+    await updateCustomConfig(servers[1].url, servers[1].accessToken, customConfig)
+    const resConfig = await getConfig(servers[1].url)
+    const serverConfig: ServerConfig = resConfig.body
+
+    expect(serverConfig.federation.videos.federateUnlisted).to.be.false
+
+    const attributes = {
+      name: 'unlisted video',
+      privacy: VideoPrivacy.UNLISTED
+    }
+    await uploadVideo(servers[1].url, servers[1].accessToken, attributes)
+
+    // Server 2 has transcoding enabled
+    await waitJobs(servers)
+  })
+
+  it('Should list my new unlisted video', async function () {
+    const res = await getMyVideos(servers[1].url, servers[1].accessToken, 0, 2)
+
+    expect(res.body.total).to.equal(2)
+    expect(res.body.data).to.have.lengthOf(2)
+
+    nonFederatedUnlistedVideoUUID = res.body.data[0].uuid
+  })
+
+  it('Should be able to get non-federated unlisted video from origin', async function () {
+    const res = await getVideo(servers[1].url, nonFederatedUnlistedVideoUUID)
+
+    expect(res.body.name).to.equal('unlisted video')
+  })
+
+  it('Should not be able to get non-federated unlisted video from federated server', async function () {
+    await getVideo(servers[0].url, nonFederatedUnlistedVideoUUID, 404)
+  })
+
   it('Should update the private and internal videos to public on server 1', async function () {
     this.timeout(10000)
 

shared/extra-utils/server/config.ts

@@ -73,6 +73,11 @@ function updateCustomSubConfig (url: string, token: string, newConfig: DeepParti
         css: 'body { background-color: red; }'
       }
     },
+    federation: {
+      videos: {
+        federateUnlisted: false
+      }
+    },
     theme: {
       default: 'default'
     },

shared/models/server/custom-config.model.ts

@@ -27,6 +27,12 @@ export interface CustomConfig {
     }
   }
 
+  federation: {
+    videos: {
+      federateUnlisted: boolean
+    }
+  }
+
   theme: {
     default: string
   }

shared/models/server/server-config.model.ts

@@ -59,6 +59,12 @@ export interface ServerConfig {
     registeredIdAndPassAuths: RegisteredIdAndPassAuthConfig[]
   }
 
+  federation: {
+    videos: {
+      federateUnlisted: boolean
+    }
+  }
+
   theme: {
     registered: ServerConfigTheme[]
     default: string

support/docker/production/config/production.yaml

@@ -64,3 +64,7 @@ tracker:
 
 admin:
   email: null
+
+federation:
+  videos:
+    federate_unlisted: true