logo

youtube-dl

[mirror] Download/Watch videos from video hostersgit clone https://hacktivis.me/git/mirror/youtube-dl.git

cache.py (4348B)


  1. # coding: utf-8
  2. from __future__ import unicode_literals
  3. import json
  4. import os
  5. import re
  6. import shutil
  7. import traceback
  8. from .compat import (
  9. compat_contextlib_suppress,
  10. compat_getenv,
  11. compat_open as open,
  12. compat_os_makedirs,
  13. )
  14. from .utils import (
  15. error_to_compat_str,
  16. escape_rfc3986,
  17. expand_path,
  18. is_outdated_version,
  19. traverse_obj,
  20. write_json_file,
  21. )
  22. from .version import __version__
  23. class Cache(object):
  24. _YTDL_DIR = 'youtube-dl'
  25. _VERSION_KEY = _YTDL_DIR + '_version'
  26. _DEFAULT_VERSION = '2021.12.17'
  27. def __init__(self, ydl):
  28. self._ydl = ydl
  29. def _write_debug(self, *args, **kwargs):
  30. self._ydl.write_debug(*args, **kwargs)
  31. def _report_warning(self, *args, **kwargs):
  32. self._ydl.report_warning(*args, **kwargs)
  33. def _to_screen(self, *args, **kwargs):
  34. self._ydl.to_screen(*args, **kwargs)
  35. def _get_param(self, k, default=None):
  36. return self._ydl.params.get(k, default)
  37. def _get_root_dir(self):
  38. res = self._get_param('cachedir')
  39. if res is None:
  40. cache_root = compat_getenv('XDG_CACHE_HOME', '~/.cache')
  41. res = os.path.join(cache_root, self._YTDL_DIR)
  42. return expand_path(res)
  43. def _get_cache_fn(self, section, key, dtype):
  44. assert re.match(r'^[\w.-]+$', section), \
  45. 'invalid section %r' % section
  46. key = escape_rfc3986(key, safe='').replace('%', ',') # encode non-ascii characters
  47. return os.path.join(
  48. self._get_root_dir(), section, '%s.%s' % (key, dtype))
  49. @property
  50. def enabled(self):
  51. return self._get_param('cachedir') is not False
  52. def store(self, section, key, data, dtype='json'):
  53. assert dtype in ('json',)
  54. if not self.enabled:
  55. return
  56. fn = self._get_cache_fn(section, key, dtype)
  57. try:
  58. compat_os_makedirs(os.path.dirname(fn), exist_ok=True)
  59. self._write_debug('Saving {section}.{key} to cache'.format(section=section, key=key))
  60. write_json_file({self._VERSION_KEY: __version__, 'data': data}, fn)
  61. except Exception:
  62. tb = traceback.format_exc()
  63. self._report_warning('Writing cache to {fn!r} failed: {tb}'.format(fn=fn, tb=tb))
  64. def _validate(self, data, min_ver):
  65. version = traverse_obj(data, self._VERSION_KEY)
  66. if not version: # Backward compatibility
  67. data, version = {'data': data}, self._DEFAULT_VERSION
  68. if not is_outdated_version(version, min_ver or '0', assume_new=False):
  69. return data['data']
  70. self._write_debug('Discarding old cache from version {version} (needs {min_ver})'.format(version=version, min_ver=min_ver))
  71. def load(self, section, key, dtype='json', default=None, **kw_min_ver):
  72. assert dtype in ('json',)
  73. min_ver = kw_min_ver.get('min_ver')
  74. if not self.enabled:
  75. return default
  76. cache_fn = self._get_cache_fn(section, key, dtype)
  77. with compat_contextlib_suppress(IOError): # If no cache available
  78. try:
  79. with open(cache_fn, encoding='utf-8') as cachef:
  80. self._write_debug('Loading {section}.{key} from cache'.format(section=section, key=key), only_once=True)
  81. return self._validate(json.load(cachef), min_ver)
  82. except (ValueError, KeyError):
  83. try:
  84. file_size = os.path.getsize(cache_fn)
  85. except (OSError, IOError) as oe:
  86. file_size = error_to_compat_str(oe)
  87. self._report_warning('Cache retrieval from %s failed (%s)' % (cache_fn, file_size))
  88. return default
  89. def remove(self):
  90. if not self.enabled:
  91. self._to_screen('Cache is disabled (Did you combine --no-cache-dir and --rm-cache-dir?)')
  92. return
  93. cachedir = self._get_root_dir()
  94. if not any((term in cachedir) for term in ('cache', 'tmp')):
  95. raise Exception('Not removing directory %s - this does not look like a cache dir' % (cachedir,))
  96. self._to_screen(
  97. 'Removing cache dir %s .' % (cachedir,), skip_eol=True, ),
  98. if os.path.exists(cachedir):
  99. self._to_screen('.', skip_eol=True)
  100. shutil.rmtree(cachedir)
  101. self._to_screen('.')