Restore 2.5 compat by activating with_statement future
[youtube-dl] / youtube_dl / __init__.py
1 #!/usr/bin/env python
2 # -*- coding: utf-8 -*-
3
4 from __future__ import with_statement
5
6 __authors__  = (
7         'Ricardo Garcia Gonzalez',
8         'Danny Colligan',
9         'Benjamin Johnson',
10         'Vasyl\' Vavrychuk',
11         'Witold Baryluk',
12         'Paweł Paprota',
13         'Gergely Imreh',
14         'Rogério Brito',
15         'Philipp Hagemeister',
16         'Sören Schulze',
17         'Kevin Ngo',
18         'Ori Avtalion',
19         'shizeeg',
20         'Filippo Valsorda',
21         )
22
23 __license__ = 'Public Domain'
24 __version__ = '2012.10.09'
25
26 UPDATE_URL = 'https://raw.github.com/rg3/youtube-dl/master/youtube-dl'
27 UPDATE_URL_VERSION = 'https://raw.github.com/rg3/youtube-dl/master/LATEST_VERSION'
28 UPDATE_URL_EXE = 'https://raw.github.com/rg3/youtube-dl/master/youtube-dl.exe'
29
30
31 import cookielib
32 import getpass
33 import optparse
34 import os
35 import re
36 import shlex
37 import socket
38 import subprocess
39 import sys
40 import urllib2
41 import warnings
42
43 from utils import *
44 from FileDownloader import *
45 from InfoExtractors import *
46 from PostProcessor import *
47
48 def updateSelf(downloader, filename):
49         ''' Update the program file with the latest version from the repository '''
50         # Note: downloader only used for options
51         
52         if not os.access(filename, os.W_OK):
53                 sys.exit('ERROR: no write permissions on %s' % filename)
54
55         downloader.to_screen(u'Updating to latest version...')
56
57         urlv = urllib2.urlopen(UPDATE_URL_VERSION)
58         newversion = urlv.read().strip()
59         if newversion == __version__:
60                 downloader.to_screen(u'youtube-dl is up-to-date (' + __version__ + ')')
61                 return
62         urlv.close()
63
64         if hasattr(sys, "frozen"): #py2exe
65                 exe = os.path.abspath(filename)
66                 directory = os.path.dirname(exe)
67                 if not os.access(directory, os.W_OK):
68                         sys.exit('ERROR: no write permissions on %s' % directory)
69                         
70                 try:
71                         urlh = urllib2.urlopen(UPDATE_URL_EXE)
72                         newcontent = urlh.read()
73                         urlh.close()
74                         with open(exe + '.new', 'wb') as outf:
75                                 outf.write(newcontent)
76                 except (IOError, OSError), err:
77                         sys.exit('ERROR: unable to download latest version')
78                         
79                 try:
80                         bat = os.path.join(directory, 'youtube-dl-updater.bat')
81                         b = open(bat, 'w')
82                         
83                         print >> b, """
84 echo Updating youtube-dl...
85 ping 127.0.0.1 -n 5 -w 1000 > NUL
86 move /Y "%s.new" "%s"
87 del "%s"
88                         """ %(exe, exe, bat)
89                         
90                         b.close()
91                         
92                         os.startfile(bat)
93                 except (IOError, OSError), err:
94                         sys.exit('ERROR: unable to overwrite current version')
95
96         else:
97                 try:
98                         urlh = urllib2.urlopen(UPDATE_URL)
99                         newcontent = urlh.read()
100                         urlh.close()
101                 except (IOError, OSError), err:
102                         sys.exit('ERROR: unable to download latest version')
103
104                 try:
105                         with open(filename, 'wb') as outf:
106                                 outf.write(newcontent)
107                 except (IOError, OSError), err:
108                         sys.exit('ERROR: unable to overwrite current version')
109
110         downloader.to_screen(u'Updated youtube-dl. Restart youtube-dl to use the new version.')
111
112 def parseOpts():
113         def _readOptions(filename_bytes):
114                 try:
115                         optionf = open(filename_bytes)
116                 except IOError:
117                         return [] # silently skip if file is not present
118                 try:
119                         res = []
120                         for l in optionf:
121                                 res += shlex.split(l, comments=True)
122                 finally:
123                         optionf.close()
124                 return res
125
126         def _format_option_string(option):
127                 ''' ('-o', '--option') -> -o, --format METAVAR'''
128
129                 opts = []
130
131                 if option._short_opts: opts.append(option._short_opts[0])
132                 if option._long_opts: opts.append(option._long_opts[0])
133                 if len(opts) > 1: opts.insert(1, ', ')
134
135                 if option.takes_value(): opts.append(' %s' % option.metavar)
136
137                 return "".join(opts)
138
139         def _find_term_columns():
140                 columns = os.environ.get('COLUMNS', None)
141                 if columns:
142                         return int(columns)
143
144                 try:
145                         sp = subprocess.Popen(['stty', 'size'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
146                         out,err = sp.communicate()
147                         return int(out.split()[1])
148                 except:
149                         pass
150                 return None
151
152         max_width = 80
153         max_help_position = 80
154
155         # No need to wrap help messages if we're on a wide console
156         columns = _find_term_columns()
157         if columns: max_width = columns
158
159         fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position)
160         fmt.format_option_strings = _format_option_string
161
162         kw = {
163                 'version'   : __version__,
164                 'formatter' : fmt,
165                 'usage' : '%prog [options] url [url...]',
166                 'conflict_handler' : 'resolve',
167         }
168
169         parser = optparse.OptionParser(**kw)
170
171         # option groups
172         general        = optparse.OptionGroup(parser, 'General Options')
173         selection      = optparse.OptionGroup(parser, 'Video Selection')
174         authentication = optparse.OptionGroup(parser, 'Authentication Options')
175         video_format   = optparse.OptionGroup(parser, 'Video Format Options')
176         postproc       = optparse.OptionGroup(parser, 'Post-processing Options')
177         filesystem     = optparse.OptionGroup(parser, 'Filesystem Options')
178         verbosity      = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
179
180         general.add_option('-h', '--help',
181                         action='help', help='print this help text and exit')
182         general.add_option('-v', '--version',
183                         action='version', help='print program version and exit')
184         general.add_option('-U', '--update',
185                         action='store_true', dest='update_self', help='update this program to latest version')
186         general.add_option('-i', '--ignore-errors',
187                         action='store_true', dest='ignoreerrors', help='continue on download errors', default=False)
188         general.add_option('-r', '--rate-limit',
189                         dest='ratelimit', metavar='LIMIT', help='download rate limit (e.g. 50k or 44.6m)')
190         general.add_option('-R', '--retries',
191                         dest='retries', metavar='RETRIES', help='number of retries (default is %default)', default=10)
192         general.add_option('--dump-user-agent',
193                         action='store_true', dest='dump_user_agent',
194                         help='display the current browser identification', default=False)
195         general.add_option('--user-agent',
196                         dest='user_agent', help='specify a custom user agent', metavar='UA')
197         general.add_option('--list-extractors',
198                         action='store_true', dest='list_extractors',
199                         help='List all supported extractors and the URLs they would handle', default=False)
200
201         selection.add_option('--playlist-start',
202                         dest='playliststart', metavar='NUMBER', help='playlist video to start at (default is %default)', default=1)
203         selection.add_option('--playlist-end',
204                         dest='playlistend', metavar='NUMBER', help='playlist video to end at (default is last)', default=-1)
205         selection.add_option('--match-title', dest='matchtitle', metavar='REGEX',help='download only matching titles (regex or caseless sub-string)')
206         selection.add_option('--reject-title', dest='rejecttitle', metavar='REGEX',help='skip download for matching titles (regex or caseless sub-string)')
207         selection.add_option('--max-downloads', metavar='NUMBER', dest='max_downloads', help='Abort after downloading NUMBER files', default=None)
208
209         authentication.add_option('-u', '--username',
210                         dest='username', metavar='USERNAME', help='account username')
211         authentication.add_option('-p', '--password',
212                         dest='password', metavar='PASSWORD', help='account password')
213         authentication.add_option('-n', '--netrc',
214                         action='store_true', dest='usenetrc', help='use .netrc authentication data', default=False)
215
216
217         video_format.add_option('-f', '--format',
218                         action='store', dest='format', metavar='FORMAT', help='video format code')
219         video_format.add_option('--all-formats',
220                         action='store_const', dest='format', help='download all available video formats', const='all')
221         video_format.add_option('--prefer-free-formats',
222                         action='store_true', dest='prefer_free_formats', default=False, help='prefer free video formats unless a specific one is requested')
223         video_format.add_option('--max-quality',
224                         action='store', dest='format_limit', metavar='FORMAT', help='highest quality format to download')
225         video_format.add_option('-F', '--list-formats',
226                         action='store_true', dest='listformats', help='list all available formats (currently youtube only)')
227         video_format.add_option('--write-srt',
228                         action='store_true', dest='writesubtitles',
229                         help='write video closed captions to a .srt file (currently youtube only)', default=False)
230         video_format.add_option('--srt-lang',
231                         action='store', dest='subtitleslang', metavar='LANG',
232                         help='language of the closed captions to download (optional) use IETF language tags like \'en\'')
233
234
235         verbosity.add_option('-q', '--quiet',
236                         action='store_true', dest='quiet', help='activates quiet mode', default=False)
237         verbosity.add_option('-s', '--simulate',
238                         action='store_true', dest='simulate', help='do not download the video and do not write anything to disk', default=False)
239         verbosity.add_option('--skip-download',
240                         action='store_true', dest='skip_download', help='do not download the video', default=False)
241         verbosity.add_option('-g', '--get-url',
242                         action='store_true', dest='geturl', help='simulate, quiet but print URL', default=False)
243         verbosity.add_option('-e', '--get-title',
244                         action='store_true', dest='gettitle', help='simulate, quiet but print title', default=False)
245         verbosity.add_option('--get-thumbnail',
246                         action='store_true', dest='getthumbnail',
247                         help='simulate, quiet but print thumbnail URL', default=False)
248         verbosity.add_option('--get-description',
249                         action='store_true', dest='getdescription',
250                         help='simulate, quiet but print video description', default=False)
251         verbosity.add_option('--get-filename',
252                         action='store_true', dest='getfilename',
253                         help='simulate, quiet but print output filename', default=False)
254         verbosity.add_option('--get-format',
255                         action='store_true', dest='getformat',
256                         help='simulate, quiet but print output format', default=False)
257         verbosity.add_option('--no-progress',
258                         action='store_true', dest='noprogress', help='do not print progress bar', default=False)
259         verbosity.add_option('--console-title',
260                         action='store_true', dest='consoletitle',
261                         help='display progress in console titlebar', default=False)
262         verbosity.add_option('-v', '--verbose',
263                         action='store_true', dest='verbose', help='print various debugging information', default=False)
264
265
266         filesystem.add_option('-t', '--title',
267                         action='store_true', dest='usetitle', help='use title in file name', default=False)
268         filesystem.add_option('-l', '--literal',
269                         action='store_true', dest='useliteral', help='use literal title in file name', default=False)
270         filesystem.add_option('-A', '--auto-number',
271                         action='store_true', dest='autonumber',
272                         help='number downloaded files starting from 00000', default=False)
273         filesystem.add_option('-o', '--output',
274                         dest='outtmpl', metavar='TEMPLATE', help='output filename template. Use %(stitle)s to get the title, %(uploader)s for the uploader name, %(autonumber)s to get an automatically incremented number, %(ext)s for the filename extension, %(upload_date)s for the upload date (YYYYMMDD), %(extractor)s for the provider (youtube, metacafe, etc), %(id)s for the video id and %% for a literal percent. Use - to output to stdout.')
275         filesystem.add_option('-a', '--batch-file',
276                         dest='batchfile', metavar='FILE', help='file containing URLs to download (\'-\' for stdin)')
277         filesystem.add_option('-w', '--no-overwrites',
278                         action='store_true', dest='nooverwrites', help='do not overwrite files', default=False)
279         filesystem.add_option('-c', '--continue',
280                         action='store_true', dest='continue_dl', help='resume partially downloaded files', default=True)
281         filesystem.add_option('--no-continue',
282                         action='store_false', dest='continue_dl',
283                         help='do not resume partially downloaded files (restart from beginning)')
284         filesystem.add_option('--cookies',
285                         dest='cookiefile', metavar='FILE', help='file to read cookies from and dump cookie jar in')
286         filesystem.add_option('--no-part',
287                         action='store_true', dest='nopart', help='do not use .part files', default=False)
288         filesystem.add_option('--no-mtime',
289                         action='store_false', dest='updatetime',
290                         help='do not use the Last-modified header to set the file modification time', default=True)
291         filesystem.add_option('--write-description',
292                         action='store_true', dest='writedescription',
293                         help='write video description to a .description file', default=False)
294         filesystem.add_option('--write-info-json',
295                         action='store_true', dest='writeinfojson',
296                         help='write video metadata to a .info.json file', default=False)
297
298
299         postproc.add_option('--extract-audio', action='store_true', dest='extractaudio', default=False,
300                         help='convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)')
301         postproc.add_option('--audio-format', metavar='FORMAT', dest='audioformat', default='best',
302                         help='"best", "aac", "vorbis", "mp3", "m4a", or "wav"; best by default')
303         postproc.add_option('--audio-quality', metavar='QUALITY', dest='audioquality', default='5',
304                         help='ffmpeg/avconv audio quality specification, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default 5)')
305         postproc.add_option('-k', '--keep-video', action='store_true', dest='keepvideo', default=False,
306                         help='keeps the video file on disk after the post-processing; the video is erased by default')
307
308
309         parser.add_option_group(general)
310         parser.add_option_group(selection)
311         parser.add_option_group(filesystem)
312         parser.add_option_group(verbosity)
313         parser.add_option_group(video_format)
314         parser.add_option_group(authentication)
315         parser.add_option_group(postproc)
316
317         xdg_config_home = os.environ.get('XDG_CONFIG_HOME')
318         if xdg_config_home:
319                 userConf = os.path.join(xdg_config_home, 'youtube-dl.conf')
320         else:
321                 userConf = os.path.join(os.path.expanduser('~'), '.config', 'youtube-dl.conf')
322         argv = _readOptions('/etc/youtube-dl.conf') + _readOptions(userConf) + sys.argv[1:]
323         opts, args = parser.parse_args(argv)
324
325         return parser, opts, args
326
327 def gen_extractors():
328         """ Return a list of an instance of every supported extractor.
329         The order does matter; the first extractor matched is the one handling the URL.
330         """
331         return [
332                 YoutubePlaylistIE(),
333                 YoutubeChannelIE(),
334                 YoutubeUserIE(),
335                 YoutubeSearchIE(),
336                 YoutubeIE(),
337                 MetacafeIE(),
338                 DailymotionIE(),
339                 GoogleIE(),
340                 GoogleSearchIE(),
341                 PhotobucketIE(),
342                 YahooIE(),
343                 YahooSearchIE(),
344                 DepositFilesIE(),
345                 FacebookIE(),
346                 BlipTVUserIE(),
347                 BlipTVIE(),
348                 VimeoIE(),
349                 MyVideoIE(),
350                 ComedyCentralIE(),
351                 EscapistIE(),
352                 CollegeHumorIE(),
353                 XVideosIE(),
354                 SoundcloudIE(),
355                 InfoQIE(),
356                 MixcloudIE(),
357                 StanfordOpenClassroomIE(),
358                 MTVIE(),
359                 YoukuIE(),
360                 XNXXIE(),
361                 GooglePlusIE(),
362
363                 GenericIE()
364         ]
365
366 def _real_main():
367         parser, opts, args = parseOpts()
368
369         # Open appropriate CookieJar
370         if opts.cookiefile is None:
371                 jar = cookielib.CookieJar()
372         else:
373                 try:
374                         jar = cookielib.MozillaCookieJar(opts.cookiefile)
375                         if os.path.isfile(opts.cookiefile) and os.access(opts.cookiefile, os.R_OK):
376                                 jar.load()
377                 except (IOError, OSError), err:
378                         sys.exit(u'ERROR: unable to open cookie file')
379         # Set user agent
380         if opts.user_agent is not None:
381                 std_headers['User-Agent'] = opts.user_agent
382
383         # Dump user agent
384         if opts.dump_user_agent:
385                 print std_headers['User-Agent']
386                 sys.exit(0)
387
388         # Batch file verification
389         batchurls = []
390         if opts.batchfile is not None:
391                 try:
392                         if opts.batchfile == '-':
393                                 batchfd = sys.stdin
394                         else:
395                                 batchfd = open(opts.batchfile, 'r')
396                         batchurls = batchfd.readlines()
397                         batchurls = [x.strip() for x in batchurls]
398                         batchurls = [x for x in batchurls if len(x) > 0 and not re.search(r'^[#/;]', x)]
399                 except IOError:
400                         sys.exit(u'ERROR: batch file could not be read')
401         all_urls = batchurls + args
402         all_urls = map(lambda url: url.strip(), all_urls)
403
404         # General configuration
405         cookie_processor = urllib2.HTTPCookieProcessor(jar)
406         proxy_handler = urllib2.ProxyHandler()
407         opener = urllib2.build_opener(proxy_handler, cookie_processor, YoutubeDLHandler())
408         urllib2.install_opener(opener)
409         socket.setdefaulttimeout(300) # 5 minutes should be enough (famous last words)
410
411         extractors = gen_extractors()
412
413         if opts.list_extractors:
414                 for ie in extractors:
415                         print(ie.IE_NAME)
416                         matchedUrls = filter(lambda url: ie.suitable(url), all_urls)
417                         all_urls = filter(lambda url: url not in matchedUrls, all_urls)
418                         for mu in matchedUrls:
419                                 print(u'  ' + mu)
420                 sys.exit(0)
421
422         # Conflicting, missing and erroneous options
423         if opts.usenetrc and (opts.username is not None or opts.password is not None):
424                 parser.error(u'using .netrc conflicts with giving username/password')
425         if opts.password is not None and opts.username is None:
426                 parser.error(u'account username missing')
427         if opts.outtmpl is not None and (opts.useliteral or opts.usetitle or opts.autonumber):
428                 parser.error(u'using output template conflicts with using title, literal title or auto number')
429         if opts.usetitle and opts.useliteral:
430                 parser.error(u'using title conflicts with using literal title')
431         if opts.username is not None and opts.password is None:
432                 opts.password = getpass.getpass(u'Type account password and press return:')
433         if opts.ratelimit is not None:
434                 numeric_limit = FileDownloader.parse_bytes(opts.ratelimit)
435                 if numeric_limit is None:
436                         parser.error(u'invalid rate limit specified')
437                 opts.ratelimit = numeric_limit
438         if opts.retries is not None:
439                 try:
440                         opts.retries = long(opts.retries)
441                 except (TypeError, ValueError), err:
442                         parser.error(u'invalid retry count specified')
443         try:
444                 opts.playliststart = int(opts.playliststart)
445                 if opts.playliststart <= 0:
446                         raise ValueError(u'Playlist start must be positive')
447         except (TypeError, ValueError), err:
448                 parser.error(u'invalid playlist start number specified')
449         try:
450                 opts.playlistend = int(opts.playlistend)
451                 if opts.playlistend != -1 and (opts.playlistend <= 0 or opts.playlistend < opts.playliststart):
452                         raise ValueError(u'Playlist end must be greater than playlist start')
453         except (TypeError, ValueError), err:
454                 parser.error(u'invalid playlist end number specified')
455         if opts.extractaudio:
456                 if opts.audioformat not in ['best', 'aac', 'mp3', 'vorbis', 'm4a', 'wav']:
457                         parser.error(u'invalid audio format specified')
458         if opts.audioquality:
459                 opts.audioquality = opts.audioquality.strip('k').strip('K')
460                 if not opts.audioquality.isdigit():
461                         parser.error(u'invalid audio quality specified')
462
463         # File downloader
464         fd = FileDownloader({
465                 'usenetrc': opts.usenetrc,
466                 'username': opts.username,
467                 'password': opts.password,
468                 'quiet': (opts.quiet or opts.geturl or opts.gettitle or opts.getthumbnail or opts.getdescription or opts.getfilename or opts.getformat),
469                 'forceurl': opts.geturl,
470                 'forcetitle': opts.gettitle,
471                 'forcethumbnail': opts.getthumbnail,
472                 'forcedescription': opts.getdescription,
473                 'forcefilename': opts.getfilename,
474                 'forceformat': opts.getformat,
475                 'simulate': opts.simulate,
476                 'skip_download': (opts.skip_download or opts.simulate or opts.geturl or opts.gettitle or opts.getthumbnail or opts.getdescription or opts.getfilename or opts.getformat),
477                 'format': opts.format,
478                 'format_limit': opts.format_limit,
479                 'listformats': opts.listformats,
480                 'outtmpl': ((opts.outtmpl is not None and opts.outtmpl.decode(preferredencoding()))
481                         or (opts.format == '-1' and opts.usetitle and u'%(stitle)s-%(id)s-%(format)s.%(ext)s')
482                         or (opts.format == '-1' and opts.useliteral and u'%(title)s-%(id)s-%(format)s.%(ext)s')
483                         or (opts.format == '-1' and u'%(id)s-%(format)s.%(ext)s')
484                         or (opts.usetitle and opts.autonumber and u'%(autonumber)s-%(stitle)s-%(id)s.%(ext)s')
485                         or (opts.useliteral and opts.autonumber and u'%(autonumber)s-%(title)s-%(id)s.%(ext)s')
486                         or (opts.usetitle and u'%(stitle)s-%(id)s.%(ext)s')
487                         or (opts.useliteral and u'%(title)s-%(id)s.%(ext)s')
488                         or (opts.autonumber and u'%(autonumber)s-%(id)s.%(ext)s')
489                         or u'%(id)s.%(ext)s'),
490                 'ignoreerrors': opts.ignoreerrors,
491                 'ratelimit': opts.ratelimit,
492                 'nooverwrites': opts.nooverwrites,
493                 'retries': opts.retries,
494                 'continuedl': opts.continue_dl,
495                 'noprogress': opts.noprogress,
496                 'playliststart': opts.playliststart,
497                 'playlistend': opts.playlistend,
498                 'logtostderr': opts.outtmpl == '-',
499                 'consoletitle': opts.consoletitle,
500                 'nopart': opts.nopart,
501                 'updatetime': opts.updatetime,
502                 'writedescription': opts.writedescription,
503                 'writeinfojson': opts.writeinfojson,
504                 'writesubtitles': opts.writesubtitles,
505                 'subtitleslang': opts.subtitleslang,
506                 'matchtitle': opts.matchtitle,
507                 'rejecttitle': opts.rejecttitle,
508                 'max_downloads': opts.max_downloads,
509                 'prefer_free_formats': opts.prefer_free_formats,
510                 'verbose': opts.verbose,
511                 })
512
513         if opts.verbose:
514                 fd.to_screen(u'[debug] Proxy map: ' + str(proxy_handler.proxies))
515
516         for extractor in extractors:
517                 fd.add_info_extractor(extractor)
518
519         # PostProcessors
520         if opts.extractaudio:
521                 fd.add_post_processor(FFmpegExtractAudioPP(preferredcodec=opts.audioformat, preferredquality=opts.audioquality, keepvideo=opts.keepvideo))
522
523         # Update version
524         if opts.update_self:
525                 updateSelf(fd, sys.argv[0])
526
527         # Maybe do nothing
528         if len(all_urls) < 1:
529                 if not opts.update_self:
530                         parser.error(u'you must provide at least one URL')
531                 else:
532                         sys.exit()
533         
534         try:
535                 retcode = fd.download(all_urls)
536         except MaxDownloadsReached:
537                 fd.to_screen(u'--max-download limit reached, aborting.')
538                 retcode = 101
539
540         # Dump cookie jar if requested
541         if opts.cookiefile is not None:
542                 try:
543                         jar.save()
544                 except (IOError, OSError), err:
545                         sys.exit(u'ERROR: unable to save cookie jar')
546
547         sys.exit(retcode)
548
549 def main():
550         try:
551                 _real_main()
552         except DownloadError:
553                 sys.exit(1)
554         except SameFileError:
555                 sys.exit(u'ERROR: fixed output name but more than one file to download')
556         except KeyboardInterrupt:
557                 sys.exit(u'\nERROR: Interrupted by user')