Add subscriptions endpoints to REST API

10 files changed, 148 insertions, 29 deletions

diff --git a/server/controllers/activitypub/inbox.ts b/server/controllers/activitypub/inbox.ts
index a106df717..20bd20ed4 100644
--- a/server/controllers/activitypub/inbox.ts
+++ b/server/controllers/activitypub/inbox.ts
@@ -3,9 +3,10 @@ import { Activity, ActivityPubCollection, ActivityPubOrderedCollection, RootActi
 import { isActivityValid } from '../../helpers/custom-validators/activitypub/activity'
 import { logger } from '../../helpers/logger'
 import { processActivities } from '../../lib/activitypub/process/process'
-import { asyncMiddleware, checkSignature, localAccountValidator, signatureValidator } from '../../middlewares'
+import { asyncMiddleware, checkSignature, localAccountValidator, localVideoChannelValidator, signatureValidator } from '../../middlewares'
 import { activityPubValidator } from '../../middlewares/validators/activitypub/activity'
-import { ActorModel } from '../../models/activitypub/actor'
+import { VideoChannelModel } from '../../models/video/video-channel'
+import { AccountModel } from '../../models/account/account'
 
 const inboxRouter = express.Router()
 
@@ -23,6 +24,13 @@ inboxRouter.post('/accounts/:name/inbox',
   asyncMiddleware(activityPubValidator),
   asyncMiddleware(inboxController)
 )
+inboxRouter.post('/video-channels/:name/inbox',
+  signatureValidator,
+  asyncMiddleware(checkSignature),
+  asyncMiddleware(localVideoChannelValidator),
+  asyncMiddleware(activityPubValidator),
+  asyncMiddleware(inboxController)
+)
 
 // ---------------------------------------------------------------------------
 
@@ -49,16 +57,16 @@ async function inboxController (req: express.Request, res: express.Response, nex
   activities = activities.filter(a => isActivityValid(a))
   logger.debug('We keep %d activities.', activities.length, { activities })
 
-  let specificActor: ActorModel = undefined
+  let accountOrChannel: VideoChannelModel | AccountModel
   if (res.locals.account) {
-    specificActor = res.locals.account
+    accountOrChannel = res.locals.account
   } else if (res.locals.videoChannel) {
-    specificActor = res.locals.videoChannel
+    accountOrChannel = res.locals.videoChannel
   }
 
   logger.info('Receiving inbox requests for %d activities by %s.', activities.length, res.locals.signature.actor.url)
 
-  await processActivities(activities, res.locals.signature.actor, specificActor)
+  await processActivities(activities, res.locals.signature.actor, accountOrChannel ? accountOrChannel.Actor : undefined)
 
   res.status(204).end()
 }
diff --git a/server/controllers/activitypub/outbox.ts b/server/controllers/activitypub/outbox.ts
index ae7adcd4c..db69ae54b 100644
--- a/server/controllers/activitypub/outbox.ts
+++ b/server/controllers/activitypub/outbox.ts
@@ -5,11 +5,12 @@ import { activityPubCollectionPagination, activityPubContextify } from '../../he
 import { logger } from '../../helpers/logger'
 import { announceActivityData, createActivityData } from '../../lib/activitypub/send'
 import { buildAudience } from '../../lib/activitypub/audience'
-import { asyncMiddleware, localAccountValidator } from '../../middlewares'
+import { asyncMiddleware, localAccountValidator, localVideoChannelValidator } from '../../middlewares'
 import { AccountModel } from '../../models/account/account'
 import { ActorModel } from '../../models/activitypub/actor'
 import { VideoModel } from '../../models/video/video'
 import { activityPubResponse } from './utils'
+import { VideoChannelModel } from '../../models/video/video-channel'
 
 const outboxRouter = express.Router()
 
@@ -18,6 +19,11 @@ outboxRouter.get('/accounts/:name/outbox',
   asyncMiddleware(outboxController)
 )
 
+outboxRouter.get('/video-channels/:name/outbox',
+  localVideoChannelValidator,
+  asyncMiddleware(outboxController)
+)
+
 // ---------------------------------------------------------------------------
 
 export {
@@ -27,9 +33,9 @@ export {
 // ---------------------------------------------------------------------------
 
 async function outboxController (req: express.Request, res: express.Response, next: express.NextFunction) {
-  const account: AccountModel = res.locals.account
-  const actor = account.Actor
-  const actorOutboxUrl = account.Actor.url + '/outbox'
+  const accountOrVideoChannel: AccountModel | VideoChannelModel = res.locals.account || res.locals.videoChannel
+  const actor = accountOrVideoChannel.Actor
+  const actorOutboxUrl = actor.url + '/outbox'
 
   logger.info('Receiving outbox request for %s.', actorOutboxUrl)
 
diff --git a/server/controllers/api/accounts.ts b/server/controllers/api/accounts.ts
index 0117fc8c6..308970abc 100644
--- a/server/controllers/api/accounts.ts
+++ b/server/controllers/api/accounts.ts
@@ -78,6 +78,7 @@ async function listAccountVideos (req: express.Request, res: express.Response, n
     start: req.query.start,
     count: req.query.count,
     sort: req.query.sort,
+    includeLocalVideos: false,
     categoryOneOf: req.query.categoryOneOf,
     licenceOneOf: req.query.licenceOneOf,
     languageOneOf: req.query.languageOneOf,
diff --git a/server/controllers/api/search.ts b/server/controllers/api/search.ts
index f810c7452..7a7504b7d 100644
--- a/server/controllers/api/search.ts
+++ b/server/controllers/api/search.ts
@@ -36,7 +36,10 @@ export { searchRouter }
 async function searchVideos (req: express.Request, res: express.Response) {
   const query: VideosSearchQuery = req.query
 
-  const options = Object.assign(query, { nsfw: buildNSFWFilter(res, query.nsfw) })
+  const options = Object.assign(query, {
+    includeLocalVideos: true,
+    nsfw: buildNSFWFilter(res, query.nsfw)
+  })
   const resultList = await VideoModel.searchAndPopulateAccountAndServer(options)
 
   return res.json(getFormattedObjects(resultList.data, resultList.total))
diff --git a/server/controllers/api/server/follows.ts b/server/controllers/api/server/follows.ts
index e78361c9a..23308445f 100644
--- a/server/controllers/api/server/follows.ts
+++ b/server/controllers/api/server/follows.ts
@@ -2,7 +2,7 @@ import * as express from 'express'
 import { UserRight } from '../../../../shared/models/users'
 import { logger } from '../../../helpers/logger'
 import { getFormattedObjects, getServerActor } from '../../../helpers/utils'
-import { sequelizeTypescript } from '../../../initializers'
+import { sequelizeTypescript, SERVER_ACTOR_NAME } from '../../../initializers'
 import { sendUndoFollow } from '../../../lib/activitypub/send'
 import {
   asyncMiddleware,
@@ -74,9 +74,16 @@ async function listFollowers (req: express.Request, res: express.Response, next:
 
 async function followInstance (req: express.Request, res: express.Response, next: express.NextFunction) {
   const hosts = req.body.hosts as string[]
+  const follower = await getServerActor()
 
   for (const host of hosts) {
-    JobQueue.Instance.createJob({ type: 'activitypub-follow', payload: { host } })
+    const payload = {
+      host,
+      name: SERVER_ACTOR_NAME,
+      followerActorId: follower.id
+    }
+
+    JobQueue.Instance.createJob({ type: 'activitypub-follow', payload })
       .catch(err => logger.error('Cannot create follow job for %s.', host, err))
   }
 
@@ -92,11 +99,5 @@ async function removeFollow (req: express.Request, res: express.Response, next:
     await follow.destroy({ transaction: t })
   })
 
-  // Destroy the actor that will destroy video channels, videos and video files too
-  // This could be long so don't wait this task
-  const following = follow.ActorFollowing
-  following.destroy()
-    .catch(err => logger.error('Cannot destroy actor that we do not follow anymore %s.', following.url, { err }))
-
   return res.status(204).end()
 }
diff --git a/server/controllers/api/users/index.ts b/server/controllers/api/users/index.ts
index 105244ddd..608d439ac 100644
--- a/server/controllers/api/users/index.ts
+++ b/server/controllers/api/users/index.ts
@@ -29,7 +29,6 @@ import { usersAskResetPasswordValidator, usersBlockingValidator, usersResetPassw
 import { UserModel } from '../../../models/account/user'
 import { OAuthTokenModel } from '../../../models/oauth/oauth-token'
 import { auditLoggerFactory, UserAuditView } from '../../../helpers/audit-logger'
-import { videosRouter } from '../videos'
 import { meRouter } from './me'
 
 const auditLogger = auditLoggerFactory('users')
@@ -41,7 +40,7 @@ const loginRateLimiter = new RateLimit({
 })
 
 const usersRouter = express.Router()
-videosRouter.use('/', meRouter)
+usersRouter.use('/', meRouter)
 
 usersRouter.get('/',
   authenticate,
diff --git a/server/controllers/api/users/me.ts b/server/controllers/api/users/me.ts
index 1e096a35d..403842163 100644
--- a/server/controllers/api/users/me.ts
+++ b/server/controllers/api/users/me.ts
@@ -7,23 +7,35 @@ import { sendUpdateActor } from '../../../lib/activitypub/send'
 import {
   asyncMiddleware,
   authenticate,
+  commonVideosFiltersValidator,
   paginationValidator,
   setDefaultPagination,
   setDefaultSort,
+  userSubscriptionAddValidator,
+  userSubscriptionRemoveValidator,
   usersUpdateMeValidator,
   usersVideoRatingValidator
 } from '../../../middlewares'
-import { deleteMeValidator, videoImportsSortValidator, videosSortValidator } from '../../../middlewares/validators'
+import {
+  deleteMeValidator,
+  userSubscriptionsSortValidator,
+  videoImportsSortValidator,
+  videosSortValidator
+} from '../../../middlewares/validators'
 import { AccountVideoRateModel } from '../../../models/account/account-video-rate'
 import { UserModel } from '../../../models/account/user'
 import { VideoModel } from '../../../models/video/video'
 import { VideoSortField } from '../../../../client/src/app/shared/video/sort-field.type'
-import { createReqFiles } from '../../../helpers/express-utils'
+import { buildNSFWFilter, createReqFiles } from '../../../helpers/express-utils'
 import { UserVideoQuota } from '../../../../shared/models/users/user-video-quota.model'
 import { updateAvatarValidator } from '../../../middlewares/validators/avatar'
 import { updateActorAvatarFile } from '../../../lib/avatar'
 import { auditLoggerFactory, UserAuditView } from '../../../helpers/audit-logger'
 import { VideoImportModel } from '../../../models/video/video-import'
+import { VideoFilter } from '../../../../shared/models/videos/video-query.type'
+import { ActorFollowModel } from '../../../models/activitypub/actor-follow'
+import { JobQueue } from '../../../lib/job-queue'
+import { logger } from '../../../helpers/logger'
 
 const auditLogger = auditLoggerFactory('users-me')
 
@@ -83,6 +95,40 @@ meRouter.post('/me/avatar/pick',
   asyncMiddleware(updateMyAvatar)
 )
 
+// ##### Subscriptions part #####
+
+meRouter.get('/me/subscriptions',
+  authenticate,
+  paginationValidator,
+  userSubscriptionsSortValidator,
+  setDefaultSort,
+  setDefaultPagination,
+  asyncMiddleware(getUserSubscriptions)
+)
+
+meRouter.post('/me/subscriptions',
+  authenticate,
+  userSubscriptionAddValidator,
+  asyncMiddleware(addUserSubscription)
+)
+
+meRouter.delete('/me/subscriptions/:uri',
+  authenticate,
+  userSubscriptionRemoveValidator,
+  asyncMiddleware(deleteUserSubscription)
+)
+
+meRouter.get('/me/subscriptions/videos',
+  authenticate,
+  authenticate,
+  paginationValidator,
+  videosSortValidator,
+  setDefaultSort,
+  setDefaultPagination,
+  commonVideosFiltersValidator,
+  asyncMiddleware(getUserSubscriptionVideos)
+)
+
 // ---------------------------------------------------------------------------
 
 export {
@@ -91,6 +137,62 @@ export {
 
 // ---------------------------------------------------------------------------
 
+async function addUserSubscription (req: express.Request, res: express.Response) {
+  const user = res.locals.oauth.token.User as UserModel
+  const [ name, host ] = req.body.uri.split('@')
+
+  const payload = {
+    name,
+    host,
+    followerActorId: user.Account.Actor.id
+  }
+
+  JobQueue.Instance.createJob({ type: 'activitypub-follow', payload })
+          .catch(err => logger.error('Cannot create follow job for subscription %s.', req.body.uri, err))
+
+  return res.status(204).end()
+}
+
+async function deleteUserSubscription (req: express.Request, res: express.Response) {
+  const subscription: ActorFollowModel = res.locals.subscription
+
+  await sequelizeTypescript.transaction(async t => {
+    return subscription.destroy({ transaction: t })
+  })
+
+  return res.type('json').status(204).end()
+}
+
+async function getUserSubscriptions (req: express.Request, res: express.Response) {
+  const user = res.locals.oauth.token.User as UserModel
+  const actorId = user.Account.Actor.id
+
+  const resultList = await ActorFollowModel.listSubscriptionsForApi(actorId, req.query.start, req.query.count, req.query.sort)
+
+  return res.json(getFormattedObjects(resultList.data, resultList.total))
+}
+
+async function getUserSubscriptionVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
+  const user = res.locals.oauth.token.User as UserModel
+  const resultList = await VideoModel.listForApi({
+    start: req.query.start,
+    count: req.query.count,
+    sort: req.query.sort,
+    includeLocalVideos: false,
+    categoryOneOf: req.query.categoryOneOf,
+    licenceOneOf: req.query.licenceOneOf,
+    languageOneOf: req.query.languageOneOf,
+    tagsOneOf: req.query.tagsOneOf,
+    tagsAllOf: req.query.tagsAllOf,
+    nsfw: buildNSFWFilter(res, req.query.nsfw),
+    filter: req.query.filter as VideoFilter,
+    withFiles: false,
+    actorId: user.Account.Actor.id
+  })
+
+  return res.json(getFormattedObjects(resultList.data, resultList.total))
+}
+
 async function getUserVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
   const user = res.locals.oauth.token.User as UserModel
   const resultList = await VideoModel.listUserVideosForApi(
@@ -150,7 +252,7 @@ async function getUserVideoRating (req: express.Request, res: express.Response,
     videoId,
     rating
   }
-  res.json(json)
+  return res.json(json)
 }
 
 async function deleteMe (req: express.Request, res: express.Response) {
@@ -207,9 +309,5 @@ async function updateMyAvatar (req: express.Request, res: express.Response, next
     oldUserAuditView
   )
 
-  return res
-    .json({
-      avatar: avatar.toFormattedJSON()
-    })
-    .end()
+  return res.json({ avatar: avatar.toFormattedJSON() })
 }
diff --git a/server/controllers/api/video-channel.ts b/server/controllers/api/video-channel.ts
index 023ebbedf..6ffc09f87 100644
--- a/server/controllers/api/video-channel.ts
+++ b/server/controllers/api/video-channel.ts
@@ -215,6 +215,7 @@ async function listVideoChannelVideos (req: express.Request, res: express.Respon
     start: req.query.start,
     count: req.query.count,
     sort: req.query.sort,
+    includeLocalVideos: false,
     categoryOneOf: req.query.categoryOneOf,
     licenceOneOf: req.query.licenceOneOf,
     languageOneOf: req.query.languageOneOf,
diff --git a/server/controllers/api/videos/index.ts b/server/controllers/api/videos/index.ts
index 92c6ee697..e973aa43f 100644
--- a/server/controllers/api/videos/index.ts
+++ b/server/controllers/api/videos/index.ts
@@ -414,6 +414,7 @@ async function listVideos (req: express.Request, res: express.Response, next: ex
     start: req.query.start,
     count: req.query.count,
     sort: req.query.sort,
+    includeLocalVideos: true,
     categoryOneOf: req.query.categoryOneOf,
     licenceOneOf: req.query.licenceOneOf,
     languageOneOf: req.query.languageOneOf,
diff --git a/server/controllers/feeds.ts b/server/controllers/feeds.ts
index 682f4abda..b30ad8e8d 100644
--- a/server/controllers/feeds.ts
+++ b/server/controllers/feeds.ts
@@ -96,6 +96,7 @@ async function generateVideoFeed (req: express.Request, res: express.Response, n
     start,
     count: FEEDS.COUNT,
     sort: req.query.sort,
+    includeLocalVideos: true,
     nsfw,
     filter: req.query.filter,
     withFiles: true,