]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/tools/peertube-import-videos.ts
Merge remote-tracking branch 'weblate/develop' into develop
[github/Chocobozzz/PeerTube.git] / server / tools / peertube-import-videos.ts
index d7bb00e02e7d8955a7d89b9a4a7a53ff93e20be6..9159950318d4f32316bf3c6789c233c9700e5cec 100644 (file)
@@ -1,17 +1,19 @@
-// FIXME: https://github.com/nodejs/node/pull/16853
-require('tls').DEFAULT_ECDH_CURVE = 'auto'
+import { registerTSPaths } from '../helpers/register-ts-paths'
+registerTSPaths()
 
 import * as program from 'commander'
-import { join } from 'path'
-import { doRequestAndSaveToFile } from '../helpers/requests'
-import { CONSTRAINTS_FIELDS } from '../initializers/constants'
-import { getClient, getVideoCategories, login, searchVideoWithSort, uploadVideo } from '../../shared/extra-utils/index'
+import { accessSync, constants } from 'fs'
+import { remove } from 'fs-extra'
 import { truncate } from 'lodash'
+import { join } from 'path'
 import * as prompt from 'prompt'
-import { remove } from 'fs-extra'
+import { promisify } from 'util'
+import { advancedVideosSearch, getClient, getVideoCategories, login, uploadVideo } from '../../shared/extra-utils/index'
 import { sha256 } from '../helpers/core-utils'
-import { buildOriginallyPublishedAt, safeGetYoutubeDL } from '../helpers/youtube-dl'
-import { buildCommonVideoOptions, buildVideoAttributesFromCommander, getNetrc, getRemoteObjectOrDie, getSettings } from './cli'
+import { doRequestAndSaveToFile } from '../helpers/requests'
+import { buildOriginallyPublishedAt, getYoutubeDLVideoFormat, safeGetYoutubeDL } from '../helpers/youtube-dl'
+import { CONSTRAINTS_FIELDS } from '../initializers/constants'
+import { buildCommonVideoOptions, buildVideoAttributesFromCommander, getLogger, getServerCredentials } from './cli'
 
 type UserInfo = {
   username: string
@@ -19,7 +21,6 @@ type UserInfo = {
 }
 
 const processOptions = {
-  cwd: __dirname,
   maxBuffer: Infinity
 }
 
@@ -32,31 +33,41 @@ command
   .option('-u, --url <url>', 'Server url')
   .option('-U, --username <username>', 'Username')
   .option('-p, --password <token>', 'Password')
-  .option('-t, --target-url <targetUrl>', 'Video target URL')
-  .option('-v, --verbose', 'Verbose mode')
+  .option('--target-url <targetUrl>', 'Video target URL')
+  .option('--since <since>', 'Publication date (inclusive) since which the videos can be imported (YYYY-MM-DD)', parseDate)
+  .option('--until <until>', 'Publication date (inclusive) until which the videos can be imported (YYYY-MM-DD)', parseDate)
+  .option('--first <first>', 'Process first n elements of returned playlist')
+  .option('--last <last>', 'Process last n elements of returned playlist')
+  .option('--wait-interval <waitInterval>', 'Duration between two video imports (in seconds)', convertIntoMs)
+  .option('-T, --tmpdir <tmpdir>', 'Working directory', __dirname)
+  .usage("[global options] [ -- youtube-dl options]")
   .parse(process.argv)
 
-Promise.all([ getSettings(), getNetrc() ])
-       .then(([ settings, netrc ]) => {
-         const { url, username, password } = getRemoteObjectOrDie(program, settings, netrc)
+const options = command.opts()
 
-         if (!program[ 'targetUrl' ]) {
-           console.error('--targetUrl field is required.')
+const log = getLogger(options.verbose)
 
-           process.exit(-1)
-         }
+getServerCredentials(command)
+  .then(({ url, username, password }) => {
+    if (!options.targetUrl) {
+      exitError('--target-url field is required.')
+    }
+
+    try {
+      accessSync(options.tmpdir, constants.R_OK | constants.W_OK)
+    } catch (e) {
+      exitError('--tmpdir %s: directory does not exist or is not accessible', options.tmpdir)
+    }
 
-         removeEndSlashes(url)
-         removeEndSlashes(program[ 'targetUrl' ])
+    url = normalizeTargetUrl(url)
+    options.targetUrl = normalizeTargetUrl(options.targetUrl)
 
-         const user = { username, password }
+    const user = { username, password }
 
-         run(url, user)
-           .catch(err => {
-             console.error(err)
-             process.exit(-1)
-           })
-       })
+    run(url, user)
+      .catch(err => exitError(err))
+  })
+  .catch(err => console.error(err))
 
 async function run (url: string, user: UserInfo) {
   if (!user.password) {
@@ -65,96 +76,115 @@ async function run (url: string, user: UserInfo) {
 
   const youtubeDL = await safeGetYoutubeDL()
 
-  const options = [ '-j', '--flat-playlist', '--playlist-reverse' ]
-  youtubeDL.getInfo(program[ 'targetUrl' ], options, processOptions, async (err, info) => {
-    if (err) {
-      console.log(err.message)
-      process.exit(1)
-    }
+  let info = await getYoutubeDLInfo(youtubeDL, options.targetUrl, command.args)
 
-    let infoArray: any[]
+  if (!Array.isArray(info)) info = [ info ]
 
-    // Normalize utf8 fields
-    if (Array.isArray(info) === true) {
-      infoArray = info.map(i => normalizeObject(i))
-    } else {
-      infoArray = [ normalizeObject(info) ]
-    }
-    console.log('Will download and upload %d videos.\n', infoArray.length)
+  // Try to fix youtube channels upload
+  const uploadsObject = info.find(i => !i.ie_key && !i.duration && i.title === 'Uploads')
 
-    for (const info of infoArray) {
+  if (uploadsObject) {
+    console.log('Fixing URL to %s.', uploadsObject.url)
+
+    info = await getYoutubeDLInfo(youtubeDL, uploadsObject.url, command.args)
+  }
+
+  let infoArray: any[]
+
+  infoArray = [].concat(info)
+  if (options.first) {
+    infoArray = infoArray.slice(0, options.first)
+  } else if (options.last) {
+    infoArray = infoArray.slice(-options.last)
+  }
+  // Normalize utf8 fields
+  infoArray = infoArray.map(i => normalizeObject(i))
+
+  log.info('Will download and upload %d videos.\n', infoArray.length)
+
+  for (const [ index, info ] of infoArray.entries()) {
+    try {
+      if (index > 0 && options.waitInterval) {
+        log.info("Wait for %d seconds before continuing.", options.waitInterval / 1000)
+        await new Promise(res => setTimeout(res, options.waitInterval))
+      }
       await processVideo({
-        cwd: processOptions.cwd,
+        cwd: options.tmpdir,
         url,
         user,
         youtubeInfo: info
       })
+    } catch (err) {
+      console.error('Cannot process video.', { info, url, err })
     }
+  }
 
-    console.log('Video/s for user %s imported: %s', program[ 'username' ], program[ 'targetUrl' ])
-    process.exit(0)
-  })
+  log.info('Video/s for user %s imported: %s', user.username, options.targetUrl)
+  process.exit(0)
 }
 
-function processVideo (parameters: {
-  cwd: string,
-  url: string,
-  user: { username: string, password: string },
+async function processVideo (parameters: {
+  cwd: string
+  url: string
+  user: { username: string, password: string }
   youtubeInfo: any
 }) {
   const { youtubeInfo, cwd, url, user } = parameters
 
-  return new Promise(async res => {
-    if (program[ 'verbose' ]) console.log('Fetching object.', youtubeInfo)
+  log.debug('Fetching object.', youtubeInfo)
 
-    const videoInfo = await fetchObject(youtubeInfo)
-    if (program[ 'verbose' ]) console.log('Fetched object.', videoInfo)
+  const videoInfo = await fetchObject(youtubeInfo)
+  log.debug('Fetched object.', videoInfo)
 
-    const result = await searchVideoWithSort(url, videoInfo.title, '-match')
+  const originallyPublishedAt = buildOriginallyPublishedAt(videoInfo)
+  if (options.since && originallyPublishedAt && originallyPublishedAt.getTime() < options.since.getTime()) {
+    log.info('Video "%s" has been published before "%s", don\'t upload it.\n',
+      videoInfo.title, formatDate(options.since))
+    return
+  }
+  if (options.until && originallyPublishedAt && originallyPublishedAt.getTime() > options.until.getTime()) {
+    log.info('Video "%s" has been published after "%s", don\'t upload it.\n',
+      videoInfo.title, formatDate(options.until))
+    return
+  }
 
-    console.log('############################################################\n')
+  const result = await advancedVideosSearch(url, { search: videoInfo.title, sort: '-match', searchTarget: 'local' })
 
-    if (result.body.data.find(v => v.name === videoInfo.title)) {
-      console.log('Video "%s" already exists, don\'t reupload it.\n', videoInfo.title)
-      return res()
-    }
+  log.info('############################################################\n')
 
-    const path = join(cwd, sha256(videoInfo.url) + '.mp4')
+  if (result.body.data.find(v => v.name === videoInfo.title)) {
+    log.info('Video "%s" already exists, don\'t reupload it.\n', videoInfo.title)
+    return
+  }
 
-    console.log('Downloading video "%s"...', videoInfo.title)
+  const path = join(cwd, sha256(videoInfo.url) + '.mp4')
 
-    const options = [ '-f', 'bestvideo[ext=mp4]+bestaudio[ext=m4a]/best', '-o', path ]
-    try {
-      const youtubeDL = await safeGetYoutubeDL()
-      youtubeDL.exec(videoInfo.url, options, processOptions, async (err, output) => {
-        if (err) {
-          console.error(err)
-          return res()
-        }
+  log.info('Downloading video "%s"...', videoInfo.title)
 
-        console.log(output.join('\n'))
-        await uploadVideoOnPeerTube({
-          cwd,
-          url,
-          user,
-          videoInfo: normalizeObject(videoInfo),
-          videoPath: path
-        })
-        return res()
-      })
-    } catch (err) {
-      console.log(err.message)
-      return res()
-    }
-  })
+  const youtubeDLOptions = [ '-f', getYoutubeDLVideoFormat(), ...command.args, '-o', path ]
+  try {
+    const youtubeDL = await safeGetYoutubeDL()
+    const youtubeDLExec = promisify(youtubeDL.exec).bind(youtubeDL)
+    const output = await youtubeDLExec(videoInfo.url, youtubeDLOptions, processOptions)
+    log.info(output.join('\n'))
+    await uploadVideoOnPeerTube({
+      cwd,
+      url,
+      user,
+      videoInfo: normalizeObject(videoInfo),
+      videoPath: path
+    })
+  } catch (err) {
+    log.error(err.message)
+  }
 }
 
 async function uploadVideoOnPeerTube (parameters: {
-  videoInfo: any,
-  videoPath: string,
-  cwd: string,
-  url: string,
-  user: { username: string; password: string }
+  videoInfo: any
+  videoPath: string
+  cwd: string
+  url: string
+  user: { username: string, password: string }
 }) {
   const { videoInfo, videoPath, cwd, url, user } = parameters
 
@@ -172,19 +202,16 @@ async function uploadVideoOnPeerTube (parameters: {
   if (videoInfo.thumbnail) {
     thumbnailfile = join(cwd, sha256(videoInfo.thumbnail) + '.jpg')
 
-    await doRequestAndSaveToFile({
-      method: 'GET',
-      uri: videoInfo.thumbnail
-    }, thumbnailfile)
+    await doRequestAndSaveToFile(videoInfo.thumbnail, thumbnailfile)
   }
 
   const originallyPublishedAt = buildOriginallyPublishedAt(videoInfo)
 
   const defaultAttributes = {
     name: truncate(videoInfo.title, {
-      'length': CONSTRAINTS_FIELDS.VIDEOS.NAME.max,
-      'separator': /,? +/,
-      'omission': ' […]'
+      length: CONSTRAINTS_FIELDS.VIDEOS.NAME.max,
+      separator: /,? +/,
+      omission: ' […]'
     }),
     category,
     licence,
@@ -202,7 +229,7 @@ async function uploadVideoOnPeerTube (parameters: {
     fixture: videoPath
   })
 
-  console.log('\nUploading on PeerTube video "%s".', videoAttributes.name)
+  log.info('\nUploading on PeerTube video "%s".', videoAttributes.name)
 
   let accessToken = await getAccessTokenOrDie(url, user)
 
@@ -210,21 +237,20 @@ async function uploadVideoOnPeerTube (parameters: {
     await uploadVideo(url, accessToken, videoAttributes)
   } catch (err) {
     if (err.message.indexOf('401') !== -1) {
-      console.log('Got 401 Unauthorized, token may have expired, renewing token and retry.')
+      log.info('Got 401 Unauthorized, token may have expired, renewing token and retry.')
 
       accessToken = await getAccessTokenOrDie(url, user)
 
       await uploadVideo(url, accessToken, videoAttributes)
     } else {
-      console.log(err.message)
-      process.exit(1)
+      exitError(err.message)
     }
   }
 
   await remove(videoPath)
   if (thumbnailfile) await remove(thumbnailfile)
 
-  console.log('Uploaded video "%s"!\n', videoAttributes.name)
+  log.warn('Uploaded video "%s"!\n', videoAttributes.name)
 }
 
 /* ---------------------------------------------------------- */
@@ -232,7 +258,7 @@ async function uploadVideoOnPeerTube (parameters: {
 async function getCategory (categories: string[], url: string) {
   if (!categories) return undefined
 
-  const categoryString = categories[ 0 ]
+  const categoryString = categories[0]
 
   if (categoryString === 'News & Politics') return 11
 
@@ -240,7 +266,7 @@ async function getCategory (categories: string[], url: string) {
   const categoriesServer = res.body
 
   for (const key of Object.keys(categoriesServer)) {
-    const categoryServer = categoriesServer[ key ]
+    const categoryServer = categoriesServer[key]
     if (categoryString.toLowerCase() === categoryServer.toLowerCase()) return parseInt(key, 10)
   }
 
@@ -250,7 +276,7 @@ async function getCategory (categories: string[], url: string) {
 function getLicence (licence: string) {
   if (!licence) return undefined
 
-  if (licence.indexOf('Creative Commons Attribution licence') !== -1) return 1
+  if (licence.includes('Creative Commons Attribution licence')) return 1
 
   return undefined
 }
@@ -262,12 +288,12 @@ function normalizeObject (obj: any) {
     // Deprecated key
     if (key === 'resolution') continue
 
-    const value = obj[ key ]
+    const value = obj[key]
 
     if (typeof value === 'string') {
-      newObj[ key ] = value.normalize()
+      newObj[key] = value.normalize()
     } else {
-      newObj[ key ] = value
+      newObj[key] = value
     }
   }
 
@@ -279,7 +305,7 @@ function fetchObject (info: any) {
 
   return new Promise<any>(async (res, rej) => {
     const youtubeDL = await safeGetYoutubeDL()
-    youtubeDL.getInfo(url, undefined, processOptions, async (err, videoInfo) => {
+    youtubeDL.getInfo(url, undefined, processOptions, (err, videoInfo) => {
       if (err) return rej(err)
 
       const videoInfoWithUrl = Object.assign(videoInfo, { url })
@@ -290,10 +316,10 @@ function fetchObject (info: any) {
 
 function buildUrl (info: any) {
   const webpageUrl = info.webpage_url as string
-  if (webpageUrl && webpageUrl.match(/^https?:\/\//)) return webpageUrl
+  if (webpageUrl?.match(/^https?:\/\//)) return webpageUrl
 
   const url = info.url as string
-  if (url && url.match(/^https?:\/\//)) return url
+  if (url?.match(/^https?:\/\//)) return url
 
   // It seems youtube-dl does not return the video url
   return 'https://www.youtube.com/watch?v=' + info.id
@@ -303,10 +329,14 @@ function isNSFW (info: any) {
   return info.age_limit && info.age_limit >= 16
 }
 
-function removeEndSlashes (url: string) {
-  while (url.endsWith('/')) {
-    url.slice(0, -1)
+function normalizeTargetUrl (url: string) {
+  let normalizedUrl = url.replace(/\/+$/, '')
+
+  if (!normalizedUrl.startsWith('http://') && !normalizedUrl.startsWith('https://')) {
+    normalizedUrl = 'https://' + normalizedUrl
   }
+
+  return normalizedUrl
 }
 
 async function promptPassword () {
@@ -340,7 +370,48 @@ async function getAccessTokenOrDie (url: string, user: UserInfo) {
     const res = await login(url, client, user)
     return res.body.access_token
   } catch (err) {
-    console.error('Cannot authenticate. Please check your username/password.')
-    process.exit(-1)
+    exitError('Cannot authenticate. Please check your username/password.')
+  }
+}
+
+function parseDate (dateAsStr: string): Date {
+  if (!/\d{4}-\d{2}-\d{2}/.test(dateAsStr)) {
+    exitError(`Invalid date passed: ${dateAsStr}. Expected format: YYYY-MM-DD. See help for usage.`)
+  }
+  const date = new Date(dateAsStr)
+  date.setHours(0, 0, 0)
+  if (isNaN(date.getTime())) {
+    exitError(`Invalid date passed: ${dateAsStr}. See help for usage.`)
+  }
+  return date
+}
+
+function formatDate (date: Date): string {
+  return date.toISOString().split('T')[0]
+}
+
+function convertIntoMs (secondsAsStr: string): number {
+  const seconds = parseInt(secondsAsStr, 10)
+  if (seconds <= 0) {
+    exitError(`Invalid duration passed: ${seconds}. Expected duration to be strictly positive and in seconds`)
   }
+  return Math.round(seconds * 1000)
+}
+
+function exitError (message: string, ...meta: any[]) {
+  // use console.error instead of log.error here
+  console.error(message, ...meta)
+  process.exit(-1)
+}
+
+function getYoutubeDLInfo (youtubeDL: any, url: string, args: string[]) {
+  return new Promise<any>((res, rej) => {
+    const options = [ '-j', '--flat-playlist', '--playlist-reverse', ...args ]
+
+    youtubeDL.getInfo(url, options, processOptions, async (err, info) => {
+      if (err) return rej(err)
+
+      return res(info)
+    })
+  })
 }