forked from js-kyle/nodejs-lti-provider
-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathapp.js
More file actions
600 lines (513 loc) · 20.6 KB
/
app.js
File metadata and controls
600 lines (513 loc) · 20.6 KB
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
'use strict';
require('dotenv').config();
const pkg = require('./package.json');
const bodyParser = require('body-parser');
const express = require('express');
const session = require('express-session');
const FileStore = require('session-file-store')(session);
const helmet = require('helmet');
const cors = require('cors');
const oauth = require('./oauth');
const canvas = require('./canvas');
const lti = require('./lti');
const log = require('./log');
const db = require('./db');
const error = require('./error');
const port = process.env.PORT || 3000;
const cookieMaxAge = 3600000 * 12; // 12h
const fileStoreOptions = { ttl: 3600 * 12, retries: 3, logFn: log.info };
const adminUserIds = process.env.adminCanvasUserIds ? process.env.adminCanvasUserIds.split(",") : [];
const NODE_MAJOR_VERSION = process.versions.node.split('.')[0];
const NODE_MINOR_VERSION = process.versions.node.split('.')[1];
const app = express();
app.use(helmet({
frameguard: false
}));
app.use(bodyParser.urlencoded({
extended: false
}));
app.disable('X-Powered-By');
app.set('view engine', 'pug');
app.set('json spaces', 2);
app.use(cors());
app.use(express.json());
app.use(express.urlencoded({ extended: true }));
const sessionOptions = {
store: new FileStore(fileStoreOptions),
name: process.env.SESSION_NAME ? process.env.SESSION_NAME : "groupTool.sid",
secret: process.env.SESSION_SECRET ? process.env.SESSION_SECRET : "keyboard cat fish mouse",
resave: false,
saveUninitialized: false,
rolling: true,
cookie: { maxAge: cookieMaxAge, sameSite: 'none' }
};
if (process.env.NODE_ENV === "production") {
app.set('trust proxy', 1);
sessionOptions.cookie.secure = true;
}
app.use(session(sessionOptions));
app.use("/assets", express.static(__dirname + '/public/assets'));
// Content Security Policy Header
app.use(function (req, res, next) {
res.setHeader(
'Content-Security-Policy',
"default-src 'self'; script-src 'self' cdn.jsdelivr.net maxcdn.bootstrapcdn.com ajax.googleapis.com unpkg.com; style-src 'self' 'unsafe-inline' cdn.jsdelivr.net maxcdn.bootstrapcdn.com fonts.googleapis.com; font-src 'self' cdn.jsdelivr.net fonts.gstatic.com fonts.googleapis.com; img-src 'self' data:; frame-src 'self'" + (process.env.CSP_FRAME_SRC_ALLOW ? " " + process.env.CSP_FRAME_SRC_ALLOW : "")
);
res.setHeader(
'Access-Control-Allow-Origin', '*'
);
next();
});
// Mock local session
app.use(function (req, res, next) {
if (process.env.NODE_ENV === 'development' && process.env.localCanvasDeveloperToken) {
lti.mockLocalSession(req, res, next);
}
next();
});
app.get('/', (request, response) => {
return response.send({
status: 'up',
version: pkg.version,
node: process.version
});
});
app.get('/json/stats', async(request, response) => {
if (request.session.userId) {
if (adminUserIds.length && adminUserIds.includes(request.session.userId)) {
const authorizedUsers = await db.getAllClientsData();
const selfSignupConfig = await db.getAllSelfSignupConfigData();
const cacheContents = await canvas.getCacheStat();
let now = new Date();
var activeUsersToday = 0;
let cacheStats = [];
authorizedUsers.forEach(user => {
if (user.updated_at.substr(0, 10) == now.toISOString().substr(0, 10)) {
activeUsersToday++;
}
});
cacheContents.forEach(cache => {
cache.dashboard && cacheStats.push({ name: cache.name, reads: cache.reads, writes: cache.writes });
});
return response.send({
version: pkg.version,
authorized_users: authorizedUsers.length,
active_users_today: activeUsersToday,
self_signup_configs: selfSignupConfig.length,
cache_stats: cacheStats
});
} else {
log.error("Not in admin list.");
return response.redirect('/error/code/42'); // Admin level needed
}
} else {
log.error("No session found.");
return response.redirect('/error/code/41'); // Third-party cookies
}
});
app.get('/dashboard', async(request, response) => {
if (request.session.userId) {
if (adminUserIds.length && adminUserIds.includes(request.session.userId)) {
return response.render('dashboard', {
statistics: {
name: pkg.name,
version: pkg.version,
app_env: canvas.providerEnvironment(request),
node: process.version,
pid: process.pid,
ppid: process.ppid,
resourceUsage: NODE_MAJOR_VERSION >= 12 && NODE_MINOR_VERSION >= 6 ? JSON.stringify(process.resourceUsage(), null, 2) : 'Needs node 12.6',
versions: JSON.stringify(process.versions, null, 2)
}
});
} else {
log.error("Not in admin list.");
return response.redirect('/error/code/42'); // Admin level needed
}
} else {
log.error("No session found.");
return response.redirect('/error/code/41'); // Third-party cookies
}
});
app.get('/test/sqlite3', async (request, response) => {
if (request.session.userId && adminUserIds.length && adminUserIds.includes(request.session.userId)) {
const mocked_users = await db.getAllClientsDataMocked();
for (const user of mocked_users) {
await db.setClientData(user.user_id, user.user_env, user.api_token, user.refresh_token, user.expires_at);
}
const db_single_user = await db.getClientData('abcdef_123456', 'test');
const db_users = await db.getAllClientsData();
return response.send({
success: true,
users: {
mocked: mocked_users,
db: db_users,
single: db_single_user,
}
});
}
else {
log.error("Not in admin list.");
return response.redirect('/error/code/42'); // Admin level needed
}
});
app.get('/test/cache/reads', async(request, response) => {
let caches1 = canvas.cacheBuckets();
log.info("Before adding cache read: " + caches1.find(obj => obj.name === 'groupCategoriesCache').reads);
canvas.addCacheRead('groupCategoriesCache');
let caches2 = canvas.cacheBuckets();
log.info("After adding cache read: " + caches2.find(obj => obj.name === 'groupCategoriesCache').reads);
return response.send({
success: true
});
});
app.get('/test/cache/writes', async(request, response) => {
let caches1 = canvas.cacheBuckets();
const caches1_writes = caches1.find(obj => obj.name === 'groupCategoriesCache').writes;
log.info("Before adding cache write: " + caches1_writes);
await canvas.addCacheWrite('groupCategoriesCache');
let caches2 = canvas.cacheBuckets();
const caches2_writes = caches2.find(obj => obj.name === 'groupCategoriesCache').writes;
log.info("After adding cache write: " + caches2_writes);
return response.send({
success: true,
before_write: caches1_writes,
after_write: caches2_writes
});
});
app.get('/oauth', (request, response, next) => {
try {
return response.redirect(oauth.providerLogin(request));
} catch (error) {
next(error);
}
});
app.get('/oauth/redirect', async(request, response) => {
try {
request.session.token = await oauth.providerRequestToken(request);
log.info("[Main] Written data to session: " + JSON.stringify(request.session.token));
log.info("[Main] Redirecting to /loading/groups");
response.redirect('/loading/groups');
} catch (error) {
log.error("During OAuth token exchange: " + error);
response.redirect('/error/text/During OAuth token exchange: ' + error);
}
});
app.get('/error/code/:id', async(request, response) => {
return response.render('error', {
error: {
text: await error.errorDescription(request.params.id)
},
statistics: {
name: pkg.name,
version: pkg.version,
app_env: canvas.providerEnvironment(request),
node: process.version,
pid: process.pid,
ppid: process.ppid,
resourceUsage: NODE_MAJOR_VERSION >= 12 && NODE_MINOR_VERSION >= 6 ? JSON.stringify(process.resourceUsage(), null, 2) : 'Needs node 12.6',
versions: JSON.stringify(process.versions, null, 2)
}
});
});
app.get('/error/text/:text', (request, response) => {
return response.render('error', {
error: {
text: request.params.text
},
statistics: {
name: pkg.name,
version: pkg.version,
app_env: canvas.providerEnvironment(request),
node: process.version,
pid: process.pid,
ppid: process.ppid,
resourceUsage: NODE_MAJOR_VERSION >= 12 && NODE_MINOR_VERSION >= 6 ? JSON.stringify(process.resourceUsage(), null, 2) : 'Needs node 12.6',
versions: JSON.stringify(process.versions, null, 2)
}
});
});
app.get('/stats', async(request, response) => {
if (request.session.userId) {
if (adminUserIds.length && adminUserIds.includes(request.session.userId)) {
const authorizedUsers = await db.getAllClientsData();
const cacheContents = await canvas.getCacheStat();
return response.render('stats', {
users: authorizedUsers,
usersString: JSON.stringify(authorizedUsers, null, 2),
caches: cacheContents,
cachesString: JSON.stringify(cacheContents, null, 2),
statistics: {
name: pkg.name,
version: pkg.version,
app_env: canvas.providerEnvironment(request),
node: process.version,
pid: process.pid,
ppid: process.ppid,
resourceUsage: NODE_MAJOR_VERSION >= 12 && NODE_MINOR_VERSION >= 6 ? JSON.stringify(process.resourceUsage(), null, 2) : 'Needs node 12.6',
versions: JSON.stringify(process.versions, null, 2)
}
});
} else {
log.error("Not in admin list.");
return response.redirect('/error/code/42'); // Admin level needed
}
} else {
log.error("No session found.");
return response.redirect('/error/code/41'); // Third-party cookies
}
});
app.get('/loading/:page', async(request, response) => {
return response.render('loading', { page: request.params.page });
});
/**
* General user interface for viewing and downloading csv files, plus configuring Self signup rules.
*/
app.get('/groups', async (request, response, next) => {
if (request.session.userId && request.session.canvasCourseId) {
try {
const data = await canvas.compileGroupsData(request.session.canvasCourseId, request);
data.statistics.name = pkg.name;
data.statistics.version = pkg.version;
data.statistics.node = process.version;
data.statistics.app_env = canvas.providerEnvironment(request);
data.user.isAdmin = adminUserIds.length && adminUserIds.includes(request.session.userId);
return response.render('groups', data);
} catch (error) {
log.error(error);
if (error.response.status == 401) {
try {
return response.redirect(oauth.providerLogin());
} catch (error) {
next(error);
}
} else {
next(new Error(error));
}
}
} else {
log.error("No session found.");
return response.redirect('/error/code/41'); // Third-party cookies
}
});
/**
* Public API used by Canvas injected custom js to get information on self signup
* and submissions to configured assignment for a specific user.
*/
app.get('/api/self-signup/:course_id/:user_id', async (request, response) => {
let returnedData = {};
let groupData = [];
try {
const assignment = await db.getSelfSignupConnectedAssignments(request.params.course_id);
for (const a of assignment) {
let groups = await canvas.getCategoryGroups(a.group_category_id, request, process.env.systemApiToken);
let userSubmission = await canvas.getAssignmentGrade(request.params.course_id, a.assignment_id, request.params.user_id, request, process.env.systemApiToken);
for (const g of groups) {
groupData.push({
id: g.id,
name: g.name,
passed: userSubmission.score >= a.min_points ? true : false,
description: a.description,
debug: userSubmission
});
}
}
returnedData = {
success: true,
groups: groupData
};
log.info(`[SelfSignupPublicApi] Course id ${request.params.course_id} user id ${request.params.user_id} returned ${JSON.stringify(returnedData)}`);
}
catch (error) {
log.error(error);
}
return response.json(returnedData);
});
/**
* API for deleting a ruleset.
*/
app.delete('/api/config/self-signup/:id', async (request, response, next) => {
if (request.session.userId && request.session.canvasCourseId) {
let responseData = {};
try {
await db.clearSelfSignupConfig(request.session.canvasCourseId, request.params.id);
log.info(`[SelfSignupConfig] Course id ${request.session.canvasCourseId} rule id ${request.params.id} cleared.`);
responseData = {
success: true,
message: "Self signup rule cleared."
};
}
catch (error) {
log.error(error);
if (error.response.status == 401) {
try {
return response.redirect(oauth.providerLogin());
}
catch (error) {
next(error);
}
} else {
responseData = {
success: false,
message: error.message
};
}
}
return response.send(responseData);
}
else {
log.error("No session found.");
return response.redirect('/error/code/41'); // Third-party cookies
}
});
/**
* API for creating or updating a ruleset.
*/
app.put('/api/config/self-signup/:id', async (request, response, next) => {
if (request.session.userId && request.session.canvasCourseId) {
const { assignment_id, description, min_points } = request.body;
let responseData = {};
try {
await db.setSelfSignupConfig(request.session.canvasCourseId, request.params.id, assignment_id, description, min_points, 'production');
const writtenData = await db.getSelfSignupConfig(request.session.canvasCourseId, request.params.id);
log.info(`[SelfSignupConfig] Course id ${request.session.canvasCourseId} rule id ${request.params.id} created/updated.`);
responseData = {
success: true,
message: "Rule was created or updated.",
written_data: writtenData
};
}
catch (error) {
log.error(error);
if (error.response?.status == 401) {
try {
return response.redirect(oauth.providerLogin());
}
catch (error) {
next(error);
}
} else {
responseData = {
success: false,
message: error.message
};
}
}
return response.send(responseData);
}
else {
log.error("No session found.");
return response.redirect('/error/code/41'); // Third-party cookies
}
});
app.get('/api/config/self-signup/:id/:name(*)', async (request, response, next) => {
if (request.session.userId && request.session.canvasCourseId) {
try {
const data = {
course: {
id: request.session.canvasCourseId
},
category: {
id: request.params.id,
name: request.params.name
},
current: await db.getSelfSignupConfig(request.session.canvasCourseId, request.params.id),
assignments: await canvas.getCourseAssignments(request.session.canvasCourseId, request)
}
console.log(JSON.stringify(data));
return response.json(data);
}
catch (error) {
log.error(error);
if (error.response.status == 401) {
try {
return response.redirect(oauth.providerLogin());
} catch (error) {
next(error);
}
} else {
next(new Error(error));
}
}
} else {
log.error("No session found.");
return response.redirect('/error/code/41'); // Third-party cookies
}
});
/**
* API for clearing the caches for a course
*/
app.get('/api/config/clear-cache/:course_id', async(request, response) => {
if (request.session.userId) {
await canvas.clearCourseCache(request.params.course_id, request);
return response.send({
success: true
});
}
else {
log.error("No session found.");
return response.send({
success: false,
message: "No session, you must enable third-party cookies."
});
}
});
app.get('/csv/category/:id/:name', async(request, response, next) => {
if (request.session.userId && request.session.canvasCourseId) {
try {
const id = request.params.id;
const name = request.params.name;
if (id > 0) {
const data = await canvas.compileCategoryGroupsData(id, request);
response.setHeader("Content-Disposition", "attachment; filename=Canvas Groups " + name.replace(/[^a-zA-Z0-9\s]+/g, "-").replace(/[\-]+$/, "") + ".csv");
response.set("Content-Type", "text/csv");
let csvData = "\ufeffGroup;Student;Email address\r\n";
for (const group of data.categories[0].groups) {
for (const user of group.users) {
csvData = csvData + "\"" + group.name + "\";\"" + user.sortableName + "\";\"" + user.email + "\"\r\n";
}
}
return response.status(200).end(csvData);
} else {
throw (new Error("Category id missing."));
}
} catch (error) {
next(new Error(error));
}
} else {
return response.redirect('/error/code/41'); // Third-party cookies
}
});
app.get('/csv/zoom/category/:id/:name', async(request, response, next) => {
if (request.session.userId && request.session.canvasCourseId) {
try {
const id = request.params.id;
const name = request.params.name;
if (id > 0) {
const data = await canvas.compileCategoryGroupsData(id, request);
response.setHeader("Content-Disposition", "attachment; filename=Zoom Breakout Rooms from Canvas " + name.replace(/[^a-zA-Z0-9\s]+/g, "-").replace(/[\-]+$/, "") + ".csv");
response.set("Content-Type", "text/csv");
let csvData = "Pre-assign Room Name,Email Address\r\n";
for (const group of data.categories[0].groups) {
for (const user of group.users) {
csvData = csvData + group.name + "," + (user.email.includes("student.chalmers") ? user.login_id.split("@")[0] + "@student.chalmers.se" : user.login_id) + "\r\n";
}
}
return response.status(200).end(csvData);
} else {
throw (new Error("Category id missing."));
}
} catch (error) {
next(new Error(error));
}
} else {
return response.redirect('/error/code/41'); // Third-party cookies
}
});
app.post('/launch_lti', lti.handleLaunch('loading/groups'));
app.post('/launch_lti_stats', lti.handleLaunch('loading/dashboard'));
app.listen(port, () => log.info(`[Main] Application listening on port ${port}.`));
process.on('uncaughtException', (err) => {
console.error('[Main] There was an uncaught error', err);
process.exit(1); //mandatory (as per the Node docs)
});