malojaserver 3.2.2__py3-none-any.whl → 3.2.4__py3-none-any.whl

maloja/__main__.py

@@ -26,77 +26,6 @@ def print_header_info():
 	#print("#####")
 	print()
 
-
-
-def get_instance():
-	try:
-		return int(subprocess.check_output(["pgrep","-f","maloja$"]))
-	except Exception:
-		return None
-
-def get_instance_supervisor():
-	try:
-		return int(subprocess.check_output(["pgrep","-f","maloja_supervisor"]))
-	except Exception:
-		return None
-
-def restart():
-	if stop():
-		start()
-	else:
-		print(col["red"]("Could not stop Maloja!"))
-
-def start():
-	if get_instance_supervisor() is not None:
-		print("Maloja is already running.")
-	else:
-		print_header_info()
-		setup()
-		try:
-			#p = subprocess.Popen(["python3","-m","maloja.server"],stdout=subprocess.DEVNULL,stderr=subprocess.DEVNULL)
-			sp = subprocess.Popen(["python3","-m","maloja","supervisor"],stdout=subprocess.DEVNULL,stderr=subprocess.DEVNULL)
-			print(col["green"]("Maloja started!"))
-
-			port = conf.malojaconfig["PORT"]
-
-			print("Visit your server address (Port " + str(port) + ") to see your web interface. Visit /admin_setup to get started.")
-			print("If you're installing this on your local machine, these links should get you there:")
-			print("\t" + col["blue"]("http://localhost:" + str(port)))
-			print("\t" + col["blue"]("http://localhost:" + str(port) + "/admin_setup"))
-			return True
-		except Exception:
-			print("Error while starting Maloja.")
-			return False
-
-
-def stop():
-
-	for attempt in [(signal.SIGTERM,2),(signal.SIGTERM,5),(signal.SIGKILL,3),(signal.SIGKILL,5)]:
-
-		pid_sv = get_instance_supervisor()
-		pid = get_instance()
-
-		if pid is None and pid_sv is None:
-			print("Maloja stopped!")
-			return True
-
-		if pid_sv is not None:
-			os.kill(pid_sv,attempt[0])
-		if pid is not None:
-			os.kill(pid,attempt[0])
-
-		time.sleep(attempt[1])
-
-	return False
-
-
-
-
-
-
-	print("Maloja stopped!")
-	return True
-
 def onlysetup():
 	print_header_info()
 	setup()
@@ -109,24 +38,6 @@ def run_server():
 	from . import server
 	server.run_server()
 
-def run_supervisor():
-	setproctitle("maloja_supervisor")
-	while True:
-		log("Maloja is not running, starting...",module="supervisor")
-		try:
-			process = subprocess.Popen(
-			    ["python3", "-m", "maloja","run"],
-			    stdout=subprocess.DEVNULL,
-			    stderr=subprocess.DEVNULL,
-			)
-		except Exception as e:
-			log("Error starting Maloja: " + str(e),module="supervisor")
-		else:
-			try:
-				process.wait()
-			except Exception as e:
-				log("Maloja crashed: " + str(e),module="supervisor")
-
 def debug():
 	os.environ["MALOJA_DEV_MODE"] = 'true'
 	conf.malojaconfig.load_environment()
@@ -135,7 +46,7 @@ def debug():
 def print_info():
 	print_header_info()
 	print(col['lightblue']("Configuration Directory:"),conf.dir_settings['config'])
-	print(col['lightblue']("Data Directory:         "),conf.dir_settings['state'])
+	print(col['lightblue']("State Directory:        "),conf.dir_settings['state'])
 	print(col['lightblue']("Log Directory:          "),conf.dir_settings['logs'])
 	print(col['lightblue']("Network:                "),f"Dual Stack, Port {conf.malojaconfig['port']}" if conf.malojaconfig['host'] == "*" else f"IPv{ip_address(conf.malojaconfig['host']).version}, Port {conf.malojaconfig['port']}")
 	print(col['lightblue']("Timezone:               "),f"UTC{conf.malojaconfig['timezone']:+d}")
@@ -173,11 +84,7 @@ def main(*args,**kwargs):
 
 	actions = {
 		# server
-		"start":start,
-		"restart":restart,
-		"stop":stop,
 		"run":run_server,
-		"supervisor":run_supervisor,
 		"debug":debug,
 		"setup":onlysetup,
 		# admin scripts

maloja/__pkginfo__.py

@@ -4,7 +4,7 @@
 # you know what f*ck it
 # this is hardcoded for now because of that damn project / package name discrepancy
 # i'll fix it one day
-VERSION = "3.2.2"
+VERSION = "3.2.4"
 HOMEPAGE = "https://github.com/krateng/maloja"
 
 

maloja/apis/_base.py

@@ -25,9 +25,20 @@ __logmodulename__ = "apis"
 
 cla = CleanerAgent()
 
+
+
+# wrapper method: calls handle. final net to catch exceptions and map them to the handlers proper json / xml response
+# handle method: finds the method for this path / query. can only raise InvalidMethodException
+# scrobble: NOT the exposed scrobble method - helper for all APIs to scrobble their results with self-identification
+
+
 class APIHandler:
+
+	__apiname__: str
+	errors: dict
 	# make these classes singletons
 	_instance = None
+
 	def __new__(cls, *args, **kwargs):
 		if not isinstance(cls._instance, cls):
 			cls._instance = object.__new__(cls, *args, **kwargs)
@@ -62,37 +73,33 @@ class APIHandler:
 
 		try:
 			response.status,result = self.handle(path,keys)
-		except Exception:
-			exceptiontype = sys.exc_info()[0]
-			if exceptiontype in self.errors:
-				response.status,result = self.errors[exceptiontype]
-				log(f"Error with {self.__apiname__} API: {exceptiontype} (Request: {path})")
+		except Exception as e:
+			for exc_type, exc_response in self.errors.items():
+				if isinstance(e, exc_type):
+					response.status, result = exc_response
+					log(f"Error with {self.__apiname__} API: {e} (Request: {path})")
+					break
 			else:
-				response.status,result = 500,{"status":"Unknown error","code":500}
-				log(f"Unhandled Exception with {self.__apiname__} API: {exceptiontype} (Request: {path})")
+				# THIS SHOULD NOT HAPPEN
+				response.status, result = 500, {"status": "Unknown error", "code": 500}
+				log(f"Unhandled Exception with {self.__apiname__} API: {e} (Request: {path})")
 
 		return result
-		#else:
-		#	result = {"error":"Invalid scrobble protocol"}
-		#	response.status = 500
 
 
 	def handle(self,path,keys):
 
 		try:
-			methodname = self.get_method(path,keys)
+			methodname = self.get_method(path, keys)
 			method = self.methods[methodname]
-		except Exception:
-			log("Could not find a handler for method " + str(methodname) + " in API " + self.__apiname__,module="debug")
-			log("Keys: " + str(keys),module="debug")
+		except KeyError:
+			log(f"Could not find a handler for method {methodname} in API {self.__apiname__}", module="debug")
+			log(f"Keys: {keys}", module="debug")
 			raise InvalidMethodException()
-		return method(path,keys)
+		return method(path, keys)
 
 
 	def scrobble(self,rawscrobble,client=None):
 
 		# fixing etc is handled by the main scrobble function
-		try:
-			return database.incoming_scrobble(rawscrobble,api=self.__apiname__,client=client)
-		except Exception:
-			raise ScrobblingException()
+		return database.incoming_scrobble(rawscrobble,api=self.__apiname__,client=client)

maloja/apis/_exceptions.py

@@ -3,4 +3,4 @@ class InvalidAuthException(Exception): pass
 class InvalidMethodException(Exception): pass
 class InvalidSessionKey(Exception): pass
 class MalformedJSONException(Exception): pass
-class ScrobblingException(Exception): pass
+

maloja/apis/audioscrobbler.py

@@ -21,13 +21,22 @@ class Audioscrobbler(APIHandler):
 			"track.scrobble":self.submit_scrobble
 		}
 		self.errors = {
-			BadAuthException:(400,{"error":6,"message":"Requires authentication"}),
-			InvalidAuthException:(401,{"error":4,"message":"Invalid credentials"}),
-			InvalidMethodException:(200,{"error":3,"message":"Invalid method"}),
-			InvalidSessionKey:(403,{"error":9,"message":"Invalid session key"}),
-			ScrobblingException:(500,{"error":8,"message":"Operation failed"})
+			BadAuthException: (400, {"error": 6, "message": "Requires authentication"}),
+			InvalidAuthException: (401, {"error": 4, "message": "Invalid credentials"}),
+			InvalidMethodException: (200, {"error": 3, "message": "Invalid method"}),
+			InvalidSessionKey: (403, {"error": 9, "message": "Invalid session key"}),
+			Exception: (500, {"error": 8, "message": "Operation failed"})
 		}
 
+	# xml string escaping: https://stackoverflow.com/a/28703510
+	def xml_escape(self, str_xml: str):
+		str_xml = str_xml.replace("&", "&")
+		str_xml = str_xml.replace("<", "&lt;")
+		str_xml = str_xml.replace("<", "&lt;")
+		str_xml = str_xml.replace("\"", "&quot;")
+		str_xml = str_xml.replace("'", "&apos;")
+		return str_xml
+
 	def get_method(self,pathnodes,keys):
 		return keys.get("method")
 
@@ -45,12 +54,22 @@ class Audioscrobbler(APIHandler):
 		token = keys.get("authToken")
 		user = keys.get("username")
 		password = keys.get("password")
+		format = keys.get("format") or "xml" # Audioscrobbler 2.0 uses XML by default
 		# either username and password
 		if user is not None and password is not None:
 			client = apikeystore.check_and_identify_key(password)
 			if client:
 				sessionkey = self.generate_key(client)
-				return 200,{"session":{"key":sessionkey}}
+				if format == "json":
+					return 200,{"session":{"key":sessionkey}}
+				else:
+					return 200,"""<lfm status="ok">
+	<session>
+		<name>%s</name>
+		<key>%s</key>
+		<subscriber>0</subscriber>
+	</session>
+</lfm>""" % (self.xml_escape(user), self.xml_escape(sessionkey))
 			else:
 				raise InvalidAuthException()
 		# or username and token (deprecated by lastfm)
@@ -59,7 +78,16 @@ class Audioscrobbler(APIHandler):
 				key = apikeystore[client]
 				if md5(user + md5(key)) == token:
 					sessionkey = self.generate_key(client)
-					return 200,{"session":{"key":sessionkey}}
+					if format == "json":
+						return 200,{"session":{"key":sessionkey}}
+					else:
+						return 200,"""<lfm status="ok">
+	<session>
+		<name>%s</name>
+		<key>%s</key>
+		<subscriber>0</subscriber>
+	</session>
+</lfm>""" % (self.xml_escape(user), self.xml_escape(sessionkey))
 			raise InvalidAuthException()
 		else:
 			raise BadAuthException()

maloja/apis/audioscrobbler_legacy.py

@@ -23,11 +23,11 @@ class AudioscrobblerLegacy(APIHandler):
 			"scrobble":self.submit_scrobble
 		}
 		self.errors = {
-			BadAuthException:(403,"BADAUTH\n"),
-			InvalidAuthException:(403,"BADAUTH\n"),
-			InvalidMethodException:(400,"FAILED\n"),
-			InvalidSessionKey:(403,"BADSESSION\n"),
-			ScrobblingException:(500,"FAILED\n")
+			BadAuthException: (403, "BADAUTH\n"),
+			InvalidAuthException: (403, "BADAUTH\n"),
+			InvalidMethodException: (400, "FAILED\n"),
+			InvalidSessionKey: (403, "BADSESSION\n"),
+			Exception: (500, "FAILED\n")
 		}
 
 	def get_method(self,pathnodes,keys):

maloja/apis/listenbrainz.py

@@ -3,6 +3,7 @@ from ._exceptions import *
 from .. import database
 import datetime
 from ._apikeys import apikeystore
+from ..database.exceptions import DuplicateScrobble, DuplicateTimestamp
 
 from ..pkg_global.conf import malojaconfig
 
@@ -21,11 +22,13 @@ class Listenbrainz(APIHandler):
 			"validate-token":self.validate_token
 		}
 		self.errors = {
-			BadAuthException:(401,{"code":401,"error":"You need to provide an Authorization header."}),
-			InvalidAuthException:(401,{"code":401,"error":"Incorrect Authorization"}),
-			InvalidMethodException:(200,{"code":200,"error":"Invalid Method"}),
-			MalformedJSONException:(400,{"code":400,"error":"Invalid JSON document submitted."}),
-			ScrobblingException:(500,{"code":500,"error":"Unspecified server error."})
+			BadAuthException: (401, {"code": 401, "error": "You need to provide an Authorization header."}),
+			InvalidAuthException: (401, {"code": 401, "error": "Incorrect Authorization"}),
+			InvalidMethodException: (200, {"code": 200, "error": "Invalid Method"}),
+			MalformedJSONException: (400, {"code": 400, "error": "Invalid JSON document submitted."}),
+			DuplicateScrobble: (200, {"status": "ok"}),
+			DuplicateTimestamp: (409, {"error": "Scrobble with the same timestamp already exists."}),
+			Exception: (500, {"code": 500, "error": "Unspecified server error."})
 		}
 
 	def get_method(self,pathnodes,keys):

maloja/apis/native_v1.py

@@ -7,7 +7,6 @@ from bottle import response, static_file, FormsDict
 from inspect import signature
 
 from doreah.logging import log
-from doreah.auth import authenticated_function
 
 # nimrodel API
 from nimrodel import EAPI as API
@@ -15,7 +14,7 @@ from nimrodel import Multi
 
 
 from .. import database
-from ..pkg_global.conf import malojaconfig, data_dir
+from ..pkg_global.conf import malojaconfig, data_dir, auth
 
 
 
@@ -82,6 +81,24 @@ errors = {
 			'desc':"This entity does not exist in the database."
 		}
 	}),
+	database.exceptions.DuplicateTimestamp: lambda e: (409,{
+		"status":"error",
+		"error":{
+			'type':'duplicate_timestamp',
+			'value':e.rejected_scrobble,
+			'desc':"A scrobble is already registered with this timestamp."
+		}
+	}),
+	database.exceptions.DuplicateScrobble: lambda e: (200,{
+		"status": "success",
+		"desc": "The scrobble is present in the database.",
+		"track": {},
+		"warnings": [{
+			'type': 'scrobble_exists',
+			'value': None,
+			'desc': 'This scrobble exists in the database (same timestamp and track). The submitted scrobble was not added.'
+		}]
+	}),
 	images.MalformedB64: lambda e: (400,{
 		"status":"failure",
 		"error":{
@@ -474,7 +491,7 @@ def get_top_artists_external(k_filter, k_limit, k_delimit, k_amount):
 	:rtype: Dictionary"""
 
 	ckeys = {**k_limit, **k_delimit}
-	results = database.get_top_artists(**ckeys)
+	results = database.get_top_artists(**ckeys,compatibility=True)
 
 	return {
 		"status":"ok",
@@ -493,7 +510,7 @@ def get_top_tracks_external(k_filter, k_limit, k_delimit, k_amount):
 	:rtype: Dictionary"""
 
 	ckeys = {**k_limit, **k_delimit}
-	results = database.get_top_tracks(**ckeys)
+	results = database.get_top_tracks(**ckeys,compatibility=True)
 	# IMPLEMENT THIS FOR TOP TRACKS OF ARTIST/ALBUM AS WELL?
 
 	return {
@@ -513,7 +530,7 @@ def get_top_albums_external(k_filter, k_limit, k_delimit, k_amount):
 	:rtype: Dictionary"""
 
 	ckeys = {**k_limit, **k_delimit}
-	results = database.get_top_albums(**ckeys)
+	results = database.get_top_albums(**ckeys,compatibility=True)
 	# IMPLEMENT THIS FOR TOP ALBUMS OF ARTIST AS WELL?
 
 	return {
@@ -567,7 +584,7 @@ def album_info_external(k_filter, k_limit, k_delimit, k_amount):
 
 
 @api.post("newscrobble")
-@authenticated_function(alternate=api_key_correct,api=True,pass_auth_result_as='auth_result')
+@auth.authenticated_function(alternate=api_key_correct,api=True,pass_auth_result_as='auth_result')
 @catch_exceptions
 def post_scrobble(
 		artist:Multi=None,
@@ -647,7 +664,7 @@ def post_scrobble(
 
 
 @api.post("addpicture")
-@authenticated_function(alternate=api_key_correct,api=True)
+@auth.authenticated_function(alternate=api_key_correct,api=True)
 @catch_exceptions
 @convert_kwargs
 def add_picture(k_filter, k_limit, k_delimit, k_amount, k_special):
@@ -670,7 +687,7 @@ def add_picture(k_filter, k_limit, k_delimit, k_amount, k_special):
 
 
 @api.post("importrules")
-@authenticated_function(api=True)
+@auth.authenticated_function(api=True)
 @catch_exceptions
 def import_rulemodule(**keys):
 	"""Internal Use Only"""
@@ -689,7 +706,7 @@ def import_rulemodule(**keys):
 
 
 @api.post("rebuild")
-@authenticated_function(api=True)
+@auth.authenticated_function(api=True)
 @catch_exceptions
 def rebuild(**keys):
 	"""Internal Use Only"""
@@ -765,7 +782,7 @@ def search(**keys):
 
 
 @api.post("newrule")
-@authenticated_function(api=True)
+@auth.authenticated_function(api=True)
 @catch_exceptions
 def newrule(**keys):
 	"""Internal Use Only"""
@@ -776,21 +793,21 @@ def newrule(**keys):
 
 
 @api.post("settings")
-@authenticated_function(api=True)
+@auth.authenticated_function(api=True)
 @catch_exceptions
 def set_settings(**keys):
 	"""Internal Use Only"""
 	malojaconfig.update(keys)
 
 @api.post("apikeys")
-@authenticated_function(api=True)
+@auth.authenticated_function(api=True)
 @catch_exceptions
 def set_apikeys(**keys):
 	"""Internal Use Only"""
 	apikeystore.update(keys)
 
 @api.post("import")
-@authenticated_function(api=True)
+@auth.authenticated_function(api=True)
 @catch_exceptions
 def import_scrobbles(identifier):
 	"""Internal Use Only"""
@@ -798,7 +815,7 @@ def import_scrobbles(identifier):
 	import_scrobbles(identifier)
 
 @api.get("backup")
-@authenticated_function(api=True)
+@auth.authenticated_function(api=True)
 @catch_exceptions
 def get_backup(**keys):
 	"""Internal Use Only"""
@@ -811,7 +828,7 @@ def get_backup(**keys):
 	return static_file(os.path.basename(archivefile),root=tmpfolder)
 
 @api.get("export")
-@authenticated_function(api=True)
+@auth.authenticated_function(api=True)
 @catch_exceptions
 def get_export(**keys):
 	"""Internal Use Only"""
@@ -825,7 +842,7 @@ def get_export(**keys):
 
 
 @api.post("delete_scrobble")
-@authenticated_function(api=True)
+@auth.authenticated_function(api=True)
 @catch_exceptions
 def delete_scrobble(timestamp):
 	"""Internal Use Only"""
@@ -837,7 +854,7 @@ def delete_scrobble(timestamp):
 
 
 @api.post("edit_artist")
-@authenticated_function(api=True)
+@auth.authenticated_function(api=True)
 @catch_exceptions
 def edit_artist(id,name):
 	"""Internal Use Only"""
@@ -847,7 +864,7 @@ def edit_artist(id,name):
 	}
 
 @api.post("edit_track")
-@authenticated_function(api=True)
+@auth.authenticated_function(api=True)
 @catch_exceptions
 def edit_track(id,title):
 	"""Internal Use Only"""
@@ -857,7 +874,7 @@ def edit_track(id,title):
 	}
 
 @api.post("edit_album")
-@authenticated_function(api=True)
+@auth.authenticated_function(api=True)
 @catch_exceptions
 def edit_album(id,albumtitle):
 	"""Internal Use Only"""
@@ -868,7 +885,7 @@ def edit_album(id,albumtitle):
 
 
 @api.post("merge_tracks")
-@authenticated_function(api=True)
+@auth.authenticated_function(api=True)
 @catch_exceptions
 def merge_tracks(target_id,source_ids):
 	"""Internal Use Only"""
@@ -879,7 +896,7 @@ def merge_tracks(target_id,source_ids):
 	}
 
 @api.post("merge_artists")
-@authenticated_function(api=True)
+@auth.authenticated_function(api=True)
 @catch_exceptions
 def merge_artists(target_id,source_ids):
 	"""Internal Use Only"""
@@ -890,7 +907,7 @@ def merge_artists(target_id,source_ids):
 	}
 
 @api.post("merge_albums")
-@authenticated_function(api=True)
+@auth.authenticated_function(api=True)
 @catch_exceptions
 def merge_artists(target_id,source_ids):
 	"""Internal Use Only"""
@@ -901,7 +918,7 @@ def merge_artists(target_id,source_ids):
 	}
 
 @api.post("associate_albums_to_artist")
-@authenticated_function(api=True)
+@auth.authenticated_function(api=True)
 @catch_exceptions
 def associate_albums_to_artist(target_id,source_ids,remove=False):
 	result = database.associate_albums_to_artist(target_id,source_ids,remove=remove)
@@ -913,7 +930,7 @@ def associate_albums_to_artist(target_id,source_ids,remove=False):
 		}
 
 @api.post("associate_tracks_to_artist")
-@authenticated_function(api=True)
+@auth.authenticated_function(api=True)
 @catch_exceptions
 def associate_tracks_to_artist(target_id,source_ids,remove=False):
 	result = database.associate_tracks_to_artist(target_id,source_ids,remove=remove)
@@ -925,7 +942,7 @@ def associate_tracks_to_artist(target_id,source_ids,remove=False):
 		}
 
 @api.post("associate_tracks_to_album")
-@authenticated_function(api=True)
+@auth.authenticated_function(api=True)
 @catch_exceptions
 def associate_tracks_to_album(target_id,source_ids):
 	result = database.associate_tracks_to_album(target_id,source_ids)
@@ -937,7 +954,7 @@ def associate_tracks_to_album(target_id,source_ids):
 
 
 @api.post("reparse_scrobble")
-@authenticated_function(api=True)
+@auth.authenticated_function(api=True)
 @catch_exceptions
 def reparse_scrobble(timestamp):
 	"""Internal Use Only"""

maloja/cleanup.py

@@ -15,13 +15,15 @@ class CleanerAgent:
 	def updateRules(self):
 
 		rawrules = []
-		for f in os.listdir(data_dir["rules"]()):
-			if f.split('.')[-1].lower() != 'tsv': continue
-			filepath = data_dir["rules"](f)
-			with open(filepath,'r') as filed:
-				reader = csv.reader(filed,delimiter="\t")
-				rawrules += [[col for col in entry if col] for entry in reader if len(entry)>0 and not entry[0].startswith('#')]
-
+		try:
+			for f in os.listdir(data_dir["rules"]()):
+				if f.split('.')[-1].lower() != 'tsv': continue
+				filepath = data_dir["rules"](f)
+				with open(filepath,'r') as filed:
+					reader = csv.reader(filed,delimiter="\t")
+					rawrules += [[col for col in entry if col] for entry in reader if len(entry)>0 and not entry[0].startswith('#')]
+		except FileNotFoundError:
+			pass
 
 		self.rules_belongtogether = [r[1] for r in rawrules if r[0]=="belongtogether"]
 		self.rules_notanartist = [r[1] for r in rawrules if r[0]=="notanartist"]

maloja/data_files/config/rules/predefined/krateng_kpopgirlgroups.tsv

@@ -160,8 +160,8 @@ replaceartist	여자친구 GFriend			GFriend
 # Girl's Generation
 replaceartist	소녀시대				Girls' Generation
 replaceartist	SNSD				Girls' Generation
-replaceartist Girls' Generation-TTS       TaeTiSeo
-countas       TaeTiSeo    Girls' Generation
+replaceartist	Girls' Generation-TTS	TaeTiSeo
+countas	TaeTiSeo	Girls' Generation
 
 # Apink
 replaceartist	A Pink					Apink