def get_credentials(username: str) -> str:
"""
:param username: username used for Studip
:return: password
"""
logger.debug(f"getting credentials for {username}")
return keyring.get_password("StudipCrawl", username)
def save_credentials(username: str, password: str) -> None:
"""
:param username: username used for Studip
:param password: password used for Studip
:return: sets username and password in local keyring
"""
keyring.set_password("StudipCrawl", username, password)
logger.debug(f"saved credentials {username}")
def get_file_size_of_dir(root_dir: str) -> Generator[int, str, None]:
"""
creates a list that represents the folder structure of root_dir
:param root_dir: directory where to start from
:return: yields the file sizes from the directory
"""
logger.debug(f"Getting file sizes for {root_dir}")
for root, dirs, files in os.walk(root_dir):
for file in files:
try:
yield os.stat(os.path.join(root, file)).st_size
except FileNotFoundError:
pass
def make_folder_name(old_name: str) -> str:
"""
removes certain keywords from folder name and changes it accordingly if the user specified replacements
:param old_name: not formatted name
:return: gets rid of useless words for a easier to find folder name in dst_folder
"""
logger.debug(f"Formatting {old_name}")
json_file = open(os.path.join(os.path.dirname(os.path.realpath(__file__)), "aran_config.json"))
json_data = json.load(json_file)["replacements"]
for key, values in json_data.items():
if key in old_name:
return values
old_name = old_name.strip()
for sign in ["Vorlesung:", "Übung:", "Tutorium:", " - Dateien", "sonstige:", "/ "]:
logger.debug(f"Deleting {sign} from {old_name}")
old_name = old_name.replace(sign, "")
return old_name.strip()
def validate_password(username: str, password: str) -> bool:
"""
:param username: username used for Studip
:param password: password used for Studip
:return: boolean if combination is right
"""
with requests.Session() as r:
homepage = r.get("https://studip.uni-trier.de/index.php?again=yes")
soup = BeautifulSoup(homepage.text, "html.parser")
security_token = soup.find("input",
{"name": "security_token"})["value"]
login_ticket = soup.find("input", {"name": "login_ticket"})["value"]
try:
if not homepage.ok:
logger.error("Studip or user is offline")
input("Press any key to exit")
sys.exit(1)
else:
payload = {
"security_ticket": security_token,
"login_ticket": login_ticket,
"loginname": username,
"password": password
}
login_start = r.post(
"https://studip.uni-trier.de/index.php?again=yes",
data=payload)
if "angemeldet" in login_start.text:
logger.debug(f"Password is valid")
return True
else:
logger.error(f"Wrong username and/or password")
return False
except AttributeError:
logger.debug("AttributeError, retrying login")
# weird cases where AttributeError gets thrown
validate_password(username, password)
def get_value(key: str) -> Union[bool, str]:
"""
:param key: key of json file
:return: value of key
"""
json_path = os.path.join(os.path.dirname(os.path.realpath(__file__)),
"aran_config.json")
if not os.path.exists(json_path):
logger.error("No config found")
logger.info("Setup begins")
create_json_config()
if os.path.exists(json_path):
logger.info(f"Successfully created config in {os.getcwd()}.")
logger.info("Starting the download")
else:
with open(json_path, "r") as file:
logger.debug("Succesfully opened the config file")
data = json.load(file)
if key == "maxSizeInMB":
return data["fileSettings"]["maxSizeInMB"]
elif key == "noDownload":
return data["fileSettings"]["noDownload"]
else:
return data[key]
def create_json_config() -> None:
"""
:return: saves into the json file
"""
data = {
"username":
"******",
"path":
"",
"replacements": {
"PART OF THE OLD NAME IN STUDIP": "NEW NAME FOR YOUR FILESYSTEM",
"e.g. Computer": "CS"
},
"fileSettings": {
"maxSizeInMB": 999999,
"noDownload": ["FILE-ENDING", "e.g. exe"]
},
"blacklist": [
"LINK TO A STUDIP FOLDER OR FILE",
"https://studip.uni-trier.de/dispatch.php/course/files/index/RANDOM DIGITS"
]
}
# username and password
def check_credentials():
logger.info("Enter your Studip username:"******"Enter your Studip password: "******"username"] = username
save_credentials(username, password)
check_credentials()
while not validate_password(data["username"],
get_credentials(data["username"])):
check_credentials()
# path
while not (os.path.exists(data["path"])):
logger.info(
"Enter the path where the files should be downloaded. If you need help, type \"help\"."
)
path = input()
if path == "help":
logger.debug("Entered \"help\" as path, opening GUI")
try:
import tkinter
from tkinter import filedialog
logger.debug("Opening Tkinter filedialog")
tkinter.Tk().withdraw()
path = filedialog.askdirectory()
except ImportError:
logger.error(
"Your Python version is missing Tkinter, it is not possible to open the GUI. Type "
"the path manually")
logger.debug(f"Entered {path} as path to save files to")
data["path"] = path
# convert into json data and save it
data_json = json.dumps(data, indent=4)
json_path = os.path.join(os.path.dirname(os.path.realpath(__file__)),
"aran_config.json")
with open(json_path, "w") as file:
logger.debug("Successfully opened the config file")
file.write(data_json)
logger.info(f"Successfully created a config in {json_path}!")
logger.info(
"Edit more settings (e.g. Blacklist or max file sizes) in this file and restart Aran!"
)
sys.exit(0)