CourseSelectionParser.java

/**
 * @(#) CourseSelectionParser.java
 *
 * This file is part of the Course Scheduler, an open source, cross platform
 * course scheduling tool, configurable for most universities.
 *
 * Copyright (C) 2010-2014 Devyse.io; All rights reserved.
 *
 * @license GNU General Public License version 3 (GPLv3)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see http://www.gnu.org/licenses/.
 */
package io.devyse.scheduler.parse.jsoup.banner;

import io.devyse.scheduler.parse.jsoup.FormParser;

import java.util.ArrayList;
import java.util.Collection;

import org.jsoup.Connection;
import org.jsoup.Connection.KeyVal;
import org.jsoup.helper.HttpConnection;
import org.jsoup.nodes.Document;
import org.jsoup.nodes.Element;
import org.jsoup.nodes.FormElement;
import org.jsoup.select.Elements;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;

/**
 * JSoup FormParser which processes a Banner course selection page and
 * submits the form to retrieve course data for the courses corresponding
 * to the inputs into the course selection form.
 * 
 * @author Mike Reinhold
 * @since 4.12.4
 */
public class CourseSelectionParser extends FormParser {

	/**
	 * Static logger
	 */
	private static XLogger logger = XLoggerFactory.getXLogger(CourseSelectionParser.class);
	
	/**
	 * Serial Version UID
	 */
	private static final long serialVersionUID = 1L;
	
	/**
	 * Create a new CourseSelectionParser based on the specified document,
	 * which should contain a form from Banner for selecting course data.
	 * 
	 * @param document the document from which to parse course selections
	 * @param timeout the socket connection timeout which should be used 
	 */
	public CourseSelectionParser(Document document, int timeout) {
		super(document, timeout);
	}

	/* (non-Javadoc)
	 * @see io.devyse.scheduler.parse.jsoup.FormParser#buildFormParameters(org.jsoup.nodes.FormElement, org.jsoup.Connection)
	 */
	@Override
	protected Collection<KeyVal> buildFormParameters(FormElement form, Connection connection){
		Collection<KeyVal> data = new ArrayList<>();

		//for some reason the jsoup prepare builds out the sel_day fields when the web form does not when using a browser
		//unless this is run wide open it only seems to match a small set of courses, possibly due to "AND"-like behavior
		//on the day selection evaluation
		Collection<Connection.KeyVal> toRemove = new ArrayList<>();
		for(Connection.KeyVal entry: connection.request().data()){
			if(entry.key().equals("sel_day") && !entry.value().equals("dummy")){
				toRemove.add(entry);
			}
		}
		connection.request().data().removeAll(toRemove);
				
		//add in the subject selection options
		Elements subjects = form.select("select#subj_id option");
		for(Element subject: subjects){
			logger.debug("sel_subj: {} - {}", subject.attr("value"), subject.text());
			data.add(HttpConnection.KeyVal.create("sel_subj", subject.attr("value")));
		}
		
		//add in the hour restriction options
		//TODO pull these automatically
		data.add(HttpConnection.KeyVal.create("begin_hh", "0"));
		data.add(HttpConnection.KeyVal.create("begin_mi", "0"));
		data.add(HttpConnection.KeyVal.create("begin_ap", "a"));
		data.add(HttpConnection.KeyVal.create("end_hh", "0"));
		data.add(HttpConnection.KeyVal.create("end_mi", "0"));
		data.add(HttpConnection.KeyVal.create("end_ap", "a"));

		return data;
	}
}