Add create-import-video-file-job command

[github/Chocobozzz/PeerTube.git] / server / helpers / core-utils.ts

diff --git a/server/helpers/core-utils.ts b/server/helpers/core-utils.ts
index 4ff07848ca86079f8a437478f6275d8e6337e242..c560222d3d39fd3a39ce57c477e78c71adc1cdca 100644 (file)
--- a/server/helpers/core-utils.ts
+++ b/server/helpers/core-utils.ts
@@ -3,23 +3,35 @@
   Useful to avoid circular dependencies.
 */
 
-import { join } from 'path'
-import { pseudoRandomBytes } from 'crypto'
-import {
-  readdir,
-  readFile,
-  rename,
-  unlink,
-  writeFile,
-  access,
-  stat,
-  Stats
-} from 'fs'
-import * as mkdirp from 'mkdirp'
 import * as bcrypt from 'bcrypt'
 import * as createTorrent from 'create-torrent'
-import * as rimraf from 'rimraf'
+import { pseudoRandomBytes } from 'crypto'
+import { copyFile, readdir, readFile, rename, stat, Stats, unlink, writeFile } from 'fs'
+import * as mkdirp from 'mkdirp'
+import { isAbsolute, join } from 'path'
 import * as pem from 'pem'
+import * as rimraf from 'rimraf'
+import { URL } from 'url'
+import { truncate } from 'lodash'
+
+function sanitizeUrl (url: string) {
+  const urlObject = new URL(url)
+
+  if (urlObject.protocol === 'https:' && urlObject.port === '443') {
+    urlObject.port = ''
+  } else if (urlObject.protocol === 'http:' && urlObject.port === '80') {
+    urlObject.port = ''
+  }
+
+  return urlObject.href.replace(/\/$/, '')
+}
+
+// Don't import remote scheme from constants because we are in core utils
+function sanitizeHost (host: string, remoteScheme: string) {
+  const toRemove = remoteScheme === 'https' ? 443 : 80
+
+  return host.replace(new RegExp(`:${toRemove}$`), '')
+}
 
 function isTestInstance () {
   return process.env.NODE_ENV === 'test'
@@ -39,6 +51,8 @@ function root () {
 
 // Thanks: https://stackoverflow.com/a/12034334
 function escapeHTML (stringParam) {
+  if (!stringParam) return ''
+
   const entityMap = {
     '&': '&',
     '<': '&lt;',
@@ -59,6 +73,28 @@ function pageToStartAndCount (page: number, itemsPerPage: number) {
   return { start, count: itemsPerPage }
 }
 
+function buildPath (path: string) {
+  if (isAbsolute(path)) return path
+
+  return join(root(), path)
+}
+
+// Consistent with .length, lodash truncate function is not
+function peertubeTruncate (str: string, maxLength: number) {
+  const options = {
+    length: maxLength
+  }
+  const truncatedStr = truncate(str, options)
+
+  // The truncated string is okay, we can return it
+  if (truncatedStr.length <= maxLength) return truncatedStr
+
+  // Lodash takes into account all UTF characters, whereas String.prototype.length does not: some characters have a length of 2
+  // We always use the .length so we need to truncate more if needed
+  options.length -= truncatedStr.length - maxLength
+  return truncate(str, options)
+}
+
 function promisify0<A> (func: (cb: (err: any, result: A) => void) => void): () => Promise<A> {
   return function promisified (): Promise<A> {
     return new Promise<A>((resolve: (arg: A) => void, reject: (err: any) => void) => {
@@ -100,7 +136,7 @@ function promisify2WithVoid<T, U> (func: (arg1: T, arg2: U, cb: (err: any) => vo
   }
 }
 
-const readFilePromise = promisify2<string, string, string>(readFile)
+const copyFilePromise = promisify2WithVoid<string, string>(copyFile)
 const readFileBufferPromise = promisify1<string, Buffer>(readFile)
 const unlinkPromise = promisify1WithVoid<string>(unlink)
 const renamePromise = promisify2WithVoid<string, string>(rename)
@@ -108,7 +144,6 @@ const writeFilePromise = promisify2WithVoid<string, any>(writeFile)
 const readdirPromise = promisify1<string, string[]>(readdir)
 const mkdirpPromise = promisify1<string, string>(mkdirp)
 const pseudoRandomBytesPromise = promisify1<number, Buffer>(pseudoRandomBytes)
-const accessPromise = promisify1WithVoid<string | Buffer>(access)
 const createPrivateKey = promisify1<number, { key: string }>(pem.createPrivateKey)
 const getPublicKey = promisify1<string, { publicKey: string }>(pem.getPublicKey)
 const bcryptComparePromise = promisify2<any, string, boolean>(bcrypt.compare)
@@ -125,19 +160,22 @@ export {
   root,
   escapeHTML,
   pageToStartAndCount,
+  sanitizeUrl,
+  sanitizeHost,
+  buildPath,
+  peertubeTruncate,
 
   promisify0,
   promisify1,
 
+  copyFilePromise,
   readdirPromise,
-  readFilePromise,
   readFileBufferPromise,
   unlinkPromise,
   renamePromise,
   writeFilePromise,
   mkdirpPromise,
   pseudoRandomBytesPromise,
-  accessPromise,
   createPrivateKey,
   getPublicKey,
   bcryptComparePromise,