FileDownloader.py 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840
  1. #!/usr/bin/env python
  2. # -*- coding: utf-8 -*-
  3. from __future__ import absolute_import
  4. import math
  5. import io
  6. import os
  7. import re
  8. import socket
  9. import subprocess
  10. import sys
  11. import time
  12. import traceback
  13. if os.name == 'nt':
  14. import ctypes
  15. from .utils import *
  16. class FileDownloader(object):
  17. """File Downloader class.
  18. File downloader objects are the ones responsible of downloading the
  19. actual video file and writing it to disk if the user has requested
  20. it, among some other tasks. In most cases there should be one per
  21. program. As, given a video URL, the downloader doesn't know how to
  22. extract all the needed information, task that InfoExtractors do, it
  23. has to pass the URL to one of them.
  24. For this, file downloader objects have a method that allows
  25. InfoExtractors to be registered in a given order. When it is passed
  26. a URL, the file downloader handles it to the first InfoExtractor it
  27. finds that reports being able to handle it. The InfoExtractor extracts
  28. all the information about the video or videos the URL refers to, and
  29. asks the FileDownloader to process the video information, possibly
  30. downloading the video.
  31. File downloaders accept a lot of parameters. In order not to saturate
  32. the object constructor with arguments, it receives a dictionary of
  33. options instead. These options are available through the params
  34. attribute for the InfoExtractors to use. The FileDownloader also
  35. registers itself as the downloader in charge for the InfoExtractors
  36. that are added to it, so this is a "mutual registration".
  37. Available options:
  38. username: Username for authentication purposes.
  39. password: Password for authentication purposes.
  40. usenetrc: Use netrc for authentication instead.
  41. quiet: Do not print messages to stdout.
  42. forceurl: Force printing final URL.
  43. forcetitle: Force printing title.
  44. forcethumbnail: Force printing thumbnail URL.
  45. forcedescription: Force printing description.
  46. forcefilename: Force printing final filename.
  47. simulate: Do not download the video files.
  48. format: Video format code.
  49. format_limit: Highest quality format to try.
  50. outtmpl: Template for output names.
  51. restrictfilenames: Do not allow "&" and spaces in file names
  52. ignoreerrors: Do not stop on download errors.
  53. ratelimit: Download speed limit, in bytes/sec.
  54. nooverwrites: Prevent overwriting files.
  55. retries: Number of times to retry for HTTP error 5xx
  56. buffersize: Size of download buffer in bytes.
  57. noresizebuffer: Do not automatically resize the download buffer.
  58. continuedl: Try to continue downloads if possible.
  59. noprogress: Do not print the progress bar.
  60. playliststart: Playlist item to start at.
  61. playlistend: Playlist item to end at.
  62. matchtitle: Download only matching titles.
  63. rejecttitle: Reject downloads for matching titles.
  64. logtostderr: Log messages to stderr instead of stdout.
  65. consoletitle: Display progress in console window's titlebar.
  66. nopart: Do not use temporary .part files.
  67. updatetime: Use the Last-modified header to set output file timestamps.
  68. writedescription: Write the video description to a .description file
  69. writeinfojson: Write the video description to a .info.json file
  70. writesubtitles: Write the video subtitles to a .srt file
  71. onlysubtitles: Downloads only the subtitles of the video
  72. allsubtitles: Downloads all the subtitles of the video
  73. subtitleslang: Language of the subtitles to download
  74. test: Download only first bytes to test the downloader.
  75. keepvideo: Keep the video file after post-processing
  76. min_filesize: Skip files smaller than this size
  77. max_filesize: Skip files larger than this size
  78. """
  79. params = None
  80. _ies = []
  81. _pps = []
  82. _download_retcode = None
  83. _num_downloads = None
  84. _screen_file = None
  85. def __init__(self, params):
  86. """Create a FileDownloader object with the given options."""
  87. self._ies = []
  88. self._pps = []
  89. self._progress_hooks = []
  90. self._download_retcode = 0
  91. self._num_downloads = 0
  92. self._screen_file = [sys.stdout, sys.stderr][params.get('logtostderr', False)]
  93. self.params = params
  94. if '%(stitle)s' in self.params['outtmpl']:
  95. self.to_stderr(u'WARNING: %(stitle)s is deprecated. Use the %(title)s and the --restrict-filenames flag(which also secures %(uploader)s et al) instead.')
  96. @staticmethod
  97. def format_bytes(bytes):
  98. if bytes is None:
  99. return 'N/A'
  100. if type(bytes) is str:
  101. bytes = float(bytes)
  102. if bytes == 0.0:
  103. exponent = 0
  104. else:
  105. exponent = int(math.log(bytes, 1024.0))
  106. suffix = 'bkMGTPEZY'[exponent]
  107. converted = float(bytes) / float(1024 ** exponent)
  108. return '%.2f%s' % (converted, suffix)
  109. @staticmethod
  110. def calc_percent(byte_counter, data_len):
  111. if data_len is None:
  112. return '---.-%'
  113. return '%6s' % ('%3.1f%%' % (float(byte_counter) / float(data_len) * 100.0))
  114. @staticmethod
  115. def calc_eta(start, now, total, current):
  116. if total is None:
  117. return '--:--'
  118. dif = now - start
  119. if current == 0 or dif < 0.001: # One millisecond
  120. return '--:--'
  121. rate = float(current) / dif
  122. eta = int((float(total) - float(current)) / rate)
  123. (eta_mins, eta_secs) = divmod(eta, 60)
  124. if eta_mins > 99:
  125. return '--:--'
  126. return '%02d:%02d' % (eta_mins, eta_secs)
  127. @staticmethod
  128. def calc_speed(start, now, bytes):
  129. dif = now - start
  130. if bytes == 0 or dif < 0.001: # One millisecond
  131. return '%10s' % '---b/s'
  132. return '%10s' % ('%s/s' % FileDownloader.format_bytes(float(bytes) / dif))
  133. @staticmethod
  134. def best_block_size(elapsed_time, bytes):
  135. new_min = max(bytes / 2.0, 1.0)
  136. new_max = min(max(bytes * 2.0, 1.0), 4194304) # Do not surpass 4 MB
  137. if elapsed_time < 0.001:
  138. return int(new_max)
  139. rate = bytes / elapsed_time
  140. if rate > new_max:
  141. return int(new_max)
  142. if rate < new_min:
  143. return int(new_min)
  144. return int(rate)
  145. @staticmethod
  146. def parse_bytes(bytestr):
  147. """Parse a string indicating a byte quantity into an integer."""
  148. matchobj = re.match(r'(?i)^(\d+(?:\.\d+)?)([kMGTPEZY]?)$', bytestr)
  149. if matchobj is None:
  150. return None
  151. number = float(matchobj.group(1))
  152. multiplier = 1024.0 ** 'bkmgtpezy'.index(matchobj.group(2).lower())
  153. return int(round(number * multiplier))
  154. def add_info_extractor(self, ie):
  155. """Add an InfoExtractor object to the end of the list."""
  156. self._ies.append(ie)
  157. ie.set_downloader(self)
  158. def add_post_processor(self, pp):
  159. """Add a PostProcessor object to the end of the chain."""
  160. self._pps.append(pp)
  161. pp.set_downloader(self)
  162. def to_screen(self, message, skip_eol=False):
  163. """Print message to stdout if not in quiet mode."""
  164. assert type(message) == type(u'')
  165. if not self.params.get('quiet', False):
  166. terminator = [u'\n', u''][skip_eol]
  167. output = message + terminator
  168. if 'b' in getattr(self._screen_file, 'mode', '') or sys.version_info[0] < 3: # Python 2 lies about the mode of sys.stdout/sys.stderr
  169. output = output.encode(preferredencoding(), 'ignore')
  170. self._screen_file.write(output)
  171. self._screen_file.flush()
  172. def to_stderr(self, message):
  173. """Print message to stderr."""
  174. assert type(message) == type(u'')
  175. output = message + u'\n'
  176. if 'b' in getattr(self._screen_file, 'mode', '') or sys.version_info[0] < 3: # Python 2 lies about the mode of sys.stdout/sys.stderr
  177. output = output.encode(preferredencoding())
  178. sys.stderr.write(output)
  179. def to_cons_title(self, message):
  180. """Set console/terminal window title to message."""
  181. if not self.params.get('consoletitle', False):
  182. return
  183. if os.name == 'nt' and ctypes.windll.kernel32.GetConsoleWindow():
  184. # c_wchar_p() might not be necessary if `message` is
  185. # already of type unicode()
  186. ctypes.windll.kernel32.SetConsoleTitleW(ctypes.c_wchar_p(message))
  187. elif 'TERM' in os.environ:
  188. self.to_screen('\033]0;%s\007' % message, skip_eol=True)
  189. def fixed_template(self):
  190. """Checks if the output template is fixed."""
  191. return (re.search(u'(?u)%\\(.+?\\)s', self.params['outtmpl']) is None)
  192. def trouble(self, message=None, tb=None):
  193. """Determine action to take when a download problem appears.
  194. Depending on if the downloader has been configured to ignore
  195. download errors or not, this method may throw an exception or
  196. not when errors are found, after printing the message.
  197. tb, if given, is additional traceback information.
  198. """
  199. if message is not None:
  200. self.to_stderr(message)
  201. if self.params.get('verbose'):
  202. if tb is None:
  203. tb_data = traceback.format_list(traceback.extract_stack())
  204. tb = u''.join(tb_data)
  205. self.to_stderr(tb)
  206. if not self.params.get('ignoreerrors', False):
  207. raise DownloadError(message)
  208. self._download_retcode = 1
  209. def slow_down(self, start_time, byte_counter):
  210. """Sleep if the download speed is over the rate limit."""
  211. rate_limit = self.params.get('ratelimit', None)
  212. if rate_limit is None or byte_counter == 0:
  213. return
  214. now = time.time()
  215. elapsed = now - start_time
  216. if elapsed <= 0.0:
  217. return
  218. speed = float(byte_counter) / elapsed
  219. if speed > rate_limit:
  220. time.sleep((byte_counter - rate_limit * (now - start_time)) / rate_limit)
  221. def temp_name(self, filename):
  222. """Returns a temporary filename for the given filename."""
  223. if self.params.get('nopart', False) or filename == u'-' or \
  224. (os.path.exists(encodeFilename(filename)) and not os.path.isfile(encodeFilename(filename))):
  225. return filename
  226. return filename + u'.part'
  227. def undo_temp_name(self, filename):
  228. if filename.endswith(u'.part'):
  229. return filename[:-len(u'.part')]
  230. return filename
  231. def try_rename(self, old_filename, new_filename):
  232. try:
  233. if old_filename == new_filename:
  234. return
  235. os.rename(encodeFilename(old_filename), encodeFilename(new_filename))
  236. except (IOError, OSError) as err:
  237. self.trouble(u'ERROR: unable to rename file')
  238. def try_utime(self, filename, last_modified_hdr):
  239. """Try to set the last-modified time of the given file."""
  240. if last_modified_hdr is None:
  241. return
  242. if not os.path.isfile(encodeFilename(filename)):
  243. return
  244. timestr = last_modified_hdr
  245. if timestr is None:
  246. return
  247. filetime = timeconvert(timestr)
  248. if filetime is None:
  249. return filetime
  250. try:
  251. os.utime(filename, (time.time(), filetime))
  252. except:
  253. pass
  254. return filetime
  255. def report_writedescription(self, descfn):
  256. """ Report that the description file is being written """
  257. self.to_screen(u'[info] Writing video description to: ' + descfn)
  258. def report_writesubtitles(self, srtfn):
  259. """ Report that the subtitles file is being written """
  260. self.to_screen(u'[info] Writing video subtitles to: ' + srtfn)
  261. def report_writeinfojson(self, infofn):
  262. """ Report that the metadata file has been written """
  263. self.to_screen(u'[info] Video description metadata as JSON to: ' + infofn)
  264. def report_destination(self, filename):
  265. """Report destination filename."""
  266. self.to_screen(u'[download] Destination: ' + filename)
  267. def report_progress(self, percent_str, data_len_str, speed_str, eta_str):
  268. """Report download progress."""
  269. if self.params.get('noprogress', False):
  270. return
  271. if self.params.get('progress_with_newline', False):
  272. self.to_screen(u'[download] %s of %s at %s ETA %s' %
  273. (percent_str, data_len_str, speed_str, eta_str))
  274. else:
  275. self.to_screen(u'\r[download] %s of %s at %s ETA %s' %
  276. (percent_str, data_len_str, speed_str, eta_str), skip_eol=True)
  277. self.to_cons_title(u'youtube-dl - %s of %s at %s ETA %s' %
  278. (percent_str.strip(), data_len_str.strip(), speed_str.strip(), eta_str.strip()))
  279. def report_resuming_byte(self, resume_len):
  280. """Report attempt to resume at given byte."""
  281. self.to_screen(u'[download] Resuming download at byte %s' % resume_len)
  282. def report_retry(self, count, retries):
  283. """Report retry in case of HTTP error 5xx"""
  284. self.to_screen(u'[download] Got server HTTP error. Retrying (attempt %d of %d)...' % (count, retries))
  285. def report_file_already_downloaded(self, file_name):
  286. """Report file has already been fully downloaded."""
  287. try:
  288. self.to_screen(u'[download] %s has already been downloaded' % file_name)
  289. except (UnicodeEncodeError) as err:
  290. self.to_screen(u'[download] The file has already been downloaded')
  291. def report_unable_to_resume(self):
  292. """Report it was impossible to resume download."""
  293. self.to_screen(u'[download] Unable to resume')
  294. def report_finish(self):
  295. """Report download finished."""
  296. if self.params.get('noprogress', False):
  297. self.to_screen(u'[download] Download completed')
  298. else:
  299. self.to_screen(u'')
  300. def increment_downloads(self):
  301. """Increment the ordinal that assigns a number to each file."""
  302. self._num_downloads += 1
  303. def prepare_filename(self, info_dict):
  304. """Generate the output filename."""
  305. try:
  306. template_dict = dict(info_dict)
  307. template_dict['epoch'] = int(time.time())
  308. template_dict['autonumber'] = u'%05d' % self._num_downloads
  309. sanitize = lambda k,v: sanitize_filename(
  310. u'NA' if v is None else compat_str(v),
  311. restricted=self.params.get('restrictfilenames'),
  312. is_id=(k==u'id'))
  313. template_dict = dict((k, sanitize(k, v)) for k,v in template_dict.items())
  314. filename = self.params['outtmpl'] % template_dict
  315. return filename
  316. except (ValueError, KeyError) as err:
  317. self.trouble(u'ERROR: invalid system charset or erroneous output template')
  318. return None
  319. def _match_entry(self, info_dict):
  320. """ Returns None iff the file should be downloaded """
  321. title = info_dict['title']
  322. matchtitle = self.params.get('matchtitle', False)
  323. if matchtitle:
  324. if not re.search(matchtitle, title, re.IGNORECASE):
  325. return u'[download] "' + title + '" title did not match pattern "' + matchtitle + '"'
  326. rejecttitle = self.params.get('rejecttitle', False)
  327. if rejecttitle:
  328. if re.search(rejecttitle, title, re.IGNORECASE):
  329. return u'"' + title + '" title matched reject pattern "' + rejecttitle + '"'
  330. return None
  331. def process_info(self, info_dict):
  332. """Process a single dictionary returned by an InfoExtractor."""
  333. # Keep for backwards compatibility
  334. info_dict['stitle'] = info_dict['title']
  335. if not 'format' in info_dict:
  336. info_dict['format'] = info_dict['ext']
  337. reason = self._match_entry(info_dict)
  338. if reason is not None:
  339. self.to_screen(u'[download] ' + reason)
  340. return
  341. max_downloads = self.params.get('max_downloads')
  342. if max_downloads is not None:
  343. if self._num_downloads > int(max_downloads):
  344. raise MaxDownloadsReached()
  345. filename = self.prepare_filename(info_dict)
  346. # Forced printings
  347. if self.params.get('forcetitle', False):
  348. compat_print(info_dict['title'])
  349. if self.params.get('forceurl', False):
  350. compat_print(info_dict['url'])
  351. if self.params.get('forcethumbnail', False) and 'thumbnail' in info_dict:
  352. compat_print(info_dict['thumbnail'])
  353. if self.params.get('forcedescription', False) and 'description' in info_dict:
  354. compat_print(info_dict['description'])
  355. if self.params.get('forcefilename', False) and filename is not None:
  356. compat_print(filename)
  357. if self.params.get('forceformat', False):
  358. compat_print(info_dict['format'])
  359. # Do nothing else if in simulate mode
  360. if self.params.get('simulate', False):
  361. return
  362. if filename is None:
  363. return
  364. try:
  365. dn = os.path.dirname(encodeFilename(filename))
  366. if dn != '' and not os.path.exists(dn): # dn is already encoded
  367. os.makedirs(dn)
  368. except (OSError, IOError) as err:
  369. self.trouble(u'ERROR: unable to create directory ' + compat_str(err))
  370. return
  371. if self.params.get('writedescription', False):
  372. try:
  373. descfn = filename + u'.description'
  374. self.report_writedescription(descfn)
  375. with io.open(encodeFilename(descfn), 'w', encoding='utf-8') as descfile:
  376. descfile.write(info_dict['description'])
  377. except (OSError, IOError):
  378. self.trouble(u'ERROR: Cannot write description file ' + descfn)
  379. return
  380. if self.params.get('writesubtitles', False) and 'subtitles' in info_dict and info_dict['subtitles']:
  381. # subtitles download errors are already managed as troubles in relevant IE
  382. # that way it will silently go on when used with unsupporting IE
  383. subtitle = info_dict['subtitles'][0]
  384. (srt_error, srt_lang, srt) = subtitle
  385. try:
  386. srtfn = filename.rsplit('.', 1)[0] + u'.' + srt_lang + u'.srt'
  387. self.report_writesubtitles(srtfn)
  388. with io.open(encodeFilename(srtfn), 'w', encoding='utf-8') as srtfile:
  389. srtfile.write(srt)
  390. except (OSError, IOError):
  391. self.trouble(u'ERROR: Cannot write subtitles file ' + descfn)
  392. return
  393. if self.params.get('onlysubtitles', False):
  394. return
  395. if self.params.get('allsubtitles', False) and 'subtitles' in info_dict and info_dict['subtitles']:
  396. subtitles = info_dict['subtitles']
  397. for subtitle in subtitles:
  398. (srt_error, srt_lang, srt) = subtitle
  399. try:
  400. srtfn = filename.rsplit('.', 1)[0] + u'.' + srt_lang + u'.srt'
  401. self.report_writesubtitles(srtfn)
  402. with io.open(encodeFilename(srtfn), 'w', encoding='utf-8') as srtfile:
  403. srtfile.write(srt)
  404. except (OSError, IOError):
  405. self.trouble(u'ERROR: Cannot write subtitles file ' + descfn)
  406. return
  407. if self.params.get('onlysubtitles', False):
  408. return
  409. if self.params.get('writeinfojson', False):
  410. infofn = filename + u'.info.json'
  411. self.report_writeinfojson(infofn)
  412. try:
  413. json_info_dict = dict((k, v) for k,v in info_dict.items() if not k in ['urlhandle'])
  414. write_json_file(json_info_dict, encodeFilename(infofn))
  415. except (OSError, IOError):
  416. self.trouble(u'ERROR: Cannot write metadata to JSON file ' + infofn)
  417. return
  418. if not self.params.get('skip_download', False):
  419. if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(filename)):
  420. success = True
  421. else:
  422. try:
  423. success = self._do_download(filename, info_dict)
  424. except (OSError, IOError) as err:
  425. raise UnavailableVideoError()
  426. except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
  427. self.trouble(u'ERROR: unable to download video data: %s' % str(err))
  428. return
  429. except (ContentTooShortError, ) as err:
  430. self.trouble(u'ERROR: content too short (expected %s bytes and served %s)' % (err.expected, err.downloaded))
  431. return
  432. if success:
  433. try:
  434. self.post_process(filename, info_dict)
  435. except (PostProcessingError) as err:
  436. self.trouble(u'ERROR: postprocessing: %s' % str(err))
  437. return
  438. def download(self, url_list):
  439. """Download a given list of URLs."""
  440. if len(url_list) > 1 and self.fixed_template():
  441. raise SameFileError(self.params['outtmpl'])
  442. for url in url_list:
  443. suitable_found = False
  444. for ie in self._ies:
  445. # Go to next InfoExtractor if not suitable
  446. if not ie.suitable(url):
  447. continue
  448. # Warn if the _WORKING attribute is False
  449. if not ie.working():
  450. self.to_stderr(u'WARNING: the program functionality for this site has been marked as broken, '
  451. u'and will probably not work. If you want to go on, use the -i option.')
  452. # Suitable InfoExtractor found
  453. suitable_found = True
  454. # Extract information from URL and process it
  455. try:
  456. videos = ie.extract(url)
  457. except ExtractorError as de: # An error we somewhat expected
  458. self.trouble(u'ERROR: ' + compat_str(de), de.format_traceback())
  459. break
  460. except Exception as e:
  461. if self.params.get('ignoreerrors', False):
  462. self.trouble(u'ERROR: ' + compat_str(e), tb=compat_str(traceback.format_exc()))
  463. break
  464. else:
  465. raise
  466. if len(videos or []) > 1 and self.fixed_template():
  467. raise SameFileError(self.params['outtmpl'])
  468. for video in videos or []:
  469. video['extractor'] = ie.IE_NAME
  470. try:
  471. self.increment_downloads()
  472. self.process_info(video)
  473. except UnavailableVideoError:
  474. self.trouble(u'\nERROR: unable to download video')
  475. # Suitable InfoExtractor had been found; go to next URL
  476. break
  477. if not suitable_found:
  478. self.trouble(u'ERROR: no suitable InfoExtractor: %s' % url)
  479. return self._download_retcode
  480. def post_process(self, filename, ie_info):
  481. """Run all the postprocessors on the given file."""
  482. info = dict(ie_info)
  483. info['filepath'] = filename
  484. keep_video = None
  485. for pp in self._pps:
  486. try:
  487. keep_video_wish,new_info = pp.run(info)
  488. if keep_video_wish is not None:
  489. if keep_video_wish:
  490. keep_video = keep_video_wish
  491. elif keep_video is None:
  492. # No clear decision yet, let IE decide
  493. keep_video = keep_video_wish
  494. except PostProcessingError as e:
  495. self.to_stderr(u'ERROR: ' + e.msg)
  496. if keep_video is False and not self.params.get('keepvideo', False):
  497. try:
  498. self.to_stderr(u'Deleting original file %s (pass -k to keep)' % filename)
  499. os.remove(encodeFilename(filename))
  500. except (IOError, OSError):
  501. self.to_stderr(u'WARNING: Unable to remove downloaded video file')
  502. def _download_with_rtmpdump(self, filename, url, player_url, page_url):
  503. self.report_destination(filename)
  504. tmpfilename = self.temp_name(filename)
  505. # Check for rtmpdump first
  506. try:
  507. subprocess.call(['rtmpdump', '-h'], stdout=(file(os.path.devnull, 'w')), stderr=subprocess.STDOUT)
  508. except (OSError, IOError):
  509. self.trouble(u'ERROR: RTMP download detected but "rtmpdump" could not be run')
  510. return False
  511. # Download using rtmpdump. rtmpdump returns exit code 2 when
  512. # the connection was interrumpted and resuming appears to be
  513. # possible. This is part of rtmpdump's normal usage, AFAIK.
  514. basic_args = ['rtmpdump', '-q', '-r', url, '-o', tmpfilename]
  515. if player_url is not None:
  516. basic_args += ['-W', player_url]
  517. if page_url is not None:
  518. basic_args += ['--pageUrl', page_url]
  519. args = basic_args + [[], ['-e', '-k', '1']][self.params.get('continuedl', False)]
  520. if self.params.get('verbose', False):
  521. try:
  522. import pipes
  523. shell_quote = lambda args: ' '.join(map(pipes.quote, args))
  524. except ImportError:
  525. shell_quote = repr
  526. self.to_screen(u'[debug] rtmpdump command line: ' + shell_quote(args))
  527. retval = subprocess.call(args)
  528. while retval == 2 or retval == 1:
  529. prevsize = os.path.getsize(encodeFilename(tmpfilename))
  530. self.to_screen(u'\r[rtmpdump] %s bytes' % prevsize, skip_eol=True)
  531. time.sleep(5.0) # This seems to be needed
  532. retval = subprocess.call(basic_args + ['-e'] + [[], ['-k', '1']][retval == 1])
  533. cursize = os.path.getsize(encodeFilename(tmpfilename))
  534. if prevsize == cursize and retval == 1:
  535. break
  536. # Some rtmp streams seem abort after ~ 99.8%. Don't complain for those
  537. if prevsize == cursize and retval == 2 and cursize > 1024:
  538. self.to_screen(u'\r[rtmpdump] Could not download the whole video. This can happen for some advertisements.')
  539. retval = 0
  540. break
  541. if retval == 0:
  542. fsize = os.path.getsize(encodeFilename(tmpfilename))
  543. self.to_screen(u'\r[rtmpdump] %s bytes' % fsize)
  544. self.try_rename(tmpfilename, filename)
  545. self._hook_progress({
  546. 'downloaded_bytes': fsize,
  547. 'total_bytes': fsize,
  548. 'filename': filename,
  549. 'status': 'finished',
  550. })
  551. return True
  552. else:
  553. self.trouble(u'\nERROR: rtmpdump exited with code %d' % retval)
  554. return False
  555. def _do_download(self, filename, info_dict):
  556. url = info_dict['url']
  557. # Check file already present
  558. if self.params.get('continuedl', False) and os.path.isfile(encodeFilename(filename)) and not self.params.get('nopart', False):
  559. self.report_file_already_downloaded(filename)
  560. self._hook_progress({
  561. 'filename': filename,
  562. 'status': 'finished',
  563. })
  564. return True
  565. # Attempt to download using rtmpdump
  566. if url.startswith('rtmp'):
  567. return self._download_with_rtmpdump(filename, url,
  568. info_dict.get('player_url', None),
  569. info_dict.get('page_url', None))
  570. tmpfilename = self.temp_name(filename)
  571. stream = None
  572. # Do not include the Accept-Encoding header
  573. headers = {'Youtubedl-no-compression': 'True'}
  574. if 'user_agent' in info_dict:
  575. headers['Youtubedl-user-agent'] = info_dict['user_agent']
  576. basic_request = compat_urllib_request.Request(url, None, headers)
  577. request = compat_urllib_request.Request(url, None, headers)
  578. if self.params.get('test', False):
  579. request.add_header('Range','bytes=0-10240')
  580. # Establish possible resume length
  581. if os.path.isfile(encodeFilename(tmpfilename)):
  582. resume_len = os.path.getsize(encodeFilename(tmpfilename))
  583. else:
  584. resume_len = 0
  585. open_mode = 'wb'
  586. if resume_len != 0:
  587. if self.params.get('continuedl', False):
  588. self.report_resuming_byte(resume_len)
  589. request.add_header('Range','bytes=%d-' % resume_len)
  590. open_mode = 'ab'
  591. else:
  592. resume_len = 0
  593. count = 0
  594. retries = self.params.get('retries', 0)
  595. while count <= retries:
  596. # Establish connection
  597. try:
  598. if count == 0 and 'urlhandle' in info_dict:
  599. data = info_dict['urlhandle']
  600. data = compat_urllib_request.urlopen(request)
  601. break
  602. except (compat_urllib_error.HTTPError, ) as err:
  603. if (err.code < 500 or err.code >= 600) and err.code != 416:
  604. # Unexpected HTTP error
  605. raise
  606. elif err.code == 416:
  607. # Unable to resume (requested range not satisfiable)
  608. try:
  609. # Open the connection again without the range header
  610. data = compat_urllib_request.urlopen(basic_request)
  611. content_length = data.info()['Content-Length']
  612. except (compat_urllib_error.HTTPError, ) as err:
  613. if err.code < 500 or err.code >= 600:
  614. raise
  615. else:
  616. # Examine the reported length
  617. if (content_length is not None and
  618. (resume_len - 100 < int(content_length) < resume_len + 100)):
  619. # The file had already been fully downloaded.
  620. # Explanation to the above condition: in issue #175 it was revealed that
  621. # YouTube sometimes adds or removes a few bytes from the end of the file,
  622. # changing the file size slightly and causing problems for some users. So
  623. # I decided to implement a suggested change and consider the file
  624. # completely downloaded if the file size differs less than 100 bytes from
  625. # the one in the hard drive.
  626. self.report_file_already_downloaded(filename)
  627. self.try_rename(tmpfilename, filename)
  628. self._hook_progress({
  629. 'filename': filename,
  630. 'status': 'finished',
  631. })
  632. return True
  633. else:
  634. # The length does not match, we start the download over
  635. self.report_unable_to_resume()
  636. open_mode = 'wb'
  637. break
  638. # Retry
  639. count += 1
  640. if count <= retries:
  641. self.report_retry(count, retries)
  642. if count > retries:
  643. self.trouble(u'ERROR: giving up after %s retries' % retries)
  644. return False
  645. data_len = data.info().get('Content-length', None)
  646. if data_len is not None:
  647. data_len = int(data_len) + resume_len
  648. min_data_len = self.params.get("min_filesize", None)
  649. max_data_len = self.params.get("max_filesize", None)
  650. if min_data_len is not None and data_len < min_data_len:
  651. self.to_screen(u'\r[download] File is smaller than min-filesize (%s bytes < %s bytes). Aborting.' % (data_len, min_data_len))
  652. return False
  653. if max_data_len is not None and data_len > max_data_len:
  654. self.to_screen(u'\r[download] File is larger than max-filesize (%s bytes > %s bytes). Aborting.' % (data_len, max_data_len))
  655. return False
  656. data_len_str = self.format_bytes(data_len)
  657. byte_counter = 0 + resume_len
  658. block_size = self.params.get('buffersize', 1024)
  659. start = time.time()
  660. while True:
  661. # Download and write
  662. before = time.time()
  663. data_block = data.read(block_size)
  664. after = time.time()
  665. if len(data_block) == 0:
  666. break
  667. byte_counter += len(data_block)
  668. # Open file just in time
  669. if stream is None:
  670. try:
  671. (stream, tmpfilename) = sanitize_open(tmpfilename, open_mode)
  672. assert stream is not None
  673. filename = self.undo_temp_name(tmpfilename)
  674. self.report_destination(filename)
  675. except (OSError, IOError) as err:
  676. self.trouble(u'ERROR: unable to open for writing: %s' % str(err))
  677. return False
  678. try:
  679. stream.write(data_block)
  680. except (IOError, OSError) as err:
  681. self.trouble(u'\nERROR: unable to write data: %s' % str(err))
  682. return False
  683. if not self.params.get('noresizebuffer', False):
  684. block_size = self.best_block_size(after - before, len(data_block))
  685. # Progress message
  686. speed_str = self.calc_speed(start, time.time(), byte_counter - resume_len)
  687. if data_len is None:
  688. self.report_progress('Unknown %', data_len_str, speed_str, 'Unknown ETA')
  689. else:
  690. percent_str = self.calc_percent(byte_counter, data_len)
  691. eta_str = self.calc_eta(start, time.time(), data_len - resume_len, byte_counter - resume_len)
  692. self.report_progress(percent_str, data_len_str, speed_str, eta_str)
  693. self._hook_progress({
  694. 'downloaded_bytes': byte_counter,
  695. 'total_bytes': data_len,
  696. 'tmpfilename': tmpfilename,
  697. 'filename': filename,
  698. 'status': 'downloading',
  699. })
  700. # Apply rate limit
  701. self.slow_down(start, byte_counter - resume_len)
  702. if stream is None:
  703. self.trouble(u'\nERROR: Did not get any data blocks')
  704. return False
  705. stream.close()
  706. self.report_finish()
  707. if data_len is not None and byte_counter != data_len:
  708. raise ContentTooShortError(byte_counter, int(data_len))
  709. self.try_rename(tmpfilename, filename)
  710. # Update file modification time
  711. if self.params.get('updatetime', True):
  712. info_dict['filetime'] = self.try_utime(filename, data.info().get('last-modified', None))
  713. self._hook_progress({
  714. 'downloaded_bytes': byte_counter,
  715. 'total_bytes': byte_counter,
  716. 'filename': filename,
  717. 'status': 'finished',
  718. })
  719. return True
  720. def _hook_progress(self, status):
  721. for ph in self._progress_hooks:
  722. ph(status)
  723. def add_progress_hook(self, ph):
  724. """ ph gets called on download progress, with a dictionary with the entries
  725. * filename: The final filename
  726. * status: One of "downloading" and "finished"
  727. It can also have some of the following entries:
  728. * downloaded_bytes: Bytes on disks
  729. * total_bytes: Total bytes, None if unknown
  730. * tmpfilename: The filename we're currently writing to
  731. Hooks are guaranteed to be called at least once (with status "finished")
  732. if the download is successful.
  733. """
  734. self._progress_hooks.append(ph)