server/controllers/api/users/my-subscriptions.ts

   1 import 'multer'
   2 import express from 'express'
   3 import { handlesToNameAndHost } from '@server/helpers/actors'
   4 import { pickCommonVideoQuery } from '@server/helpers/query'
   5 import { sendUndoFollow } from '@server/lib/activitypub/send'
   6 import { guessAdditionalAttributesFromQuery } from '@server/models/video/formatter/video-format-utils'
   7 import { VideoChannelModel } from '@server/models/video/video-channel'
   8 import { HttpStatusCode } from '../../../../shared/models/http/http-error-codes'
   9 import { buildNSFWFilter, getCountVideos } from '../../../helpers/express-utils'
  10 import { getFormattedObjects } from '../../../helpers/utils'
  11 import { sequelizeTypescript } from '../../../initializers/database'
  12 import { JobQueue } from '../../../lib/job-queue'
  13 import {
  14   asyncMiddleware,
  15   asyncRetryTransactionMiddleware,
  16   authenticate,
  17   commonVideosFiltersValidator,
  18   paginationValidator,
  19   setDefaultPagination,
  20   setDefaultSort,
  21   setDefaultVideosSort,
  22   userSubscriptionAddValidator,
  23   userSubscriptionGetValidator
  24 } from '../../../middlewares'
  25 import {
  26   areSubscriptionsExistValidator,
  27   userSubscriptionListValidator,
  28   userSubscriptionsSortValidator,
  29   videosSortValidator
  30 } from '../../../middlewares/validators'
  31 import { ActorFollowModel } from '../../../models/actor/actor-follow'
  32 import { VideoModel } from '../../../models/video/video'
  33
  34 const mySubscriptionsRouter = express.Router()
  35
  36 mySubscriptionsRouter.get('/me/subscriptions/videos',
  37   authenticate,
  38   paginationValidator,
  39   videosSortValidator,
  40   setDefaultVideosSort,
  41   setDefaultPagination,
  42   commonVideosFiltersValidator,
  43   asyncMiddleware(getUserSubscriptionVideos)
  44 )
  45
  46 mySubscriptionsRouter.get('/me/subscriptions/exist',
  47   authenticate,
  48   areSubscriptionsExistValidator,
  49   asyncMiddleware(areSubscriptionsExist)
  50 )
  51
  52 mySubscriptionsRouter.get('/me/subscriptions',
  53   authenticate,
  54   paginationValidator,
  55   userSubscriptionsSortValidator,
  56   setDefaultSort,
  57   setDefaultPagination,
  58   userSubscriptionListValidator,
  59   asyncMiddleware(getUserSubscriptions)
  60 )
  61
  62 mySubscriptionsRouter.post('/me/subscriptions',
  63   authenticate,
  64   userSubscriptionAddValidator,
  65   addUserSubscription
  66 )
  67
  68 mySubscriptionsRouter.get('/me/subscriptions/:uri',
  69   authenticate,
  70   userSubscriptionGetValidator,
  71   asyncMiddleware(getUserSubscription)
  72 )
  73
  74 mySubscriptionsRouter.delete('/me/subscriptions/:uri',
  75   authenticate,
  76   userSubscriptionGetValidator,
  77   asyncRetryTransactionMiddleware(deleteUserSubscription)
  78 )
  79
  80 // ---------------------------------------------------------------------------
  81
  82 export {
  83   mySubscriptionsRouter
  84 }
  85
  86 // ---------------------------------------------------------------------------
  87
  88 async function areSubscriptionsExist (req: express.Request, res: express.Response) {
  89   const uris = req.query.uris as string[]
  90   const user = res.locals.oauth.token.User
  91
  92   const sanitizedHandles = handlesToNameAndHost(uris)
  93
  94   const results = await ActorFollowModel.listSubscriptionsOf(user.Account.Actor.id, sanitizedHandles)
  95
  96   const existObject: { [id: string ]: boolean } = {}
  97   for (const sanitizedHandle of sanitizedHandles) {
  98     const obj = results.find(r => {
  99       const server = r.ActorFollowing.Server
 100
 101       return r.ActorFollowing.preferredUsername === sanitizedHandle.name &&
 102         (
 103           (!server && !sanitizedHandle.host) ||
 104           (server.host === sanitizedHandle.host)
 105         )
 106     })
 107
 108     existObject[sanitizedHandle.handle] = obj !== undefined
 109   }
 110
 111   return res.json(existObject)
 112 }
 113
 114 function addUserSubscription (req: express.Request, res: express.Response) {
 115   const user = res.locals.oauth.token.User
 116   const [ name, host ] = req.body.uri.split('@')
 117
 118   const payload = {
 119     name,
 120     host,
 121     assertIsChannel: true,
 122     followerActorId: user.Account.Actor.id
 123   }
 124
 125   JobQueue.Instance.createJobAsync({ type: 'activitypub-follow', payload })
 126
 127   return res.status(HttpStatusCode.NO_CONTENT_204).end()
 128 }
 129
 130 async function getUserSubscription (req: express.Request, res: express.Response) {
 131   const subscription = res.locals.subscription
 132   const videoChannel = await VideoChannelModel.loadAndPopulateAccount(subscription.ActorFollowing.VideoChannel.id)
 133
 134   return res.json(videoChannel.toFormattedJSON())
 135 }
 136
 137 async function deleteUserSubscription (req: express.Request, res: express.Response) {
 138   const subscription = res.locals.subscription
 139
 140   await sequelizeTypescript.transaction(async t => {
 141     if (subscription.state === 'accepted') await sendUndoFollow(subscription, t)
 142
 143     return subscription.destroy({ transaction: t })
 144   })
 145
 146   return res.type('json')
 147             .status(HttpStatusCode.NO_CONTENT_204)
 148             .end()
 149 }
 150
 151 async function getUserSubscriptions (req: express.Request, res: express.Response) {
 152   const user = res.locals.oauth.token.User
 153   const actorId = user.Account.Actor.id
 154
 155   const resultList = await ActorFollowModel.listSubscriptionsForApi({
 156     actorId,
 157     start: req.query.start,
 158     count: req.query.count,
 159     sort: req.query.sort,
 160     search: req.query.search
 161   })
 162
 163   return res.json(getFormattedObjects(resultList.data, resultList.total))
 164 }
 165
 166 async function getUserSubscriptionVideos (req: express.Request, res: express.Response) {
 167   const user = res.locals.oauth.token.User
 168   const countVideos = getCountVideos(req)
 169   const query = pickCommonVideoQuery(req.query)
 170
 171   const resultList = await VideoModel.listForApi({
 172     ...query,
 173
 174     displayOnlyForFollower: {
 175       actorId: user.Account.Actor.id,
 176       orLocalVideos: false
 177     },
 178     nsfw: buildNSFWFilter(res, query.nsfw),
 179     user,
 180     countVideos
 181   })
 182
 183   return res.json(getFormattedObjects(resultList.data, resultList.total, guessAdditionalAttributesFromQuery(query)))
 184 }