Skip to content

Commit 8ad5dae

Browse files
pbailiepbailie
authored
[Feature:InstructorUI] Autofeed -- Student Registration Types (#26)
* Upsert for student's registration type New feature for upserting a student's registration type. Registration type can be "graded", "audit", or "late drop / withdrawn". * Update ssaf_sql.php * Update ssaf_sql.php * Update submitty_student_auto_feed.php File locking can cause the autofeed to hang when run on a shared file system under certain conditions. So file locking the CSV has been removed. * Update submitty_student_auto_feed.php
1 parent d0ce6db commit 8ad5dae

File tree

4 files changed

+72
-27
lines changed

4 files changed

+72
-27
lines changed

‎student_auto_feed/config.php‎

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,17 +52,35 @@
5252
// accessed locally or remotely.
5353
define('CSV_FILE', '/path/to/datafile.csv');
5454

55-
// Student registration status is important, as data dumps can contain students
56-
// who have dropped a course either before the semester starts or during the
57-
// semester. This array will contain all valid registered-student codes can be
58-
// expected in the data dump.
59-
//
60-
// IMPORTANT: Consult with your University's IT administrator and/or registrar
61-
// to add all pertinant student-is-registered codes that can be found
62-
// in your CSV data dump. EXAMPLE: 'RA' may mean "registered by
63-
// advisor" and 'RW' may mean "registered via web"
55+
/* STUDENT REGISTRATION CODES --------------------------------------------------
56+
*
57+
* Student registration status is important, as data dumps can contain students
58+
* who have dropped a course either before the semester starts or during the
59+
* semester. Be sure that all codes are set as an array, even when only one
60+
* code is found in the CSV data. Set to NULL when there are no codes for
61+
* either student auditing a course or students late-withdrawn from a course.
62+
*
63+
* IMPORTANT: Consult with your University's IT administrator and/or registrar
64+
* for the pertinant student registration codes that can be found in
65+
* your CSV data dump.
66+
*
67+
* -------------------------------------------------------------------------- */
68+
69+
// These codes are for students who are registered to take a course for a grade.
70+
// EXAMPLE: 'RA' may mean "registered by advisor" and 'RW' may mean
71+
// "registered via web". Do not set to NULL.
6472
define('STUDENT_REGISTERED_CODES', array('RA', 'RW'));
6573

74+
// These codes are for students auditing a course. These students will not be
75+
// given a grade.
76+
// Set this to NULL if your CSV data does not provide this information.
77+
define('STUDENT_AUDIT_CODES', array('AU'));
78+
79+
// These codes are for students who have dropped their course after the drop
80+
// deadline and are given a late-drop or withdrawn code on their transcript.
81+
// Set this to NULL if your CSV data does not provide this information.
82+
define('STUDENT_LATEDROP_CODES', array('W'));
83+
6684
//An exceptionally small file size can indicate a problem with the feed, and
6785
//therefore the feed should not be processed to preserve data integrity of the
6886
//users table. Value is in bytes. You should pick a reasonable minimum

‎student_auto_feed/ssaf_db.php‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,12 +175,27 @@ public static function upsert($semester, $course, $rows) : bool {
175175
$row[COLUMN_EMAIL]
176176
);
177177

178+
// Determine registration type for courses_users table
179+
// Registration type code has already been validated by now.
180+
switch(true) {
181+
case in_array($row[COLUMN_REGISTRATION], STUDENT_REGISTERED_CODES):
182+
$registration_type = sql::RT_GRADED;
183+
break;
184+
case in_array($row[COLUMN_REGISTRATION], STUDENT_AUDIT_CODES):
185+
$registration_type = sql::RT_AUDIT;
186+
break;
187+
default:
188+
$registration_type = sql::RT_LATEDROP;
189+
break;
190+
}
191+
178192
$courses_users_params = array(
179193
$semester,
180194
$course,
181195
$row[COLUMN_USER_ID],
182196
4,
183197
$row[COLUMN_SECTION],
198+
$registration_type,
184199
"FALSE"
185200
);
186201

‎student_auto_feed/ssaf_sql.php‎

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ class sql {
1212
public const COMMIT = "COMMIT";
1313
public const ROLLBACK = "ROLLBACK";
1414

15+
// Registration type constants
16+
public const RT_GRADED = "graded";
17+
public const RT_AUDIT = "audit";
18+
public const RT_LATEDROP = "withdrawn";
19+
1520
// SELECT queries
1621
public const GET_COURSES = <<<SQL
1722
SELECT course
@@ -72,15 +77,22 @@ class sql {
7277
user_id,
7378
user_group,
7479
registration_section,
80+
registration_type,
7581
manual_registration
76-
) VALUES ($1, $2, $3, $4, $5, $6)
82+
) VALUES ($1, $2, $3, $4, $5, $6, $7)
7783
ON CONFLICT (semester, course, user_id) DO UPDATE
7884
SET registration_section=
79-
CASE WHEN courses_users.user_group=4
80-
AND courses_users.manual_registration=FALSE
81-
THEN EXCLUDED.registration_section
82-
ELSE courses_users.registration_section
83-
END
85+
CASE WHEN courses_users.user_group=4
86+
AND courses_users.manual_registration=FALSE
87+
THEN EXCLUDED.registration_section
88+
ELSE courses_users.registration_section
89+
END,
90+
registration_type=
91+
CASE WHEN courses_users.user_group=4
92+
AND courses_users.manual_registration=FALSE
93+
THEN EXCLUDED.registration_type
94+
ELSE courses_users.registration_type
95+
END
8496
SQL;
8597

8698
// INSERT courses_registration_sections table

‎student_auto_feed/submitty_student_auto_feed.php‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,11 @@ private function get_csv_data() {
170170
$course = strtolower($row[COLUMN_COURSE_PREFIX] . $row[COLUMN_COURSE_NUMBER]);
171171

172172
// Does $row have a valid registration code?
173-
if (array_search($row[COLUMN_REGISTRATION], STUDENT_REGISTERED_CODES) !== false) {
173+
$graded_codes = STUDENT_REGISTERED_CODES;
174+
$audit_codes = is_null(STUDENT_AUDIT_CODES) ? array() : STUDENT_AUDIT_CODES;
175+
$latedrop_codes = is_null(STUDENT_LATEDROP_CODES) ? array() : STUDENT_LATEDROP_CODES;
176+
$all_valid_codes = array_merge($graded_codes, $audit_codes, $latedrop_codes);
177+
if (array_search($row[COLUMN_REGISTRATION], $all_valid_codes) !== false) {
174178
// Check that $row is associated with the course list
175179
if (array_search($course, $this->course_list) !== false) {
176180
if (validate::validate_row($row, $row_num)) {
@@ -192,6 +196,10 @@ private function get_csv_data() {
192196
if (validate::validate_row($row, $row_num)) {
193197
$row[COLUMN_SECTION] = $this->mapped_courses[$course][$section]['mapped_section'];
194198
$this->data[$m_course][] = $row;
199+
// Rows with blank emails are allowed, but they are being logged.
200+
if ($row[COLUMN_EMAIL] === "") {
201+
$this->log_it("Blank email found for user {$row[COLUMN_USER_ID]}, row {$row_num}.");
202+
}
195203
} else {
196204
$this->invalid_courses[$m_course] = true;
197205
$this->log_it(validate::$error);
@@ -335,20 +343,12 @@ private function invalidate_courses() {
335343
*/
336344
private function open_csv() {
337345
$this->fh = fopen(CSV_FILE, "r");
338-
if ($this->fh !== false) {
339-
if (flock($this->fh, LOCK_SH, $wouldblock)) {
340-
return true;
341-
} else if ($wouldblock === 1) {
342-
$this->logit("Another process has locked the CSV.");
343-
return false;
344-
} else {
345-
$this->logit("CSV not blocked, but still could not attain lock for reading.");
346-
return false;
347-
}
348-
} else {
346+
if ($this->fh === false) {
349347
$this->log_it("Could not open CSV file.");
350348
return false;
351349
}
350+
351+
return true;
352352
}
353353

354354
/** Close CSV file */

0 commit comments

Comments
 (0)