This repository has been archived on 2026-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
SpideyDetector/modules/agnostic_paths.py

165 lines
5.6 KiB
Python

"""
The agnostic path handler, gives all methods to access all paths of the discord client, regardless of the os.
"""
import os
import re
import sys
class AgnosticPaths:
"""
An agnostic path object, containing all methods to access the files and folders in a standard discord install
"""
def __init__(self, ptb, forced_path=None):
"""
:param ptb: Whether the discord is a public beta install (ptb="PTB") or not (ptb="")
:type ptb: str
:param forced_path: An alternative discord install path, usefull to test the script on a non standard install
:type forced_path: str
"""
self.ptb = ptb
self.os = self.get_os()
self.main_path = self._get_path()
self.version = self.get_version()
self._update_path()
def get_os(self):
"""
Get the os string in a short, spydey-detector way.
For now only windows and linux are supported, note that due to the nature of linux builds, strings will likely become
linux-arch-deb, linux-arch-snap etc...
:return: ("windows", "linux", "mac")
:rtype: str
"""
platform = sys.platform
if platform.startswith('win'):
self.os = 'windows'
elif platform.startswith('linux'):
self.os = 'linux'
elif platform.startswith('darwin'):
self.os = 'mac'
else:
raise OSError("This script can only check for Spideys on Windows, Linux and Mac.")
return self.os
def _get_path(self):
"""
Return the base path of the install, note that the self.main_path is not returned,
and this method is meant to be used at init only
:return: Base path of the install (minus the version on windows)
:rtype: str
"""
if self.os == 'windows':
return os.path.join(os.path.expanduser('~'), "AppData", "Local", f"Discord{self.ptb}")
elif self.os == 'linux':
return os.path.join("/", "opt", "discord")
# return os.path.join("usr","share","discord")
elif self.os == 'mac':
return ""
raise OSError("Cannot detect discord PATH")
def get_version(self):
"""
Looks for the version file in the discord folder
and return the latest version of the discord build
:return: The version build
:rtype: str
"""
versions = []
if self.os == 'windows':
for element in os.listdir(self._get_path()):
if re.match(r"app-[\d.]+", element):
versions.append(element)
if not versions:
raise FileNotFoundError("Could not find discord version folder.")
versions.sort()
return versions[-1]
elif self.os == 'linux':
from json import load
with open(self('resources', 'build_info.json'), "r") as versionFile:
versions = load(versionFile)
return versions['version']
else:
raise OSError("Can't find for version on your OS.")
def _update_path(self):
"""
Update the main path with the version, if needed (windows & mac only)
"""
if self.os == 'windows':
self.main_path = os.path.join(self.main_path, self.version)
def list(self, *args):
"""
Lists all files in the path /discord_path/args[0]/args[1].../args[n]
:param args: The path as a list of parameters list("folder1", "folder2", ..., "foldern")
:type args: str
:return: The list of all files and folders in the given path
:rtype: list[str]
"""
return os.listdir(self(*args))
def list_dir_files(self, *args):
"""
Lists all files and directories in the given path.
:param args: The path
"""
all_files = self.list(*args)
_path = self(*args)
files = []
dirs = []
for element in all_files:
if os.path.isdir(os.path.join(_path, element)):
dirs.append(element)
else:
files.append(element)
return dirs, files
def __call__(self, *args):
"""
Tries to open the path /discord_path/args[0]/args[1].../args[n]
:param args: The path of the file or directory as a list of parameters __call__("folder1", "folder2", ..., "foldern")
:type args: str
:return: The path is it exists
:rtype: str
:raises: FileNotFoundError if the path doesn't exists
"""
_path = os.path.join(self.main_path, *args)
if not os.path.exists(_path):
raise FileNotFoundError(f"Could not find {_path}")
return _path
def get_path(self):
"""
The main path of the discord install
:return: self.main_path
:rtype: str
"""
return self.main_path
def __repr__(self):
"""
:return: A representation of the AgnosticPath
:rtype: str
"""
return f"AgnosticPaths(ptb={self.ptb}, os={self.os}, main_path={self.main_path}, version={self.version})"
def __str__(self):
"""
:return: The main path of the discord install
:rtype: str
"""
return self.main_path
if __name__ == '__main__':
path = AgnosticPaths("")
print(path)
print(path.version)
print(path.list())
print(path())
print(path("resources", "bootstrap")) # Return the main_path plus resources, bootstrap
print(path.list_dir_files("resources", "bootstrap")) # List the base_path/resources/bootstrap and return [[folders], [files]]