]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/tools/peertube-import-videos.ts
Add since parameter to peertube-import-videos (#1991)
[github/Chocobozzz/PeerTube.git] / server / tools / peertube-import-videos.ts
index 151c5a9896690ffd630d8ae7bc1983aa86e4c06c..0ebfa744263d19b807eb6427432d85c395a66309 100644 (file)
@@ -3,130 +3,70 @@ require('tls').DEFAULT_ECDH_CURVE = 'auto'
 
 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'
-import { getClient, getVideoCategories, login, searchVideoWithSort, uploadVideo } from '../../shared/utils/index'
+import { CONSTRAINTS_FIELDS } from '../initializers/constants'
+import { getClient, getVideoCategories, login, searchVideoWithSort, uploadVideo } from '../../shared/extra-utils/index'
 import { truncate } from 'lodash'
 import * as prompt from 'prompt'
 import { remove } from 'fs-extra'
 import { sha256 } from '../helpers/core-utils'
-import { safeGetYoutubeDL } from '../helpers/youtube-dl'
-import { getSettings, netrc } from './cli'
+import { buildOriginallyPublishedAt, safeGetYoutubeDL } from '../helpers/youtube-dl'
+import { buildCommonVideoOptions, buildVideoAttributesFromCommander, 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('--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('-v, --verbose', 'Verbose mode')
   .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)
-  }
+getServerCredentials(command)
+  .then(({ url, username, password }) => {
+    if (!program[ 'targetUrl' ]) {
+      console.error('--targetUrl field is required.')
 
-  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]
+      process.exit(-1)
     }
 
-    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'])
-
-  const user = {
-    username: program['username'],
-    password: program['password']
-  }
+    removeEndSlashes(url)
+    removeEndSlashes(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 => {
+        console.error(err)
+        process.exit(-1)
+      })
   })
-}
 
-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' ]
-  youtubeDL.getInfo(program['targetUrl'], options, processOptions, async (err, info) => {
+  youtubeDL.getInfo(program[ 'targetUrl' ], options, processOptions, async (err, info) => {
     if (err) {
       console.log(err.message)
       process.exit(1)
@@ -143,20 +83,47 @@ async function run (user, url: string) {
     console.log('Will download and upload %d videos.\n', infoArray.length)
 
     for (const info of infoArray) {
-      await processVideo(info, program['language'], processOptions.cwd, url, user)
+      await processVideo({
+        cwd: processOptions.cwd,
+        url,
+        user,
+        youtubeInfo: info
+      })
     }
 
-    console.log('Video/s for user %s imported: %s', program['username'], program['targetUrl'])
+    console.log('Video/s for user %s imported: %s', program[ '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)
+    if (program[ 'verbose' ]) console.log('Fetching object.', youtubeInfo)
 
-    const videoInfo = await fetchObject(info)
-    if (program['verbose']) console.log('Fetched object.', videoInfo)
+    const videoInfo = await fetchObject(youtubeInfo)
+    if (program[ 'verbose' ]) console.log('Fetched object.', videoInfo)
+
+    if (program[ 'since' ]) {
+      if (buildOriginallyPublishedAt(videoInfo).getTime() < program[ 'since' ].getTime()) {
+        console.log('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()) {
+        console.log('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')
 
@@ -181,7 +148,13 @@ function processVideo (info: any, languageCode: string, cwd: string, url: string
         }
 
         console.log(output.join('\n'))
-        await uploadVideoOnPeerTube(normalizeObject(videoInfo), path, cwd, url, user, languageCode)
+        await uploadVideoOnPeerTube({
+          cwd,
+          url,
+          user,
+          videoInfo: normalizeObject(videoInfo),
+          videoPath: path
+        })
         return res()
       })
     } catch (err) {
@@ -191,15 +164,23 @@ function processVideo (info: any, languageCode: string, cwd: string, url: string
   })
 }
 
-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
@@ -212,7 +193,9 @@ async function uploadVideoOnPeerTube (videoInfo: any, videoPath: string, cwd: st
     }, thumbnailfile)
   }
 
-  const videoAttributes = {
+  const originallyPublishedAt = buildOriginallyPublishedAt(videoInfo)
+
+  const defaultAttributes = {
     name: truncate(videoInfo.title, {
       'length': CONSTRAINTS_FIELDS.VIDEOS.NAME.max,
       'separator': /,? +/,
@@ -220,29 +203,31 @@ async function uploadVideoOnPeerTube (videoInfo: any, videoPath: string, cwd: st
     }),
     category,
     licence,
-    language,
     nsfw: isNSFW(videoInfo),
-    waitTranscoding: true,
-    commentsEnabled: true,
-    downloadEnabled: true,
-    description: videoInfo.description || undefined,
-    support: undefined,
-    tags,
-    privacy: VideoPrivacy.PUBLIC,
-    fixture: videoPath,
-    thumbnailfile,
-    previewfile: thumbnailfile
+    description: videoInfo.description,
+    tags
   }
 
+  const videoAttributes = await buildVideoAttributesFromCommander(url, program, defaultAttributes)
+
+  Object.assign(videoAttributes, {
+    originallyPublishedAt: originallyPublishedAt ? originallyPublishedAt.toISOString() : null,
+    thumbnailfile,
+    previewfile: thumbnailfile,
+    fixture: videoPath
+  })
+
   console.log('\nUploading on PeerTube video "%s".', videoAttributes.name)
+
+  let accessToken = await getAccessTokenOrDie(url, user)
+
   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.')
 
-      const res = await login(url, client, user)
-      accessToken = res.body.access_token
+      accessToken = await getAccessTokenOrDie(url, user)
 
       await uploadVideo(url, accessToken, videoAttributes)
     } else {
@@ -257,10 +242,12 @@ async function uploadVideoOnPeerTube (videoInfo: any, videoPath: string, cwd: st
   console.log('Uploaded video "%s"!\n', videoAttributes.name)
 }
 
+/* ---------------------------------------------------------- */
+
 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
 
@@ -268,15 +255,13 @@ 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)
   }
 
   return undefined
 }
 
-/* ---------------------------------------------------------- */
-
 function getLicence (licence: string) {
   if (!licence) return undefined
 
@@ -292,12 +277,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
     }
   }
 
@@ -330,9 +315,7 @@ function buildUrl (info: any) {
 }
 
 function isNSFW (info: any) {
-  if (info.age_limit && info.age_limit >= 16) return true
-
-  return false
+  return info.age_limit && info.age_limit >= 16
 }
 
 function removeEndSlashes (url: string) {
@@ -340,3 +323,56 @@ function removeEndSlashes (url: string) {
     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) {
+    console.error('Cannot authenticate. Please check your username/password.')
+    process.exit(-1)
+  }
+}
+
+function parseDate (dateAsStr: string): Date {
+  if (!/\d{4}-\d{2}-\d{2}/.test(dateAsStr)) {
+    console.error(`Invalid date passed: ${dateAsStr}. Expected format: YYYY-MM-DD. See help for usage.`);
+    process.exit(-1);
+  }
+  const date = new Date(dateAsStr);
+  if (isNaN(date.getTime())) {
+    console.error(`Invalid date passed: ${dateAsStr}. See help for usage.`);
+    process.exit(-1);
+  }
+  return date;
+}
+
+function formatDate (date: Date): string {
+  return date.toISOString().split('T')[0];
+}