Move common libs to libs/common

libs/common/beetsplug/permissions.py

@@ -0,0 +1,123 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import division, absolute_import, print_function
+
+"""Fixes file permissions after the file gets written on import. Put something
+like the following in your config.yaml to configure:
+
+    permissions:
+            file: 644
+            dir: 755
+"""
+import os
+from beets import config, util
+from beets.plugins import BeetsPlugin
+from beets.util import ancestry
+import six
+
+
+def convert_perm(perm):
+    """Convert a string to an integer, interpreting the text as octal.
+    Or, if `perm` is an integer, reinterpret it as an octal number that
+    has been "misinterpreted" as decimal.
+    """
+    if isinstance(perm, six.integer_types):
+        perm = six.text_type(perm)
+    return int(perm, 8)
+
+
+def check_permissions(path, permission):
+    """Check whether the file's permissions equal the given vector.
+    Return a boolean.
+    """
+    return oct(os.stat(path).st_mode & 0o777) == oct(permission)
+
+
+def assert_permissions(path, permission, log):
+    """Check whether the file's permissions are as expected, otherwise,
+    log a warning message. Return a boolean indicating the match, like
+    `check_permissions`.
+    """
+    if not check_permissions(util.syspath(path), permission):
+        log.warning(
+            u'could not set permissions on {}',
+            util.displayable_path(path),
+        )
+        log.debug(
+            u'set permissions to {}, but permissions are now {}',
+            permission,
+            os.stat(util.syspath(path)).st_mode & 0o777,
+        )
+
+
+def dirs_in_library(library, item):
+    """Creates a list of ancestor directories in the beets library path.
+    """
+    return [ancestor
+            for ancestor in ancestry(item)
+            if ancestor.startswith(library)][1:]
+
+
+class Permissions(BeetsPlugin):
+    def __init__(self):
+        super(Permissions, self).__init__()
+
+        # Adding defaults.
+        self.config.add({
+            u'file': '644',
+            u'dir': '755',
+        })
+
+        self.register_listener('item_imported', self.fix)
+        self.register_listener('album_imported', self.fix)
+
+    def fix(self, lib, item=None, album=None):
+        """Fix the permissions for an imported Item or Album.
+        """
+        # Get the configured permissions. The user can specify this either a
+        # string (in YAML quotes) or, for convenience, as an integer so the
+        # quotes can be omitted. In the latter case, we need to reinterpret the
+        # integer as octal, not decimal.
+        file_perm = config['permissions']['file'].get()
+        dir_perm = config['permissions']['dir'].get()
+        file_perm = convert_perm(file_perm)
+        dir_perm = convert_perm(dir_perm)
+
+        # Create chmod_queue.
+        file_chmod_queue = []
+        if item:
+            file_chmod_queue.append(item.path)
+        elif album:
+            for album_item in album.items():
+                file_chmod_queue.append(album_item.path)
+
+        # A set of directories to change permissions for.
+        dir_chmod_queue = set()
+
+        for path in file_chmod_queue:
+            # Changing permissions on the destination file.
+            self._log.debug(
+                u'setting file permissions on {}',
+                util.displayable_path(path),
+            )
+            os.chmod(util.syspath(path), file_perm)
+
+            # Checks if the destination path has the permissions configured.
+            assert_permissions(path, file_perm, self._log)
+
+            # Adding directories to the directory chmod queue.
+            dir_chmod_queue.update(
+                dirs_in_library(lib.directory,
+                                path))
+
+        # Change permissions for the directories.
+        for path in dir_chmod_queue:
+            # Chaning permissions on the destination directory.
+            self._log.debug(
+                u'setting directory permissions on {}',
+                util.displayable_path(path),
+            )
+            os.chmod(util.syspath(path), dir_perm)
+
+            # Checks if the destination path has the permissions configured.
+            assert_permissions(path, dir_perm, self._log)