server/controllers/static.ts

   1 import * as cors from 'cors'
   2 import * as express from 'express'
   3 import { CONFIG, ROUTE_CACHE_LIFETIME, STATIC_DOWNLOAD_PATHS, STATIC_MAX_AGE, STATIC_PATHS } from '../initializers'
   4 import { VideosPreviewCache } from '../lib/cache'
   5 import { cacheRoute } from '../middlewares/cache'
   6 import { asyncMiddleware, videosGetValidator } from '../middlewares'
   7 import { VideoModel } from '../models/video/video'
   8 import { VideosCaptionCache } from '../lib/cache/videos-caption-cache'
   9 import { UserModel } from '../models/account/user'
  10 import { VideoCommentModel } from '../models/video/video-comment'
  11 import { HttpNodeinfoDiasporaSoftwareNsSchema20 } from '../../shared/models/nodeinfo'
  12 import { join } from 'path'
  13 import { root } from '../helpers/core-utils'
  14
  15 const packageJSON = require('../../../package.json')
  16 const staticRouter = express.Router()
  17
  18 staticRouter.use(cors())
  19
  20 /*
  21   Cors is very important to let other servers access torrent and video files
  22 */
  23
  24 const torrentsPhysicalPath = CONFIG.STORAGE.TORRENTS_DIR
  25 staticRouter.use(
  26   STATIC_PATHS.TORRENTS,
  27   cors(),
  28   express.static(torrentsPhysicalPath, { maxAge: 0 }) // Don't cache because we could regenerate the torrent file
  29 )
  30 staticRouter.use(
  31   STATIC_DOWNLOAD_PATHS.TORRENTS + ':id-:resolution([0-9]+).torrent',
  32   asyncMiddleware(videosGetValidator),
  33   asyncMiddleware(downloadTorrent)
  34 )
  35
  36 // Videos path for webseeding
  37 staticRouter.use(
  38   STATIC_PATHS.WEBSEED,
  39   cors(),
  40   express.static(CONFIG.STORAGE.VIDEOS_DIR, { fallthrough: false }) // 404 because we don't have this video
  41 )
  42 staticRouter.use(
  43   STATIC_PATHS.REDUNDANCY,
  44   cors(),
  45   express.static(CONFIG.STORAGE.REDUNDANCY_DIR, { fallthrough: false }) // 404 because we don't have this video
  46 )
  47
  48 staticRouter.use(
  49   STATIC_DOWNLOAD_PATHS.VIDEOS + ':id-:resolution([0-9]+).:extension',
  50   asyncMiddleware(videosGetValidator),
  51   asyncMiddleware(downloadVideoFile)
  52 )
  53
  54 // Thumbnails path for express
  55 const thumbnailsPhysicalPath = CONFIG.STORAGE.THUMBNAILS_DIR
  56 staticRouter.use(
  57   STATIC_PATHS.THUMBNAILS,
  58   express.static(thumbnailsPhysicalPath, { maxAge: STATIC_MAX_AGE, fallthrough: false }) // 404 if the file does not exist
  59 )
  60
  61 const avatarsPhysicalPath = CONFIG.STORAGE.AVATARS_DIR
  62 staticRouter.use(
  63   STATIC_PATHS.AVATARS,
  64   express.static(avatarsPhysicalPath, { maxAge: STATIC_MAX_AGE, fallthrough: false }) // 404 if the file does not exist
  65 )
  66
  67 // We don't have video previews, fetch them from the origin instance
  68 staticRouter.use(
  69   STATIC_PATHS.PREVIEWS + ':uuid.jpg',
  70   asyncMiddleware(getPreview)
  71 )
  72
  73 // We don't have video captions, fetch them from the origin instance
  74 staticRouter.use(
  75   STATIC_PATHS.VIDEO_CAPTIONS + ':videoId-:captionLanguage([a-z]+).vtt',
  76   asyncMiddleware(getVideoCaption)
  77 )
  78
  79 // robots.txt service
  80 staticRouter.get('/robots.txt',
  81   asyncMiddleware(cacheRoute(ROUTE_CACHE_LIFETIME.ROBOTS)),
  82   (_, res: express.Response) => {
  83     res.type('text/plain')
  84     return res.send(CONFIG.INSTANCE.ROBOTS)
  85   }
  86 )
  87
  88 // security.txt service
  89 staticRouter.get('/security.txt',
  90   (_, res: express.Response) => {
  91     return res.redirect(301, '/.well-known/security.txt')
  92   }
  93 )
  94
  95 staticRouter.get('/.well-known/security.txt',
  96   asyncMiddleware(cacheRoute(ROUTE_CACHE_LIFETIME.SECURITYTXT)),
  97   (_, res: express.Response) => {
  98     res.type('text/plain')
  99     return res.send(CONFIG.INSTANCE.SECURITYTXT + CONFIG.INSTANCE.SECURITYTXT_CONTACT)
 100   }
 101 )
 102
 103 // nodeinfo service
 104 staticRouter.use('/.well-known/nodeinfo',
 105   asyncMiddleware(cacheRoute(ROUTE_CACHE_LIFETIME.NODEINFO)),
 106   (_, res: express.Response) => {
 107     return res.json({
 108       links: [
 109         {
 110           rel: 'http://nodeinfo.diaspora.software/ns/schema/2.0',
 111           href: CONFIG.WEBSERVER.URL + '/nodeinfo/2.0.json'
 112         }
 113       ]
 114     })
 115   }
 116 )
 117 staticRouter.use('/nodeinfo/:version.json',
 118   asyncMiddleware(cacheRoute(ROUTE_CACHE_LIFETIME.NODEINFO)),
 119   asyncMiddleware(generateNodeinfo)
 120 )
 121
 122 // dnt-policy.txt service (see https://www.eff.org/dnt-policy)
 123 staticRouter.use('/.well-known/dnt-policy.txt',
 124   asyncMiddleware(cacheRoute(ROUTE_CACHE_LIFETIME.DNT_POLICY)),
 125   (_, res: express.Response) => {
 126     res.type('text/plain')
 127
 128     return res.sendFile(join(root(), 'dist/server/static/dnt-policy/dnt-policy-1.0.txt'))
 129   }
 130 )
 131
 132 // dnt service (see https://www.w3.org/TR/tracking-dnt/#status-resource)
 133 staticRouter.use('/.well-known/dnt/',
 134   (_, res: express.Response) => {
 135     res.json({ tracking: 'N' })
 136   }
 137 )
 138
 139 staticRouter.use('/.well-known/change-password',
 140   (_, res: express.Response) => {
 141     res.redirect('/my-account/settings')
 142   }
 143 )
 144
 145 // ---------------------------------------------------------------------------
 146
 147 export {
 148   staticRouter
 149 }
 150
 151 // ---------------------------------------------------------------------------
 152
 153 async function getPreview (req: express.Request, res: express.Response, next: express.NextFunction) {
 154   const path = await VideosPreviewCache.Instance.getFilePath(req.params.uuid)
 155   if (!path) return res.sendStatus(404)
 156
 157   return res.sendFile(path, { maxAge: STATIC_MAX_AGE })
 158 }
 159
 160 async function getVideoCaption (req: express.Request, res: express.Response) {
 161   const path = await VideosCaptionCache.Instance.getFilePath({
 162     videoId: req.params.videoId,
 163     language: req.params.captionLanguage
 164   })
 165   if (!path) return res.sendStatus(404)
 166
 167   return res.sendFile(path, { maxAge: STATIC_MAX_AGE })
 168 }
 169
 170 async function generateNodeinfo (req: express.Request, res: express.Response, next: express.NextFunction) {
 171   const { totalVideos } = await VideoModel.getStats()
 172   const { totalLocalVideoComments } = await VideoCommentModel.getStats()
 173   const { totalUsers } = await UserModel.getStats()
 174   let json = {}
 175
 176   if (req.params.version && (req.params.version === '2.0')) {
 177     json = {
 178       version: '2.0',
 179       software: {
 180         name: 'peertube',
 181         version: packageJSON.version
 182       },
 183       protocols: [
 184         'activitypub'
 185       ],
 186       services: {
 187         inbound: [],
 188         outbound: [
 189           'atom1.0',
 190           'rss2.0'
 191         ]
 192       },
 193       openRegistrations: CONFIG.SIGNUP.ENABLED,
 194       usage: {
 195         users: {
 196           total: totalUsers
 197         },
 198         localPosts: totalVideos,
 199         localComments: totalLocalVideoComments
 200       },
 201       metadata: {
 202         taxonomy: {
 203           postsName: 'Videos'
 204         },
 205         nodeName: CONFIG.INSTANCE.NAME,
 206         nodeDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION
 207       }
 208     } as HttpNodeinfoDiasporaSoftwareNsSchema20
 209     res.contentType('application/json; profile="http://nodeinfo.diaspora.software/ns/schema/2.0#"')
 210   } else {
 211     json = { error: 'Nodeinfo schema version not handled' }
 212     res.status(404)
 213   }
 214
 215   return res.send(json).end()
 216 }
 217
 218 async function downloadTorrent (req: express.Request, res: express.Response, next: express.NextFunction) {
 219   const { video, videoFile } = getVideoAndFile(req, res)
 220   if (!videoFile) return res.status(404).end()
 221
 222   return res.download(video.getTorrentFilePath(videoFile), `${video.name}-${videoFile.resolution}p.torrent`)
 223 }
 224
 225 async function downloadVideoFile (req: express.Request, res: express.Response, next: express.NextFunction) {
 226   const { video, videoFile } = getVideoAndFile(req, res)
 227   if (!videoFile) return res.status(404).end()
 228
 229   return res.download(video.getVideoFilePath(videoFile), `${video.name}-${videoFile.resolution}p${videoFile.extname}`)
 230 }
 231
 232 function getVideoAndFile (req: express.Request, res: express.Response) {
 233   const resolution = parseInt(req.params.resolution, 10)
 234   const video: VideoModel = res.locals.video
 235
 236   const videoFile = video.VideoFiles.find(f => f.resolution === resolution)
 237
 238   return { video, videoFile }
 239 }