server/helpers/requests.ts

   1 import * as Bluebird from 'bluebird'
   2 import { createWriteStream, remove } from 'fs-extra'
   3 import * as request from 'request'
   4 import { ACTIVITY_PUB, PEERTUBE_VERSION, WEBSERVER } from '../initializers/constants'
   5 import { processImage } from './image-utils'
   6 import { join } from 'path'
   7 import { logger } from './logger'
   8 import { CONFIG } from '../initializers/config'
   9
  10 function doRequest <T> (
  11   requestOptions: request.CoreOptions & request.UriOptions & { activityPub?: boolean },
  12   bodyKBLimit = 1000 // 1MB
  13 ): Bluebird<{ response: request.RequestResponse, body: T }> {
  14   if (!(requestOptions.headers)) requestOptions.headers = {}
  15   requestOptions.headers['User-Agent'] = getUserAgent()
  16
  17   if (requestOptions.activityPub === true) {
  18     requestOptions.headers['accept'] = ACTIVITY_PUB.ACCEPT_HEADER
  19   }
  20
  21   return new Bluebird<{ response: request.RequestResponse, body: T }>((res, rej) => {
  22     request(requestOptions, (err, response, body) => err ? rej(err) : res({ response, body }))
  23       .on('data', onRequestDataLengthCheck(bodyKBLimit))
  24   })
  25 }
  26
  27 function doRequestAndSaveToFile (
  28   requestOptions: request.CoreOptions & request.UriOptions,
  29   destPath: string,
  30   bodyKBLimit = 10000 // 10MB
  31 ) {
  32   if (!requestOptions.headers) requestOptions.headers = {}
  33   requestOptions.headers['User-Agent'] = getUserAgent()
  34
  35   return new Bluebird<void>((res, rej) => {
  36     const file = createWriteStream(destPath)
  37     file.on('finish', () => res())
  38
  39     request(requestOptions)
  40       .on('data', onRequestDataLengthCheck(bodyKBLimit))
  41       .on('error', err => {
  42         file.close()
  43
  44         remove(destPath)
  45           .catch(err => logger.error('Cannot remove %s after request failure.', destPath, { err }))
  46
  47         return rej(err)
  48       })
  49       .pipe(file)
  50   })
  51 }
  52
  53 async function downloadImage (url: string, destDir: string, destName: string, size: { width: number, height: number }) {
  54   const tmpPath = join(CONFIG.STORAGE.TMP_DIR, 'pending-' + destName)
  55   await doRequestAndSaveToFile({ method: 'GET', uri: url }, tmpPath)
  56
  57   const destPath = join(destDir, destName)
  58
  59   try {
  60     await processImage(tmpPath, destPath, size)
  61   } catch (err) {
  62     await remove(tmpPath)
  63
  64     throw err
  65   }
  66 }
  67
  68 function getUserAgent () {
  69   return `PeerTube/${PEERTUBE_VERSION} (+${WEBSERVER.URL})`
  70 }
  71
  72 // ---------------------------------------------------------------------------
  73
  74 export {
  75   doRequest,
  76   doRequestAndSaveToFile,
  77   downloadImage
  78 }
  79
  80 // ---------------------------------------------------------------------------
  81
  82 // Thanks to https://github.com/request/request/issues/2470#issuecomment-268929907 <3
  83 function onRequestDataLengthCheck (bodyKBLimit: number) {
  84   let bufferLength = 0
  85   const bytesLimit = bodyKBLimit * 1000
  86
  87   return function (chunk) {
  88     bufferLength += chunk.length
  89     if (bufferLength > bytesLimit) {
  90       this.abort()
  91
  92       const error = new Error(`Response was too large - aborted after ${bytesLimit} bytes.`)
  93       this.emit('error', error)
  94     }
  95   }
  96 }