Skip to content

Commit 68db79d

Browse files
pbailiepbailie
authored
[Feature:System] Autofeed Update For PHP 8.1+ (#35)
I performed a code audit and made required changes for PHP 8+ while maintaining compatibility with PHP 7.4. This is in preparation to migrate the autofeed's production server from Ubuntu 20.04 to (upcoming) Ubuntu 24.04 LTS. This also includes other various minor code adjustments.
1 parent 0fdecb4 commit 68db79d

File tree

9 files changed

+194
-175
lines changed

9 files changed

+194
-175
lines changed

‎student_auto_feed/add_drop_report.php‎

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -126,13 +126,16 @@ public static function close() {
126126
}
127127

128128
/**
129-
* Verify that DB connection resource is OK
129+
* Verify that DB connection resource/instance is OK
130+
*
131+
* PHP < 8.1: self::$db is a resource
132+
* PHP >= 8.1: self::$db is an instanceof \PgSql\Connection
130133
*
131134
* @access private
132-
* @return bool true when DB connection resource is OK, false otherwise.
135+
* @return bool true when DB connection resource/instance is OK, false otherwise.
133136
*/
134137
private static function check() {
135-
return is_resource(self::$db) && pg_connection_status(self::$db) === PGSQL_CONNECTION_OK;
138+
return (is_resource(self::$db) || self::$db instanceof \PgSql\Connection) && pg_connection_status(self::$db) === PGSQL_CONNECTION_OK;
136139
}
137140

138141
/**
@@ -148,7 +151,7 @@ public static function get_courses($term) {
148151

149152
// Undergraduate courses from DB.
150153
$sql = "SELECT course FROM courses WHERE term=$1 AND status=1";
151-
$params = array($term);
154+
$params = [$term];
152155
$res = pg_query_params(self::$db, $sql, $params);
153156
if ($res === false)
154157
die("Failed to retrieve course list from DB\n");
@@ -171,7 +174,7 @@ public static function get_mapped_courses($term) {
171174

172175
// mapped courses from DB
173176
$sql = "SELECT course, mapped_course FROM mapped_courses WHERE term=$1";
174-
$params = array($term);
177+
$params = [$term];
175178
$res = pg_query_params(self::$db, $sql, $params);
176179
if ($res === false) {
177180
die("Failed to retrieve mapped courses from DB\n");
@@ -199,15 +202,15 @@ public static function count_enrollments($term, $course_list, $mapped_courses) {
199202
die("Not connected to DB when querying course enrollments\n");
200203
}
201204

202-
$course_enrollments = array();
203-
$manual_flags = array();
205+
$course_enrollments = [];
206+
$manual_flags = [];
204207

205208
foreach ($course_list as $course) {
206209
$grad_course = array_search($course, $mapped_courses);
207210
if ($grad_course === false) {
208211
// COURSE HAS NO GRAD SECTION (not mapped).
209212
$sql = "SELECT COUNT(*) FROM courses_users WHERE term=$1 AND course=$2 AND user_group=4 AND registration_section IS NOT NULL";
210-
$params = array($term, $course);
213+
$params = [$term, $course];
211214
$res = pg_query_params(self::$db, $sql, $params);
212215
if ($res === false)
213216
die("Failed to lookup enrollments for {$course}\n");
@@ -222,7 +225,7 @@ public static function count_enrollments($term, $course_list, $mapped_courses) {
222225
} else {
223226
// UNDERGRADUATE SECTION
224227
$sql = "SELECT COUNT(*) FROM courses_users WHERE term=$1 AND course=$2 AND user_group=4 AND registration_section='1'";
225-
$params = array($term, $course);
228+
$params = [$term, $course];
226229
$res = pg_query_params(self::$db, $sql, $params);
227230
if ($res === false)
228231
die("Failed to lookup enrollments for {$course}\n");
@@ -254,7 +257,7 @@ public static function count_enrollments($term, $course_list, $mapped_courses) {
254257
// Courses make up array keys. Sort by courses.
255258
ksort($course_enrollments);
256259
ksort($manual_flags);
257-
return array($course_enrollments, $manual_flags);
260+
return [$course_enrollments, $manual_flags];
258261
}
259262
}
260263

@@ -282,7 +285,7 @@ public static function write_temp_csv($course_enrollments) {
282285
}
283286

284287
foreach($course_enrollments as $course=>$num_students) {
285-
fputcsv($fh, array($course, $num_students), CSV_DELIM_CHAR);
288+
fputcsv($fh, [$course, $num_students], CSV_DELIM_CHAR);
286289
}
287290
fclose($fh);
288291
chmod($tmp_path . $tmp_file, 0660);
@@ -305,7 +308,7 @@ public static function read_temp_csv() {
305308

306309
unlink($tmp_path . $tmp_file); // remove tmp file.
307310
array_walk($csv, 'callbacks::str_getcsv_cb');
308-
// return array of array('course' => enrollment). e.g. ('csci1000' => 100)
311+
// return array of ['course' => enrollment]. e.g. ['csci1000' => 100]
309312
return array_combine(array_column($csv, 0), array_column($csv, 1));
310313
}
311314

@@ -321,9 +324,11 @@ public static function compile_report($prev_course_enrollments, $course_enrollme
321324
// Compile stats
322325
$date = date("F j, Y");
323326
$time = date("g:i A");
324-
$report = "Student autofeed counts report for {$date} at {$time}\n";
325-
$report .= "NOTE: Difference and ratio do not account for the manual flag.\n";
326-
$report .= "COURSE YESTERDAY TODAY MANUAL DIFFERENCE RATIO\n";
327+
$report = <<<HEADING
328+
Student autofeed counts report for {$date} at {$time}
329+
NOTE: Difference and ratio do not account for the manual flag.
330+
COURSE YESTERDAY TODAY MANUAL DIFFERENCE RATIO\n
331+
HEADING;
327332

328333
foreach ($course_enrollments as $course=>$course_enrollment) {
329334
// Calculate data
@@ -363,7 +368,7 @@ public static function send_report($term, $report) {
363368
$from = ADD_DROP_FROM_EMAIL;
364369
$subject = "Submitty Autofeed Add/Drop Report For {$date}";
365370
$report = str_replace("\n", "\r\n", $report); // needed for email formatting
366-
$is_sent = mail($to, $subject, $report, array('from' => $from));
371+
$is_sent = mail($to, $subject, $report, ['from' => $from]);
367372
if (!$is_sent) {
368373
$report = str_replace("\r\n", "\n", $report); // revert back since not being emailed.
369374
fprintf(STDERR, "Add/Drop report could not be emailed.\n%s", $report);

‎student_auto_feed/config.php‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* config.php script used by submitty_student_auto_feed
66
* By Peter Bailie, Systems Programmer (RPI dept of computer science)
77
*
8-
* Requires minimum PHP version 7.1 with pgsql extension.
8+
* Requires minimum PHP version 7.3 with pgsql extension.
99
*
1010
* Configuration of submitty_student_auto_feed is structured through a series
1111
* of named constants.
@@ -127,9 +127,6 @@
127127
//Set to true, if Submitty is using SAML for authentication.
128128
define('PROCESS_SAML', true);
129129

130-
//Allows "\r" EOL encoding. This is rare but exists (e.g. Excel for Macintosh).
131-
ini_set('auto_detect_line_endings', true);
132-
133130
/* DATA SOURCING --------------------------------------------------------------
134131
* The Student Autofeed provides helper scripts to retrieve the CSV file for
135132
* processing. Shell script ssaf.sh is used to invoke one of the helper

‎student_auto_feed/crn_copymap.php‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,18 +58,18 @@ private function write_mappings($args) {
5858

5959
$len = count($source_sections);
6060
for ($i = 0; $i < $len; $i++) {
61-
$row = array($source_course, $source_sections[$i], $dest_course, $dest_sections[$i]);
61+
$row = [$source_course, $source_sections[$i], $dest_course, $dest_sections[$i]];
6262
fputcsv($fh, $row, ",");
6363
}
6464

6565
fclose($fh);
6666
}
6767

6868
private function get_mappings($sections) {
69-
if ($sections === "" || $sections === "all") return array($sections);
69+
if ($sections === "" || $sections === "all") return [$sections];
7070

7171
$arr = explode(",", $sections);
72-
$expanded = array();
72+
$expanded = [];
7373
foreach($arr as $val) {
7474
if (preg_match("/(\d+)\-(\d+)/", $val, $matches) === 1) {
7575
$expanded = array_merge($expanded, range((int) $matches[1], (int) $matches[2]));
@@ -100,10 +100,12 @@ class cli {
100100
Arguments:
101101
-h, --help, help Show this help message.
102102
term Term code of courses and sections being mapped. Required.
103-
course-a Original course
104-
sections Section list, or "all" of preceding course
105-
course-b Course being copied to
106-
sections For course-b, this can be ommited when course-a sections is "all"
103+
course-a Original course.
104+
sections Section list or "all" for course-a.
105+
course-b Course being copied to.
106+
sections Section list or "all" for course-b.
107+
108+
Course-b sections can be ommited when course-a sections is "all"\n
107109
ARGS_LIST;
108110

109111
/**
@@ -115,7 +117,7 @@ class cli {
115117
*/
116118
public static function parse_args() {
117119
global $argc, $argv;
118-
$matches = array();
120+
$matches = [];
119121

120122
switch(true) {
121123
// Check for request for help
@@ -130,7 +132,7 @@ public static function parse_args() {
130132
case preg_match("/^[\w\d\-]+$/", $argv[2], $matches['source']['course']) !== 1:
131133
case preg_match("/^\d+(?:(?:,|\-)\d+)*$|^all$/", $argv[3], $matches['source']['sections']) !== 1:
132134
case preg_match("/^[\w\d\-]+$/", $argv[4], $matches['dest']['course']) !== 1:
133-
case preg_match("/^\d+(?:(?:,|\-)\d+)*$|^(?:all)?$/", $argv[5], $matches['dest']['sections']) !== 1:
135+
case preg_match("/^\d+(?:(?:,|\-)\d+)*$|^(?:all)?$/", $argv[5] ?? "", $matches['dest']['sections']) !== 1:
134136
self::print_usage();
135137
exit;
136138
}

‎student_auto_feed/readme.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ policies and practices.__
1010

1111
Detailed instructions can be found at [http://submitty.org/sysadmin/student\_auto\_feed](http://submitty.org/sysadmin/student_auto_feed)
1212

13-
Requirements: PHP 7.1 or higher with pgsql extension. `imap_remote.php` also
13+
Requirements: PHP 7.3 or higher with pgsql extension. `imap_remote.php` also
1414
requires the imap extension. This system is intended to be platform agnostic,
1515
but has been developed and tested with Ubuntu Linux.
1616

‎student_auto_feed/ssaf_cli.php‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,19 @@
44
/** class to parse command line arguments */
55
class cli_args {
66
/** @var array Holds all CLI argument flags and their values */
7-
private static $args = array();
7+
private static $args = [];
88
/** @var string usage help message */
99
private static $help_usage = "Usage: submitty_student_auto_feed.php [-h | --help] [-a auth str] (-t term code)\n";
1010
/** @var string short description help message */
1111
private static $help_short_desc = "Read student enrollment CSV and upsert to Submitty database.\n";
1212
/** @var string argument list help message */
1313
private static $help_args_list = <<<HELP
14-
Arguments:
15-
-h, --help Show this help message.
16-
-a auth str Specify 'user:password@server', overriding config.php. Optional.
17-
-t term code Term code associated with current student enrollment. Required.
18-
-l Send a test message to error log(s) and quit.
19-
20-
HELP;
14+
Arguments:
15+
-h, --help Show this help message.
16+
-a auth str Specify 'user:password@server', overriding config.php. Optional.
17+
-t term code Term code associated with current student enrollment. Required.
18+
-l Send a test message to error log(s) and quit.\n
19+
HELP;
2120

2221
/**
2322
* Parse command line arguments
@@ -27,7 +26,7 @@ class cli_args {
2726
* @return mixed term code as string or boolean false when no term code is present.
2827
*/
2928
public static function parse_args() {
30-
self::$args = getopt('ha:t:l', array('help'));
29+
self::$args = getopt('ha:t:l', ['help']);
3130

3231
switch(true) {
3332
case array_key_exists('h', self::$args):

‎student_auto_feed/ssaf_db.php‎

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -82,15 +82,15 @@ public static function get_mapped_courses($term) {
8282

8383
// Describe how auto-feed data is translated by mappings.
8484
// There are no mappings when $result is null.
85-
$mappings = array();
85+
$mappings = [];
8686
if (!is_null($results)) {
8787
foreach ($results as $row) {
8888
$course = $row['course'];
8989
$section = $row['registration_section'];
90-
$mappings[$course][$section] = array(
90+
$mappings[$course][$section] = [
9191
'mapped_course' => $row['mapped_course'],
9292
'mapped_section' => $row['mapped_section']
93-
);
93+
];
9494
}
9595
}
9696

@@ -110,7 +110,7 @@ public static function get_enrollment_count($semester, $course) {
110110
return false;
111111
}
112112

113-
$results = self::run_query(sql::GET_COURSE_ENROLLMENT_COUNT, array($semester, $course));
113+
$results = self::run_query(sql::GET_COURSE_ENROLLMENT_COUNT, [$semester, $course]);
114114
if ($results === false) {
115115
self::$error .= "Error while retrieving course enrollment counts.";
116116
return false;
@@ -166,14 +166,14 @@ public static function upsert($semester, $course, $rows) : bool {
166166

167167
// Do upsert of course enrollment data.
168168
foreach($rows as $row) {
169-
$users_params = array(
169+
$users_params = [
170170
$row[COLUMN_USER_ID],
171171
$row[COLUMN_NUMERIC_ID],
172172
$row[COLUMN_FIRSTNAME],
173173
$row[COLUMN_LASTNAME],
174174
$row[COLUMN_PREFERREDNAME],
175175
$row[COLUMN_EMAIL]
176-
);
176+
];
177177

178178
// Determine registration type for courses_users table
179179
// Registration type code has already been validated by now.
@@ -189,19 +189,19 @@ public static function upsert($semester, $course, $rows) : bool {
189189
break;
190190
}
191191

192-
$courses_users_params = array(
192+
$courses_users_params = [
193193
$semester,
194194
$course,
195195
$row[COLUMN_USER_ID],
196196
4,
197197
$row[COLUMN_SECTION],
198198
$registration_type,
199199
"FALSE"
200-
);
200+
];
201201

202-
$reg_sections_params = array($semester, $course, $row[COLUMN_SECTION], $row[COLUMN_REG_ID]);
203-
$tmp_table_params = array($row[COLUMN_USER_ID]);
204-
$dropped_users_params = array($semester, $course);
202+
$reg_sections_params = [$semester, $course, $row[COLUMN_SECTION], $row[COLUMN_REG_ID]];
203+
$tmp_table_params = [$row[COLUMN_USER_ID]];
204+
$dropped_users_params = [$semester, $course];
205205

206206
// Upsert queries
207207
// If any query returns false, we need to rollback and bail out.
@@ -247,8 +247,16 @@ public static function upsert($semester, $course, $rows) : bool {
247247

248248
// PRIVATE STATIC FUNCTIONS ------------------------------------------------
249249

250+
/**
251+
* Verify that DB connection resource/instance is OK
252+
*
253+
* PHP < 8.1: self::$db is a resource
254+
* PHP >= 8.1: self::$db is an instanceof \PgSql\Connection
255+
*
256+
* @return bool true when DB connection resource/instance is OK, false otherwise.
257+
*/
250258
private static function check() : bool {
251-
if (!is_resource(self::$db) || pg_connection_status(self::$db) !== PGSQL_CONNECTION_OK) {
259+
if ((!is_resource(self::$db) && !(self::$db instanceof \PgSql\Connection)) || pg_connection_status(self::$db) !== PGSQL_CONNECTION_OK) {
252260
self::$error = "No DB connection.";
253261
return false;
254262
}
@@ -273,8 +281,8 @@ private static function run_query($sql, $params = null) {
273281
return false;
274282
}
275283

276-
if (is_null($params)) $params = array();
277-
else if (!is_array($params)) $params = array($params);
284+
if (is_null($params)) $params = [];
285+
elseif (is_scalar($params)) $params = [$params];
278286

279287
$res = pg_query_params(self::$db, $sql, $params);
280288
if ($res === false) {

0 commit comments

Comments
 (0)