banner/internal/api/api.go

package api

import (
	"banner/internal/config"
	"banner/internal/models"
	"banner/internal/utils"
	"context"
	"encoding/json"
	"errors"
	"fmt"
	"net/url"
	"strconv"
	"strings"

	"time"

	"github.com/redis/go-redis/v9"
	"github.com/rs/zerolog/log"
	"github.com/samber/lo"
	"resty.dev/v3"
)

type API struct {
	config *config.Config
}

func New(config *config.Config) *API {
	return &API{config: config}
}

var (
	latestSession string
	sessionTime   time.Time
	expiryTime    = 25 * time.Minute
)

// SessionMiddleware creates a Resty middleware that resets the session timer on each Banner API call.
func SessionMiddleware(c *resty.Client, r *resty.Response) error {
	// log.Debug().Str("url", r.Request.RawRequest.URL.Path).Msg("Session middleware")

	// Reset session timer on successful requests to Banner API endpoints
	if r.IsSuccess() && strings.HasPrefix(r.Request.RawRequest.URL.Path, "StudentRegistrationSsb/ssb/classSearch/") {
		// Only reset the session time if the session is still valid
		if time.Since(sessionTime) <= expiryTime {
			sessionTime = time.Now()
		}
	}
	return nil
}

// GenerateSession generates a new session ID (nonce) for use with the Banner API.
// Don't use this function directly, use GetSession instead.
func GenerateSession() string {
	return utils.RandomString(5) + utils.Nonce()
}

var terms []BannerTerm
var lastTermUpdate time.Time

// TryReloadTerms attempts to reload the terms if they are not loaded or the last update was more than 24 hours ago
func (a *API) TryReloadTerms() error {
	if len(terms) > 0 && time.Since(lastTermUpdate) < 24*time.Hour {
		return nil
	}

	// Load the terms
	var err error
	terms, err = a.GetTerms("", 1, 100)
	if err != nil {
		return fmt.Errorf("failed to load terms: %w", err)
	}

	lastTermUpdate = time.Now()
	return nil
}

// IsTermArchived checks if the given term is archived
// TODO: Add error, switch missing term logic to error
func (a *API) IsTermArchived(term string) bool {
	// Ensure the terms are loaded
	err := a.TryReloadTerms()
	if err != nil {
		log.Err(err).Stack().Msg("Failed to reload terms")
		return true
	}

	// Check if the term is in the list of terms
	bannerTerm, exists := lo.Find(terms, func(t BannerTerm) bool {
		return t.Code == term
	})

	if !exists {
		log.Warn().Str("term", term).Msg("Term does not exist")
		return true
	}

	return bannerTerm.Archived()
}

// EnsureSession ensures that a valid session is available, creating one if necessary.
func (a *API) EnsureSession() string {
	if latestSession == "" || time.Since(sessionTime) >= expiryTime {
		latestSession = GenerateSession()
		sessionTime = time.Now()
	}
	return latestSession
}

type Pair struct {
	Code        string `json:"code"`
	Description string `json:"description"`
}

type BannerTerm Pair
type Instructor Pair

// Archived returns true if the term is in it's archival state (view only)
func (term BannerTerm) Archived() bool {
	return strings.Contains(term.Description, "View Only")
}

// GetTerms retrieves and parses the term information for a given search term.
// Page number must be at least 1.
func (a *API) GetTerms(search string, page int, maxResults int) ([]BannerTerm, error) {
	// Ensure offset is valid
	if page <= 0 {
		return nil, errors.New("offset must be greater than 0")
	}

	req := a.config.Client.NewRequest().
		SetQueryParam("searchTerm", search).
		SetQueryParam("offset", strconv.Itoa(page)).
		SetQueryParam("max", strconv.Itoa(maxResults)).
		SetQueryParam("_", utils.Nonce()).
		SetExpectResponseContentType("application/json").
		SetResult(&[]BannerTerm{})

	res, err := req.Get("/classSearch/getTerms")
	if err != nil {
		return nil, fmt.Errorf("failed to get terms: %w", err)
	}

	terms, ok := res.Result().(*[]BannerTerm)
	if !ok {
		return nil, fmt.Errorf("terms parsing failed to cast: %v", res.Result())
	}

	return *terms, nil
}

// SelectTerm selects the given term in the Banner system.
// This function completes the initial term selection process, which is required before any other API calls can be made with the session ID.
func (a *API) SelectTerm(term string, sessionID string) error {
	form := url.Values{
		"term":            {term},
		"studyPath":       {""},
		"studyPathText":   {""},
		"startDatepicker": {""},
		"endDatepicker":   {""},
		"uniqueSessionId": {sessionID},
	}

	type RedirectResponse struct {
		FwdURL string `json:"fwdUrl"`
	}

	req := a.config.Client.NewRequest().
		SetResult(&RedirectResponse{}).
		SetQueryParam("mode", "search").
		SetBody(form.Encode()).
		SetExpectResponseContentType("application/json").
		SetHeader("Content-Type", "application/x-www-form-urlencoded")

	res, err := req.Post("/term/search")
	if err != nil {
		return fmt.Errorf("failed to select term: %w", err)
	}

	redirectResponse := res.Result().(*RedirectResponse)

	// TODO: Mild validation to ensure the redirect is appropriate

	// Make a GET request to the fwdUrl
	req = a.config.Client.NewRequest()
	res, err = req.Get(redirectResponse.FwdURL)

	// Assert that the response is OK (200)
	if res.StatusCode() != 200 {
		return fmt.Errorf("redirect response was not OK: %d", res.StatusCode())
	}

	return nil
}

// GetPartOfTerms retrieves and parses the part of term information for a given term.
// Ensure that the offset is greater than 0.
func (a *API) GetPartOfTerms(search string, term int, offset int, maxResults int) ([]BannerTerm, error) {
	// Ensure offset is valid
	if offset <= 0 {
		return nil, errors.New("offset must be greater than 0")
	}

	req := a.config.Client.NewRequest().
		SetQueryParam("searchTerm", search).
		SetQueryParam("term", strconv.Itoa(term)).
		SetQueryParam("offset", strconv.Itoa(offset)).
		SetQueryParam("max", strconv.Itoa(maxResults)).
		SetQueryParam("uniqueSessionId", a.EnsureSession()).
		SetQueryParam("_", utils.Nonce()).
		SetExpectResponseContentType("application/json").
		SetResult(&[]BannerTerm{})

	res, err := req.Get("/classSearch/get_partOfTerm")
	if err != nil {
		return nil, fmt.Errorf("failed to get part of terms: %w", err)
	}

	terms, ok := res.Result().(*[]BannerTerm)
	if !ok {
		return nil, fmt.Errorf("term parsing failed to cast: %v", res.Result())
	}

	return *terms, nil
}

// GetInstructors retrieves and parses the instructor information for a given search term.
// In my opinion, it is unclear what providing the term does, as the results should be the same regardless of the term.
// This function is included for completeness, but probably isn't useful.
// Ensure that the offset is greater than 0.
func (a *API) GetInstructors(search string, term string, offset int, maxResults int) ([]Instructor, error) {
	// Ensure offset is valid
	if offset <= 0 {
		return nil, errors.New("offset must be greater than 0")
	}

	req := a.config.Client.NewRequest().
		SetQueryParam("searchTerm", search).
		SetQueryParam("term", term).
		SetQueryParam("offset", strconv.Itoa(offset)).
		SetQueryParam("max", strconv.Itoa(maxResults)).
		SetQueryParam("uniqueSessionId", a.EnsureSession()).
		SetQueryParam("_", utils.Nonce()).
		SetExpectResponseContentType("application/json").
		SetResult(&[]Instructor{})

	res, err := req.Get("/classSearch/get_instructor")
	if err != nil {
		return nil, fmt.Errorf("failed to get instructors: %w", err)
	}

	instructors, ok := res.Result().(*[]Instructor)
	if !ok {
		return nil, fmt.Errorf("instructor parsing failed to cast: %v", res.Result())
	}

	return *instructors, nil
}

// ClassDetails represents the details of a course.
// TODO: Finish this struct & function
type ClassDetails struct {
}

func (a *API) GetCourseDetails(term int, crn int) (*ClassDetails, error) {
	body, err := json.Marshal(map[string]string{
		"term":                  strconv.Itoa(term),
		"courseReferenceNumber": strconv.Itoa(crn),
		"first":                 "first", // TODO: What is this?
	})
	if err != nil {
		log.Fatal().Stack().Err(err).Msg("Failed to marshal body")
	}

	req := a.config.Client.NewRequest().
		SetBody(body).
		SetExpectResponseContentType("application/json").
		SetResult(&ClassDetails{})

	res, err := req.Get("/searchResults/getClassDetails")
	if err != nil {
		return nil, fmt.Errorf("failed to get course details: %w", err)
	}

	details, ok := res.Result().(*ClassDetails)
	if !ok {
		return nil, fmt.Errorf("course details parsing failed to cast: %v", res.Result())
	}

	return details, nil
}

// Search invokes a search on the Banner system with the given query and returns the results.
func (a *API) Search(term string, query *Query, sort string, sortDescending bool) (*models.SearchResult, error) {
	a.ResetDataForm()

	params := query.Paramify()

	params["txt_term"] = term
	params["uniqueSessionId"] = a.EnsureSession()
	params["sortColumn"] = sort
	params["sortDirection"] = "asc"

	// These dates are not available for usage anywhere in the UI, but are included in every query
	params["startDatepicker"] = ""
	params["endDatepicker"] = ""

	req := a.config.Client.NewRequest().
		SetQueryParams(params).
		SetExpectResponseContentType("application/json").
		SetResult(&models.SearchResult{})

	res, err := req.Get("/searchResults/searchResults")
	if err != nil {
		return nil, fmt.Errorf("failed to search: %w", err)
	}

	searchResult, ok := res.Result().(*models.SearchResult)
	if !ok {
		return nil, fmt.Errorf("search result parsing failed to cast: %v", res.Result())
	}

	return searchResult, nil
}

// GetSubjects retrieves and parses the subject information for a given search term.
// The results of this response shouldn't change much, but technically could as new majors are developed, or old ones are removed.
// Ensure that the offset is greater than 0.
func (a *API) GetSubjects(search string, term string, offset int, maxResults int) ([]Pair, error) {
	// Ensure offset is valid
	if offset <= 0 {
		return nil, errors.New("offset must be greater than 0")
	}

	req := a.config.Client.NewRequest().
		SetQueryParam("searchTerm", search).
		SetQueryParam("term", term).
		SetQueryParam("offset", strconv.Itoa(offset)).
		SetQueryParam("max", strconv.Itoa(maxResults)).
		SetQueryParam("uniqueSessionId", a.EnsureSession()).
		SetQueryParam("_", utils.Nonce()).
		SetExpectResponseContentType("application/json").
		SetResult(&[]Pair{})

	res, err := req.Get("/classSearch/get_subject")
	if err != nil {
		return nil, fmt.Errorf("failed to get subjects: %w", err)
	}

	subjects, ok := res.Result().(*[]Pair)
	if !ok {
		return nil, fmt.Errorf("subjects parsing failed to cast: %v", res.Result())
	}

	return *subjects, nil
}

// GetCampuses retrieves and parses the campus information for a given search term.
// In my opinion, it is unclear what providing the term does, as the results should be the same regardless of the term.
// This function is included for completeness, but probably isn't useful.
// Ensure that the offset is greater than 0.
func (a *API) GetCampuses(search string, term int, offset int, maxResults int) ([]Pair, error) {
	// Ensure offset is valid
	if offset <= 0 {
		return nil, errors.New("offset must be greater than 0")
	}

	req := a.config.Client.NewRequest().
		SetQueryParam("searchTerm", search).
		SetQueryParam("term", strconv.Itoa(term)).
		SetQueryParam("offset", strconv.Itoa(offset)).
		SetQueryParam("max", strconv.Itoa(maxResults)).
		SetQueryParam("uniqueSessionId", a.EnsureSession()).
		SetQueryParam("_", utils.Nonce()).
		SetExpectResponseContentType("application/json").
		SetResult(&[]Pair{})

	res, err := req.Get("/classSearch/get_campus")
	if err != nil {
		return nil, fmt.Errorf("failed to get campuses: %w", err)
	}

	campuses, ok := res.Result().(*[]Pair)
	if !ok {
		return nil, fmt.Errorf("campuses parsing failed to cast: %v", res.Result())
	}

	return *campuses, nil
}

// GetInstructionalMethods retrieves and parses the instructional method information for a given search term.
// In my opinion, it is unclear what providing the term does, as the results should be the same regardless of the term.
// This function is included for completeness, but probably isn't useful.
// Ensure that the offset is greater than 0.
func (a *API) GetInstructionalMethods(search string, term string, offset int, maxResults int) ([]Pair, error) {
	// Ensure offset is valid
	if offset <= 0 {
		return nil, errors.New("offset must be greater than 0")
	}

	req := a.config.Client.NewRequest().
		SetQueryParam("searchTerm", search).
		SetQueryParam("term", term).
		SetQueryParam("offset", strconv.Itoa(offset)).
		SetQueryParam("max", strconv.Itoa(maxResults)).
		SetQueryParam("uniqueSessionId", a.EnsureSession()).
		SetQueryParam("_", utils.Nonce()).
		SetExpectResponseContentType("application/json").
		SetResult(&[]Pair{})

	res, err := req.Get("/classSearch/get_instructionalMethod")
	if err != nil {
		return nil, fmt.Errorf("failed to get instructional methods: %w", err)
	}

	methods, ok := res.Result().(*[]Pair)
	if !ok {
		return nil, fmt.Errorf("instructional methods parsing failed to cast: %v", res.Result())
	}
	return *methods, nil
}

// GetCourseMeetingTime retrieves the meeting time information for a course based on the given term and course reference number (CRN).
// It makes an HTTP GET request to the appropriate API endpoint and parses the response to extract the meeting time data.
// The function returns a MeetingTimeResponse struct containing the extracted information.
func (a *API) GetCourseMeetingTime(term int, crn int) ([]models.MeetingTimeResponse, error) {
	req := a.config.Client.NewRequest().
		SetQueryParam("term", strconv.Itoa(term)).
		SetQueryParam("courseReferenceNumber", strconv.Itoa(crn)).
		SetExpectResponseContentType("application/json").
		SetResult(&[]models.MeetingTimeResponse{})

	res, err := req.Get("/searchResults/getFacultyMeetingTimes")
	if err != nil {
		return nil, fmt.Errorf("failed to get meeting time: %w", err)
	}

	meetingTimes, ok := res.Result().(*[]models.MeetingTimeResponse)
	if !ok {
		return nil, fmt.Errorf("meeting times parsing failed to cast: %v", res.Result())
	}

	return *meetingTimes, nil
}

// ResetDataForm makes a POST request that needs to be made upon before new search requests can be made.
func (a *API) ResetDataForm() {
	req := a.config.Client.NewRequest()

	_, err := req.Post("/classSearch/resetDataForm")
	if err != nil {
		log.Fatal().Stack().Err(err).Msg("Failed to reset data form")
	}
}

// GetCourse retrieves the course information.
// This course does not retrieve directly from the API, but rather uses scraped data stored in Redis.
func (a *API) GetCourse(crn string) (*models.Course, error) {
	// Create a timeout context for Redis operations
	ctx, cancel := context.WithTimeout(a.config.Ctx, 5*time.Second)
	defer cancel()

	// Retrieve raw data
	result, err := a.config.KV.Get(ctx, fmt.Sprintf("class:%s", crn)).Result()
	if err != nil {
		if err == redis.Nil {
			return nil, fmt.Errorf("course not found: %w", err)
		}
		return nil, fmt.Errorf("failed to get course: %w", err)
	}

	// Unmarshal the raw data
	var course models.Course
	err = json.Unmarshal([]byte(result), &course)
	if err != nil {
		return nil, fmt.Errorf("failed to unmarshal course: %w", err)
	}

	return &course, nil
}