import os import sys from .common import PostProcessor from ..utils import ( PostProcessingError, XAttrMetadataError, XAttrUnavailableError, hyphenate_date, write_xattr, ) class XAttrMetadataPP(PostProcessor): """Set extended attributes on downloaded file (if xattr support is found) More info about extended attributes for media: http://freedesktop.org/wiki/CommonExtendedAttributes/ http://www.freedesktop.org/wiki/PhreedomDraft/ http://dublincore.org/documents/usageguide/elements.shtml TODO: * capture youtube keywords and put them in 'user.dublincore.subject' (comma-separated) * figure out which xattrs can be used for 'duration', 'thumbnail', 'resolution' """ XATTR_MAPPING = { 'user.xdg.referrer.url': 'webpage_url', 'user.dublincore.title': 'title', 'user.dublincore.date': 'upload_date', 'user.dublincore.contributor': 'uploader', 'user.dublincore.format': 'format', # We do this last because it may get us close to the xattr limits # (e.g., 4kB on ext4), and we don't want to have the other ones fail 'user.dublincore.description': 'description', # 'user.xdg.comment': 'description', } PLATFORM_XATTR_MAPPING = { 'darwin': { 'com.apple.metadata:kMDItemWhereFroms': 'webpage_url', }, } APPLE_PLIST_TEMPLATE = ''' \t%s ''' def format_value(self, xattrname, infoname, value): if infoname == 'upload_date': return hyphenate_date(value) if xattrname == 'com.apple.metadata:kMDItemWhereFroms': return self.APPLE_PLIST_TEMPLATE % value return value def run(self, info): mtime = os.stat(info['filepath']).st_mtime self.to_screen('Writing metadata to file\'s xattrs') mapping = dict(self.XATTR_MAPPING) mapping.update(self.PLATFORM_XATTR_MAPPING.get(sys.platform, {})) for xattrname, infoname in mapping.items(): try: value = info.get(infoname) if value: value = self.format_value(xattrname, infoname, value) write_xattr(info['filepath'], xattrname, value.encode()) except XAttrUnavailableError as e: raise PostProcessingError(str(e)) except XAttrMetadataError as e: if e.reason == 'NO_SPACE': self.report_warning( 'There\'s no disk space left, disk quota exceeded or filesystem xattr limit exceeded. ' f'Extended attribute "{xattrname}" was not written.') elif e.reason == 'VALUE_TOO_LONG': self.report_warning(f'Unable to write extended attribute "{xattrname}" due to too long values.') else: tip = ('You need to use NTFS' if os.name == 'nt' else 'You may have to enable them in your "/etc/fstab"') raise PostProcessingError(f'This filesystem doesn\'t support extended attributes. {tip}') self.try_utime(info['filepath'], mtime, mtime) return [], info