Merge remote-tracking branch 'alphapapa/master'
authorPhilipp Hagemeister <phihag@phihag.de>
Tue, 15 Oct 2013 02:52:07 +0000 (04:52 +0200)
committerPhilipp Hagemeister <phihag@phihag.de>
Tue, 15 Oct 2013 02:52:07 +0000 (04:52 +0200)
1  2 
youtube_dl/__init__.py

diff --combined youtube_dl/__init__.py
index 5248a92c7d09c0b2d6eb8a59c39ecc694afb3336,250cf62f866581a0278923e275a5b9c4c05a7eca..472ae9c0c7ef6a1f3aa5e122e8ad31778113c570
@@@ -27,17 -27,11 +27,17 @@@ __authors__  = 
      'Johny Mo Swag',
      'Axel Noack',
      'Albert Kim',
 +    'Pierre Rudloff',
 +    'Huarong Huo',
 +    'Ismael Mej√≠a',
 +    'Steffan \'Ruirize\' James',
 +    'Andras Elso',
  )
  
  __license__ = 'Public Domain'
  
  import codecs
 +import collections
  import getpass
  import optparse
  import os
@@@ -47,43 -41,16 +47,43 @@@ import shle
  import socket
  import subprocess
  import sys
 -import warnings
 +import traceback
  import platform
  
 -from .utils import *
 +
 +from .utils import (
 +    compat_cookiejar,
 +    compat_print,
 +    compat_str,
 +    compat_urllib_request,
 +    DateRange,
 +    decodeOption,
 +    determine_ext,
 +    DownloadError,
 +    get_cachedir,
 +    make_HTTPS_handler,
 +    MaxDownloadsReached,
 +    platform_name,
 +    preferredencoding,
 +    SameFileError,
 +    std_headers,
 +    write_string,
 +    YoutubeDLHandler,
 +)
  from .update import update_self
  from .version import __version__
 -from .FileDownloader import *
 +from .FileDownloader import (
 +    FileDownloader,
 +)
  from .extractor import gen_extractors
  from .YoutubeDL import YoutubeDL
 -from .PostProcessor import *
 +from .PostProcessor import (
 +    FFmpegMetadataPP,
 +    FFmpegVideoConvertor,
 +    FFmpegExtractAudioPP,
 +    FFmpegEmbedSubtitlePP,
 +)
 +
  
  def parseOpts(overrideArguments=None):
      def _readOptions(filename_bytes):
  
          return "".join(opts)
  
 +    def _comma_separated_values_options_callback(option, opt_str, value, parser):
 +        setattr(parser.values, option.dest, value.split(','))
 +
      def _find_term_columns():
          columns = os.environ.get('COLUMNS', None)
          if columns:
              pass
          return None
  
 +    def _hide_login_info(opts):
 +        opts = list(opts)
 +        for private_opt in ['-p', '--password', '-u', '--username']:
 +            try:
 +                i = opts.index(private_opt)
 +                opts[i+1] = '<PRIVATE>'
 +            except ValueError:
 +                pass
 +        return opts
 +
      max_width = 80
      max_help_position = 80
  
      selection      = optparse.OptionGroup(parser, 'Video Selection')
      authentication = optparse.OptionGroup(parser, 'Authentication Options')
      video_format   = optparse.OptionGroup(parser, 'Video Format Options')
 +    subtitles      = optparse.OptionGroup(parser, 'Subtitle Options')
      downloader     = optparse.OptionGroup(parser, 'Download Options')
      postproc       = optparse.OptionGroup(parser, 'Post-processing Options')
      filesystem     = optparse.OptionGroup(parser, 'Filesystem Options')
      general.add_option('-v', '--version',
              action='version', help='print program version and exit')
      general.add_option('-U', '--update',
 -            action='store_true', dest='update_self', help='update this program to latest version')
 +            action='store_true', dest='update_self', help='update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
      general.add_option('-i', '--ignore-errors',
 -            action='store_true', dest='ignoreerrors', help='continue on download errors', default=False)
 +            action='store_true', dest='ignoreerrors', help='continue on download errors, for example to to skip unavailable videos in a playlist', default=False)
      general.add_option('--dump-user-agent',
              action='store_true', dest='dump_user_agent',
              help='display the current browser identification', default=False)
              help='Output descriptions of all supported extractors', default=False)
      general.add_option('--proxy', dest='proxy', default=None, help='Use the specified HTTP/HTTPS proxy', metavar='URL')
      general.add_option('--no-check-certificate', action='store_true', dest='no_check_certificate', default=False, help='Suppress HTTPS certificate validation.')
 +    general.add_option(
 +        '--cache-dir', dest='cachedir', default=get_cachedir(),
 +        help='Location in the filesystem where youtube-dl can store downloaded information permanently. By default $XDG_CACHE_HOME/youtube-dl or ~/.cache/youtube-dl .')
 +    general.add_option(
 +        '--no-cache-dir', action='store_const', const=None, dest='cachedir',
 +        help='Disable filesystem caching')
  
  
      selection.add_option('--playlist-start',
      selection.add_option('--date', metavar='DATE', dest='date', help='download only videos uploaded in this date', default=None)
      selection.add_option('--datebefore', metavar='DATE', dest='datebefore', help='download only videos uploaded before this date', default=None)
      selection.add_option('--dateafter', metavar='DATE', dest='dateafter', help='download only videos uploaded after this date', default=None)
 +    selection.add_option('--no-playlist', action='store_true', dest='noplaylist', help='download only the currently playing video', default=False)
 +    selection.add_option('--age-limit', metavar='YEARS', dest='age_limit',
 +                         help='download only videos suitable for the given age',
 +                         default=None, type=int)
 +    selection.add_option('--download-archive', metavar='FILE',
 +                         dest='download_archive',
 +                         help='Download only videos not present in the archive file. Record all downloaded videos in it.')
  
  
      authentication.add_option('-u', '--username',
  
      video_format.add_option('-f', '--format',
              action='store', dest='format', metavar='FORMAT',
 -            help='video format code, specifiy the order of preference using slashes: "-f 22/17/18"')
 +            help='video format code, specifiy the order of preference using slashes: "-f 22/17/18". "-f mp4" and "-f flv" are also supported')
      video_format.add_option('--all-formats',
              action='store_const', dest='format', help='download all available video formats', const='all')
      video_format.add_option('--prefer-free-formats',
              action='store', dest='format_limit', metavar='FORMAT', help='highest quality format to download')
      video_format.add_option('-F', '--list-formats',
              action='store_true', dest='listformats', help='list all available formats (currently youtube only)')
 -    video_format.add_option('--write-sub', '--write-srt',
 +
 +    subtitles.add_option('--write-sub', '--write-srt',
              action='store_true', dest='writesubtitles',
 -            help='write subtitle file (currently youtube only)', default=False)
 -    video_format.add_option('--write-auto-sub', '--write-automatic-sub',
 +            help='write subtitle file', default=False)
 +    subtitles.add_option('--write-auto-sub', '--write-automatic-sub',
              action='store_true', dest='writeautomaticsub',
 -            help='write automatic subtitle file (currently youtube only)', default=False)
 -    video_format.add_option('--only-sub',
 -            action='store_true', dest='skip_download',
 -            help='[deprecated] alias of --skip-download', default=False)
 -    video_format.add_option('--all-subs',
 +            help='write automatic subtitle file (youtube only)', default=False)
 +    subtitles.add_option('--all-subs',
              action='store_true', dest='allsubtitles',
 -            help='downloads all the available subtitles of the video (currently youtube only)', default=False)
 -    video_format.add_option('--list-subs',
 +            help='downloads all the available subtitles of the video', default=False)
 +    subtitles.add_option('--list-subs',
              action='store_true', dest='listsubtitles',
 -            help='lists all available subtitles for the video (currently youtube only)', default=False)
 -    video_format.add_option('--sub-format',
 +            help='lists all available subtitles for the video', default=False)
 +    subtitles.add_option('--sub-format',
              action='store', dest='subtitlesformat', metavar='FORMAT',
 -            help='subtitle format [srt/sbv/vtt] (default=srt) (currently youtube only)', default='srt')
 -    video_format.add_option('--sub-lang', '--srt-lang',
 -            action='store', dest='subtitleslang', metavar='LANG',
 -            help='language of the subtitles to download (optional) use IETF language tags like \'en\'')
 +            help='subtitle format (default=srt) ([sbv/vtt] youtube only)', default='srt')
 +    subtitles.add_option('--sub-lang', '--sub-langs', '--srt-lang',
 +            action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
 +            default=[], callback=_comma_separated_values_options_callback,
 +            help='languages of the subtitles to download (optional) separated by commas, use IETF language tags like \'en,pt\'')
  
      downloader.add_option('-r', '--rate-limit',
-             dest='ratelimit', metavar='LIMIT', help='maximum download rate (e.g. 50k or 44.6m)')
+             dest='ratelimit', metavar='LIMIT', help='maximum download rate in bytes per second (e.g. 50k or 44.6m)')
      downloader.add_option('-R', '--retries',
              dest='retries', metavar='RETRIES', help='number of retries (default is %default)', default=10)
      downloader.add_option('--buffer-size',
      verbosity.add_option('--dump-intermediate-pages',
              action='store_true', dest='dump_intermediate_pages', default=False,
              help='print downloaded pages to debug problems(very verbose)')
 +    verbosity.add_option('--youtube-print-sig-code',
 +            action='store_true', dest='youtube_print_sig_code', default=False,
 +            help=optparse.SUPPRESS_HELP)
 +
  
      filesystem.add_option('-t', '--title',
              action='store_true', dest='usetitle', help='use title in file name (default)', default=False)
      filesystem.add_option('--write-info-json',
              action='store_true', dest='writeinfojson',
              help='write video metadata to a .info.json file', default=False)
 +    filesystem.add_option('--write-annotations',
 +            action='store_true', dest='writeannotations',
 +            help='write video annotations to a .annotation file', default=False)
      filesystem.add_option('--write-thumbnail',
              action='store_true', dest='writethumbnail',
              help='write thumbnail image to disk', default=False)
              help='keeps the video file on disk after the post-processing; the video is erased by default')
      postproc.add_option('--no-post-overwrites', action='store_true', dest='nopostoverwrites', default=False,
              help='do not overwrite post-processed files; the post-processed files are overwritten by default')
 +    postproc.add_option('--embed-subs', action='store_true', dest='embedsubtitles', default=False,
 +            help='embed subtitles in the video (only for mp4 videos)')
 +    postproc.add_option('--add-metadata', action='store_true', dest='addmetadata', default=False,
 +            help='add metadata to the files')
  
  
      parser.add_option_group(general)
      parser.add_option_group(filesystem)
      parser.add_option_group(verbosity)
      parser.add_option_group(video_format)
 +    parser.add_option_group(subtitles)
      parser.add_option_group(authentication)
      parser.add_option_group(postproc)
  
      if overrideArguments is not None:
          opts, args = parser.parse_args(overrideArguments)
          if opts.verbose:
 -            sys.stderr.write(u'[debug] Override config: ' + repr(overrideArguments) + '\n')
 +            write_string(u'[debug] Override config: ' + repr(overrideArguments) + '\n')
      else:
          xdg_config_home = os.environ.get('XDG_CONFIG_HOME')
          if xdg_config_home:
 -            userConfFile = os.path.join(xdg_config_home, 'youtube-dl.conf')
 +            userConfFile = os.path.join(xdg_config_home, 'youtube-dl', 'config')
 +            if not os.path.isfile(userConfFile):
 +                userConfFile = os.path.join(xdg_config_home, 'youtube-dl.conf')
          else:
 -            userConfFile = os.path.join(os.path.expanduser('~'), '.config', 'youtube-dl.conf')
 +            userConfFile = os.path.join(os.path.expanduser('~'), '.config', 'youtube-dl', 'config')
 +            if not os.path.isfile(userConfFile):
 +                userConfFile = os.path.join(os.path.expanduser('~'), '.config', 'youtube-dl.conf')
          systemConf = _readOptions('/etc/youtube-dl.conf')
          userConf = _readOptions(userConfFile)
 -        commandLineConf = sys.argv[1:] 
 +        commandLineConf = sys.argv[1:]
          argv = systemConf + userConf + commandLineConf
          opts, args = parser.parse_args(argv)
          if opts.verbose:
 -            sys.stderr.write(u'[debug] System config: ' + repr(systemConf) + '\n')
 -            sys.stderr.write(u'[debug] User config: ' + repr(userConf) + '\n')
 -            sys.stderr.write(u'[debug] Command-line args: ' + repr(commandLineConf) + '\n')
 +            write_string(u'[debug] System config: ' + repr(_hide_login_info(systemConf)) + '\n')
 +            write_string(u'[debug] User config: ' + repr(_hide_login_info(userConf)) + '\n')
 +            write_string(u'[debug] Command-line args: ' + repr(_hide_login_info(commandLineConf)) + '\n')
  
      return parser, opts, args
  
@@@ -447,12 -372,12 +447,12 @@@ def _real_main(argv=None)
          except (IOError, OSError) as err:
              if opts.verbose:
                  traceback.print_exc()
 -            sys.stderr.write(u'ERROR: unable to open cookie file\n')
 +            write_string(u'ERROR: unable to open cookie file\n')
              sys.exit(101)
      # Set user agent
      if opts.user_agent is not None:
          std_headers['User-Agent'] = opts.user_agent
 -    
 +
      # Set referer
      if opts.referer is not None:
          std_headers['Referer'] = opts.referer
              batchurls = batchfd.readlines()
              batchurls = [x.strip() for x in batchurls]
              batchurls = [x for x in batchurls if len(x) > 0 and not re.search(r'^[#/;]', x)]
 +            if opts.verbose:
 +                write_string(u'[debug] Batch file urls: ' + repr(batchurls) + u'\n')
          except IOError:
              sys.exit(u'ERROR: batch file could not be read')
      all_urls = batchurls + args
      all_urls = [url.strip() for url in all_urls]
  
 -    # General configuration
 -    cookie_processor = compat_urllib_request.HTTPCookieProcessor(jar)
 -    if opts.proxy is not None:
 -        if opts.proxy == '':
 -            proxies = {}
 -        else:
 -            proxies = {'http': opts.proxy, 'https': opts.proxy}
 -    else:
 -        proxies = compat_urllib_request.getproxies()
 -        # Set HTTPS proxy to HTTP one if given (https://github.com/rg3/youtube-dl/issues/805)
 -        if 'http' in proxies and 'https' not in proxies:
 -            proxies['https'] = proxies['http']
 -    proxy_handler = compat_urllib_request.ProxyHandler(proxies)
 -    https_handler = make_HTTPS_handler(opts)
 -    opener = compat_urllib_request.build_opener(https_handler, proxy_handler, cookie_processor, YoutubeDLHandler())
 -    compat_urllib_request.install_opener(opener)
 -    socket.setdefaulttimeout(300) # 5 minutes should be enough (famous last words)
 +    opener = _setup_opener(jar=jar, opts=opts)
  
      extractors = gen_extractors()
  
              if not ie._WORKING:
                  continue
              desc = getattr(ie, 'IE_DESC', ie.IE_NAME)
 +            if desc is False:
 +                continue
              if hasattr(ie, 'SEARCH_KEY'):
                  _SEARCHES = (u'cute kittens', u'slithering pythons', u'falling cat', u'angry poodle', u'purple fish', u'running tortoise')
                  _COUNTS = (u'', u'5', u'10', u'all')
      else:
          date = DateRange(opts.dateafter, opts.datebefore)
  
 +    # --all-sub automatically sets --write-sub if --write-auto-sub is not given
 +    # this was the old behaviour if only --all-sub was given.
 +    if opts.allsubtitles and (opts.writeautomaticsub == False):
 +        opts.writesubtitles = True
 +
      if sys.version_info < (3,):
          # In Python 2, sys.argv is a bytestring (also note http://bugs.python.org/issue2128 for Windows systems)
          if opts.outtmpl is not None:
              or (opts.useid and u'%(id)s.%(ext)s')
              or (opts.autonumber and u'%(autonumber)s-%(id)s.%(ext)s')
              or u'%(title)s-%(id)s.%(ext)s')
 +    if '%(ext)s' not in outtmpl and opts.extractaudio:
 +        parser.error(u'Cannot download a video and extract audio into the same'
 +                     u' file! Use "%%(ext)s" instead of %r' %
 +                     determine_ext(outtmpl, u''))
  
      # YoutubeDL
      ydl = YoutubeDL({
          'progress_with_newline': opts.progress_with_newline,
          'playliststart': opts.playliststart,
          'playlistend': opts.playlistend,
 +        'noplaylist': opts.noplaylist,
          'logtostderr': opts.outtmpl == '-',
          'consoletitle': opts.consoletitle,
          'nopart': opts.nopart,
          'updatetime': opts.updatetime,
          'writedescription': opts.writedescription,
 +        'writeannotations': opts.writeannotations,
          'writeinfojson': opts.writeinfojson,
          'writethumbnail': opts.writethumbnail,
          'writesubtitles': opts.writesubtitles,
          'allsubtitles': opts.allsubtitles,
          'listsubtitles': opts.listsubtitles,
          'subtitlesformat': opts.subtitlesformat,
 -        'subtitleslang': opts.subtitleslang,
 +        'subtitleslangs': opts.subtitleslangs,
          'matchtitle': decodeOption(opts.matchtitle),
          'rejecttitle': decodeOption(opts.rejecttitle),
          'max_downloads': opts.max_downloads,
          'min_filesize': opts.min_filesize,
          'max_filesize': opts.max_filesize,
          'daterange': date,
 +        'cachedir': opts.cachedir,
 +        'youtube_print_sig_code': opts.youtube_print_sig_code,
 +        'age_limit': opts.age_limit,
 +        'download_archive': opts.download_archive,
          })
  
      if opts.verbose:
 -        ydl.to_screen(u'[debug] youtube-dl version ' + __version__)
 +        write_string(u'[debug] youtube-dl version ' + __version__ + u'\n')
          try:
              sp = subprocess.Popen(
                  ['git', 'rev-parse', '--short', 'HEAD'],
              out, err = sp.communicate()
              out = out.decode().strip()
              if re.match('[0-9a-f]+', out):
 -                ydl.to_screen(u'[debug] Git HEAD: ' + out)
 +                write_string(u'[debug] Git HEAD: ' + out + u'\n')
          except:
 -            sys.exc_clear()
 -        ydl.to_screen(u'[debug] Python version %s - %s' %(platform.python_version(), platform.platform()))
 -        ydl.to_screen(u'[debug] Proxy map: ' + str(proxy_handler.proxies))
 +            try:
 +                sys.exc_clear()
 +            except:
 +                pass
 +        write_string(u'[debug] Python version %s - %s' %(platform.python_version(), platform_name()) + u'\n')
 +
 +        proxy_map = {}
 +        for handler in opener.handlers:
 +            if hasattr(handler, 'proxies'):
 +                proxy_map.update(handler.proxies)
 +        write_string(u'[debug] Proxy map: ' + compat_str(proxy_map) + u'\n')
  
      ydl.add_default_info_extractors()
  
      # PostProcessors
 +    # Add the metadata pp first, the other pps will copy it
 +    if opts.addmetadata:
 +        ydl.add_post_processor(FFmpegMetadataPP())
      if opts.extractaudio:
          ydl.add_post_processor(FFmpegExtractAudioPP(preferredcodec=opts.audioformat, preferredquality=opts.audioquality, nopostoverwrites=opts.nopostoverwrites))
      if opts.recodevideo:
          ydl.add_post_processor(FFmpegVideoConvertor(preferedformat=opts.recodevideo))
 +    if opts.embedsubtitles:
 +        ydl.add_post_processor(FFmpegEmbedSubtitlePP(subtitlesformat=opts.subtitlesformat))
  
      # Update version
      if opts.update_self:
 -        update_self(ydl.to_screen, opts.verbose, sys.argv[0])
 +        update_self(ydl.to_screen, opts.verbose)
  
      # Maybe do nothing
      if len(all_urls) < 1:
      if opts.cookiefile is not None:
          try:
              jar.save()
 -        except (IOError, OSError) as err:
 +        except (IOError, OSError):
              sys.exit(u'ERROR: unable to save cookie jar')
  
      sys.exit(retcode)
  
 +
 +def _setup_opener(jar=None, opts=None, timeout=300):
 +    if opts is None:
 +        FakeOptions = collections.namedtuple(
 +            'FakeOptions', ['proxy', 'no_check_certificate'])
 +        opts = FakeOptions(proxy=None, no_check_certificate=False)
 +
 +    cookie_processor = compat_urllib_request.HTTPCookieProcessor(jar)
 +    if opts.proxy is not None:
 +        if opts.proxy == '':
 +            proxies = {}
 +        else:
 +            proxies = {'http': opts.proxy, 'https': opts.proxy}
 +    else:
 +        proxies = compat_urllib_request.getproxies()
 +        # Set HTTPS proxy to HTTP one if given (https://github.com/rg3/youtube-dl/issues/805)
 +        if 'http' in proxies and 'https' not in proxies:
 +            proxies['https'] = proxies['http']
 +    proxy_handler = compat_urllib_request.ProxyHandler(proxies)
 +    https_handler = make_HTTPS_handler(opts)
 +    opener = compat_urllib_request.build_opener(
 +        https_handler, proxy_handler, cookie_processor, YoutubeDLHandler())
 +    # Delete the default user-agent header, which would otherwise apply in
 +    # cases where our custom HTTP handler doesn't come into play
 +    # (See https://github.com/rg3/youtube-dl/issues/1309 for details)
 +    opener.addheaders = []
 +    compat_urllib_request.install_opener(opener)
 +    socket.setdefaulttimeout(timeout)
 +    return opener
 +
 +
  def main(argv=None):
      try:
          _real_main(argv)