server/controllers/static.ts

   1 import cors from 'cors'
   2 import express from 'express'
   3 import { join } from 'path'
   4 import { serveIndexHTML } from '@server/lib/client-html'
   5 import { ServerConfigManager } from '@server/lib/server-config-manager'
   6 import { HttpStatusCode } from '@shared/models'
   7 import { HttpNodeinfoDiasporaSoftwareNsSchema20 } from '../../shared/models/nodeinfo/nodeinfo.model'
   8 import { root } from '../helpers/core-utils'
   9 import { CONFIG, isEmailEnabled } from '../initializers/config'
  10 import {
  11   CONSTRAINTS_FIELDS,
  12   DEFAULT_THEME_NAME,
  13   HLS_STREAMING_PLAYLIST_DIRECTORY,
  14   PEERTUBE_VERSION,
  15   ROUTE_CACHE_LIFETIME,
  16   STATIC_MAX_AGE,
  17   STATIC_PATHS,
  18   WEBSERVER
  19 } from '../initializers/constants'
  20 import { getThemeOrDefault } from '../lib/plugins/theme-utils'
  21 import { asyncMiddleware } from '../middlewares'
  22 import { cacheRoute } from '../middlewares/cache/cache'
  23 import { UserModel } from '../models/user/user'
  24 import { VideoModel } from '../models/video/video'
  25 import { VideoCommentModel } from '../models/video/video-comment'
  26
  27 const staticRouter = express.Router()
  28
  29 staticRouter.use(cors())
  30
  31 /*
  32   Cors is very important to let other servers access torrent and video files
  33 */
  34
  35 // FIXME: deprecated in 3.2, use lazy-statics instead
  36 // Due to historical reasons, we can't really remove this controller
  37 const torrentsPhysicalPath = CONFIG.STORAGE.TORRENTS_DIR
  38 staticRouter.use(
  39   STATIC_PATHS.TORRENTS,
  40   express.static(torrentsPhysicalPath, { maxAge: 0 }) // Don't cache because we could regenerate the torrent file
  41 )
  42
  43 // Videos path for webseed
  44 staticRouter.use(
  45   STATIC_PATHS.WEBSEED,
  46   express.static(CONFIG.STORAGE.VIDEOS_DIR, { fallthrough: false }) // 404 because we don't have this video
  47 )
  48 staticRouter.use(
  49   STATIC_PATHS.REDUNDANCY,
  50   express.static(CONFIG.STORAGE.REDUNDANCY_DIR, { fallthrough: false }) // 404 because we don't have this video
  51 )
  52
  53 // HLS
  54 staticRouter.use(
  55   STATIC_PATHS.STREAMING_PLAYLISTS.HLS,
  56   cors(),
  57   express.static(HLS_STREAMING_PLAYLIST_DIRECTORY, { fallthrough: false }) // 404 if the file does not exist
  58 )
  59
  60 // Thumbnails path for express
  61 const thumbnailsPhysicalPath = CONFIG.STORAGE.THUMBNAILS_DIR
  62 staticRouter.use(
  63   STATIC_PATHS.THUMBNAILS,
  64   express.static(thumbnailsPhysicalPath, { maxAge: STATIC_MAX_AGE.SERVER, fallthrough: false }) // 404 if the file does not exist
  65 )
  66
  67 // robots.txt service
  68 staticRouter.get('/robots.txt',
  69   cacheRoute(ROUTE_CACHE_LIFETIME.ROBOTS),
  70   (_, res: express.Response) => {
  71     res.type('text/plain')
  72
  73     return res.send(CONFIG.INSTANCE.ROBOTS)
  74   }
  75 )
  76
  77 staticRouter.all('/teapot',
  78   getCup,
  79   asyncMiddleware(serveIndexHTML)
  80 )
  81
  82 // security.txt service
  83 staticRouter.get('/security.txt',
  84   (_, res: express.Response) => {
  85     return res.redirect(HttpStatusCode.MOVED_PERMANENTLY_301, '/.well-known/security.txt')
  86   }
  87 )
  88
  89 staticRouter.get('/.well-known/security.txt',
  90   cacheRoute(ROUTE_CACHE_LIFETIME.SECURITYTXT),
  91   (_, res: express.Response) => {
  92     res.type('text/plain')
  93     return res.send(CONFIG.INSTANCE.SECURITYTXT + CONFIG.INSTANCE.SECURITYTXT_CONTACT)
  94   }
  95 )
  96
  97 // nodeinfo service
  98 staticRouter.use('/.well-known/nodeinfo',
  99   cacheRoute(ROUTE_CACHE_LIFETIME.NODEINFO),
 100   (_, res: express.Response) => {
 101     return res.json({
 102       links: [
 103         {
 104           rel: 'http://nodeinfo.diaspora.software/ns/schema/2.0',
 105           href: WEBSERVER.URL + '/nodeinfo/2.0.json'
 106         }
 107       ]
 108     })
 109   }
 110 )
 111 staticRouter.use('/nodeinfo/:version.json',
 112   cacheRoute(ROUTE_CACHE_LIFETIME.NODEINFO),
 113   asyncMiddleware(generateNodeinfo)
 114 )
 115
 116 // dnt-policy.txt service (see https://www.eff.org/dnt-policy)
 117 staticRouter.use('/.well-known/dnt-policy.txt',
 118   cacheRoute(ROUTE_CACHE_LIFETIME.DNT_POLICY),
 119   (_, res: express.Response) => {
 120     res.type('text/plain')
 121
 122     return res.sendFile(join(root(), 'dist/server/static/dnt-policy/dnt-policy-1.0.txt'))
 123   }
 124 )
 125
 126 // dnt service (see https://www.w3.org/TR/tracking-dnt/#status-resource)
 127 staticRouter.use('/.well-known/dnt/',
 128   (_, res: express.Response) => {
 129     res.json({ tracking: 'N' })
 130   }
 131 )
 132
 133 staticRouter.use('/.well-known/change-password',
 134   (_, res: express.Response) => {
 135     res.redirect('/my-account/settings')
 136   }
 137 )
 138
 139 staticRouter.use('/.well-known/host-meta',
 140   (_, res: express.Response) => {
 141     res.type('application/xml')
 142
 143     const xml = '<?xml version="1.0" encoding="UTF-8"?>\n' +
 144       '<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">\n' +
 145       `  <Link rel="lrdd" type="application/xrd+xml" template="${WEBSERVER.URL}/.well-known/webfinger?resource={uri}"/>\n` +
 146       '</XRD>'
 147
 148     res.send(xml).end()
 149   }
 150 )
 151
 152 // ---------------------------------------------------------------------------
 153
 154 export {
 155   staticRouter
 156 }
 157
 158 // ---------------------------------------------------------------------------
 159
 160 async function generateNodeinfo (req: express.Request, res: express.Response) {
 161   const { totalVideos } = await VideoModel.getStats()
 162   const { totalLocalVideoComments } = await VideoCommentModel.getStats()
 163   const { totalUsers, totalMonthlyActiveUsers, totalHalfYearActiveUsers } = await UserModel.getStats()
 164
 165   if (!req.params.version || req.params.version !== '2.0') {
 166     return res.fail({
 167       status: HttpStatusCode.NOT_FOUND_404,
 168       message: 'Nodeinfo schema version not handled'
 169     })
 170   }
 171
 172   const json = {
 173     version: '2.0',
 174     software: {
 175       name: 'peertube',
 176       version: PEERTUBE_VERSION
 177     },
 178     protocols: [
 179       'activitypub'
 180     ],
 181     services: {
 182       inbound: [],
 183       outbound: [
 184         'atom1.0',
 185         'rss2.0'
 186       ]
 187     },
 188     openRegistrations: CONFIG.SIGNUP.ENABLED,
 189     usage: {
 190       users: {
 191         total: totalUsers,
 192         activeMonth: totalMonthlyActiveUsers,
 193         activeHalfyear: totalHalfYearActiveUsers
 194       },
 195       localPosts: totalVideos,
 196       localComments: totalLocalVideoComments
 197     },
 198     metadata: {
 199       taxonomy: {
 200         postsName: 'Videos'
 201       },
 202       nodeName: CONFIG.INSTANCE.NAME,
 203       nodeDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
 204       nodeConfig: {
 205         search: {
 206           remoteUri: {
 207             users: CONFIG.SEARCH.REMOTE_URI.USERS,
 208             anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
 209           }
 210         },
 211         plugin: {
 212           registered: ServerConfigManager.Instance.getRegisteredPlugins()
 213         },
 214         theme: {
 215           registered: ServerConfigManager.Instance.getRegisteredThemes(),
 216           default: getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
 217         },
 218         email: {
 219           enabled: isEmailEnabled()
 220         },
 221         contactForm: {
 222           enabled: CONFIG.CONTACT_FORM.ENABLED
 223         },
 224         transcoding: {
 225           hls: {
 226             enabled: CONFIG.TRANSCODING.HLS.ENABLED
 227           },
 228           webtorrent: {
 229             enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
 230           },
 231           enabledResolutions: ServerConfigManager.Instance.getEnabledResolutions('vod')
 232         },
 233         live: {
 234           enabled: CONFIG.LIVE.ENABLED,
 235           transcoding: {
 236             enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
 237             enabledResolutions: ServerConfigManager.Instance.getEnabledResolutions('live')
 238           }
 239         },
 240         import: {
 241           videos: {
 242             http: {
 243               enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
 244             },
 245             torrent: {
 246               enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
 247             }
 248           }
 249         },
 250         autoBlacklist: {
 251           videos: {
 252             ofUsers: {
 253               enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
 254             }
 255           }
 256         },
 257         avatar: {
 258           file: {
 259             size: {
 260               max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
 261             },
 262             extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
 263           }
 264         },
 265         video: {
 266           image: {
 267             extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
 268             size: {
 269               max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
 270             }
 271           },
 272           file: {
 273             extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
 274           }
 275         },
 276         videoCaption: {
 277           file: {
 278             size: {
 279               max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
 280             },
 281             extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
 282           }
 283         },
 284         user: {
 285           videoQuota: CONFIG.USER.VIDEO_QUOTA,
 286           videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
 287         },
 288         trending: {
 289           videos: {
 290             intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
 291           }
 292         },
 293         tracker: {
 294           enabled: CONFIG.TRACKER.ENABLED
 295         }
 296       }
 297     }
 298   } as HttpNodeinfoDiasporaSoftwareNsSchema20
 299
 300   res.contentType('application/json; profile="http://nodeinfo.diaspora.software/ns/schema/2.0#"')
 301       .send(json)
 302       .end()
 303 }
 304
 305 function getCup (req: express.Request, res: express.Response, next: express.NextFunction) {
 306   res.status(HttpStatusCode.I_AM_A_TEAPOT_418)
 307   res.setHeader('Accept-Additions', 'Non-Dairy;1,Sugar;1')
 308   res.setHeader('Safe', 'if-sepia-awake')
 309
 310   return next()
 311 }