yt_dlp/postprocessor/xattrpp.py

   1 from __future__ import unicode_literals
   2
   3 from .common import PostProcessor
   4 from ..compat import compat_os_name
   5 from ..utils import (
   6     hyphenate_date,
   7     write_xattr,
   8     PostProcessingError,
   9     XAttrMetadataError,
  10     XAttrUnavailableError,
  11 )
  12
  13
  14 class XAttrMetadataPP(PostProcessor):
  15     #
  16     # More info about extended attributes for media:
  17     #   http://freedesktop.org/wiki/CommonExtendedAttributes/
  18     #   http://www.freedesktop.org/wiki/PhreedomDraft/
  19     #   http://dublincore.org/documents/usageguide/elements.shtml
  20     #
  21     # TODO:
  22     #  * capture youtube keywords and put them in 'user.dublincore.subject' (comma-separated)
  23     #  * figure out which xattrs can be used for 'duration', 'thumbnail', 'resolution'
  24     #
  25
  26     def run(self, info):
  27         """ Set extended attributes on downloaded file (if xattr support is found). """
  28
  29         # Write the metadata to the file's xattrs
  30         self.to_screen('Writing metadata to file\'s xattrs')
  31
  32         filename = info['filepath']
  33
  34         try:
  35             xattr_mapping = {
  36                 'user.xdg.referrer.url': 'webpage_url',
  37                 # 'user.xdg.comment':            'description',
  38                 'user.dublincore.title': 'title',
  39                 'user.dublincore.date': 'upload_date',
  40                 'user.dublincore.description': 'description',
  41                 'user.dublincore.contributor': 'uploader',
  42                 'user.dublincore.format': 'format',
  43             }
  44
  45             num_written = 0
  46             for xattrname, infoname in xattr_mapping.items():
  47
  48                 value = info.get(infoname)
  49
  50                 if value:
  51                     if infoname == 'upload_date':
  52                         value = hyphenate_date(value)
  53
  54                     byte_value = value.encode('utf-8')
  55                     write_xattr(filename, xattrname, byte_value)
  56                     num_written += 1
  57
  58             return [], info
  59
  60         except XAttrUnavailableError as e:
  61             raise PostProcessingError(str(e))
  62
  63         except XAttrMetadataError as e:
  64             if e.reason == 'NO_SPACE':
  65                 self.report_warning(
  66                     'There\'s no disk space left, disk quota exceeded or filesystem xattr limit exceeded. '
  67                     + (('Some ' if num_written else '') + 'extended attributes are not written.').capitalize())
  68             elif e.reason == 'VALUE_TOO_LONG':
  69                 self.report_warning(
  70                     'Unable to write extended attributes due to too long values.')
  71             else:
  72                 msg = 'This filesystem doesn\'t support extended attributes. '
  73                 if compat_os_name == 'nt':
  74                     msg += 'You need to use NTFS.'
  75                 else:
  76                     msg += '(You may have to enable them in your /etc/fstab)'
  77                 raise PostProcessingError(str(e))
  78             return [], info