mirror of
https://github.com/Code-For-Groningen/temmies.git
synced 2025-07-01 11:34:58 +02:00
Compare commits
7 Commits
213a4d5471
...
main
Author | SHA1 | Date | |
---|---|---|---|
c9a2e1f456 | |||
0ed744dff8 | |||
03a1fd1b33 | |||
813519f642 | |||
edabec3e7c | |||
194daf89eb | |||
172e2a0ebf |
@ -15,7 +15,7 @@ A python library which interacts with [Themis](https://themis.housing.rug.nl/).
|
|||||||
* [x] Submission status
|
* [x] Submission status
|
||||||
|
|
||||||
## Docs
|
## Docs
|
||||||
- [here](http://temmies.confest.im/).
|
- [Click here](http://temmies.confest.im/).
|
||||||
|
|
||||||
## Possible continuations
|
## Possible continuations
|
||||||
* Discord bot
|
* Discord bot
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
attrs==25.1.0
|
||||||
beautifulsoup4==4.12.3
|
beautifulsoup4==4.12.3
|
||||||
bs4==0.0.2
|
bs4==0.0.2
|
||||||
certifi==2024.8.30
|
certifi==2024.8.30
|
||||||
@ -15,5 +16,6 @@ more-itertools==10.5.0
|
|||||||
pycparser==2.22
|
pycparser==2.22
|
||||||
requests==2.32.3
|
requests==2.32.3
|
||||||
SecretStorage==3.3.3
|
SecretStorage==3.3.3
|
||||||
|
selenium==4.28.1
|
||||||
soupsieve==2.6
|
soupsieve==2.6
|
||||||
urllib3==2.2.3
|
urllib3==2.2.3
|
||||||
|
5
setup.py
5
setup.py
@ -5,7 +5,7 @@ with open("README.md", "r") as f:
|
|||||||
|
|
||||||
setup(
|
setup(
|
||||||
name="temmies",
|
name="temmies",
|
||||||
version="1.2.121",
|
version="1.2.124",
|
||||||
packages=find_packages(),
|
packages=find_packages(),
|
||||||
description="A wrapper for the Themis website",
|
description="A wrapper for the Themis website",
|
||||||
long_description=l_description,
|
long_description=l_description,
|
||||||
@ -25,7 +25,8 @@ setup(
|
|||||||
"requests",
|
"requests",
|
||||||
"lxml",
|
"lxml",
|
||||||
"beautifulsoup4",
|
"beautifulsoup4",
|
||||||
"keyring"
|
"keyring",
|
||||||
|
"selenium",
|
||||||
],
|
],
|
||||||
python_requires=">=3.9",
|
python_requires=">=3.9",
|
||||||
)
|
)
|
@ -2,12 +2,18 @@
|
|||||||
Main class for the Themis API using the new JSON endpoints.
|
Main class for the Themis API using the new JSON endpoints.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
from requests import Session
|
||||||
|
from selenium import webdriver
|
||||||
|
from selenium.webdriver.support.ui import WebDriverWait
|
||||||
|
from selenium.webdriver.support import expected_conditions as EC
|
||||||
|
from selenium.common.exceptions import TimeoutException
|
||||||
|
|
||||||
|
from selenium.webdriver.common.by import By
|
||||||
|
from selenium.common.exceptions import NoSuchElementException, StaleElementReferenceException
|
||||||
|
from json import dumps
|
||||||
|
from .year import Year
|
||||||
import getpass
|
import getpass
|
||||||
import keyring
|
import keyring
|
||||||
from requests import Session
|
|
||||||
from bs4 import BeautifulSoup
|
|
||||||
from .year import Year
|
|
||||||
|
|
||||||
|
|
||||||
class Themis:
|
class Themis:
|
||||||
"""
|
"""
|
||||||
@ -17,7 +23,7 @@ class Themis:
|
|||||||
- all_years: Get all years
|
- all_years: Get all years
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(self, user: str):
|
def __init__(self, cookies: dict = None, user=None):
|
||||||
"""
|
"""
|
||||||
Initialize Themis object, logging in with the given user.
|
Initialize Themis object, logging in with the given user.
|
||||||
|
|
||||||
@ -30,12 +36,25 @@ class Themis:
|
|||||||
base_url (str): Base URL of the Themis website.
|
base_url (str): Base URL of the Themis website.
|
||||||
session (requests.Session): Authenticated session.
|
session (requests.Session): Authenticated session.
|
||||||
"""
|
"""
|
||||||
self.user = user
|
|
||||||
self.password = self.__get_password()
|
|
||||||
self.base_url = "https://themis.housing.rug.nl"
|
self.base_url = "https://themis.housing.rug.nl"
|
||||||
self.session = self.login(self.user, self.password)
|
self.session = self._setup_agent()
|
||||||
|
|
||||||
def __get_password(self) -> str:
|
self.user, self.password = None, None
|
||||||
|
|
||||||
|
# Old login logic
|
||||||
|
if user:
|
||||||
|
self.user = user
|
||||||
|
self.password = self._get_password()
|
||||||
|
|
||||||
|
# Reusing session logic
|
||||||
|
if not cookies:
|
||||||
|
self.session = self.login(self.session)
|
||||||
|
else:
|
||||||
|
self.session.cookies.update(cookies)
|
||||||
|
if not self.check_session():
|
||||||
|
self.session = self.login(self.session)
|
||||||
|
|
||||||
|
def _get_password(self) -> str:
|
||||||
"""
|
"""
|
||||||
Retrieve the password from the keyring, prompting the user if not found.
|
Retrieve the password from the keyring, prompting the user if not found.
|
||||||
"""
|
"""
|
||||||
@ -48,12 +67,9 @@ class Themis:
|
|||||||
print("Password saved securely in keyring.")
|
print("Password saved securely in keyring.")
|
||||||
return password
|
return password
|
||||||
|
|
||||||
def login(self, user: str, passwd: str) -> Session:
|
def _setup_agent(self) -> Session:
|
||||||
"""
|
|
||||||
Login to Themis using the original method, parsing CSRF token from the login page.
|
|
||||||
"""
|
|
||||||
session = Session()
|
session = Session()
|
||||||
login_url = f"{self.base_url}/log/in"
|
|
||||||
|
|
||||||
user_agent = (
|
user_agent = (
|
||||||
"Mozilla/5.0 (X11; Linux x86_64) "
|
"Mozilla/5.0 (X11; Linux x86_64) "
|
||||||
@ -61,38 +77,73 @@ class Themis:
|
|||||||
"Chromium/80.0.3987.160 Chrome/80.0.3987.163 Safari/537.36"
|
"Chromium/80.0.3987.160 Chrome/80.0.3987.163 Safari/537.36"
|
||||||
)
|
)
|
||||||
|
|
||||||
headers = {"user-agent": user_agent}
|
session.headers.update({"User-Agent": user_agent})
|
||||||
|
|
||||||
data = {"user": user, "password": passwd, "null": None}
|
|
||||||
|
|
||||||
# Get login page to retrieve CSRF token
|
|
||||||
response = session.get(login_url, headers=headers, verify=False)
|
|
||||||
if response.status_code != 200:
|
|
||||||
raise ConnectionError("Failed to connect to Themis login page.")
|
|
||||||
|
|
||||||
# Parse CSRF token from login page
|
|
||||||
soup = BeautifulSoup(response.text, "lxml")
|
|
||||||
csrf_input = soup.find("input", attrs={"name": "_csrf"})
|
|
||||||
if not csrf_input or not csrf_input.get("value"):
|
|
||||||
raise ValueError("Unable to retrieve CSRF token.")
|
|
||||||
csrf_token = csrf_input["value"]
|
|
||||||
data["_csrf"] = csrf_token
|
|
||||||
data["sudo"] = user.lower()
|
|
||||||
|
|
||||||
# Attempt login
|
|
||||||
response = session.post(login_url, data=data, headers=headers)
|
|
||||||
if "Invalid credentials" in response.text:
|
|
||||||
# Prompt for password again
|
|
||||||
print("Invalid credentials. Please try again.")
|
|
||||||
passwd = getpass.getpass(prompt="Enter password: ")
|
|
||||||
keyring.set_password(f'{self.user}-temmies', self.user, passwd)
|
|
||||||
return self.login(user, passwd)
|
|
||||||
|
|
||||||
if "Welcome, logged in as" not in response.text:
|
|
||||||
raise ValueError("Login failed for an unknown reason.")
|
|
||||||
|
|
||||||
return session
|
return session
|
||||||
|
|
||||||
|
def check_session(self) -> bool:
|
||||||
|
"""
|
||||||
|
Check if the session is still valid.
|
||||||
|
"""
|
||||||
|
|
||||||
|
# look at the /login and find a pre tag
|
||||||
|
login_url = f"{self.base_url}/login"
|
||||||
|
response = self.session.get(login_url)
|
||||||
|
return "pre" in response.text
|
||||||
|
|
||||||
|
|
||||||
|
def login(self, session: Session) -> Session:
|
||||||
|
"""
|
||||||
|
Login to Themis by spawning a selenium browser
|
||||||
|
"""
|
||||||
|
login_url = f"{self.base_url}/login"
|
||||||
|
driver = webdriver.Chrome()
|
||||||
|
|
||||||
|
driver.get(login_url)
|
||||||
|
|
||||||
|
wait = WebDriverWait(driver, 60)
|
||||||
|
|
||||||
|
try:
|
||||||
|
wait.until(EC.url_contains("signon.rug.nl/nidp/saml2/sso"))
|
||||||
|
current_url = driver.current_url
|
||||||
|
|
||||||
|
# If on the sign-on page fill in the credentials
|
||||||
|
if "signon.rug.nl/nidp/saml2/sso" in current_url:
|
||||||
|
user_field = wait.until(EC.presence_of_element_located((By.NAME, "Ecom_User_ID")))
|
||||||
|
pass_field = wait.until(EC.presence_of_element_located((By.NAME, "Ecom_Password")))
|
||||||
|
|
||||||
|
if self.user and not user_field.get_attribute("value"):
|
||||||
|
user_field.clear()
|
||||||
|
user_field.send_keys(self.user)
|
||||||
|
if self.password and not pass_field.get_attribute("value"):
|
||||||
|
pass_field.clear()
|
||||||
|
pass_field.send_keys(self.password)
|
||||||
|
|
||||||
|
# THIS IS LIKELY TO BREAK AT SOME POINT
|
||||||
|
wait.until(EC.text_to_be_present_in_element((By.TAG_NAME, "body"), "Cannot GET"))
|
||||||
|
|
||||||
|
except TimeoutException:
|
||||||
|
print("Timeout waiting for login/2FA page to load.")
|
||||||
|
except (NoSuchElementException, StaleElementReferenceException) as e:
|
||||||
|
print(f"Encountered an error: {e}")
|
||||||
|
finally:
|
||||||
|
# security
|
||||||
|
self.password = "I-HAVE-BEEN-REMOVED"
|
||||||
|
cookies = driver.get_cookies()
|
||||||
|
driver.quit()
|
||||||
|
|
||||||
|
# Add all cookies to the session.
|
||||||
|
for cookie in cookies:
|
||||||
|
session.cookies.set(name=cookie["name"], value=cookie["value"])
|
||||||
|
|
||||||
|
return session
|
||||||
|
|
||||||
|
def get_session_cookies(self):
|
||||||
|
"""
|
||||||
|
Get the session cookies in json
|
||||||
|
"""
|
||||||
|
return dumps(self.session.cookies.get_dict())
|
||||||
|
|
||||||
def get_year(self, start_year: int = None, end_year: int = None) -> Year:
|
def get_year(self, start_year: int = None, end_year: int = None) -> Year:
|
||||||
"""
|
"""
|
||||||
Gets a Year object using the year path (e.g., 2023, 2024).
|
Gets a Year object using the year path (e.g., 2023, 2024).
|
||||||
|
Reference in New Issue
Block a user