# 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 from binascii import hexlify import requests from beets.plugins import BeetsPlugin __author__ = "https://github.com/maffo999" class SubsonicUpdate(BeetsPlugin): def __init__(self): super().__init__("subsonic") # Set default configuration values self.config.add( { "user": "admin", "pass": "admin", "url": "http://localhost:4040", "auth": "token", } ) self.config["user"].redact = True self.config["pass"].redact = True self.register_listener("database_change", self.db_change) self.register_listener("smartplaylist_update", self.spl_update) def db_change(self, lib, model): self.register_listener("cli_exit", self.start_scan) def spl_update(self): self.register_listener("cli_exit", self.start_scan) def __create_token(self): """Create salt and token from given password. :return: The generated salt and hashed token """ password = self.config["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 = f"{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 def __format_url(self, 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 = self.config["url"].as_str() if url and url.endswith("/"): url = url[:-1] # @deprecated("Use url config option instead") if not url: host = self.config["host"].as_str() port = self.config["port"].get(int) context_path = self.config["contextpath"].as_str() if context_path == "/": context_path = "" url = f"http://{host}:{port}{context_path}" return f"{url}/rest/{endpoint}" def start_scan(self): user = self.config["user"].as_str() auth = self.config["auth"].as_str() url = self.__format_url("startScan") self._log.debug("URL is {}", url) self._log.debug("auth type is {}", self.config["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 = self.config["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, timeout=10, ) 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: {}", json) except Exception as error: self._log.error(f"Error: {error}")