Course Table Information Extension

.gitignore

@@ -36,3 +36,4 @@ web.config
 vwd.webinfo
 WebEssentials-Settings.json
 vendor
+.vscode

Dockerfile

@@ -1,4 +1,4 @@
-FROM docker.io/node:12-buster-slim as builder
+FROM docker.io/node:12-buster-slim AS builder
 LABEL author="Devin Matte <matted@csh.rit.edu>"
 
 WORKDIR /usr/src/schedule

README.md

@@ -22,7 +22,7 @@ Available at [schedule.csh.rit.edu](https://schedule.csh.rit.edu)
 - If you wish to see images locally, you will also need S3 credentials, either supply your own or reach out.
 
 ### Run Locally
-In order to run locally youre going to need [docker](https://www.docker.com/).
+In order to run locally you're going to need [docker](https://www.docker.com/).
 
 ```
 docker build -t schedulemaker .

api/entity.php

@@ -40,7 +40,7 @@
         }
 
         // Do the query
-        $query = "SELECT c.title, c.course, c.description, c.id, d.number, d.code
+        $query = "SELECT c.title, c.course, c.description, c.id, d.number, d.code, c.prerequisites, c.typically_offered, c.contact_hours
                   FROM sections AS s
                   JOIN courses AS c ON s.course = c.id
                   JOIN departments AS d ON d.id = c.department
@@ -62,7 +62,10 @@
                 "course" => $course['course'],
                 "department" => ["code" => $course['code'], "number" => $course['number']],
                 "title" => $course['title'],
-                "description" => htmlentities($course['description'])
+                "description" => htmlentities($course['description']),
+                "prerequisites" => $course['prerequisites'],
+                "typically_offered" => $course['typically_offered'],
+                "contact_hours" => $course['contact_hours']
             ];
         }
 

schema/migrationScripts/building-extension.sql

@@ -0,0 +1,15 @@
+-- -------------------------------------------------------------------------
+-- Migration Script for building-extension
+-- 
+-- @author  Nathan Russo (nathanr@csh.rit.edu)
+-- @descrip Migration script to add missing buildings to the buildings table.
+-- -------------------------------------------------------------------------
+
+INSERT INTO buildings (number, code, name, off_campus) VALUES
+    ('83', 'PAC', 'Performing Arts Center', 0),
+    ('820', '820', '820', 0),
+    ('909', '909', 'Annex IX', 0),
+    ('G', 'G', 'G DUBAI', 1),
+    ('H', 'H', 'H DUBAI', 1),
+    ('TIRM', 'TIRM', 'TIRANA', 1),
+    ('TIRT', 'TIRT', 'TIRT', 1);

schema/migrationScripts/course-extension.sql

@@ -0,0 +1,11 @@
+-- -------------------------------------------------------------------------
+-- Migration Script for course-extension
+-- 
+-- @author  Nathan Russo (nathanr@csh.rit.edu)
+-- @descrip Migration script to add prerequisites, typically offered, and contact hours to the course table.
+-- -------------------------------------------------------------------------
+
+ALTER TABLE courses
+    ADD COLUMN IF NOT EXISTS prerequisites TEXT NOT NULL DEFAULT '',
+    ADD COLUMN IF NOT EXISTS typically_offered TEXT NOT NULL DEFAULT '',
+    ADD COLUMN IF NOT EXISTS contact_hours FLOAT UNSIGNED NOT NULL DEFAULT 0;

schema/migrationScripts/section-type-extension.sql

@@ -0,0 +1,10 @@
+-- -------------------------------------------------------------------------
+-- Migration Script for section-type-extension
+-- 
+-- @author  Nathan Russo (nathanr@csh.rit.edu)
+-- @descrip Migration script to add 'OA' and 'OS' to the possible enum values for a section's type.
+-- -------------------------------------------------------------------------
+
+ALTER TABLE sections MODIFY COLUMN type 
+    ENUM('R', 'N', 'H', 'BL', 'OL', 'OS', 'OA') DEFAULT 'R' NOT NULL 
+    COMMENT 'R=Regular, N=Night, H=Honors, BL=Blended Learning, OL=Online, OS=Online - Synchronous, OA=Online - Asynchronous';

schema/procedures/InsertOrUpdateCourse.sql

@@ -7,7 +7,10 @@ CREATE PROCEDURE InsertOrUpdateCourse(
   IN p_course VARCHAR(4),
   IN p_credits INT,
   IN p_title VARCHAR(50),
-  IN p_description TEXT
+  IN p_description TEXT,
+  IN p_prerequisites TEXT,
+  IN p_typically_offered TEXT,
+  IN p_contact_hours FLOAT
 )
 BEGIN
   -- Determine if the course already exists
@@ -40,14 +43,14 @@ BEGIN
   IF recordFound > 0 THEN
       -- Course exists, so update it
       UPDATE courses AS c
-          SET c.title = p_title, c.description = p_description, c.credits = p_credits
+          SET c.title = p_title, c.description = p_description, c.credits = p_credits, c.prerequisites = p_prerequisites, c.typically_offered = p_typically_offered, c.contact_hours = p_contact_hours
           WHERE c.department = v_department AND course = p_course AND quarter = p_quarter;
-      SELECT "updated" AS action;
+      SELECT 'updated' AS action;
   ELSE
       -- Course doesn't exist, so insert it
-      INSERT INTO courses (quarter, department, course, title, description, credits)
-          VALUES(p_quarter, v_department, p_course, p_title, p_description, p_credits);
-      SELECT "inserted" AS action;
+      INSERT INTO courses (quarter, department, course, title, description, credits, prerequisites, typically_offered, contact_hours)
+          VALUES(p_quarter, v_department, p_course, p_title, p_description, p_credits, p_prerequisites, p_typically_offered, p_contact_hours);
+      SELECT 'inserted' AS action;
   END IF;
 
   -- Return the id of the course

schema/procedures/InsertOrUpdateSection.sql

@@ -25,12 +25,12 @@ BEGIN
                 maxenroll = p_maxenroll, 
                 curenroll = p_curenroll
             WHERE course = p_course AND section = p_section;
-        SELECT "updated" AS action;
+        SELECT 'updated' AS action;
     ELSE
         -- Section does not exist, so insert it
         INSERT INTO sections (course, section, title, instructor, type, status, maxenroll, curenroll)
             VALUES(p_course, p_section, p_title, p_instructor, p_type, p_status, p_maxenroll, p_curenroll);
-        SELECT "inserted" AS action;
+        SELECT 'inserted' AS action;
     END IF;
 
     -- Get the id of the section we just inserted or updated

schema/tables/courses.sql

@@ -15,7 +15,10 @@ CREATE TABLE courses (
   `course`      VARCHAR(4) NOT NULL,
   `credits`     TINYINT(2) UNSIGNED NOT NULL DEFAULT 0,
   `title`       VARCHAR(50) NOT NULL,
-  `description` TEXT NOT NULL
+  `description` TEXT NOT NULL,
+  `prerequisites` TEXT NOT NULL DEFAULT '',
+  `typically_offered` TEXT NOT NULL DEFAULT '',
+  `contact_hours` FLOAT UNSIGNED NOT NULL DEFAULT 0
 )ENGINE=InnoDb;
 
 -- INDEXING ----------------------------------------------------------------

schema/tables/schools.sql

@@ -11,8 +11,7 @@ CREATE TABLE IF NOT EXISTS `schools` (
   `id`      INT UNSIGNED NOT NULL PRIMARY KEY,
   `number`  tinyint(2) UNSIGNED ZEROFILL NULL DEFAULT NULL,
   `code`    VARCHAR(5) NULL DEFAULT NULL,
-  `title` varchar(30) NOT NULL,
-  PRIMARY KEY  (`id`)
+  `title` varchar(30) NOT NULL
 ) ENGINE=InnoDb;
 
 -- ADD INDEXES -------------------------------------------------------------

tools/Parser.php

@@ -86,31 +86,43 @@ function halt($messages) {
     /**
      * Inserts or updates a course. This function calls the stored procedure for
      * inserting or updating a course.
-     * @param $quarter      int     The term that the course is in
-     * @param $departCode   string  The code of the department
-     * @param $classCode    string  The code for the class
-     * @param $course       string  The number of the course
-     * @param $credits      int     The credits the course offers
-     * @param $title        string  The title of the course
-     * @param $description  string  The description for the course
+     * @param $quarter          int     The term that the course is in
+     * @param $departCode       string  The code of the department
+     * @param $classCode        string  The code for the class
+     * @param $course           string  The number of the course
+     * @param $credits          int     The credits the course offers
+     * @param $title            string  The title of the course
+     * @param $description      string  The description for the course
+     * @param $prerequisites    string  The prerequisites for the course
+     * @param $typicallyOffered string  The typically offered semester for the course
+     * @param $contactHours     float   The contact hours for the course
      * @return  mixed   String of error message returned on failure.
      *                  Integer of course ID returned on success
      */
-    function insertOrUpdateCourse(int $quarter, string $departCode, string $classCode, string $course, int $credits, string $title, string $description) {
+    function insertOrUpdateCourse(int $quarter, string $departCode, string $classCode, string $course, int $credits, string $title, string $description, string $prerequisites, string $typicallyOffered, float $contactHours) {
         global $coursesUpdated, $coursesAdded;
         // Call the stored proc
         // TODO: Refactor out department ID number (0000)
-        $query = "CALL InsertOrUpdateCourse({$quarter}, 0000, '{$classCode}', '{$course}', {$credits}, '{$title}', '{$description}')";
-        $success = mysqli_multi_query($this->dbConn, $query);
+        $query = "CALL InsertOrUpdateCourse({$quarter}, 0000, '{$classCode}', '{$course}', {$credits}, '{$title}', '{$description}', '{$prerequisites}', '{$typicallyOffered}', {$contactHours})";
 
-        // Catch errors or return the id
+        // Error check
+        try {
+            mysqli_multi_query($this->dbConn, $query);
+            $success = true;
+        } catch (\mysqli_sql_exception $e) {
+            $success = false;
+        }
+
+        // Error check
         if (!$success) {
             // If the class code errors out, try the department code
             // TODO: Refactor out department ID number (0000)
-            $query = "CALL InsertOrUpdateCourse({$quarter}, 0000, '{$departCode}', '{$course}', {$credits}, '{$title}', '{$description}')";
-            $success = mysqli_multi_query($this->dbConn, $query);
-            if (!$success) {
-                return mysqli_error($this->dbConn);
+            $query = "CALL InsertOrUpdateCourse({$quarter}, 0000, '{$departCode}', '{$course}', {$credits}, '{$title}', '{$description}', '{$prerequisites}', '{$typicallyOffered}', {$contactHours})";
+            try {
+                mysqli_multi_query($this->dbConn, $query);
+            } catch (\mysqli_sql_exception $e) {
+                return $e->getMessage();
+                //return mysqli_error($this->dbConn);
             }
         }
 
@@ -144,8 +156,11 @@ function insertOrUpdateSection($courseId, $section, $title, $instructor, $type,
         $query .= "{$maxenroll},{$curenroll})";
 
         // Error check
-        if (!mysqli_multi_query($this->dbConn, $query)) {
-            return mysqli_error($this->dbConn);
+        try {
+            mysqli_multi_query($this->dbConn, $query);
+        } catch (\mysqli_sql_exception $e) {
+            return $e->getMessage();
+            //return mysqli_error($this->dbConn);
         }
 
         // First result is the action performed
@@ -191,7 +206,7 @@ function getTempSections($courseNum, $offerNum, $term, $sessionNum) {
         return $list;
     }
 
-    function fileToTempTable(string $tableName, $file, $fields, $fileSize, string $procFunc = null) {
+    function fileToTempTable(string $tableName, $file, $fields, $fileSize, ?string $procFunc = null) {
         // Process the file
         $procBytes = 0;
         $outPercent = [0];

tools/processDump.php

@@ -102,6 +102,9 @@
   `acad_career` varchar(4) NOT NULL,
   `instruction_mode` varchar(2) NOT NULL,
   `course_descrlong` text NOT NULL,
+  `prereqs` text NOT NULL,
+  `typ_offr` text NOT NULL,
+  `ctc_hrs` float NOT NULL,
   PRIMARY KEY (`crse_id`,`crse_offer_nbr`,`strm`,`session_code`,`class_section`)
 ) ENGINE=MyISAM DEFAULT CHARSET=latin1;
 ENE;
@@ -112,7 +115,7 @@
     $parser->halt(["Error: Failed to create temporary class table", mysqli_error($dbConn)]);
 }
 
-$parser->fileToTempTable("classes", $classFile, 24, $classSize, "procClassArray");
+$parser->fileToTempTable("classes", $classFile, 27, $classSize, "procClassArray");
 fclose($classFile);
 
 // Build a temporary table for the meeting patterns
@@ -268,7 +271,7 @@
 $departmentsProc = mysqli_affected_rows($dbConn);
 
 // Grab each COURSE from the classes table
-$courseQuery = "SELECT strm, subject, units, acad_org, catalog_nbr, descr, course_descrlong,";
+$courseQuery = "SELECT strm, subject, units, acad_org, catalog_nbr, descr, course_descrlong, prereqs, typ_offr, ctc_hrs, ";
 $courseQuery .= " crse_id, crse_offer_nbr, session_code";
 $courseQuery .= " FROM classes WHERE strm < 20130 GROUP BY crse_id, strm, session_code";
 $parser->debug("... Updating courses\n0%", false);
@@ -298,10 +301,12 @@
     // Escape the necessary fields
     $row['descr'] = mysqli_real_escape_string($dbConn, $row['descr']);
     $row['course_descrlong'] = mysqli_real_escape_string($dbConn, $row['course_descrlong']);
+    $row['prereqs'] = mysqli_real_escape_string($dbConn, $row['prereqs']);
+    $row['typ_offr'] = mysqli_real_escape_string($dbConn, $row['typ_offr']);
 
     // Insert or update the course
     @$courseId = $parser->insertOrUpdateCourse($row['qtr'], $row['acad_org'], $row['subject'], $row['catalog_nbr'],
-        (int)$row['units'], $row['descr'], $row['course_descrlong']);
+        (int)$row['units'], $row['descr'], $row['course_descrlong'], $row['prereqs'], $row['typ_offr'], (float)$row['ctc_hrs']);
     if (!is_numeric($courseId)) {
         echo("    *** Error: Failed to update {$row['qtr']} {$row['subject']}-{$row['catalog_nbr']}\n");
         echo("    ");