Annotate changelog with bug being closed.

[youtubedl] / youtube_dl / postprocessor / xattrpp.py

diff --git a/youtube_dl/postprocessor/xattrpp.py b/youtube_dl/postprocessor/xattrpp.py
index f6940940b340dea5c23e5ce118b8fcc4d7ee8574..e39ca60aa08326b6f05814ff800bb09c75755e48 100644 (file)
--- a/youtube_dl/postprocessor/xattrpp.py
+++ b/youtube_dl/postprocessor/xattrpp.py
@@ -1,15 +1,37 @@
+from __future__ import unicode_literals
+

 import os
 import subprocess
 import sys
 import os
 import subprocess
 import sys

+import errno

 
 from .common import PostProcessor
 
 from .common import PostProcessor

+from ..compat import compat_os_name

 from ..utils import (
     check_executable,
     hyphenate_date,
 from ..utils import (
     check_executable,
     hyphenate_date,

-    subprocess_check_output
+    version_tuple,
+    PostProcessingError,
+    encodeArgument,
+    encodeFilename,

 )
 
 
 )
 
 

+class XAttrMetadataError(PostProcessingError):
+    def __init__(self, code=None, msg='Unknown error'):
+        super(XAttrMetadataError, self).__init__(msg)
+        self.code = code
+
+        # Parsing code and msg
+        if (self.code in (errno.ENOSPC, errno.EDQUOT) or
+                'No space left' in self.msg or 'Disk quota excedded' in self.msg):
+            self.reason = 'NO_SPACE'
+        elif self.code == errno.E2BIG or 'Argument list too long' in self.msg:
+            self.reason = 'VALUE_TOO_LONG'
+        else:
+            self.reason = 'NOT_SUPPORTED'
+
+

 class XAttrMetadataPP(PostProcessor):
 
     #
 class XAttrMetadataPP(PostProcessor):
 
     #


@@ -32,33 +54,67 @@ class XAttrMetadataPP(PostProcessor):
             # try the pyxattr module...
             import xattr
 
             # try the pyxattr module...
             import xattr
 

+            # Unicode arguments are not supported in python-pyxattr until
+            # version 0.5.0
+            # See https://github.com/rg3/youtube-dl/issues/5498
+            pyxattr_required_version = '0.5.0'
+            if version_tuple(xattr.__version__) < version_tuple(pyxattr_required_version):
+                self._downloader.report_warning(
+                    'python-pyxattr is detected but is too old. '
+                    'youtube-dl requires %s or above while your version is %s. '
+                    'Falling back to other xattr implementations' % (
+                        pyxattr_required_version, xattr.__version__))
+
+                raise ImportError
+

             def write_xattr(path, key, value):
             def write_xattr(path, key, value):

-                return xattr.setxattr(path, key, value)
+                try:
+                    xattr.set(path, key, value)
+                except EnvironmentError as e:
+                    raise XAttrMetadataError(e.errno, e.strerror)

 
         except ImportError:
 
         except ImportError:

-            if os.name == 'nt':
+            if compat_os_name == 'nt':

                 # Write xattrs to NTFS Alternate Data Streams:
                 # http://en.wikipedia.org/wiki/NTFS#Alternate_data_streams_.28ADS.29
                 def write_xattr(path, key, value):
                     assert ':' not in key
                     assert os.path.exists(path)
 
                 # Write xattrs to NTFS Alternate Data Streams:
                 # http://en.wikipedia.org/wiki/NTFS#Alternate_data_streams_.28ADS.29
                 def write_xattr(path, key, value):
                     assert ':' not in key
                     assert os.path.exists(path)
 

-                    ads_fn = path + ":" + key
-                    with open(ads_fn, "wb") as f:
-                        f.write(value)
+                    ads_fn = path + ':' + key
+                    try:
+                        with open(ads_fn, 'wb') as f:
+                            f.write(value)
+                    except EnvironmentError as e:
+                        raise XAttrMetadataError(e.errno, e.strerror)

             else:
             else:

-                user_has_setfattr = check_executable("setfattr", ['--version'])
-                user_has_xattr = check_executable("xattr", ['-h'])
+                user_has_setfattr = check_executable('setfattr', ['--version'])
+                user_has_xattr = check_executable('xattr', ['-h'])

 
                 if user_has_setfattr or user_has_xattr:
 
                     def write_xattr(path, key, value):
 
                 if user_has_setfattr or user_has_xattr:
 
                     def write_xattr(path, key, value):

+                        value = value.decode('utf-8')

                         if user_has_setfattr:
                         if user_has_setfattr:

-                            cmd = ['setfattr', '-n', key, '-v', value, path]
+                            executable = 'setfattr'
+                            opts = ['-n', key, '-v', value]

                         elif user_has_xattr:
                         elif user_has_xattr:

-                            cmd = ['xattr', '-w', key, value, path]
-
-                        subprocess_check_output(cmd)
+                            executable = 'xattr'
+                            opts = ['-w', key, value]
+
+                        cmd = ([encodeFilename(executable, True)] +
+                               [encodeArgument(o) for o in opts] +
+                               [encodeFilename(path, True)])
+
+                        try:
+                            p = subprocess.Popen(
+                                cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, stdin=subprocess.PIPE)
+                        except EnvironmentError as e:
+                            raise XAttrMetadataError(e.errno, e.strerror)
+                        stdout, stderr = p.communicate()
+                        stderr = stderr.decode('utf-8', 'replace')
+                        if p.returncode != 0:
+                            raise XAttrMetadataError(p.returncode, stderr)

 
                 else:
                     # On Unix, and can't find pyxattr, setfattr, or xattr.
 
                 else:
                     # On Unix, and can't find pyxattr, setfattr, or xattr.


@@ -95,15 +151,27 @@ class XAttrMetadataPP(PostProcessor):
                 value = info.get(infoname)
 
                 if value:
                 value = info.get(infoname)
 
                 if value:

-                    if infoname == "upload_date":
+                    if infoname == 'upload_date':

                         value = hyphenate_date(value)
 
                     byte_value = value.encode('utf-8')
                     write_xattr(filename, xattrname, byte_value)
 
                         value = hyphenate_date(value)
 
                     byte_value = value.encode('utf-8')
                     write_xattr(filename, xattrname, byte_value)
 

-            return True, info
-
-        except (subprocess.CalledProcessError, OSError):
-            self._downloader.report_error("This filesystem doesn't support extended attributes. (You may have to enable them in your /etc/fstab)")
-            return False, info
+            return [], info

 
 

+        except XAttrMetadataError as e:
+            if e.reason == 'NO_SPACE':
+                self._downloader.report_warning(
+                    'There\'s no disk space left or disk quota exceeded. ' +
+                    'Extended attributes are not written.')
+            elif e.reason == 'VALUE_TOO_LONG':
+                self._downloader.report_warning(
+                    'Unable to write extended attributes due to too long values.')
+            else:
+                msg = 'This filesystem doesn\'t support extended attributes. '
+                if compat_os_name == 'nt':
+                    msg += 'You need to use NTFS.'
+                else:
+                    msg += '(You may have to enable them in your /etc/fstab)'
+                self._downloader.report_error(msg)
+            return [], info