forked from PrairieLearn/PrairieLearn
-
Notifications
You must be signed in to change notification settings - Fork 0
/
server.js
680 lines (619 loc) · 31.6 KB
/
server.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
const ERR = require('async-stacktrace');
const fs = require('fs');
const path = require('path');
const favicon = require('serve-favicon');
const async = require('async');
const express = require('express');
const bodyParser = require('body-parser');
const cookieParser = require('cookie-parser');
const passport = require('passport');
const http = require('http');
const https = require('https');
const blocked = require('blocked-at');
const onFinished = require('on-finished');
const uuidv4 = require('uuid/v4');
const argv = require('yargs-parser') (process.argv.slice(2));
const multer = require('multer');
const logger = require('./lib/logger');
const config = require('./lib/config');
const load = require('./lib/load');
const externalGrader = require('./lib/externalGrader');
const externalGraderResults = require('./lib/externalGraderResults');
const externalGradingSocket = require('./lib/externalGradingSocket');
const assessment = require('./lib/assessment');
const sqldb = require('@prairielearn/prairielib/sql-db');
const migrations = require('./migrations');
const sprocs = require('./sprocs');
const cron = require('./cron');
const redis = require('./lib/redis');
const socketServer = require('./lib/socket-server');
const serverJobs = require('./lib/server-jobs');
const freeformServer = require('./question-servers/freeform.js');
const cache = require('./lib/cache');
const workers = require('./lib/workers');
// If there is only one argument, legacy it into the config option
if (argv['_'].length == 1) {
argv['config'] = argv['_'][0];
argv['_'] = [];
}
if ('h' in argv || 'help' in argv) {
var msg = `PrairieLearn command line options:
-h, --help Display this help and exit
--config <filename>
<filename> and no other args Load an alternative config filename
--migrate-and-exit Run the DB initialization parts and exit
--exit Run all the initialization and exit
`;
console.log(msg); // eslint-disable-line no-console
process.exit(0);
}
if (config.startServer) {
logger.info('PrairieLearn server start');
var configFilename = 'config.json';
if ('config' in argv) {
configFilename = argv['config'];
}
config.loadConfig(configFilename);
if (config.logFilename) {
logger.addFileLogging(config.logFilename);
logger.verbose('activated file logging: ' + config.logFilename);
}
}
if (config.blockedWarnEnable) {
blocked((time, stack) => {
const msg = `BLOCKED-AT: Blocked for ${time}ms`;
logger.verbose(msg, {stack});
console.log(msg + '\n' + stack.join('\n')); // eslint-disable-line no-console
}, {threshold: config.blockedWarnThresholdMS}); // threshold in milliseconds
}
const app = express();
app.set('views', path.join(__dirname, 'pages'));
app.set('view engine', 'ejs');
config.devMode = (app.get('env') == 'development');
app.use(function(req, res, next) {res.locals.homeUrl = config.homeUrl; next();});
app.use(function(req, res, next) {res.locals.urlPrefix = res.locals.plainUrlPrefix = config.urlPrefix; next();});
app.use(function(req, res, next) {res.locals.navbarType = 'plain'; next();});
app.use(function(req, res, next) {res.locals.devMode = config.devMode; next();});
app.use(function(req, res, next) {res.locals.is_administrator = false; next();});
if (config.hasAzure) {
var OIDCStrategy = require('passport-azure-ad').OIDCStrategy;
const azureConfig = {
identityMetadata: config.azureIdentityMetadata,
clientID: config.azureClientID,
responseType: config.azureResponseType,
responseMode: config.azureResponseMode,
redirectUrl: config.azureRedirectUrl,
allowHttpForRedirectUrl: config.azureAllowHttpForRedirectUrl,
clientSecret: config.azureClientSecret,
validateIssuer: config.azureValidateIssuer,
isB2C: config.azureIsB2C,
issuer: config.azureIssuer,
passReqToCallback: config.azurePassReqToCallback,
scope: config.azureScope,
loggingLevel: config.azureLoggingLevel,
nonceLifetime: config.azureNonceLifetime,
nonceMaxAmount: config.azureNonceMaxAmount,
useCookieInsteadOfSession: config.azureUseCookieInsteadOfSession,
cookieEncryptionKeys: config.azureCookieEncryptionKeys,
clockSkew: config.azureClockSkew,
};
passport.use(new OIDCStrategy(azureConfig, function(iss, sub, profile, accessToken, refreshToken, done) {return done(null, profile);}));
}
// special parsing of file upload paths -- this is inelegant having it
// separate from the route handlers but it seems to be necessary
// Special handling of file-upload routes so that we can parse multipart/form-data
const upload = multer({
storage: multer.memoryStorage(),
limits: {
fieldSize: 1e7, // max in bytes
fileSize: 1e7, // max in bytes
parts: 100, // max number of fields + files
},
});
app.post('/pl/course_instance/:course_instance_id/instructor/assessment/:assessment_id/uploads', upload.single('file'));
// Limit to 1MB of JSON
app.use(bodyParser.json({limit: 1024 * 1024}));
app.use(bodyParser.urlencoded({extended: false, limit: 200 * 1024}));
app.use(cookieParser());
app.use(passport.initialize());
app.use(favicon(path.join(__dirname, 'public', 'favicon.ico')));
if ('localRootFilesDir' in config) {
logger.info(`localRootFilesDir: Mapping ${config.localRootFilesDir} into /`);
app.use(express.static(config.localRootFilesDir));
}
app.use(express.static(path.join(__dirname, 'public')));
app.use('/MathJax', express.static(path.join(__dirname, 'node_modules', 'mathjax')));
app.use('/node_modules', express.static(path.join(__dirname, 'node_modules')));
// Middleware for all requests
// response_id is logged on request, response, and error to link them together
app.use(function(req, res, next) {res.locals.response_id = uuidv4(); next();});
app.use(function(req, res, next) {res.locals.config = config; next();});
// load accounting for requests
app.use(function(req, res, next) {load.startJob('request', res.locals.response_id); next();});
app.use(function(req, res, next) {
onFinished(res, function (err, res) {
if (ERR(err, () => {})) logger.verbose('on-request-finished error', {err});
load.endJob('request', res.locals.response_id);
});
next();
});
// More middlewares
app.use(require('./middlewares/logResponse')); // defers to end of response
app.use(require('./middlewares/cors'));
app.use(require('./middlewares/date'));
app.use('/pl/oauth2login', require('./pages/authLoginOAuth2/authLoginOAuth2'));
app.use('/pl/oauth2callback', require('./pages/authCallbackOAuth2/authCallbackOAuth2'));
app.use('/pl/shibcallback', require('./pages/authCallbackShib/authCallbackShib'));
app.use('/pl/azure_login', require('./pages/authLoginAzure/authLoginAzure'));
app.use('/pl/azure_callback', require('./pages/authCallbackAzure/authCallbackAzure'));
app.use('/pl/lti', require('./pages/authCallbackLti/authCallbackLti'));
app.use('/pl/login', require('./pages/authLogin/authLogin'));
// disable SEB until we can fix the mcrypt issues
// app.use('/pl/downloadSEBConfig', require('./pages/studentSEBConfig/studentSEBConfig'));
app.use(require('./middlewares/authn')); // authentication, set res.locals.authn_user
app.use('/pl/api', require('./middlewares/authnToken')); // authn for the API, set res.locals.authn_user
app.use(require('./middlewares/csrfToken')); // sets and checks res.locals.__csrf_token
app.use(require('./middlewares/logRequest'));
// load accounting for authenticated accesses
app.use(function(req, res, next) {load.startJob('authed_request', res.locals.response_id); next();});
app.use(function(req, res, next) {
onFinished(res, function (err, res) {
if (ERR(err, () => {})) logger.verbose('on-request-finished error', {err});
load.endJob('authed_request', res.locals.response_id);
});
next();
});
// clear all cached course code in dev mode (no authorization needed)
if (config.devMode) {
app.use(require('./middlewares/undefCourseCode'));
}
// clear cookies on the homepage to reset any stale session state
app.use(/^\/pl\/?/, require('./middlewares/clearCookies'));
// some pages don't need authorization
app.use('/', require('./pages/home/home'));
app.use('/pl', require('./pages/home/home'));
app.use('/pl/settings', require('./pages/userSettings/userSettings'));
app.use('/pl/enroll', require('./pages/enroll/enroll'));
app.use('/pl/logout', require('./pages/authLogout/authLogout'));
app.use('/pl/password', require('./pages/authPassword/authPassword'));
// dev-mode pages are mounted for both out-of-course access (here) and within-course access (see below)
if (config.devMode) {
app.use('/pl/loadFromDisk', require('./pages/instructorLoadFromDisk/instructorLoadFromDisk'));
app.use('/pl/jobSequence', require('./pages/instructorJobSequence/instructorJobSequence'));
}
// all pages under /pl/course_instance require authorization
app.use('/pl/course_instance/:course_instance_id', require('./middlewares/authzCourseInstance')); // sets res.locals.course and res.locals.courseInstance
app.use('/pl/course_instance/:course_instance_id', function(req, res, next) {res.locals.urlPrefix = '/pl/course_instance/' + req.params.course_instance_id; next();});
app.use('/pl/course_instance/:course_instance_id', function(req, res, next) {res.locals.navbarType = 'student'; next();});
// Redirect plain course page to Instructor or Student assessments page.
// We have to do this after initial authz so we know whether we are an Instructor,
// but before instructor authz so we still get a chance to enforce that.
app.use(/^\/pl\/course_instance\/[0-9]+\/?$/, function(req, res, _next) {
if (res.locals.authz_data.has_instructor_view) {
res.redirect(res.locals.urlPrefix + '/instructor/assessments');
} else {
res.redirect(res.locals.urlPrefix + '/assessments');
}
});
// Redirect Instructor effectiveUser page to the Student version if we don't have Instructor authz.
// This is needed to handle the redirection after we change effective user to a student.
app.use(/^\/pl\/course_instance\/[0-9]+\/instructor\/effectiveUser(\/?.*)$/, function(req, res, next) {
if (!res.locals.authz_data.has_instructor_view) {
res.redirect(res.locals.urlPrefix + '/effectiveUser');
} else {
next();
}
});
// all pages under /pl/course_instance/*/instructor require instructor permissions
app.use('/pl/course_instance/:course_instance_id/instructor', require('./middlewares/authzCourseInstanceHasInstructorView'));
app.use('/pl/course_instance/:course_instance_id/instructor', function(req, res, next) {res.locals.urlPrefix = '/pl/course_instance/' + req.params.course_instance_id + '/instructor'; next();});
app.use('/pl/course_instance/:course_instance_id/instructor', function(req, res, next) {res.locals.navbarType = 'instructor'; next();});
app.use('/pl/course_instance/:course_instance_id/instructor', require('./middlewares/selectOpenIssueCount'));
// Serve element statics
app.use('/pl/static/elements', require('./pages/elementFiles/elementFiles'));
app.use('/pl/course_instance/:course_instance_id/elements', require('./pages/elementFiles/elementFiles'));
//////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
// API ///////////////////////////////////////////////////////////////
app.use('/pl/api/v1', require('./api/v1'));
//////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
// Instructor pages //////////////////////////////////////////////////
app.use('/pl/course_instance/:course_instance_id/instructor/effectiveUser', [
require('./pages/instructorEffectiveUser/instructorEffectiveUser'),
]);
app.use('/pl/course_instance/:course_instance_id/instructor/assessments', [
require('./pages/instructorAssessments/instructorAssessments'),
]);
// single assessment
app.use('/pl/course_instance/:course_instance_id/instructor/assessment/:assessment_id', [
require('./middlewares/selectAndAuthzAssessment'),
]);
app.use(/^(\/pl\/course_instance\/[0-9]+\/instructor\/assessment\/[0-9]+)\/?$/, (req, res, _next) => {
res.redirect(`${req.params[0]}/questions`);
});
app.use('/pl/course_instance/:course_instance_id/instructor/assessment/:assessment_id/questions', [
require('./pages/instructorAssessmentQuestions/instructorAssessmentQuestions'),
]);
app.use('/pl/course_instance/:course_instance_id/instructor/assessment/:assessment_id/access', [
require('./pages/instructorAssessmentAccess/instructorAssessmentAccess'),
]);
app.use('/pl/course_instance/:course_instance_id/instructor/assessment/:assessment_id/assessment_statistics', [
require('./pages/instructorAssessmentStatistics/instructorAssessmentStatistics'),
]);
app.use('/pl/course_instance/:course_instance_id/instructor/assessment/:assessment_id/question_statistics', [
require('./pages/shared/assessmentStatDescriptions'),
require('./pages/shared/floatFormatters'),
require('./pages/instructorAssessmentQuestionStatistics/instructorAssessmentQuestionStatistics'),
]);
app.use('/pl/course_instance/:course_instance_id/instructor/assessment/:assessment_id/downloads', [
require('./pages/instructorAssessmentDownloads/instructorAssessmentDownloads'),
]);
app.use('/pl/course_instance/:course_instance_id/instructor/assessment/:assessment_id/uploads', [
require('./pages/instructorAssessmentUploads/instructorAssessmentUploads'),
]);
app.use('/pl/course_instance/:course_instance_id/instructor/assessment/:assessment_id/regrading', [
require('./pages/instructorAssessmentRegrading/instructorAssessmentRegrading'),
]);
app.use('/pl/course_instance/:course_instance_id/instructor/assessment/:assessment_id/instances', [
require('./pages/instructorAssessmentInstances/instructorAssessmentInstances'),
]);
app.use('/pl/course_instance/:course_instance_id/instructor/assessment_instance/:assessment_instance_id', [
require('./middlewares/selectAndAuthzAssessmentInstance'),
require('./pages/shared/floatFormatters'),
require('./pages/instructorAssessmentInstance/instructorAssessmentInstance'),
]);
app.use('/pl/course_instance/:course_instance_id/instructor/question/:question_id', [
require('./middlewares/selectAndAuthzInstructorQuestion'),
require('./pages/shared/assessmentStatDescriptions'),
require('./pages/shared/floatFormatters'),
require('./pages/instructorQuestion/instructorQuestion'),
]);
app.use('/pl/course_instance/:course_instance_id/instructor/gradebook', require('./pages/instructorGradebook/instructorGradebook'));
app.use('/pl/course_instance/:course_instance_id/instructor/questions', require('./pages/instructorQuestions/instructorQuestions'));
app.use('/pl/course_instance/:course_instance_id/instructor/issues', require('./pages/instructorIssues/instructorIssues'));
app.use('/pl/course_instance/:course_instance_id/instructor/grading_job', require('./pages/instructorGradingJob/instructorGradingJob'));
app.use('/pl/course_instance/:course_instance_id/instructor/syncs', require('./pages/courseSyncs/courseSyncs'));
app.use('/pl/course_instance/:course_instance_id/instructor/jobSequence', require('./pages/instructorJobSequence/instructorJobSequence'));
app.use('/pl/course_instance/:course_instance_id/instructor/loadFromDisk', require('./pages/instructorLoadFromDisk/instructorLoadFromDisk'));
// admin pages
app.use(/^(\/pl\/course_instance\/[0-9]+\/instructor\/admin)\/?$/, (req, res, _next) => {
res.redirect(`${req.params[0]}/access`);
});
app.use('/pl/course_instance/:course_instance_id/instructor/admin/access', [
require('./pages/instructorAdminAccess/instructorAdminAccess'),
]);
app.use('/pl/course_instance/:course_instance_id/instructor/admin/lti', [
require('./pages/instructorAdminLti/instructorAdminLti'),
]);
app.use('/pl/course_instance/:course_instance_id/instructor/admin/course', [
require('./middlewares/authzCourseInstanceHasCourseView'),
require('./pages/courseOverview/courseOverview'),
]);
// clientFiles
app.use('/pl/course_instance/:course_instance_id/instructor/clientFilesCourse', require('./pages/clientFilesCourse/clientFilesCourse'));
app.use('/pl/course_instance/:course_instance_id/instructor/clientFilesCourseInstance', require('./pages/clientFilesCourseInstance/clientFilesCourseInstance'));
app.use('/pl/course_instance/:course_instance_id/instructor/assessment/:assessment_id/clientFilesAssessment', [
require('./middlewares/selectAndAuthzAssessment'),
require('./pages/clientFilesAssessment/clientFilesAssessment'),
]);
app.use('/pl/course_instance/:course_instance_id/instructor/question/:question_id/clientFilesQuestion', [
require('./middlewares/selectAndAuthzInstructorQuestion'),
require('./pages/clientFilesQuestion/clientFilesQuestion'),
]);
// generatedFiles
app.use('/pl/course_instance/:course_instance_id/instructor/question/:question_id/generatedFilesQuestion', [
require('./middlewares/selectAndAuthzInstructorQuestion'),
require('./pages/instructorGeneratedFilesQuestion/instructorGeneratedFilesQuestion'),
]);
// legacy client file paths
app.use('/pl/course_instance/:course_instance_id/instructor/question/:question_id/file', [
require('./middlewares/selectAndAuthzInstructorQuestion'),
require('./pages/legacyQuestionFile/legacyQuestionFile'),
]);
app.use('/pl/course_instance/:course_instance_id/instructor/question/:question_id/text', [
require('./middlewares/selectAndAuthzInstructorQuestion'),
require('./pages/legacyQuestionText/legacyQuestionText'),
]);
//////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
// Student pages /////////////////////////////////////////////////////
// Exam/Homeworks student routes are polymorphic - they have multiple handlers, each of
// which checks the assessment type and calls next() if it's not the right type
app.use('/pl/course_instance/:course_instance_id/assessments', [
require('./middlewares/logPageView')('studentAssessments'),
require('./middlewares/studentAssessmentAccess'),
require('./pages/studentAssessments/studentAssessments'),
]);
app.use('/pl/course_instance/:course_instance_id/assessment/:assessment_id', [
require('./middlewares/selectAndAuthzAssessment'),
require('./middlewares/logPageView')('studentAssessment'),
require('./middlewares/studentAssessmentAccess'),
require('./pages/studentAssessmentHomework/studentAssessmentHomework'),
require('./pages/studentAssessmentExam/studentAssessmentExam'),
]);
app.use('/pl/course_instance/:course_instance_id/assessment_instance/:assessment_instance_id', [
require('./middlewares/selectAndAuthzAssessmentInstance'),
require('./middlewares/logPageView')('studentAssessmentInstance'),
require('./middlewares/studentAssessmentAccess'),
require('./pages/studentAssessmentInstanceHomework/studentAssessmentInstanceHomework'),
require('./pages/studentAssessmentInstanceExam/studentAssessmentInstanceExam'),
]);
app.use('/pl/course_instance/:course_instance_id/instance_question/:instance_question_id', [
require('./middlewares/selectAndAuthzInstanceQuestion'),
// don't use logPageView here, we load it inside the page so it can get the variant_id
require('./middlewares/studentAssessmentAccess'),
require('./pages/studentInstanceQuestionHomework/studentInstanceQuestionHomework'),
require('./pages/studentInstanceQuestionExam/studentInstanceQuestionExam'),
]);
app.use('/pl/course_instance/:course_instance_id/report_cheating', require('./pages/studentReportCheating/studentReportCheating'));
if (config.devMode) {
app.use('/pl/course_instance/:course_instance_id/loadFromDisk', require('./pages/instructorLoadFromDisk/instructorLoadFromDisk'));
app.use('/pl/course_instance/:course_instance_id/jobSequence', require('./middlewares/authzCourseInstanceAuthnHasInstructorView'));
app.use('/pl/course_instance/:course_instance_id/jobSequence', require('./pages/instructorJobSequence/instructorJobSequence'));
}
// Allow access to effectiveUser as a Student page, but only for users have authn (not authz) as Instructor
app.use('/pl/course_instance/:course_instance_id/effectiveUser', require('./middlewares/authzCourseInstanceAuthnHasInstructorView'));
app.use('/pl/course_instance/:course_instance_id/effectiveUser', require('./pages/instructorEffectiveUser/instructorEffectiveUser'));
// clientFiles
app.use('/pl/course_instance/:course_instance_id/clientFilesCourse', [
require('./middlewares/studentAssessmentAccess'),
require('./pages/clientFilesCourse/clientFilesCourse'),
]);
app.use('/pl/course_instance/:course_instance_id/clientFilesCourseInstance', [
require('./middlewares/studentAssessmentAccess'),
require('./pages/clientFilesCourseInstance/clientFilesCourseInstance'),
]);
app.use('/pl/course_instance/:course_instance_id/assessment/:assessment_id/clientFilesAssessment', [
require('./middlewares/selectAndAuthzAssessment'),
require('./middlewares/studentAssessmentAccess'),
require('./pages/clientFilesAssessment/clientFilesAssessment'),
]);
app.use('/pl/course_instance/:course_instance_id/instance_question/:instance_question_id/clientFilesQuestion', [
require('./middlewares/selectAndAuthzInstanceQuestion'),
require('./middlewares/studentAssessmentAccess'),
require('./pages/clientFilesQuestion/clientFilesQuestion'),
]);
// generatedFiles
app.use('/pl/course_instance/:course_instance_id/instance_question/:instance_question_id/generatedFilesQuestion', [
require('./middlewares/selectAndAuthzInstanceQuestion'),
require('./middlewares/studentAssessmentAccess'),
require('./pages/studentGeneratedFilesQuestion/studentGeneratedFilesQuestion'),
]);
// legacy client file paths
app.use('/pl/course_instance/:course_instance_id/instance_question/:instance_question_id/file', [
require('./middlewares/selectAndAuthzInstanceQuestion'),
require('./middlewares/studentAssessmentAccess'),
require('./pages/legacyQuestionFile/legacyQuestionFile'),
]);
app.use('/pl/course_instance/:course_instance_id/instance_question/:instance_question_id/text', [
require('./middlewares/selectAndAuthzInstanceQuestion'),
require('./middlewares/studentAssessmentAccess'),
require('./pages/legacyQuestionText/legacyQuestionText'),
]);
//////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
// Course pages //////////////////////////////////////////////////////
app.use('/pl/course/:course_id', require('./middlewares/authzCourse')); // set res.locals.course
app.use('/pl/course/:course_id', function(req, res, next) {res.locals.urlPrefix = '/pl/course/' + req.params.course_id; next();});
app.use('/pl/course/:course_id', function(req, res, next) {res.locals.navbarType = 'course'; next();});
app.use(/^\/pl\/course\/[0-9]+\/?$/, function(req, res, _next) {res.redirect(res.locals.urlPrefix + '/overview');}); // redirect plain course URL to overview page
app.use('/pl/course/:course_id/overview', require('./pages/courseOverview/courseOverview'));
app.use('/pl/course/:course_id/loadFromDisk', require('./pages/instructorLoadFromDisk/instructorLoadFromDisk'));
app.use('/pl/course/:course_id/syncs', require('./pages/courseSyncs/courseSyncs'));
app.use('/pl/course/:course_id/jobSequence', require('./pages/instructorJobSequence/instructorJobSequence'));
//////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
// Administrator pages ///////////////////////////////////////////////
app.use('/pl/administrator', require('./middlewares/authzIsAdministrator'));
app.use('/pl/administrator/overview', require('./pages/administratorOverview/administratorOverview'));
//////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
// Webhooks //////////////////////////////////////////////////////////
app.get('/pl/webhooks/ping', function(req, res, _next) {res.send('.');});
app.use('/pl/webhooks/grading', require('./webhooks/grading/grading'));
//////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
// Error handling ////////////////////////////////////////////////////
app.use(require('./middlewares/notFound')); // if no earlier routes matched, this will match and generate a 404 error
app.use(require('./pages/error/error'));
//////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
// Server startup ////////////////////////////////////////////////////
var server;
module.exports.startServer = function(callback) {
if (config.serverType === 'https') {
var options = {
key: fs.readFileSync('/etc/pki/tls/private/localhost.key'),
cert: fs.readFileSync('/etc/pki/tls/certs/localhost.crt'),
ca: [fs.readFileSync('/etc/pki/tls/certs/server-chain.crt')],
};
server = https.createServer(options, app);
server.listen(config.serverPort);
server.timeout = 600000; // 10 minutes
logger.verbose('server listening to HTTPS on port ' + config.serverPort);
callback(null);
} else if (config.serverType === 'http') {
server = http.createServer(app);
server.listen(config.serverPort);
server.timeout = 600000; // 10 minutes
logger.verbose('server listening to HTTP on port ' + config.serverPort);
callback(null);
} else {
callback('unknown serverType: ' + config.serverType);
}
};
module.exports.stopServer = function(callback) {
if (!server) return callback(new Error('cannot stop an undefined server'));
server.close(function(err) {
if (ERR(err, callback)) return;
callback(null);
});
};
module.exports.insertDevUser = function(callback) {
// add dev user as Administrator
var sql
= 'INSERT INTO users (uid, name)'
+ ' VALUES (\'[email protected]\', \'Dev User\')'
+ ' ON CONFLICT (uid) DO UPDATE'
+ ' SET name = EXCLUDED.name'
+ ' RETURNING user_id;';
sqldb.queryOneRow(sql, [], function(err, result) {
if (ERR(err, callback)) return;
var user_id = result.rows[0].user_id;
var sql
= 'INSERT INTO administrators (user_id)'
+ ' VALUES ($user_id)'
+ ' ON CONFLICT (user_id) DO NOTHING;';
var params = {user_id};
sqldb.query(sql, params, function(err, _result) {
if (ERR(err, callback)) return;
callback(null);
});
});
};
if (config.startServer) {
async.series([
function(callback) {
var pgConfig = {
user: config.postgresqlUser,
database: config.postgresqlDatabase,
host: config.postgresqlHost,
password: config.postgresqlPassword,
max: 100,
idleTimeoutMillis: 30000,
};
logger.verbose('Connecting to database ' + pgConfig.user + '@' + pgConfig.host + ':' + pgConfig.database);
var idleErrorHandler = function(err) {
logger.error('idle client error', err);
};
sqldb.init(pgConfig, idleErrorHandler, function(err) {
if (ERR(err, callback)) return;
logger.verbose('Successfully connected to database');
callback(null);
});
},
function(callback) {
migrations.init(function(err) {
if (ERR(err, callback)) return;
callback(null);
});
},
function(callback) {
sprocs.init(function(err) {
if (ERR(err, callback)) return;
callback(null);
});
},
function(callback) {
if ('migrate-and-exit' in argv && argv['migrate-and-exit']) {
logger.info('option --migrate-and-exit passed, running DB setup and exiting');
process.exit(0);
} else {
callback(null);
}
},
function(callback) {
cron.init(function(err) {
if (ERR(err, callback)) return;
callback(null);
});
},
(callback) => {
redis.init((err) => {
if (ERR(err, callback)) return;
callback(null);
});
},
(callback) => {
cache.init((err) => {
if (ERR(err, callback)) return;
callback(null);
});
},
(callback) => {
externalGrader.init(assessment, (err) => {
if (ERR(err, callback)) return;
callback(null);
});
},
(callback) => {
externalGraderResults.init((err) => {
if (ERR(err, callback)) return;
callback(null);
});
},
function(callback) {
if (!config.devMode) return callback(null);
module.exports.insertDevUser(function(err) {
if (ERR(err, callback)) return;
callback(null);
});
},
function(callback) {
load.initEstimator('request', 1);
load.initEstimator('authed_request', 1);
load.initEstimator('python', 1, false);
load.initEstimator('python_worker_active', 1);
load.initEstimator('python_worker_idle', 1, false);
load.initEstimator('python_callback_waiting', 1);
callback(null);
},
function(callback) {
workers.init();
callback(null);
},
function(callback) {
logger.verbose('Starting server...');
module.exports.startServer(function(err) {
if (ERR(err, callback)) return;
callback(null);
});
},
function(callback) {
socketServer.init(server, function(err) {
if (ERR(err, callback)) return;
callback(null);
});
},
function(callback) {
externalGradingSocket.init(function(err) {
if (ERR(err, callback)) return;
callback(null);
});
},
function(callback) {
serverJobs.init(function(err) {
if (ERR(err, callback)) return;
callback(null);
});
},
function(callback) {
freeformServer.init(function(err) {
if (ERR(err, callback)) return;
callback(null);
});
},
], function(err, data) {
if (err) {
logger.error('Error initializing PrairieLearn server:', err, data);
logger.error('Exiting...');
process.exit(1);
} else {
logger.info('PrairieLearn server ready, press Control-C to quit');
if (config.devMode) {
logger.info('Go to ' + config.serverType + '://localhost:' + config.serverPort + '/pl');
}
if ('exit' in argv) { logger.info('exit option passed, quitting...'); process.exit(0); }
}
});
}
module.exports.app = app;