Add some parentheses around print for #180
[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.11.17'
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                         b.write("""
83 echo Updating youtube-dl...
84 ping 127.0.0.1 -n 5 -w 1000 > NUL
85 move /Y "%s.new" "%s"
86 del "%s"
87                         \n""" %(exe, exe, bat))
88                         b.close()
89
90                         os.startfile(bat)
91                 except (IOError, OSError), err:
92                         sys.exit('ERROR: unable to overwrite current version')
93
94         else:
95                 try:
96                         urlh = urllib2.urlopen(UPDATE_URL)
97                         newcontent = urlh.read()
98                         urlh.close()
99                 except (IOError, OSError), err:
100                         sys.exit('ERROR: unable to download latest version')
101
102                 try:
103                         with open(filename, 'wb') as outf:
104                                 outf.write(newcontent)
105                 except (IOError, OSError), err:
106                         sys.exit('ERROR: unable to overwrite current version')
107
108         downloader.to_screen(u'Updated youtube-dl. Restart youtube-dl to use the new version.')
109
110 def parseOpts():
111         def _readOptions(filename_bytes):
112                 try:
113                         optionf = open(filename_bytes)
114                 except IOError:
115                         return [] # silently skip if file is not present
116                 try:
117                         res = []
118                         for l in optionf:
119                                 res += shlex.split(l, comments=True)
120                 finally:
121                         optionf.close()
122                 return res
123
124         def _format_option_string(option):
125                 ''' ('-o', '--option') -> -o, --format METAVAR'''
126
127                 opts = []
128
129                 if option._short_opts: opts.append(option._short_opts[0])
130                 if option._long_opts: opts.append(option._long_opts[0])
131                 if len(opts) > 1: opts.insert(1, ', ')
132
133                 if option.takes_value(): opts.append(' %s' % option.metavar)
134
135                 return "".join(opts)
136
137         def _find_term_columns():
138                 columns = os.environ.get('COLUMNS', None)
139                 if columns:
140                         return int(columns)
141
142                 try:
143                         sp = subprocess.Popen(['stty', 'size'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
144                         out,err = sp.communicate()
145                         return int(out.split()[1])
146                 except:
147                         pass
148                 return None
149
150         max_width = 80
151         max_help_position = 80
152
153         # No need to wrap help messages if we're on a wide console
154         columns = _find_term_columns()
155         if columns: max_width = columns
156
157         fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position)
158         fmt.format_option_strings = _format_option_string
159
160         kw = {
161                 'version'   : __version__,
162                 'formatter' : fmt,
163                 'usage' : '%prog [options] url [url...]',
164                 'conflict_handler' : 'resolve',
165         }
166
167         parser = optparse.OptionParser(**kw)
168
169         # option groups
170         general        = optparse.OptionGroup(parser, 'General Options')
171         selection      = optparse.OptionGroup(parser, 'Video Selection')
172         authentication = optparse.OptionGroup(parser, 'Authentication Options')
173         video_format   = optparse.OptionGroup(parser, 'Video Format Options')
174         postproc       = optparse.OptionGroup(parser, 'Post-processing Options')
175         filesystem     = optparse.OptionGroup(parser, 'Filesystem Options')
176         verbosity      = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
177
178         general.add_option('-h', '--help',
179                         action='help', help='print this help text and exit')
180         general.add_option('-v', '--version',
181                         action='version', help='print program version and exit')
182         general.add_option('-U', '--update',
183                         action='store_true', dest='update_self', help='update this program to latest version')
184         general.add_option('-i', '--ignore-errors',
185                         action='store_true', dest='ignoreerrors', help='continue on download errors', default=False)
186         general.add_option('-r', '--rate-limit',
187                         dest='ratelimit', metavar='LIMIT', help='download rate limit (e.g. 50k or 44.6m)')
188         general.add_option('-R', '--retries',
189                         dest='retries', metavar='RETRIES', help='number of retries (default is %default)', default=10)
190         general.add_option('--dump-user-agent',
191                         action='store_true', dest='dump_user_agent',
192                         help='display the current browser identification', default=False)
193         general.add_option('--user-agent',
194                         dest='user_agent', help='specify a custom user agent', metavar='UA')
195         general.add_option('--list-extractors',
196                         action='store_true', dest='list_extractors',
197                         help='List all supported extractors and the URLs they would handle', default=False)
198
199         selection.add_option('--playlist-start',
200                         dest='playliststart', metavar='NUMBER', help='playlist video to start at (default is %default)', default=1)
201         selection.add_option('--playlist-end',
202                         dest='playlistend', metavar='NUMBER', help='playlist video to end at (default is last)', default=-1)
203         selection.add_option('--match-title', dest='matchtitle', metavar='REGEX',help='download only matching titles (regex or caseless sub-string)')
204         selection.add_option('--reject-title', dest='rejecttitle', metavar='REGEX',help='skip download for matching titles (regex or caseless sub-string)')
205         selection.add_option('--max-downloads', metavar='NUMBER', dest='max_downloads', help='Abort after downloading NUMBER files', default=None)
206
207         authentication.add_option('-u', '--username',
208                         dest='username', metavar='USERNAME', help='account username')
209         authentication.add_option('-p', '--password',
210                         dest='password', metavar='PASSWORD', help='account password')
211         authentication.add_option('-n', '--netrc',
212                         action='store_true', dest='usenetrc', help='use .netrc authentication data', default=False)
213
214
215         video_format.add_option('-f', '--format',
216                         action='store', dest='format', metavar='FORMAT', help='video format code')
217         video_format.add_option('--all-formats',
218                         action='store_const', dest='format', help='download all available video formats', const='all')
219         video_format.add_option('--prefer-free-formats',
220                         action='store_true', dest='prefer_free_formats', default=False, help='prefer free video formats unless a specific one is requested')
221         video_format.add_option('--max-quality',
222                         action='store', dest='format_limit', metavar='FORMAT', help='highest quality format to download')
223         video_format.add_option('-F', '--list-formats',
224                         action='store_true', dest='listformats', help='list all available formats (currently youtube only)')
225         video_format.add_option('--write-srt',
226                         action='store_true', dest='writesubtitles',
227                         help='write video closed captions to a .srt file (currently youtube only)', default=False)
228         video_format.add_option('--srt-lang',
229                         action='store', dest='subtitleslang', metavar='LANG',
230                         help='language of the closed captions to download (optional) use IETF language tags like \'en\'')
231
232
233         verbosity.add_option('-q', '--quiet',
234                         action='store_true', dest='quiet', help='activates quiet mode', default=False)
235         verbosity.add_option('-s', '--simulate',
236                         action='store_true', dest='simulate', help='do not download the video and do not write anything to disk', default=False)
237         verbosity.add_option('--skip-download',
238                         action='store_true', dest='skip_download', help='do not download the video', default=False)
239         verbosity.add_option('-g', '--get-url',
240                         action='store_true', dest='geturl', help='simulate, quiet but print URL', default=False)
241         verbosity.add_option('-e', '--get-title',
242                         action='store_true', dest='gettitle', help='simulate, quiet but print title', default=False)
243         verbosity.add_option('--get-thumbnail',
244                         action='store_true', dest='getthumbnail',
245                         help='simulate, quiet but print thumbnail URL', default=False)
246         verbosity.add_option('--get-description',
247                         action='store_true', dest='getdescription',
248                         help='simulate, quiet but print video description', default=False)
249         verbosity.add_option('--get-filename',
250                         action='store_true', dest='getfilename',
251                         help='simulate, quiet but print output filename', default=False)
252         verbosity.add_option('--get-format',
253                         action='store_true', dest='getformat',
254                         help='simulate, quiet but print output format', default=False)
255         verbosity.add_option('--no-progress',
256                         action='store_true', dest='noprogress', help='do not print progress bar', default=False)
257         verbosity.add_option('--console-title',
258                         action='store_true', dest='consoletitle',
259                         help='display progress in console titlebar', default=False)
260         verbosity.add_option('-v', '--verbose',
261                         action='store_true', dest='verbose', help='print various debugging information', default=False)
262
263
264         filesystem.add_option('-t', '--title',
265                         action='store_true', dest='usetitle', help='use title in file name', default=False)
266         filesystem.add_option('--id',
267                         action='store_true', dest='useid', help='use video ID in file name', default=False)
268         filesystem.add_option('-l', '--literal',
269                         action='store_true', dest='usetitle', help='[deprecated] alias of --title', 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 %(title)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('-x', '--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.usetitle or opts.autonumber or opts.useid):
428                 parser.error(u'using output template conflicts with using title, video ID or auto number')
429         if opts.usetitle and opts.useid:
430                 parser.error(u'using title conflicts with using video ID')
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'%(title)s-%(id)s-%(format)s.%(ext)s')
482                         or (opts.format == '-1' and u'%(id)s-%(format)s.%(ext)s')
483                         or (opts.usetitle and opts.autonumber and u'%(autonumber)s-%(title)s-%(id)s.%(ext)s')
484                         or (opts.usetitle and u'%(title)s-%(id)s.%(ext)s')
485                         or (opts.useid and u'%(id)s.%(ext)s')
486                         or (opts.autonumber and u'%(autonumber)s-%(id)s.%(ext)s')
487                         or u'%(id)s.%(ext)s'),
488                 'ignoreerrors': opts.ignoreerrors,
489                 'ratelimit': opts.ratelimit,
490                 'nooverwrites': opts.nooverwrites,
491                 'retries': opts.retries,
492                 'continuedl': opts.continue_dl,
493                 'noprogress': opts.noprogress,
494                 'playliststart': opts.playliststart,
495                 'playlistend': opts.playlistend,
496                 'logtostderr': opts.outtmpl == '-',
497                 'consoletitle': opts.consoletitle,
498                 'nopart': opts.nopart,
499                 'updatetime': opts.updatetime,
500                 'writedescription': opts.writedescription,
501                 'writeinfojson': opts.writeinfojson,
502                 'writesubtitles': opts.writesubtitles,
503                 'subtitleslang': opts.subtitleslang,
504                 'matchtitle': opts.matchtitle,
505                 'rejecttitle': opts.rejecttitle,
506                 'max_downloads': opts.max_downloads,
507                 'prefer_free_formats': opts.prefer_free_formats,
508                 'verbose': opts.verbose,
509                 })
510
511         if opts.verbose:
512                 fd.to_screen(u'[debug] Proxy map: ' + str(proxy_handler.proxies))
513
514         for extractor in extractors:
515                 fd.add_info_extractor(extractor)
516
517         # PostProcessors
518         if opts.extractaudio:
519                 fd.add_post_processor(FFmpegExtractAudioPP(preferredcodec=opts.audioformat, preferredquality=opts.audioquality, keepvideo=opts.keepvideo))
520
521         # Update version
522         if opts.update_self:
523                 updateSelf(fd, sys.argv[0])
524
525         # Maybe do nothing
526         if len(all_urls) < 1:
527                 if not opts.update_self:
528                         parser.error(u'you must provide at least one URL')
529                 else:
530                         sys.exit()
531         
532         try:
533                 retcode = fd.download(all_urls)
534         except MaxDownloadsReached:
535                 fd.to_screen(u'--max-download limit reached, aborting.')
536                 retcode = 101
537
538         # Dump cookie jar if requested
539         if opts.cookiefile is not None:
540                 try:
541                         jar.save()
542                 except (IOError, OSError), err:
543                         sys.exit(u'ERROR: unable to save cookie jar')
544
545         sys.exit(retcode)
546
547 def main():
548         try:
549                 _real_main()
550         except DownloadError:
551                 sys.exit(1)
552         except SameFileError:
553                 sys.exit(u'ERROR: fixed output name but more than one file to download')
554         except KeyboardInterrupt:
555                 sys.exit(u'\nERROR: Interrupted by user')