warlock-manager 2.2.5__tar.gz → 2.2.7__tar.gz

{warlock_manager-2.2.5 → warlock_manager-2.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: warlock-manager
-Version: 2.2.5
+Version: 2.2.7
 Summary: Dependency library for game-server management applications.
 Author-email: Charlie Powell <cdp1337@bitsnbytes.dev>
 Maintainer-email: Charlie Powell <cdp1337@bitsnbytes.dev>

{warlock_manager-2.2.5 → warlock_manager-2.2.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "warlock-manager"
-version = "2.2.5"
+version = "2.2.7"
 description = "Dependency library for game-server management applications."
 readme = "README.md"
 requires-python = ">=3.10"

{warlock_manager-2.2.5 → warlock_manager-2.2.7}/tests/test_cmd.py

@@ -3,16 +3,34 @@ from warlock_manager.libs.cmd import Cmd
 
 
 class TestCmd(unittest.TestCase):
-	def test_exists_true(self):
+	def test_exists(self):
+		"""
+		Test if commands exist and do not exist
+		:return:
+		"""
 		cmd = Cmd(["echo"])
 		self.assertTrue(cmd.exists)
 
-	def test_exists_false(self):
 		cmd = Cmd(["nonexistentbinary12345"])
 		self.assertFalse(cmd.exists)
 		self.assertFalse(cmd.success)
 
+	def test_exists_sudo(self):
+		"""
+		Test exists functionality when used with sudo
+		:return:
+		"""
+		cmd = Cmd(["true"]).sudo('nobody')
+		self.assertTrue(cmd.exists)
+
+		cmd = Cmd(["nonexistentbinary12345"]).sudo('nobody')
+		self.assertFalse(cmd.exists)
+
 	def test_text(self):
+		"""
+		Test that .text returns the output of the command
+		:return:
+		"""
 		cmd = Cmd(["echo", "hello world"])
 		self.assertEqual(cmd.text, "hello world")
 
@@ -42,6 +60,15 @@ class TestCmd(unittest.TestCase):
 		with self.assertRaises(Exception):
 			_ = cmd.json
 
+	def test_cwd(self):
+		"""
+		Test that the cwd is set and used correctly
+
+		:return:
+		"""
+		cmd = Cmd(["pwd"]).cwd("/tmp")
+		self.assertEqual(cmd.text, "/tmp")
+
 
 if __name__ == "__main__":
 	unittest.main()

{warlock_manager-2.2.5 → warlock_manager-2.2.7}/warlock_manager/apps/base_app.py

@@ -88,7 +88,6 @@ class BaseApp(ABC):
 			'api',  # Game supports baseline API features
 			'cmd',  # Game supports commands sent via the API
 			'create_service',  # Game supports creating new services
-			'mods',  # Game supports mods
 		}
 		"""
 		List of features available in this game

{warlock_manager-2.2.5 → warlock_manager-2.2.7}/warlock_manager/libs/cmd.py

@@ -3,6 +3,7 @@ import subprocess
 import json
 import logging
 import time
+import pwd
 
 from warlock_manager.libs import cache
 
@@ -39,7 +40,7 @@ class Cmd:
 		CompletedProcess: The result of the command execution
 		"""
 
-		self.executable: str | None = cmd[0] if len(cmd) > 0 else None
+		self.executable: str | None = self.cmd[0] if len(self.cmd) > 0 else None
 		"""
 		str: The executable name of the command
 		"""
@@ -65,7 +66,12 @@ class Cmd:
 		These commands are NOT persistent across calls!
 		"""
 
-	def sudo(self, runas: str | int):
+		self._cwd: str | None = None
+		"""
+		The current working directory for this command
+		"""
+
+	def sudo(self, runas: str | int) -> 'Cmd':
 		"""
 		Run this command as another user using sudo.
 
@@ -78,55 +84,73 @@ class Cmd:
 		:return:
 		"""
 		if isinstance(runas, str):
-			if os.getlogin() == runas:
+			# Get the name of the user owning the current process
+			# use pwd instead of os.getlogin to address CI tests on 3.13
+			current_user = pwd.getpwuid(os.geteuid()).pw_name
+			if current_user == runas:
 				# If we're already running as this user, no need to prefix with sudo
-				return
+				return self
 			prefix = ['sudo', '-u', runas]
 		else:
 			if os.geteuid() == runas:
 				# If we're already running as this user, no need to prefix with sudo
-				return
+				return self
 			prefix = ['sudo', '-u', '#%s' % runas]
 
 		self.cmd = prefix + self.cmd
 		self.result = None
+		return self
 
-	def use_stdout(self):
+	def use_stdout(self) -> 'Cmd':
 		"""
 		Set this command to use stdout for output instead of stderr.
 		:return:
 		"""
 		self.uses = 'stdout'
+		return self
 
-	def use_stderr(self):
+	def use_stderr(self) -> 'Cmd':
 		"""
 		Set this command to use stderr for output instead of stdout.
 		:return:
 		"""
 		self.uses = 'stderr'
+		return self
 
-	def stream_output(self):
+	def stream_output(self) -> 'Cmd':
 		"""
 		Set this command to stream to stdout/stderr directly.  Useful for long-running commands.
 		:return:
 		"""
 		self.uses = None
+		return self
 
-	def is_cacheable(self, expires: int = 3600):
+	def is_cacheable(self, expires: int = 3600) -> 'Cmd':
 		"""
 		Set this command as cacheable for N seconds.
 		:param expires:
 		:return:
 		"""
 		self.cacheable = expires
+		return self
 
-	def is_memory_cacheable(self, expires: int = 2):
+	def is_memory_cacheable(self, expires: int = 2) -> 'Cmd':
 		"""
 		Set this command as cacheable in memory for N seconds.
 		:param expires:
 		:return:
 		"""
 		self.memory_cacheable = expires
+		return self
+
+	def cwd(self, path: str | None) -> 'Cmd':
+		"""
+		Set the current working directory for this command.
+		:param path:
+		:return:
+		"""
+		self._cwd = path
+		return self
 
 	@property
 	def exists(self) -> bool:
@@ -230,6 +254,7 @@ class Cmd:
 					self.cmd,
 					capture_output=capture_output,
 					check=False,
+					cwd=self._cwd,
 					encoding='utf-8'
 				)
 			except FileNotFoundError as e:
@@ -265,21 +290,55 @@ class Cmd:
 
 		return self.result
 
-	def extend(self, args: list):
+	def extend(self, args: list) -> 'Cmd':
 		"""
 		Extend the command with additional arguments.
 		:param args:
 		"""
 		self.cmd = self.cmd + args
 		self.result = None
+		return self
 
-	def append(self, arg: str):
+	def append(self, arg: str) -> 'Cmd':
 		"""
 		Append a single argument to the command.
 		:param arg:
 		"""
 		self.cmd.append(arg)
 		self.result = None
+		return self
+
+
+class PipeCmd(Cmd):
+	"""
+	Convenience wrapper for piping command output to a parent process
+	"""
+
+	def run(self):
+		"""
+		Run the command in the background using nohup. Caches the result so subsequent calls don't re-run the command.
+
+		:return:
+		"""
+		if self.result is None:
+
+			if self.cacheable is not False:
+				logging.warning('Piped commands cannot be cached!')
+
+			try:
+				logging.debug('Running piped command: %s' % ' '.join(self.cmd))
+				self.result = subprocess.Popen(
+					self.cmd,
+					cwd=self._cwd,
+					stdout=subprocess.PIPE,
+					stderr=subprocess.PIPE
+				)
+			except FileNotFoundError as e:
+				self.result = CmdFakeResponse('', str(e), 127)
+			except OSError as e:
+				self.result = CmdFakeResponse('', str(e), 1)
+
+		return self.result
 
 
 class BackgroundCmd(Cmd):
@@ -299,11 +358,12 @@ class BackgroundCmd(Cmd):
 				logging.warning('Background commands cannot be cached!')
 
 			try:
+				logging.debug('Running background command: %s' % ' '.join(self.cmd))
 				self.result = subprocess.Popen(
 					self.cmd,
+					cwd=self._cwd,
 					stdout=subprocess.DEVNULL,
-					stderr=subprocess.DEVNULL,
-					preexec_fn=lambda: logging.debug('Running background command: %s' % ' '.join(self.cmd))
+					stderr=subprocess.DEVNULL
 				)
 			except FileNotFoundError as e:
 				self.result = CmdFakeResponse('', str(e), 127)

{warlock_manager-2.2.5 → warlock_manager-2.2.7}/warlock_manager/libs/download.py

@@ -3,6 +3,10 @@ import requests
 import json
 from warlock_manager.libs import utils
 from warlock_manager.libs import cache
+from warlock_manager.libs.meta import get_meta
+
+# "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36"
+USER_AGENT = 'Warlock Manager/%s (warlock.nexus) <staff@bitsnbytes.dev>' % get_meta()['version']
 
 
 def download_file(url: str, destination: str):
@@ -18,7 +22,7 @@ def download_file(url: str, destination: str):
     # Ensure the target directory exists
     utils.ensure_file_parent_exists(destination)
 
-    response = requests.get(url, stream=True)
+    response = requests.get(url, stream=True, headers={'User-Agent': USER_AGENT})
     response.raise_for_status()  # Check if the request was successful
 
     with open(destination, 'wb') as f:
@@ -47,7 +51,7 @@ def download_json(url: str) -> dict:
     if cached is not None:
         return json.loads(cached)
 
-    response = requests.get(url)
+    response = requests.get(url, headers={'User-Agent': USER_AGENT, 'Accept': 'application/json'})
     response.raise_for_status()  # Check if the request was successful
     data = response.json()
 

{warlock_manager-2.2.5 → warlock_manager-2.2.7}/warlock_manager/libs/firewall.py

@@ -95,9 +95,15 @@ class Firewall:
 			logging.error(f"Invalid port number: {port}")
 			return False
 
+		if protocol.lower() not in ['tcp', 'udp']:
+			logging.error(f"Invalid protocol: {protocol}")
+			return False
+
 		firewall = cls.get_available()
 
 		if firewall == 'ufw':
+			# UFW requires the protocol to be all lowercase.
+			protocol = protocol.lower()
 			logging.info(f"Allowing {port}/{protocol} via UFW")
 			cmd = Cmd(['ufw', 'allow', f'{port}/{protocol}'])
 			if comment:
@@ -139,6 +145,10 @@ class Firewall:
 			logging.error(f"Invalid port number: {port}")
 			return False
 
+		if protocol.lower() not in ['tcp', 'udp']:
+			logging.error(f"Invalid protocol: {protocol}")
+			return False
+
 		firewall = cls.get_available()
 
 		if firewall == 'ufw':
@@ -183,7 +193,8 @@ class Firewall:
 			ufw_check = Cmd(['ufw', 'status'])
 			ufw_check.is_memory_cacheable(3)
 			result = ufw_check.text
-			port_proto = f"{port}/{protocol}"
+			# UFW requires the protocol to be all lowercase.
+			port_proto = f"{port}/{protocol}".lower()
 			for line in result.splitlines():
 				if port_proto in line and "ALLOW" in line and ("Anywhere" in line or "Anywhere (v6)" in line):
 					return True

{warlock_manager-2.2.5 → warlock_manager-2.2.7}/warlock_manager/libs/utils.py

@@ -121,7 +121,7 @@ def makedirs(target_dir: str):
 		return
 
 	# Ensure the directory exists within the context of either this game or the game owner's home directory
-	if not (target_dir.startswith(get_app_directory()) or target_dir.startswith(get_home_directory())):
+	if not (target_dir.startswith(get_base_directory()) or target_dir.startswith(get_home_directory())):
 		raise Exception('Cannot create directory outside of game directory: %s' % target_dir)
 
 	# Iterate up until the parent directory exists.

{warlock_manager-2.2.5 → warlock_manager-2.2.7}/warlock_manager/nexus/nexus.py

@@ -8,7 +8,7 @@ import hashlib
 import secrets
 from warlock_manager.libs.cmd import Cmd
 from warlock_manager.services.base_service import BaseService
-from warlock_manager.libs.utils import get_app_directory
+from warlock_manager.libs.utils import get_base_directory
 
 
 class Nexus:
@@ -34,7 +34,7 @@ class Nexus:
 			with open(self.email_file, 'r') as f:
 				self.email = f.read().strip()
 
-		manager_meta_path = os.path.join(get_app_directory(), '.manage.json')
+		manager_meta_path = os.path.join(get_base_directory(), '.manage.json')
 		if os.path.exists(manager_meta_path):
 			with open(manager_meta_path, 'r') as f:
 				meta = json.load(f)
@@ -222,7 +222,7 @@ class Nexus:
 			# Only push stats for running services
 			return
 
-		last_checkin_file = os.path.join(get_app_directory(), '.cache', '.%s.checkin' % service.service)
+		last_checkin_file = os.path.join(get_base_directory(), '.cache', '.%s.checkin' % service.service)
 		now = int(time.time())
 		if os.path.exists(last_checkin_file):
 			# Only push stats once every 15 minutes

{warlock_manager-2.2.5 → warlock_manager-2.2.7}/warlock_manager/services/base_service.py

@@ -1321,7 +1321,7 @@ class BaseService(ABC):
 			logging.info('Removed environment file for %s at %s' % (self.service, self._env_file))
 
 		target_dir = self.get_app_directory()
-		app_dir = os.path.join(self.game.get_app_directory(), 'AppFiles')
+		app_dir = os.path.join(utils.get_base_directory(), 'AppFiles')
 		if target_dir != app_dir and os.path.exists(target_dir):
 			# Only remove app directory if it's different than the game app.
 			# This is important because by default game instances share the same application base.
@@ -1379,7 +1379,7 @@ class BaseService(ABC):
 
 		:return:
 		"""
-		base = self.game.get_app_directory()
+		base = utils.get_base_directory()
 		temp_store = os.path.join(base, '.save-%s' % self.service)
 		save_source = self.get_save_directory()
 		save_files = self.get_save_files()
@@ -1433,7 +1433,7 @@ class BaseService(ABC):
 
 		:return:
 		"""
-		base = self.game.get_app_directory()
+		base = utils.get_base_directory()
 		temp_store = os.path.join(base, '.save-%s' % self.service)
 		target_dir = self.get_backup_directory()
 		base_name = self.service
@@ -1517,7 +1517,7 @@ class BaseService(ABC):
 			print('Game server is currently running, please stop it before restoring a backup!', file=sys.stderr)
 			return False
 
-		base = self.game.get_app_directory()
+		base = utils.get_base_directory()
 		temp_store = os.path.join(base, '.restore-%s' % self.service)
 		save_dest = self.get_save_directory()
 
@@ -1567,7 +1567,7 @@ class BaseService(ABC):
 
 		:return:
 		"""
-		base = self.game.get_app_directory()
+		base = utils.get_base_directory()
 		temp_store = os.path.join(base, '.restore-%s' % self.service)
 
 		# Cleanup

{warlock_manager-2.2.5 → warlock_manager-2.2.7}/warlock_manager.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: warlock-manager
-Version: 2.2.5
+Version: 2.2.7
 Summary: Dependency library for game-server management applications.
 Author-email: Charlie Powell <cdp1337@bitsnbytes.dev>
 Maintainer-email: Charlie Powell <cdp1337@bitsnbytes.dev>