Initial python3 changes

Mostly just updating libraries, removing string encoding/decoding,
fixing some edge cases. No new functionality was added in this
commit.

lib/beetsplug/subsonicupdate.py

@@ -0,0 +1,144 @@
+# This file is part of beets.
+# Copyright 2016, Adrian Sampson.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+
+"""Updates Subsonic library on Beets import
+Your Beets configuration file should contain
+a "subsonic" section like the following:
+    subsonic:
+        url: https://mydomain.com:443/subsonic
+        user: username
+        pass: password
+        auth: token
+For older Subsonic versions, token authentication
+is not supported, use password instead:
+    subsonic:
+        url: https://mydomain.com:443/subsonic
+        user: username
+        pass: password
+        auth: pass
+"""
+
+import hashlib
+import random
+import string
+
+import requests
+
+from binascii import hexlify
+from beets import config
+from beets.plugins import BeetsPlugin
+
+__author__ = 'https://github.com/maffo999'
+
+
+class SubsonicUpdate(BeetsPlugin):
+    def __init__(self):
+        super().__init__()
+        # Set default configuration values
+        config['subsonic'].add({
+            'user': 'admin',
+            'pass': 'admin',
+            'url': 'http://localhost:4040',
+            'auth': 'token',
+        })
+        config['subsonic']['pass'].redact = True
+        self.register_listener('import', self.start_scan)
+
+    @staticmethod
+    def __create_token():
+        """Create salt and token from given password.
+
+        :return: The generated salt and hashed token
+        """
+        password = config['subsonic']['pass'].as_str()
+
+        # Pick the random sequence and salt the password
+        r = string.ascii_letters + string.digits
+        salt = "".join([random.choice(r) for _ in range(6)])
+        salted_password = password + salt
+        token = hashlib.md5(salted_password.encode('utf-8')).hexdigest()
+
+        # Put together the payload of the request to the server and the URL
+        return salt, token
+
+    @staticmethod
+    def __format_url(endpoint):
+        """Get the Subsonic URL to trigger the given endpoint.
+        Uses either the url config option or the deprecated host, port,
+        and context_path config options together.
+
+        :return: Endpoint for updating Subsonic
+        """
+
+        url = config['subsonic']['url'].as_str()
+        if url and url.endswith('/'):
+            url = url[:-1]
+
+        # @deprecated("Use url config option instead")
+        if not url:
+            host = config['subsonic']['host'].as_str()
+            port = config['subsonic']['port'].get(int)
+            context_path = config['subsonic']['contextpath'].as_str()
+            if context_path == '/':
+                context_path = ''
+            url = f"http://{host}:{port}{context_path}"
+
+        return url + f'/rest/{endpoint}'
+
+    def start_scan(self):
+        user = config['subsonic']['user'].as_str()
+        auth = config['subsonic']['auth'].as_str()
+        url = self.__format_url("startScan")
+        self._log.debug('URL is {0}', url)
+        self._log.debug('auth type is {0}', config['subsonic']['auth'])
+
+        if auth == "token":
+            salt, token = self.__create_token()
+            payload = {
+                'u': user,
+                't': token,
+                's': salt,
+                'v': '1.13.0',  # Subsonic 5.3 and newer
+                'c': 'beets',
+                'f': 'json'
+            }
+        elif auth == "password":
+            password = config['subsonic']['pass'].as_str()
+            encpass = hexlify(password.encode()).decode()
+            payload = {
+                'u': user,
+                'p': f'enc:{encpass}',
+                'v': '1.12.0',
+                'c': 'beets',
+                'f': 'json'
+            }
+        else:
+            return
+        try:
+            response = requests.get(url, params=payload)
+            json = response.json()
+
+            if response.status_code == 200 and \
+                    json['subsonic-response']['status'] == "ok":
+                count = json['subsonic-response']['scanStatus']['count']
+                self._log.info(
+                    f'Updating Subsonic; scanning {count} tracks')
+            elif response.status_code == 200 and \
+                    json['subsonic-response']['status'] == "failed":
+                error_message = json['subsonic-response']['error']['message']
+                self._log.error(f'Error: {error_message}')
+            else:
+                self._log.error('Error: {0}', json)
+        except Exception as error:
+            self._log.error(f'Error: {error}')