]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/tools/peertube-import-videos.ts
Catch error in import script
[github/Chocobozzz/PeerTube.git] / server / tools / peertube-import-videos.ts
index 03f13b5e2681a49d4a2cdb6140bf5b7d3e482dd2..2c9eabe9889173b4091091c58b02191ee2a5ffa8 100644 (file)
-// 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 { VideoPrivacy } from '../../shared/models/videos'
 import { doRequestAndSaveToFile } from '../helpers/requests'
 import { CONSTRAINTS_FIELDS } from '../initializers/constants'
-import { getClient, getVideoCategories, login, searchVideoWithSort, uploadVideo } from '../../shared/utils/index'
+import { getClient, getVideoCategories, login, searchVideoWithSort, uploadVideo } from '../../shared/extra-utils/index'
 import { truncate } from 'lodash'
 import * as prompt from 'prompt'
+import { accessSync, constants } from 'fs'
 import { remove } from 'fs-extra'
 import { sha256 } from '../helpers/core-utils'
-import { safeGetYoutubeDL, buildOriginallyPublishedAt } from '../helpers/youtube-dl'
-import { getSettings, netrc } from './cli'
+import { buildOriginallyPublishedAt, safeGetYoutubeDL } from '../helpers/youtube-dl'
+import { buildCommonVideoOptions, buildVideoAttributesFromCommander, getLogger, getServerCredentials } from './cli'
 
-let accessToken: string
-let client: { id: string, secret: string }
+type UserInfo = {
+  username: string
+  password: string
+}
 
 const processOptions = {
-  cwd: __dirname,
   maxBuffer: Infinity
 }
 
-program
+let command = program
   .name('import-videos')
+
+command = buildCommonVideoOptions(command)
+
+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('-l, --language <languageCode>', 'Language ISO 639 code (fr or en...)')
-  .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('-T, --tmpdir <tmpdir>', 'Working directory', __dirname)
+  .usage("[global options] [ -- youtube-dl options]")
   .parse(process.argv)
 
-getSettings()
-.then(settings => {
-  if (
-    (!program['url'] ||
-    !program['username'] ||
-    !program['password']) &&
-    (settings.remotes.length === 0)
-  ) {
-    if (!program['url']) console.error('--url field is required.')
-    if (!program['username']) console.error('--username field is required.')
-    if (!program['password']) console.error('--password field is required.')
-    if (!program['targetUrl']) console.error('--targetUrl field is required.')
-    process.exit(-1)
-  }
+const log = getLogger(program['verbose'])
 
-  if (
-    (!program['url'] ||
-    !program['username'] ||
-    !program['password']) &&
-    (settings.remotes.length > 0)
-  ) {
-    if (!program['url']) {
-      program['url'] = (settings.default !== -1) ?
-        settings.remotes[settings.default] :
-        settings.remotes[0]
+getServerCredentials(command)
+  .then(({ url, username, password }) => {
+    if (!program['targetUrl']) {
+      exitError('--target-url field is required.')
     }
 
-    if (!program['username']) program['username'] = netrc.machines[program['url']].login
-    if (!program['password']) program['password'] = netrc.machines[program['url']].password
-  }
-
-  if (
-    !program['targetUrl']
-  ) {
-    if (!program['targetUrl']) console.error('--targetUrl field is required.')
-    process.exit(-1)
-  }
-
-  removeEndSlashes(program['url'])
-  removeEndSlashes(program['targetUrl'])
+    try {
+      accessSync(program['tmpdir'], constants.R_OK | constants.W_OK)
+    } catch (e) {
+      exitError('--tmpdir %s: directory does not exist or is not accessible', program['tmpdir'])
+    }
 
-  const user = {
-    username: program['username'],
-    password: program['password']
-  }
+    url = normalizeTargetUrl(url)
+    program['targetUrl'] = normalizeTargetUrl(program['targetUrl'])
 
-  run(user, program['url'])
-    .catch(err => {
-      console.error(err)
-      process.exit(-1)
-    })
-})
+    const user = { username, password }
 
-async function promptPassword () {
-  return new Promise((res, rej) => {
-    prompt.start()
-    const schema = {
-      properties: {
-        password: {
-          hidden: true,
-          required: true
-        }
-      }
-    }
-    prompt.get(schema, function (err, result) {
-      if (err) {
-        return rej(err)
-      }
-      return res(result.password)
-    })
+    run(url, user)
+      .catch(err => exitError(err))
   })
-}
+  .catch(err => console.error(err))
 
-async function run (user, url: string) {
+async function run (url: string, user: UserInfo) {
   if (!user.password) {
     user.password = await promptPassword()
   }
 
-  const res = await getClient(url)
-  client = {
-    id: res.body.client_id,
-    secret: res.body.client_secret
-  }
-
-  try {
-    const res = await login(program[ 'url' ], client, user)
-    accessToken = res.body.access_token
-  } catch (err) {
-    throw new Error('Cannot authenticate. Please check your username/password.')
-  }
-
   const youtubeDL = await safeGetYoutubeDL()
 
-  const options = [ '-j', '--flat-playlist', '--playlist-reverse' ]
+  const options = [ '-j', '--flat-playlist', '--playlist-reverse', ...command.args ]
+
   youtubeDL.getInfo(program['targetUrl'], options, processOptions, async (err, info) => {
     if (err) {
-      console.log(err.message)
-      process.exit(1)
+      exitError(err.stderr + ' ' + err.message)
     }
 
     let infoArray: any[]
 
     // Normalize utf8 fields
-    if (Array.isArray(info) === true) {
-      infoArray = info.map(i => normalizeObject(i))
-    } else {
-      infoArray = [ normalizeObject(info) ]
+    infoArray = [].concat(info)
+    if (program['first']) {
+      infoArray = infoArray.slice(0, program['first'])
+    } else if (program['last']) {
+      infoArray = infoArray.slice(-program['last'])
     }
-    console.log('Will download and upload %d videos.\n', infoArray.length)
+    infoArray = infoArray.map(i => normalizeObject(i))
+
+    log.info('Will download and upload %d videos.\n', infoArray.length)
 
     for (const info of infoArray) {
-      await processVideo(info, program['language'], processOptions.cwd, url, user)
+      try {
+        await processVideo({
+          cwd: program['tmpdir'],
+          url,
+          user,
+          youtubeInfo: info
+        })
+      } catch (err) {
+        console.error('Cannot process video.', { info, url })
+      }
     }
 
-    console.log('Video/s for user %s imported: %s', program['username'], program['targetUrl'])
+    log.info('Video/s for user %s imported: %s', user.username, program['targetUrl'])
     process.exit(0)
   })
 }
 
-function processVideo (info: any, languageCode: string, cwd: string, url: string, user) {
+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.', info)
+    log.debug('Fetching object.', youtubeInfo)
+
+    const videoInfo = await fetchObject(youtubeInfo)
+    log.debug('Fetched object.', videoInfo)
 
-    const videoInfo = await fetchObject(info)
-    if (program['verbose']) console.log('Fetched object.', videoInfo)
+    if (program['since']) {
+      if (buildOriginallyPublishedAt(videoInfo).getTime() < program['since'].getTime()) {
+        log.info('Video "%s" has been published before "%s", don\'t upload it.\n',
+          videoInfo.title, formatDate(program['since']))
+        return res()
+      }
+    }
+    if (program['until']) {
+      if (buildOriginallyPublishedAt(videoInfo).getTime() > program['until'].getTime()) {
+        log.info('Video "%s" has been published after "%s", don\'t upload it.\n',
+          videoInfo.title, formatDate(program['until']))
+        return res()
+      }
+    }
 
     const result = await searchVideoWithSort(url, videoInfo.title, '-match')
 
-    console.log('############################################################\n')
+    log.info('############################################################\n')
 
     if (result.body.data.find(v => v.name === videoInfo.title)) {
-      console.log('Video "%s" already exists, don\'t reupload it.\n', videoInfo.title)
+      log.info('Video "%s" already exists, don\'t reupload it.\n', videoInfo.title)
       return res()
     }
 
     const path = join(cwd, sha256(videoInfo.url) + '.mp4')
 
-    console.log('Downloading video "%s"...', videoInfo.title)
+    log.info('Downloading video "%s"...', videoInfo.title)
 
-    const options = [ '-f', 'bestvideo[ext=mp4]+bestaudio[ext=m4a]/best', '-o', path ]
+    const options = [ '-f', 'bestvideo[ext=mp4]+bestaudio[ext=m4a]/best', ...command.args, '-o', path ]
     try {
       const youtubeDL = await safeGetYoutubeDL()
       youtubeDL.exec(videoInfo.url, options, processOptions, async (err, output) => {
         if (err) {
-          console.error(err)
+          log.error(err)
           return res()
         }
 
-        console.log(output.join('\n'))
-        await uploadVideoOnPeerTube(normalizeObject(videoInfo), path, cwd, url, user, languageCode)
+        log.info(output.join('\n'))
+        await uploadVideoOnPeerTube({
+          cwd,
+          url,
+          user,
+          videoInfo: normalizeObject(videoInfo),
+          videoPath: path
+        })
         return res()
       })
     } catch (err) {
-      console.log(err.message)
+      log.error(err.message)
       return res()
     }
   })
 }
 
-async function uploadVideoOnPeerTube (videoInfo: any, videoPath: string, cwd: string, url: string, user, language?: string) {
+async function uploadVideoOnPeerTube (parameters: {
+  videoInfo: any
+  videoPath: string
+  cwd: string
+  url: string
+  user: { username: string, password: string }
+}) {
+  const { videoInfo, videoPath, cwd, url, user } = parameters
+
   const category = await getCategory(videoInfo.categories, url)
   const licence = getLicence(videoInfo.license)
   let tags = []
   if (Array.isArray(videoInfo.tags)) {
     tags = videoInfo.tags
-      .filter(t => t.length < CONSTRAINTS_FIELDS.VIDEOS.TAG.max && t.length > CONSTRAINTS_FIELDS.VIDEOS.TAG.min)
-      .map(t => t.normalize())
-      .slice(0, 5)
+                    .filter(t => t.length < CONSTRAINTS_FIELDS.VIDEOS.TAG.max && t.length > CONSTRAINTS_FIELDS.VIDEOS.TAG.min)
+                    .map(t => t.normalize())
+                    .slice(0, 5)
   }
 
   let thumbnailfile
@@ -214,52 +209,54 @@ async function uploadVideoOnPeerTube (videoInfo: any, videoPath: string, cwd: st
 
   const originallyPublishedAt = buildOriginallyPublishedAt(videoInfo)
 
-  const videoAttributes = {
+  const defaultAttributes = {
     name: truncate(videoInfo.title, {
-      'length': CONSTRAINTS_FIELDS.VIDEOS.NAME.max,
-      'separator': /,? +/,
-      'omission': ' […]'
+      length: CONSTRAINTS_FIELDS.VIDEOS.NAME.max,
+      separator: /,? +/,
+      omission: ' […]'
     }),
     category,
     licence,
-    language,
     nsfw: isNSFW(videoInfo),
-    waitTranscoding: true,
-    commentsEnabled: true,
-    downloadEnabled: true,
-    description: videoInfo.description || undefined,
-    support: undefined,
-    tags,
-    privacy: VideoPrivacy.PUBLIC,
-    fixture: videoPath,
+    description: videoInfo.description,
+    tags
+  }
+
+  const videoAttributes = await buildVideoAttributesFromCommander(url, program, defaultAttributes)
+
+  Object.assign(videoAttributes, {
+    originallyPublishedAt: originallyPublishedAt ? originallyPublishedAt.toISOString() : null,
     thumbnailfile,
     previewfile: thumbnailfile,
-    originallyPublishedAt: originallyPublishedAt ? originallyPublishedAt.toISOString() : null
-  }
+    fixture: videoPath
+  })
+
+  log.info('\nUploading on PeerTube video "%s".', videoAttributes.name)
+
+  let accessToken = await getAccessTokenOrDie(url, user)
 
-  console.log('\nUploading on PeerTube video "%s".', videoAttributes.name)
   try {
     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.')
 
-      const res = await login(url, client, user)
-      accessToken = res.body.access_token
+      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)
 }
 
+/* ---------------------------------------------------------- */
+
 async function getCategory (categories: string[], url: string) {
   if (!categories) return undefined
 
@@ -278,12 +275,10 @@ async function getCategory (categories: string[], url: string) {
   return undefined
 }
 
-/* ---------------------------------------------------------- */
-
 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
 }
@@ -312,7 +307,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 })
@@ -323,23 +318,82 @@ 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
 }
 
 function isNSFW (info: any) {
-  if (info.age_limit && info.age_limit >= 16) return true
+  return info.age_limit && info.age_limit >= 16
+}
+
+function normalizeTargetUrl (url: string) {
+  let normalizedUrl = url.replace(/\/+$/, '')
+
+  if (!normalizedUrl.startsWith('http://') && !normalizedUrl.startsWith('https://')) {
+    normalizedUrl = 'https://' + normalizedUrl
+  }
 
-  return false
+  return normalizedUrl
 }
 
-function removeEndSlashes (url: string) {
-  while (url.endsWith('/')) {
-    url.slice(0, -1)
+async function promptPassword () {
+  return new Promise<string>((res, rej) => {
+    prompt.start()
+    const schema = {
+      properties: {
+        password: {
+          hidden: true,
+          required: true
+        }
+      }
+    }
+    prompt.get(schema, function (err, result) {
+      if (err) {
+        return rej(err)
+      }
+      return res(result.password)
+    })
+  })
+}
+
+async function getAccessTokenOrDie (url: string, user: UserInfo) {
+  const resClient = await getClient(url)
+  const client = {
+    id: resClient.body.client_id,
+    secret: resClient.body.client_secret
   }
+
+  try {
+    const res = await login(url, client, user)
+    return res.body.access_token
+  } catch (err) {
+    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 exitError (message: string, ...meta: any[]) {
+  // use console.error instead of log.error here
+  console.error(message, ...meta)
+  process.exit(-1)
 }