/* -*- tab-width: 4; -*-
* Copyright 2010 Nathan Gelderloos, Ethan Zonca, Nathan Phillip Brink
*
* This file is part of SlatePermutate.
*
* SlatePermutate is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* SlatePermutate 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with SlatePermutate. If not, see .
*/
//--------------------------------------------------
// General Notes
//--------------------------------------------------
/**
* \brief
* The next course_i value that will be produced when add_class() is
* called.
*
* If iterating through all of the possible courses, use (classNum -
* 1) as the upper bound.
*/
var classNum = 0;
/**
* \brief
* The number of section entries for a given course.
*
* Key is course_i, value is the current number of sections.
*/
var sectionsOfClass = new Array();
/**
* \brief
* Help to generate a unique section identifier for each section
* added to a given course.
*
* Necessary to support PHP-style post array thingies, like
* classes[0][1][$x] would be all of the data for course_i=0,
* section_i=1, variable $x (ex. day of week, start time, end time,
* teacher). We can't have two sections for a given course using the
* same section_i because those values would override eachother.
*/
var last_section_i = 0;
/**
* \brief
* A quick hash to prevent there from being two AJAX requests for a
* given course at one time.
*/
var course_ajax_requests = [];
/**
* \brief
* The course number which contains nothing.
*
* To avoid having a user need to click the ``Add course'' button, we
* keep a course added at the end of the list of courses. If this
* variable is -1, it indicates that no such free course exists. If it
* is zero or greater, that number is the class which is the free one.
*/
var slate_permutate_course_free = -1;
/**
* \brief
* Whether or not we should divulge the existence of course slots to
* the user.
*
* This will automatically be set to true as soon as a course
* utilizing multiple slots is added using autocomplete.
*/
var show_course_slots = false;
/*
* General Input Functions
*/
/**
* Outputs an element. It will inlcude selected="selected"
* if the value param equals the test_value param.
*/
function genOptionHtml(value, content, test_value)
{
var selected = ' selected="selected"';
if (value != test_value)
selected = '';
return '\n";
}
/** Add tooltips for user guidance */
function addTips()
{
var tr = jQuery('tr');
var td = tr.eq(tr.length-1);
/* slate_permutate_example_course_id is set globally in input.php. */
jQuery('td:first', td).qtip(
{
content: 'Start typing your class ID (such as ' + slate_permutate_example_course_id + ') and click a suggestion to add sections',
style: {
tip: true,
classes: "ui-tooltip-dark ui-tooltip-shadow ui-tooltip-rounded"
},
show: {
ready: true
},
position:{
my: 'top left',
at: 'bottom right'
}
}
);
}
/**
* \brief
* Add a section to a class.
*/
function add_section_n(cnum, name, synonym, stime, etime, days, instructor, location, type, slot, credit_hours)
{
var snum = last_section_i ++;
var cssclasses = 'section class' + cnum + ' ' + safe_css_class('slot-' + slot);
var last_tr;
/*
* Add the type of the course to the CSS if it's a valid (and
* _clean-looking_ CSS class). Supports things like Cedarville's
* coloration of labs/ILB.
*/
if (/[a-z-]+/.exec(type) != null)
cssclasses += ' type-' + type;
var section_html = '
' +
'
' +
' ' +
' ' +
'
' +
'
' +
'
\
\
\
\
\
\
\
' +
'
' +
'' +
'' +
'' +
'
';
/*
* Try to append this section to the last section in its
* associated CourseSlot...
*/
last_tr = jQuery('tr.class' + cnum + '.' + safe_css_class('slot-' + slot) + ':last');
if (!last_tr.length)
{
/* Also append a a new ``we are this slot'' row... */
course_add_slot_row(cnum, slot);
last_tr = jQuery('tr.class' + cnum + ':last');
}
last_tr.after(section_html);
sectionsOfClass[cnum] ++;
var section_tr = jQuery('#tr-section-' + String(snum));
/* store course_i in a place the newly added section will look for it */
section_tr.data({course_i: cnum});
/*
* Store data into the newly created HTML. With this method we
* have to _avoid_ escaping entities in the text we're setting as
* values because the DOM stuff will escape it for us.
*/
section_tr.find('.section-letter-entry').val(name);
section_tr.find('.section-synonym-entry').val(synonym);
section_tr.find('.section-slot-entry').val(slot);
section_tr.find('.profName').val(instructor);
section_tr.find('.section-location-entry').val(location);
section_tr.find('.section-type-entry').val(type);
section_tr.find('.section-credit-hours-entry').val(credit_hours);
/* unhide the saturday columns if it's used by autocomplete data */
if (days.s)
jQuery('#jsrows col.saturday').removeClass('collapsed');
credit_hours_change(cnum);
return last_section_i - 1;
}
function add_section(cnum)
{
var section_i = add_section_n(cnum, '', '', '', '', {m: false, t: false, w: false, h: false, f: false, s: false}, '', '', '', 'default', -1);
if (cnum == slate_permutate_course_free)
course_free_check(cnum);
return section_i;
}
/**
* Add a list of sections gotten via an AJAX call.
*/
function add_sections(cnum, data)
{
var i;
if (data.title)
jQuery('.pclass' + cnum + ' .course-title-entry').val(data.title);
/*
* If the user enterred something iffy, correct him. Or do so
* regardless ;-).
*/
/* this data['class'] stuff is for the old JSON format we used... */
if (data['class'])
data.course = data['class'];
if (data.course)
jQuery('.className' + cnum).val(data.course);
if (!data.sections)
return;
jQuery.each(data.sections, function(i, section)
{
if (!section.slot)
section.slot = 'default';
if (section.credit_hours === undefined)
section.credit_hours = -1;
add_section_n(cnum, section.section, section.synonym, section.time_start, section.time_end, section.days, section.instructor, section.location, section.type, section.slot, section.credit_hours);
});
/*
* Handle course-level interdependencies.
*/
if (data.dependencies)
jQuery.each(data.dependencies, function(i, dep) {
/* Gracefully deprecate the old crawler's JSON format. */
if (dep['class'])
dep.course = dep['class'];
var new_course_num = add_class_n(dep.course, dep['title'] ? dep['title'] : '');
add_sections(new_course_num, dep);
});
}
/**
* \brief
* Adds an identifier for a course slot.
*
* \param course_i
* The javascript index of the course to which a slot is being
* added.
* \param slot_id
* The idenfifier of the slot.
*/
function course_add_slot_row(course_i, slot_id)
{
var extra_classes = '';
if (!show_course_slots)
{
var aclass;
/*
* Then check if this course has multiple slots and we should
* enable displaying them to the user.
*/
aclass = jQuery('.' + safe_css_class('class' + course_i) + '.section .section-slot-entry');
if (aclass.length && aclass.val() != slot_id)
{
enable_course_slots();
}
}
if (!show_course_slots)
extra_classes += ' tr-slot-id-hidden';
jQuery('tr.class' + course_i + ':last').after(
'
\n' +
'
\n' +
'
\n' +
'
\n' +
'
\n'
);
jQuery('tr.class' + course_i + ':last .slot-id-text').text('The following are ' + slot_id + ' sections and will be scheduled as a group.');
}
/**
* \brief
* Dynamically enable the displification of course slots to the user.
*/
function enable_course_slots()
{
show_course_slots = true;
jQuery('.tr-slot-id-hidden').removeClass('tr-slot-id-hidden');
}
/**
* \brief
* Adds a new class to the input.
*
* \param course_id
* The course_id.
* \param title
* The human-friendly course title.
* \return
* The javascript-local course entry identifying number.
*/
function add_class_n(course_id, title)
{
/*
* If we're adding a course entry form with preadded
* content, first remove the empty course.
*/
if (course_id.length && slate_permutate_course_free != -1)
course_remove(slate_permutate_course_free);
sectionsOfClass[classNum] = 0; // Initialize at 0
course_ajax_requests[classNum] = false;
jQuery('#jsrows').append('
');
/* store classNum as course_i into the
: */
var tr_course = jQuery('#tr-course-' + classNum);
tr_course.data({course_i: classNum});
tr_course.find('.course-title-entry').val(title);
tr_course.find('.className').val(course_id);
tr_course.find('.course-credit-hours-label').attr('for', 'course-credit-hours-entry-' + classNum);
var class_elem = jQuery('.className' + classNum);
class_elem.autocomplete({ source: 'auto.php?school=' + slate_permutate_school + '&semester=' + slate_permutate_semester });
class_elem.bind('autocompleteselect', {class_num: classNum, class_elem: class_elem},
function(event, ui)
{
if (!ui.item)
return;
if (ui.item.value.indexOf('-') != -1)
{
course_autocomplete(event.data.class_num, ui.item.value);
}
else
{
/*
* The user selected a department, such as CS or MATH.
* Thus, we should append a '-' to the value and do a search for that.
*/
var newval = ui.item.value + '-';
event.data.class_elem.
val(newval).
autocomplete("search", newval);
/* void out the default event since we are setting the value ourselves, with a '-' */
event.preventDefault();
}
});
classNum++;
return (classNum - 1);
}
/**
* \brief
* Ensure that there is an empty course entry and return its
* identifier.
*/
function add_class()
{
/*
* Don't add an empty new course entry if there already is
* one. Otherwise, set this new class to be the ``hot'' one.
*/
if (slate_permutate_course_free == -1)
slate_permutate_course_free = add_class_n('', '');
return slate_permutate_course_free;
}
/**
* \brief
* Try to fetch a section once the user has chosen an autocomplete
* entry.
*
* Since this can be called also when the user just types in a course
* and hits enter without what he typed necessarily matching an
* autocomplete item, this function handles the case where the
* requested course might not have information on the server.
*
* \param course_i
* The javascript/postData index of the course to autocomplete.
* \param term
* The term which the user entered. Optional.
* \return
* Nothing.
*/
function course_autocomplete(course_i, term)
{
var course_name_elem = jQuery('.className' + course_i);
/*
* A safety mechanism: don't autocomplete a course if it already
* has sections. Since this is AJAX, this same check must also
* show up in the AJAX callback.
*/
if (course_ajax_requests[course_i] || sectionsOfClass[course_i])
return;
course_ajax_requests[course_i] = true;
if (jQuery.type(term) == 'undefined')
term = course_name_elem.val();
jQuery.ajax(
{
url: 'auto.php',
complete: function()
{
/*
* Not matter how the request goes -- if it fails or
* returns nothing or whatnot -- the channel must be
* opened up for more AJAX requests.
*/
course_ajax_requests[course_i] = false;
},
data: {
getsections: 1,
term: term,
school: slate_permutate_school,
semester: slate_permutate_semester
},
success: function(data, textStatus, reqobj)
{
var new_course_num;
if (data.sections)
{
if (sectionsOfClass[course_i])
return;
add_sections(course_i, data);
/* Close the autocomplete menu thingy. */
course_name_elem.autocomplete('close');
new_course_num = add_class();
if (course_name_elem.val() != data.course_id)
/* position the user's cursor the new class's input box */
jQuery('#input-course-' + new_course_num).focus();
}
}
}
);
return;
}
/**
* \brief
* Remove a course entry.
*
* Ensures that slate_permutate_course_free is kept consistent.
*
* \param course_i
* The internal JS identifer for the course (not the course_id which
* the PHP cares about).
*/
function course_remove(course_i)
{
jQuery('.class' + course_i).remove();
/*
* Check if the class intended for the user to
* enter information into has been removed.
*/
if (slate_permutate_course_free == course_i)
slate_permutate_course_free = -1;
credit_hours_change(course_i);
}
/**
* \brief
* Figure whether or not a given course entry has sections.
*
* \param course_i
* The internal javascript representation of a course entry.
* \return
* true or false.
*/
function course_has_sections(course_i)
{
return sectionsOfClass[course_i] > 0;
}
/**
* \brief
* Figure out whether or not an empty course entry has become filled
* or whether a full course has become emptied and react.
*
* This mainly ensures that there is always exactly one course entry
* spot, eliminating the need of an ``Add class'' button.
*
* \param course_i
* If this is not being called as a 'change' or 'keyup' event
* handler for a , then course_i may refer to
* a the course_i to check.
*/
function course_free_check(course_i)
{
var me;
if (jQuery.type(course_i) == 'number')
me = jQuery('.pclass' + course_i + ' .className');
else
me = jQuery(this);
course_i = me.parent().parent().data('course_i');
if (course_i == slate_permutate_course_free && (me.val().length || course_has_sections(course_i)))
{
/* I am no longer the empty course entry */
slate_permutate_course_free = -1;
add_class();
}
if (course_i != slate_permutate_course_free && !(me.val().length || course_has_sections(course_i)))
{
/* I am now an empty course entry */
/* kill an other empty course entry if it exists... */
if (slate_permutate_course_free != -1)
course_remove(slate_permutate_course_free);
slate_permutate_course_free = course_i;
}
}
/**
* \brief
* A function to prevent accidental form submission.
*
* To be bound to keyup and keydown events for objects which may
* accidentally be used to cause form submission.
*/
function slate_permutate_nullify_enter(e)
{
/* is 13 */
if (e.which == 13)
{
/*
* The user has pressed enter before selecting an autocomplete entry, which means the
* form will be submitted without his expecting it to be. We yet need code
* to figure out what the first autocomplete result is :-/.
*/
return false;
}
return true;
}
/**
* \brief
* Render a slate_permutate-encoded time-of-day.
*
* \param time_str
* A four-character representation of a time of day based on a
* time's 24-hour representation.
* \return
* A string representing the specified time.
*/
function prettyTime(time_str)
{
var i_hour;
var hour_str;
var m;
i_hour = time_str.substr(0, 2) * 1;
if (i_hour < 12)
{
m = 'a';
}
else
{
m = 'p';
if (i_hour > 12)
i_hour -= 12;
}
hour_str = new String(i_hour);
/* uncomment to have 08:01 instead of 8:01 */
/*
while (hour_str.length < 2)
hour_str = '0' + hour_str;
*/
return hour_str + ':' + time_str.substr(2) + ' ' + m + 'm';
}
/**
* \brief
* Takes any value classname and tries to smooth it out to a valid
* CSS class name.
*
* \todo STUB
*/
function safe_css_class(classname)
{
return classname;
}
/**
* \internal
* \brief
* Whether or not to display the credit_hours column is currently
* being displayed to the user.
*
* An internal state variable for show_credit_hours().
*/
var credit_hours_shown = false;
/**
* \brief
* Display the Credit Hours column to the user.
*/
function show_credit_hours()
{
if (credit_hours_shown)
return;
jQuery('#content').addClass('credit-hours-shown');
credit_hours_shown = true;
}
/**
* \brief
* Hide the Credit Hours column from the user.
*/
function hide_credit_hours()
{
if (!credit_hours_shown)
return;
jQuery('#content').removeClass('credit-hours-shown');
credit_hours_shown = false;
}
/**
* \brief
* State for the displification of the total number of credit hours.
*/
var credit_hours = [];
/**
* \brief
* Update the running credit hours total.
*/
function credit_hours_change(course_i)
{
var objs = jQuery('.section.class' + course_i + ' .section-credit-hours-entry');
if (objs.length)
{
var course_credit_hours = {min: -1, max: -1};
objs.each(function(i, e) {
var obj = jQuery(e);
var section = obj.closest('.section').find('.section-letter-entry').val();
var val = obj.val();
if (!val.length)
return true;
var hours = parseFloat(val);
if (!isNaN(hours) && hours >= 0)
{
if (hours > course_credit_hours.max)
course_credit_hours.max = hours;
if (course_credit_hours.min < 0 || hours < course_credit_hours.min)
course_credit_hours.min = hours;
}
});
credit_hours[course_i] = course_credit_hours;
if (course_credit_hours.min >= 0)
{
var text = course_credit_hours.min;
if (course_credit_hours.max != course_credit_hours.min)
text += '-' + course_credit_hours.max;
text += ' Credits';
jQuery('#tr-course-' + course_i + ' .course-credit-hours').text(text);
}
}
else
/* course_i was deleted or is void */
credit_hours[course_i] = {min: -1, max: -1};
var credit_hours_total = {min: 0, max: 0};
var saw_credit_hours = false;
var course_j;
for (course_j = 0; course_j < classNum; course_j ++)
{
if (credit_hours[course_j] === undefined)
continue;
/* Ignore deleted courses */
if (credit_hours[course_j] && !jQuery('tr.class' + course_j).length)
{
credit_hours[course_j] = undefined;
continue;
}
/* Ignore courses which have no credit_hours set. */
if (credit_hours[course_j].min < 0)
continue;
saw_credit_hours = true;
credit_hours_total.min += credit_hours[course_j].min;
credit_hours_total.max += credit_hours[course_j].max;
}
if (saw_credit_hours)
show_credit_hours();
else
hide_credit_hours();
var text = credit_hours_total.min;
if (credit_hours_total.max != credit_hours_total.min)
text += '-' + credit_hours_total.max;
jQuery('.credit-hours-total-value').text(text);
}
//--------------------------------------------------
// Items bound to pageload/events
//--------------------------------------------------
jQuery(document).ready(function() {
//--------------------------------------------------
// Deletes the selected class from input
//--------------------------------------------------
jQuery('.deleteClass').live('click', function() {
/* The user is not allowed to interactively delete the one empty course */
var course_i = jQuery(this).parent().parent().data('course_i');
if (slate_permutate_course_free == course_i)
return false;
if(confirm('Delete class and all sections of this class?')) {
/* The one empty course may have became this course in that time */
if (slate_permutate_course_free == course_i)
return false;
course_remove(course_i);
return false;
}
return false;
});
//--------------------------------------------------
// Deletes the selected section from the input
//--------------------------------------------------
jQuery('.deleteSection').live('click', function() {
// Decreases the total number of classes
var course_i = jQuery(this).parent().parent().data('course_i');
// Find the ID cell of the row we're in
var row = jQuery(this).parent().parent().find(".sectionIdentifier");
// The first input is the one containing the section ID
var toMatch = jQuery(row).find("input").val();
// This gets the second class of the row, "class#"
var classClass = "." + jQuery(row).parent().attr("class").split(" ")[1];
// Iterate over each section of this class
jQuery(classClass).each( function() {
// If this section has the same course ID as the item clicked, remove it.
if(jQuery(this).find("input").val() == toMatch) {
jQuery(this).remove();
sectionsOfClass[course_i]--;
}
});
course_free_check(course_i);
});
jQuery('.className').live('change', course_free_check).live('keyup', course_free_check);
//--------------------------------------------------
// Bind the section-adding method
//--------------------------------------------------
jQuery('.addSection').live('click', function() {
var course_i = jQuery(this).parent().parent().data('course_i');
add_section(course_i);
});
//--------------------------------------------------
// Default text
//--------------------------------------------------
jQuery(".defText").focus(function(srcc)
{
if (jQuery(this).val() == jQuery(this)[0].title)
{
jQuery(this).removeClass("defaultTextActive");
jQuery(this).val("");
}
});
jQuery(".defText").blur(function()
{
if (jQuery(this).val().length === 0)
{
jQuery(this).addClass("defaultTextActive");
jQuery(this).val($(this)[0].title);
}
});
jQuery(".defText").blur();
//--------------------------------------------------
// Show/Hide advanced items
//--------------------------------------------------
jQuery('.advanced').hide();
jQuery('#showadvanced').click( function() {
jQuery('#showadvanced').hide();
jQuery('.advanced').slideToggle();
});
//--------------------------------------------------
// Show/Hide instructions
//--------------------------------------------------
jQuery('#schoolInstructionsBox').hide();
jQuery('#showInstructions').click( function(e) {
jQuery('#showInstructions').hide();
jQuery('#schoolInstructionsBox').slideToggle();
e.preventDefault();
});
//-------------------------------------------------
// Show more saved schedules
//-------------------------------------------------
jQuery('#showMore').click( function() {
jQuery('.hidden').show();
jQuery('#showMore').hide();
jQuery('#showLess').show();
});
jQuery('#showLess').click( function() {
jQuery('.hidden').hide();
jQuery('#showMore').show();
jQuery('#showLess').hide();
});
//-------------------------------------------------
// Style course titles as inputs when clicked
//-------------------------------------------------
jQuery('.inPlace-enable').live('click', function() {
jQuery(this).removeClass('inPlace');
});
/*
* Prevent accidental form submission for className and course
* title entry text fields.
*/
jQuery('.input-submit-disable').live('keyup keydown', slate_permutate_nullify_enter);
jQuery('.className').live('keyup keydown', function(e)
{
if (e.which == 13)
{
course_autocomplete(jQuery(this).parent().parent().data('course_i'));
/* Prevent form submission like slate_permutate_nullify_enter() does. */
return false;
}
});
jQuery('.inPlace-enable').live('blur', function() {
jQuery(this).addClass('inPlace');
});
credit_hours_shown = jQuery('#content').is('.credit-hours-shown');
jQuery('.section-credit-hours-entry').live('change', function() {
credit_hours_change(jQuery(this).closest('.section').data('course_i'));
});
/* For the ``Select Semester'' page */
jQuery('.hysterical-show-a').click(function() {
jQuery('.hysterical').show();
jQuery('.hysterical-show').hide();
});
jQuery('.hysterical-show').show();
jQuery('.hysterical').hide();
});