1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
//! Low-level access to the host connection.
use std::sync::Arc;
use cookie::Cookie;
use futures::{stream, StreamExt, TryFutureExt, TryStream, TryStreamExt};
use hyper::{
body::{self, Bytes},
client::{connect::Connect, ResponseFuture},
header, Body, Client, HeaderMap, Request,
};
use thiserror::Error;
use crate::{
ids::{Course, Semester},
Career,
};
const USER_AGENT: &str = "ubs";
// TODO: remove excess queries from url
const FAKE1_URL: &str = "https://www.pub.hub.buffalo.edu/psc/csprdpub_1/EMPLOYEE/SA/c/SSR_STUDENT_FL.SSR_CLSRCH_MAIN_FL.GBL?Page=SSR_CLSRCH_MAIN_FL&pslnkid=CS_S201605302223124733554248&ICAJAXTrf=true&ICAJAX=1&ICMDTarget=start&ICPanelControlStyle=%20pst_side1-fixed%20pst_panel-mode%20";
const FAKE2_URL: &str ="https://www.pub.hub.buffalo.edu/psc/csprdpub_1/EMPLOYEE/SA/c/SSR_STUDENT_FL.SSR_CLSRCH_ES_FL.GBL?Page=SSR_CLSRCH_ES_FL&SEARCH_GROUP=SSR_CLASS_SEARCH_LFF&SEARCH_TEXT=gly%20105&ES_INST=UBFLO&ES_STRM=2231&ES_ADV=N&INVOKE_SEARCHAGAIN=PTSF_GBLSRCH_FLUID";
macro_rules! PAGE1_URL {
() => { "https://www.pub.hub.buffalo.edu/psc/csprdpub_3/EMPLOYEE/SA/c/SSR_STUDENT_FL.SSR_CRSE_INFO_FL.GBL?Page=SSR_CRSE_INFO_FL&Page=SSR_CS_WRAP_FL&CRSE_OFFER_NBR=1&INSTITUTION=UBFLO&CRSE_ID={}&STRM={}&ACAD_CAREER={}" };
}
const TOKEN1_URL: &str ="https://www.pub.hub.buffalo.edu/psc/csprdpub/EMPLOYEE/SA/c/NUI_FRAMEWORK.PT_LANDINGPAGE.GBL?tab=DEFAULT";
const TOKEN2_URL: &str ="https://www.pub.hub.buffalo.edu/psc/csprdpub/EMPLOYEE/SA/c/NUI_FRAMEWORK.PT_LANDINGPAGE.GBL?tab=DEFAULT&";
const TOKEN_COOKIE_NAME: &str = "psprd-8083-PORTAL-PSJSESSIONID";
/// Information about the course query.
#[derive(Debug, Clone)]
pub struct Query {
course: Course,
semester: Semester,
career: Career,
}
impl Query {
/// Construct a new [`Query`](Query).
pub fn new(course: Course, semester: Semester, career: Career) -> Self {
Self {
course,
semester,
career,
}
}
}
/// Manages the session to the host server.
pub struct Session<T> {
client: Client<T, Body>,
token: Token,
}
impl<T> Session<T> {
/// Construct a new [`Session`](Session).
pub fn new(client: Client<T, Body>, token: Token) -> Self {
Self { client, token }
}
}
impl<T> Session<T>
where
T: Connect + Clone + Send + Sync + 'static,
{
/// Iterate over pages of schedules with the specified [`Query`](Query).
pub fn schedule_iter(&self, query: Query) -> impl TryStream<Ok = Bytes, Error = SessionError> {
let client = self.client.clone();
let token = self.token.clone();
stream::iter(1..)
.then(move |page_num| {
// Cloning `client` and `token` above is to avoid having the closure live as long
// as `self`. Cloning again is necessary because new ownership is needed for each
// step in the iteration.
let client = client.clone();
let token = token.clone();
let query = query.clone(); // TODO: take query as an Arc?
// `async move` doesn't implement `Unpin`, thus it is necessary to manually pin it.
// TODO: simplify this
Box::pin(async move {
Ok(Self::get_page(client, token, query, page_num)
.await?
.await?)
})
})
.and_then(|response| Box::pin(body::to_bytes(response.into_body()).err_into()))
}
// async fn load_fakes() {}
// TODO: you MUST go page-by-page, otherwise it won't return the correct result?
/// Get specific page for query.
///
/// Note that this must be called incrementally, page-by-page.
async fn get_page(
client: Client<T, Body>,
token: Token,
query: Query,
page_num: u32,
) -> Result<ResponseFuture, SessionError> {
#[allow(clippy::never_loop)] // TODO: tem
loop {
match page_num {
1 => {
// TODO: I can separate the "get_page" functionality from the fake url
// TODO: fix boilerplate
client
.request(
Request::builder()
.uri(FAKE1_URL)
.header(header::COOKIE, token.as_str())
.body(Body::empty())?,
)
.await?;
client
.request(
Request::builder()
.uri(FAKE2_URL)
.header(header::COOKIE, token.as_str())
.body(Body::empty())?,
)
.await?;
let page = client.request(
Request::builder()
.uri(format!(
PAGE1_URL!(),
query.course.id(),
query.semester.id(),
query.career.id()
))
.header(header::USER_AGENT, USER_AGENT)
.header(header::COOKIE, token.as_str())
.header(header::COOKIE, "HttpOnly")
.header(header::COOKIE, "Path=/")
.body(Body::empty())?,
);
// TODO: do I need to send the fake result here (with ICState=2) for the next
// pages to load?
return Ok(page);
}
_ => {
// The second page has an `ICState` of 3.
let _page_num = page_num + 1;
// TODO: Multiple things to know about >1 pages:
// 1. Each page holds 50 groups max.
// 2. They are all POST requests with a slightly differing body (ICState and
// ICAction).
// 3. How I currently have it set up is not how it may actually work. Meaning,
// I know there is a second "phony" request, though invoking it does not
// seem to enable the next page to return the correct result. I'm either
// missing some minute detail in the request or I need to send more phony
// requests prior.
return Err(SessionError::PagesNotImplemented);
}
}
}
}
}
/// Contains a unique identifier for the current session.
#[derive(Debug, Clone)]
pub struct Token(Arc<str>);
impl Token {
/// Construct a new [`Token`](Token) with the specified [`Client`](Client).
pub async fn new<T>(client: &Client<T, Body>) -> Result<Self, SessionError>
where
T: Connect + Clone + Send + Sync + 'static,
{
// TODO: need to follow redirect returned by this URL, two ways to do this:
// 1. Make a loop and do some magic, hopefully it works.
// 2. Go to 1st redirect.
// 3. Just use reqwest.
let response = client
.request(
Request::builder()
.uri(TOKEN1_URL)
.header(header::USER_AGENT, USER_AGENT)
// TODO: may or may not need the httponly and path cookies
.body(Body::empty())?,
)
.await?;
let response = client
.request(
Request::builder()
.uri(TOKEN2_URL)
.header(header::USER_AGENT, USER_AGENT)
.header(
header::COOKIE,
Token::token_cookie(response.headers())
.ok_or(SessionError::TokenCookieNotFound)?
.to_string(),
)
// TODO: may or may not need the httponly and path cookies
.body(Body::empty())?,
)
.await?;
Ok(Self(Arc::from(
Token::token_cookie(response.headers())
.ok_or(SessionError::TokenCookieNotFound)?
.to_string(),
)))
}
/// Convert the token to its string form.
fn as_str(&self) -> &str {
&self.0
}
/// Fetch the [`Cookie`](Cookie) object from the specified headers.
fn token_cookie(headers: &HeaderMap) -> Option<Cookie<'_>> {
headers
.get_all(header::SET_COOKIE)
.iter()
// TODO: collect errors and return them if no cookie was found
// If it can't be parsed then skip it
.filter_map(|string| {
string
.to_str()
.ok()
.and_then(|raw_cookie| Cookie::parse(raw_cookie).ok())
})
.find(|cookie| cookie.name() == TOKEN_COOKIE_NAME)
}
}
/// Error while fetching course data.
#[derive(Debug, Error)]
pub enum SessionError {
/// An argument to build the HTTP request was invalid.
/// See more [here](https://docs.rs/http/0.2.8/http/request/struct.Builder.html#errors)
#[error("an argument while building an HTTP request was invalid")]
MalformedHttpArgs(#[from] hyper::http::Error),
/// Failed to send HTTP request.
#[error(transparent)]
HttpRequestFailed(#[from] hyper::Error),
/// Attempt to parse a cookie with an invalid format.
#[error("could not parse cookie with an invalid format")]
MalformedCookie(#[from] cookie::ParseError),
// TODO: provide cookie parsing errors
/// Could not find or parse the token cookie.
#[error("could not find or parse the token cookie")]
TokenCookieNotFound,
/// More than one page has not yet been implemented.
#[error("more than one page has not been implemented")]
PagesNotImplemented,
}