blob: 45e9304e5be9c377a2950308f607be5cbe529722 [file] [log] [blame]
j7940eec2020-12-28 14:00:41 -06001/**
2 * @file DTPS Canvas LMS Integration
3 * @author jottocraft
4 *
j6e1a7bf2026-10-13 03:37:04 +00005 * @copyright Copyright (c) jottocraft 2020
j40db0272022-01-14 15:18:29 -08006 * @license MIT
j7940eec2020-12-28 14:00:41 -06007 *
8 * JSDoc documentation for these LMS functions can be found near the end of core.js
9 */
10
11//DTPS LMS configuration for Canvas
12var dtpsLMS = {
13 name: "Canvas LMS",
14 shortName: "Canvas",
15 legalName: "Canvas LMS or Instructure Inc.",
16 description: "Power+ integration for Canvas LMS",
17 url: "https://www.instructure.com/canvas/",
j450fbd42022-09-01 11:13:11 -070018 inboxURL: "/conversations",
j7940eec2020-12-28 14:00:41 -060019 logo: "https://i.imgur.com/rGjNVoc.png",
j0e5b1c72026-10-13 03:49:38 +000020 source: "https://src.jottocraft.com/browser/dtps/+/refs/heads/main/scripts/lms/canvas.js",
j7940eec2020-12-28 14:00:41 -060021 genericGradebook: true
22};
23
24
25/**
26 * Common headers used for Canvas web requests.
27 * This variable is specific to Canvas LMS integration in DTPS and is not required for other LMS integrations.
28 */
j69843082023-08-22 12:26:55 -070029dtpsLMS.commonHeaders = { Accept: "application/json+canvas-string-ids, application/json", "From": "jottocraft/dtps <[email protected]>" };
j7940eec2020-12-28 14:00:41 -060030
31/**
32 * List of teachers from dtpsLMS.fetchClasses for use in other methods
33 * This variable is specific to Canvas LMS integration in DTPS and is not required for other LMS integrations.
34 */
35dtpsLMS.teacherCache = {};
36
j58471992021-01-17 19:29:37 -080037/**
38 * A queue for API requests
39 */
40dtpsLMS.fetchQueue = [];
41
42/**
43 * A function that behaves the same way as fetch, although it adds the request to the queue for spacing
44 */
45dtpsLMS.fetchWrapper = function () {
46 //Start a queue interval if it isn't already started
47 if (!dtpsLMS.fetchInterval) {
j608526f2022-04-26 20:32:47 -070048 dtpsLMS.fetchInterval = setInterval(function () {
j58471992021-01-17 19:29:37 -080049 //Run request at the start of the queue
50 if (dtpsLMS.fetchQueue[0]) {
51 dtpsLMS.fetchQueue[0]();
52 }
53 }, dtps.remoteConfig.canvasRequestSpacing);
54 }
55
56 return new Promise((resolve, reject) => {
57 dtpsLMS.fetchQueue.push(() => {
58 dtpsLMS.fetchQueue.shift();
59 fetch(...arguments).then(function (d) {
j58471992021-01-17 19:29:37 -080060 resolve(...arguments);
61 }).catch(reject);
62 });
63 });
64}
65
j7940eec2020-12-28 14:00:41 -060066//Fetch userdata from Canvas
67dtpsLMS.fetchUser = function () {
68 return new Promise(function (resolve, reject) {
j69843082023-08-22 12:26:55 -070069 dtpsLMS.fetchWrapper("/api/v1/users/self", { headers: dtpsLMS.commonHeaders }).then(response => {
70 if (response.status !== 200) reject({ action: "login", redirectURL: "/?dtpsLogin=true" });
j7940eec2020-12-28 14:00:41 -060071
j69843082023-08-22 12:26:55 -070072 return response.json();
73 }).then(userData => {
74 var user = {
75 name: userData.name,
76 id: userData.id,
77 photoURL: userData.avatar_url
78 };
j7940eec2020-12-28 14:00:41 -060079
j58471992021-01-17 19:29:37 -080080 dtpsLMS.fetchWrapper("/api/v1/users/self/observees?include[]=avatar_url", { headers: dtpsLMS.commonHeaders }).then(response => {
j7940eec2020-12-28 14:00:41 -060081 return response.json();
82 }).then(childrenData => {
83 if (childrenData && childrenData.length) {
84 //Parent account
85 user.children = childrenData.map(child => {
86 return {
87 name: child.name.split(" ")[0],
88 id: child.id,
89 photoURL: child.avatar_url
90 }
91 });
92 }
93
94 resolve(user);
95 }).catch(reject);
j69843082023-08-22 12:26:55 -070096 });
j7940eec2020-12-28 14:00:41 -060097 })
98}
99
j450fbd42022-09-01 11:13:11 -0700100//Fetch unread message count from Canvas
101dtpsLMS.fetchUnreadMessageCount = function () {
102 return new Promise(function (resolve, reject) {
103 dtpsLMS.fetchWrapper("/api/v1/conversations/unread_count", { headers: dtpsLMS.commonHeaders }).then(response => response.json()).then(data => {
104 resolve(data.unread_count);
105 }).catch(reject);
106 });
107}
108
j7940eec2020-12-28 14:00:41 -0600109//Fetch class data from Canvas
110dtpsLMS.fetchClasses = function (userID) {
111 return new Promise(function (resolve, reject) {
112 Promise.all([
j58471992021-01-17 19:29:37 -0800113 dtpsLMS.fetchWrapper("/api/v1/users/" + dtps.user.id + "/colors", { headers: dtpsLMS.commonHeaders }),
114 dtpsLMS.fetchWrapper("/api/v1/users/" + userID + "/dashboard_positions", { headers: dtpsLMS.commonHeaders }),
115 dtpsLMS.fetchWrapper("/api/v1/users/" + userID + "/courses?per_page=100&enrollment_state=active&include[]=term&include[]=total_scores&include[]=account&include[]=teachers&include[]=course_image&include[]=tabs&include[]=sections", { headers: dtpsLMS.commonHeaders })
j7940eec2020-12-28 14:00:41 -0600116 ]).then(responses => {
117 return Promise.all(responses.map(r => r.json()));
118 }).then(data => {
119 var [colorData, dashboardData, courseData] = data;
120 var courses = [];
121
122 //Add courses from canvas to courses array as a DTPS course object
123 courseData.forEach((course, index) => {
j608526f2022-04-26 20:32:47 -0700124 const forceAllClasses = fluid.get("pref-showAllClasses") == "true";
125 if (!forceAllClasses) {
126 if (course.end_at && (new Date() > new Date(course.end_at))) return;
127 if (course.term?.end_at && (new Date() > new Date(course.term?.end_at))) return;
128 }
129
j6831cfe2021-04-19 21:06:38 -0700130 var termSegments = course.course_code.split(" - ");
j7940eec2020-12-28 14:00:41 -0600131 var dtpsCourse = {
132 name: course.course_code,
133 id: course.id,
134 lmsID: course.id,
135 people: !dtps.user.parent,
136 userID: userID,
137 period: course.sections && course.sections[0] && (course.sections.find(section => /[0-9](?=\(A)/.test(section.name)) || course.sections[0]).name,
jd80b6e02021-04-19 20:16:38 -0700138 section: course.sections && course.sections[0] && (course.sections.find(section => /[0-9](?=\(A)/.test(section.name)) || course.sections[0]).name,
j7aa22df2021-01-08 10:03:59 -0800139 subject: window.localStorage["pref-fullNames"] == "true" ? course.course_code : (course.original_name ? course.name : course.course_code.split(" - ")[0]),
j7940eec2020-12-28 14:00:41 -0600140 homepage: course.default_view == "wiki",
j6831cfe2021-04-19 21:06:38 -0700141 term: termSegments[termSegments.length - 2],
j7940eec2020-12-28 14:00:41 -0600142 color: colorData.custom_colors["course_" + course.id],
143 grade: course.enrollments[0].computed_current_score,
144 letter: course.enrollments[0].computed_current_grade,
145 image: course.image_download_url,
146 newDiscussionThreadURL: '/courses/' + course.id + '/discussion_topics/new',
147 pages: course.tabs.map(tab => tab.id).includes("pages"),
148 modules: course.tabs.map(tab => tab.id).includes("modules"),
149 discussions: true || course.tabs.map(tab => tab.id).includes("discussions"),
j324e5f12021-01-26 13:43:49 -0800150 endDate: course.end_at,
j2566c4e2021-10-01 15:25:49 -0700151 startDate: course.start_at,
152 termEndDate: course.term?.end_at,
153 termStartDate: course.term?.start_at
j7940eec2020-12-28 14:00:41 -0600154 };
155
156 //Save teachers in cache
157 dtpsLMS.teacherCache[course.id] = course.teachers;
158
jd80b6e02021-04-19 20:16:38 -0700159 if (course.teachers.length == 1) {
j7940eec2020-12-28 14:00:41 -0600160 dtpsCourse.teacher = {
161 name: course.teachers[0] && course.teachers[0].display_name,
162 id: course.teachers[0] && course.teachers[0].id,
163 photoURL: course.teachers[0] && course.teachers[0].avatar_image_url
164 };
jd80b6e02021-04-19 20:16:38 -0700165 } else {
166 var matches = 0;
167 course.teachers.forEach(teacher => {
168 teacher.display_name.split(" ").forEach((fragment) => {
169 if (dtpsCourse.name.includes(fragment)) {
170 dtpsCourse.teacher = {
171 name: teacher.display_name,
172 id: teacher.id,
173 photoURL: teacher.avatar_image_url
174 };
175 matches++;
176 }
177 });
178 });
179 if (matches > 1) delete dtpsCourse.teacher;
j7940eec2020-12-28 14:00:41 -0600180 }
181
182 courses.push(dtpsCourse);
183 });
184
185 //Sort courses array
186 courses.sort(function (a, b) {
187 var keyA = dashboardData.dashboard_positions["course_" + a.id],
188 keyB = dashboardData.dashboard_positions["course_" + b.id];
189
190 if (keyA < keyB) return -1;
191 if (keyA > keyB) return 1;
192 return 0;
193 });
194
195 resolve(courses);
196 }).catch(reject);
197 })
198}
199
200//Fetches assignment data from Canvas
201dtpsLMS.fetchAssignments = function (userID, classID) {
202 return new Promise(function (resolve, reject) {
203 Promise.all([
j58471992021-01-17 19:29:37 -0800204 dtpsLMS.fetchWrapper("/api/v1/courses/" + classID + "/students/submissions?include[]=rubric_assessment&include[]=submission_comments&per_page=100&student_ids[]=" + userID, { headers: dtpsLMS.commonHeaders }),
205 dtpsLMS.fetchWrapper("/api/v1/users/" + userID + "/courses/" + classID + "/assignments?per_page=100", { headers: dtpsLMS.commonHeaders })
206 ]).then((responses) => {
j7940eec2020-12-28 14:00:41 -0600207 return Promise.all(responses.map(r => r.json()));
208 }).then(data => {
209 var [submissionData, assignmentData] = data;
210
211 //All fetches have been completed successfully
212 var assignments = [];
213
214 //Add assignments from canvas to assignments array as a DTPS assignment object
215 assignmentData.forEach((assignment, index) => {
216 //Define dtpsAssignment
217 var dtpsAssignment = {
218 title: assignment.name,
219 body: assignment.description,
220 id: assignment.id,
221 dueAt: assignment.due_at,
222 url: assignment.html_url,
223 locked: assignment.locked_for_user,
224 publishedAt: assignment.created_at,
225 value: assignment.points_possible
226 };
227
228 //Save score names to an array temporarily
229 //This is because the scoreNames can only be found in the rubric data from Canvas
230 //And we don't know which name to use until the outcome score data is processed
231 var temporaryScoreNames = {};
232
233 //Add rubric data from Canvas to the dtpsAssignment
234 if (assignment.rubric) {
235 assignment.rubric.forEach(canvasRubric => {
236 //Add rubric array to assignment if it doesn't exist yet
237 if (!dtpsAssignment.rubric) dtpsAssignment.rubric = [];
238
239 dtpsAssignment.rubric.push({
240 title: canvasRubric.description,
241 description: canvasRubric.long_description,
242 id: canvasRubric.id,
243 value: canvasRubric.points,
244 outcome: canvasRubric.outcome_id,
245 assignmentTitle: assignment.name,
j4d933ce2022-04-08 21:49:55 +0000246 assignmentID: assignment.id,
247 assignmentDue: assignment.due_at
j7940eec2020-12-28 14:00:41 -0600248 });
249
250 temporaryScoreNames[canvasRubric.id] = {};
251 canvasRubric.ratings.forEach(canvasRating => {
252 temporaryScoreNames[canvasRubric.id][canvasRating.points] = canvasRating.description;
253 });
254 })
255 }
256
257 //Add submission data from Canvas to the dtpsAssignment
258 submissionData.forEach(submission => {
259 if (submission.assignment_id == assignment.id) {
260 //Add scores from this submission to the rubric
261 if (submission.rubric_assessment) {
j2566c4e2021-10-01 15:25:49 -0700262 let matches = 0;
263 if (dtpsAssignment.rubric) {
264 dtpsAssignment.rubric.forEach(rubric => {
265 if (submission.rubric_assessment[rubric.id]) {
266 rubric.score = submission.rubric_assessment[rubric.id].points;
267 rubric.scoreName = temporaryScoreNames[rubric.id][rubric.score];
268 matches++;
269 }
270 });
271 }
j7940eec2020-12-28 14:00:41 -0600272 }
273
274 //Check for turned in, late, missing, gradedAt, and feedback
275 dtpsAssignment.turnedIn = submission.submission_type !== null;
j4d933ce2022-04-08 21:49:55 +0000276 if (dtpsAssignment.turnedIn && dtpsAssignment.rubric) dtpsAssignment.rubric.forEach(r => r.assignmentSubmitted = true);
j7940eec2020-12-28 14:00:41 -0600277 dtpsAssignment.late = submission.late;
278 dtpsAssignment.missing = submission.missing;
279 dtpsAssignment.gradedAt = submission.graded_at;
280 dtpsAssignment.grade = submission.score;
281 var letter = submission.grade;
282 if (letter == "complete") letter = "✔️";
283 if (letter == "incomplete") letter = "❌";
284 if (isNaN(letter)) dtpsAssignment.letter = letter; //letter cannot be a number
285
286 //Check for submission comments
287 if (submission.submission_comments) {
288 //Add feedback array to assignment
289 dtpsAssignment.feedback = [];
290
291 //Add each comment to feedback array
292 submission.submission_comments.forEach(comment => {
293 var feedback = {
294 comment: comment.comment
295 };
296
297 //Add author to feedback if found
298 if (comment.author) {
299 feedback.author = {
300 name: comment.author.display_name,
301 id: comment.author.id,
302 photoURL: comment.author.avatar_image_url
303 }
304 }
305
306 dtpsAssignment.feedback.push(feedback)
307 });
308 }
309 }
310 });
311
312 //Add assignment to results array
313 assignments.push(dtpsAssignment);
314 });
315
316 resolve(assignments);
317 }).catch(reject);
318 });
319}
320
321//Fetches modules data from Canvas
322dtpsLMS.fetchModules = function (userID, classID) {
323 return new Promise(function (resolve, reject) {
324 Promise.all([
j58471992021-01-17 19:29:37 -0800325 dtpsLMS.fetchWrapper("/api/v1/courses/" + classID + "/modules?include[]=items&include[]=content_details", { headers: dtpsLMS.commonHeaders }),
326 dtpsLMS.fetchWrapper("/courses/" + classID + "/modules/progressions", { headers: dtpsLMS.commonHeaders })
j7940eec2020-12-28 14:00:41 -0600327 ]).then(responses => {
328 return Promise.all(responses.map(r => r.json()));
329 }).then(data => {
330 var [modulesData, progressionData] = data;
331
332 //Get collapsed modules from progression data
333 var collapsedModules = {};
334
335 //Loop over progression data
336 progressionData.forEach(prog => {
337 //Store collapsed state
338 collapsedModules[prog.context_module_progression.context_module_id] = prog.context_module_progression.collapsed;
339 })
340
341 //Parse data from Canvas
342 var dtpsModules = modulesData.map(module => {
343 //Create module items array
344 var moduleItems = [];
345
346 //Add module items to array
347 module.items.forEach(item => {
348 if (item.type.toUpperCase() == "ASSIGNMENT") {
349 moduleItems.push({
350 type: "assignment",
351 title: item.title,
352 id: item.content_id,
353 indent: item.indent,
354 url: item.html_url,
355 completed: item.completion_requirement && item.completion_requirement.completed
356 })
357 } else if (item.type.toUpperCase() == "PAGE") {
358 moduleItems.push({
359 type: "page",
360 title: item.title,
361 id: item.page_url,
362 indent: item.indent,
363 url: item.html_url,
364 completed: item.completion_requirement && item.completion_requirement.completed
365 })
366 } else if (item.type.toUpperCase() == "DISCUSSION") {
367 moduleItems.push({
368 type: "discussion",
369 title: item.title,
370 id: item.content_id,
371 indent: item.indent,
372 url: item.html_url,
373 completed: item.completion_requirement && item.completion_requirement.completed
374 })
375 } else if (item.type.toUpperCase() == "EXTERNALURL") {
376 moduleItems.push({
377 type: "url",
378 title: item.title,
379 url: item.external_url,
380 indent: item.indent,
381 completed: item.completion_requirement && item.completion_requirement.completed
382 })
383 } else if (item.type.toUpperCase() == "EXTERNALTOOL") {
384 moduleItems.push({
385 type: "embed",
386 title: item.title,
387 url: item.html_url,
388 indent: item.indent,
389 completed: item.completion_requirement && item.completion_requirement.completed
390 });
391 } else if (item.type.toUpperCase() == "SUBHEADER") {
392 moduleItems.push({
393 type: "header",
394 title: item.title,
395 indent: item.indent,
396 completed: item.completion_requirement && item.completion_requirement.completed
397 })
398 }
399 })
400
401 return {
402 id: module.id,
403 title: module.name,
404 collapsed: collapsedModules[module.id] || false,
405 items: moduleItems
406 }
407 })
408
409 //Resolve with module data
410 resolve(dtpsModules);
411 }).catch(reject);
412 });
413}
414
415//Collapses a module in Canvas
416dtpsLMS.collapseModule = function (classID, modID, collapsed) {
j58471992021-01-17 19:29:37 -0800417 return dtpsLMS.fetchWrapper("/courses/" + classID + "/modules/" + modID + "/collapse", {
j7940eec2020-12-28 14:00:41 -0600418 method: "POST",
419 headers: {
420 "Accept": "application/json, text/javascript, application/json+canvas-string-ids, */*; q=0.01",
421 "Content-Type": "application/x-www-form-urlencoded; charset=UTF-8",
422 "X-CSRF-Token": decodeURIComponent(document.cookie).split("_csrf_token=")[1].split(";")[0]
423 },
424 body: "_method=POST&collapse=" + (collapsed ? 1 : 0) + "&authenticity_token=" + decodeURIComponent(document.cookie).split("_csrf_token=")[1].split(";")[0]
425 });
426}
427
428//Collapses all modules in Canvas
429dtpsLMS.collapseAllModules = function (classID, collapsed) {
j58471992021-01-17 19:29:37 -0800430 return dtpsLMS.fetchWrapper("/courses/" + classID + "/collapse_all_modules", {
j7940eec2020-12-28 14:00:41 -0600431 method: "POST",
432 headers: {
433 "Accept": "application/json, text/javascript, application/json+canvas-string-ids, */*; q=0.01",
434 "Content-Type": "application/x-www-form-urlencoded; charset=UTF-8",
435 "X-CSRF-Token": decodeURIComponent(document.cookie).split("_csrf_token=")[1].split(";")[0]
436 },
437 body: "_method=POST&collapse=" + (collapsed ? 1 : 0) + "&authenticity_token=" + decodeURIComponent(document.cookie).split("_csrf_token=")[1].split(";")[0]
438 });
439}
440
441//Fetches announcement data from Canvas
442dtpsLMS.fetchAnnouncements = function (classID) {
443 return new Promise(function (resolve, reject) {
j58471992021-01-17 19:29:37 -0800444 dtpsLMS.fetchWrapper("/api/v1/announcements?context_codes[]=course_" + classID, { headers: dtpsLMS.commonHeaders }).then(response => response.json()).then(data => {
j7940eec2020-12-28 14:00:41 -0600445 var dtpsAnnouncements = data.map(function (announcement) {
446 return {
447 title: announcement.title,
448 postedAt: announcement.created_at,
449 body: announcement.message,
450 url: announcement.html_url
451 }
452 });
453
454 resolve(dtpsAnnouncements);
455 }).catch(reject);
456 });
457}
458
459//Fetches user data from Canvas
460dtpsLMS.fetchUsers = function (classID) {
461 return new Promise(function (resolve, reject) {
j58471992021-01-17 19:29:37 -0800462 dtpsLMS.fetchWrapper("/api/v1/courses/" + classID + "/sections?include[]=avatar_url&include[]=students&per_page=99", { headers: dtpsLMS.commonHeaders }).then(response => response.json()).then(data => {
j7940eec2020-12-28 14:00:41 -0600463 var teachers = dtpsLMS.teacherCache[classID];
464 var sections = [{
465 title: "Teachers",
466 id: "lms.dtps.canvas-teachers",
467 users: []
468 }];
469
470 teachers.forEach(teacher => {
471 sections[0].users.push({
472 name: teacher.display_name,
473 id: teacher.id,
474 photoURL: teacher.avatar_image_url,
475 url: "/courses/" + classID + "/users/" + teacher.id
476 });
477 });
478
479 data.forEach(section => {
480 if (!section.students) return;
481 var users = [];
482 section.students.forEach(student => {
483 users.push({
484 name: student.short_name,
485 id: student.id,
486 photoURL: student.avatar_url,
487 url: "/courses/" + classID + "/users/" + student.id
488 });
489 });
j7940eec2020-12-28 14:00:41 -0600490 sections.push({
491 title: section.name,
492 id: section.id,
493 users
494 });
495 });
496 resolve(sections);
497 }).catch(reject);
498 });
499}
500
501//Fetches homepage data from Canvas
502dtpsLMS.fetchHomepage = function (classID) {
503 return new Promise(function (resolve, reject) {
j58471992021-01-17 19:29:37 -0800504 dtpsLMS.fetchWrapper("/api/v1/courses/" + classID + "/front_page", { headers: dtpsLMS.commonHeaders }).then(response => response.json()).then(data => {
j7940eec2020-12-28 14:00:41 -0600505 resolve(data.body);
506 }).catch(reject);
507 });
508}
509
510//Fetches discussion thread data from Canvas
511dtpsLMS.fetchDiscussionThreads = function (classID) {
512 return new Promise(function (resolve, reject) {
j58471992021-01-17 19:29:37 -0800513 dtpsLMS.fetchWrapper("/api/v1/courses/" + classID + "/discussion_topics", { headers: dtpsLMS.commonHeaders }).then(response => response.json()).then(data => {
j7940eec2020-12-28 14:00:41 -0600514 var dtpsDiscussionThreads = data.map(function (thread) {
515 return {
516 title: thread.title,
517 id: thread.id,
518 locked: thread.locked_for_user
519 }
520 });
521
522 resolve(dtpsDiscussionThreads);
523 }).catch(reject);
524 })
525}
526
527//Fetches discussion thread posts from Canvas
528dtpsLMS.fetchDiscussionPosts = function (classID, threadID) {
529 return new Promise(function (resolve, reject) {
j58471992021-01-17 19:29:37 -0800530 dtpsLMS.fetchWrapper("/api/v1/courses/" + classID + "/discussion_topics/" + threadID + "/", { headers: dtpsLMS.commonHeaders }).then(response => response.json()).then(threadData => {
j7940eec2020-12-28 14:00:41 -0600531 //Check if this discussion is a group discussion
532 if (threadData.group_topic_children && threadData.group_topic_children.length) {
533 //This discussion is probably a group discussion, check groups, then fetch posts
j58471992021-01-17 19:29:37 -0800534 dtpsLMS.fetchWrapper("/api/v1/courses/" + classID + "/groups?only_own_groups=true", { headers: dtpsLMS.commonHeaders }).then(response => response.json()).then(groupData => {
j7940eec2020-12-28 14:00:41 -0600535 //Get array of group IDs
536 var myGroups = groupData.map(group => group.id);
537
538 //Set default group and discussion ID variables
539 var groupID = null;
540 var groupDiscussionID = null;
541
542 //Check every group this discussion has and see if one of them is in myGroups, set that group as the group to fetch posts for
543 threadData.group_topic_children.forEach(group => {
544 if (myGroups.includes(group.group_id)) {
545 groupID = group.group_id;
546 groupDiscussionID = group.id;
547 }
548 });
549
550 if (!groupID || !groupDiscussionID) {
551 //Couldn't find a group match, fetch class discussion
j58471992021-01-17 19:29:37 -0800552 dtpsLMS.fetchWrapper("/api/v1/courses/" + classID + "/discussion_topics/" + threadID + "/view", { headers: dtpsLMS.commonHeaders }).then(response => response.json()).then(responsesData => {
j7940eec2020-12-28 14:00:41 -0600553 parseResponse(responsesData, "/courses/" + classID + "/discussion_topics/" + threadID);
554 });
555 } else {
556 //Group match found, fetch group discussion
j58471992021-01-17 19:29:37 -0800557 dtpsLMS.fetchWrapper("/api/v1/groups/" + groupID + "/discussion_topics/" + groupDiscussionID + "/view", { headers: dtpsLMS.commonHeaders }).then(response => response.json()).then(responsesData => {
j7940eec2020-12-28 14:00:41 -0600558 parseResponse(responsesData, "/groups/" + groupID + "/discussion_topics/" + groupDiscussionID);
559 });
560 }
561 });
562 } else {
563 //Not a group discussion, directly fetch posts
j58471992021-01-17 19:29:37 -0800564 dtpsLMS.fetchWrapper("/api/v1/courses/" + classID + "/discussion_topics/" + threadID + "/view", { headers: dtpsLMS.commonHeaders }).then(response => response.json()).then(responsesData => {
j7940eec2020-12-28 14:00:41 -0600565 parseResponse(responsesData, "/courses/" + classID + "/discussion_topics/" + threadID);
566 });
567 }
568
569
570 //This function handles the response from Canavs and returns the data to DTPS
571 //BaseURL is the baseURL of the thread, since this might be different for group discussions
572 function parseResponse(responsesData, baseURL) {
573 //Define discussions post array
574 var dtpsDiscussionPosts = [];
575
576 //Define the initial post
577 var initialPost = {
578 id: threadID,
579 body: threadData.message,
580 postedAt: threadData.created_at,
581 replyURL: baseURL
582 };
583
584 //Check for author
585 if (threadData.author && threadData.author.display_name) {
586 initialPost.author = {
587 name: threadData.author.display_name,
588 id: threadData.author.id,
589 photoURL: threadData.author.avatar_image_url
590 };
591 }
592
593 //Add initial post to array
594 dtpsDiscussionPosts.push(initialPost);
595
596 if (responsesData.view) {
597 //Get thread author information
598 var people = {};
599 if (responsesData.participants) {
600 responsesData.participants.forEach(participant => {
601 people[participant.id] = participant;
602 })
603 }
604
605 //If there are posts found from the second request, add those as well
606 responsesData.view.forEach(function (post) {
607 if (!post.deleted) {
608 var replies = [];
609
610 //Get replies for this post
611 if (post.replies) {
612 //If this post has replies, flatten them into a single array
613 function addReplies(arr, depth) {
614 //Loop over replies to add
615 arr.forEach(reply => {
616 //Add this reply to the array
617 if (!reply.deleted) {
618 //Define reply object
619 var dtpsReply = {
620 id: reply.id,
621 body: reply.message,
622 postedAt: reply.created_at,
623 replyURL: baseURL + "/entry-" + reply.id,
624 depth: depth
625 };
626
627 //Check for reply author
628 if (people[reply.user_id]) {
629 dtpsReply.author = {
630 name: people[reply.user_id].display_name,
631 id: reply.user_id,
632 photoURL: people[reply.user_id].avatar_image_url
633 }
634 }
635
636 //Add reply to flattened array
637 replies.push(dtpsReply);
638 }
639
640 //Add nested replies to array
641 if (reply.replies) addReplies(reply.replies, depth + 1);
642 });
643 }
644
645 addReplies(post.replies, 0);
646 }
647
648 //Define post object
649 var dtpsPost = {
650 id: post.id,
651 body: post.message,
652 postedAt: post.created_at,
653 replies: replies,
654 replyURL: baseURL + "/entry-" + post.id
655 };
656
657 //Check for post author
658 if (people[post.user_id]) {
659 dtpsPost.author = {
660 name: people[post.user_id].display_name,
661 id: post.user_id,
662 photoURL: people[post.user_id].avatar_image_url
663 }
664 }
665
666 //Add post to array
667 dtpsDiscussionPosts.push(dtpsPost);
668 }
669 });
670 }
671
672 resolve({
673 title: threadData.title,
674 id: threadData.id,
675 locked: threadData.locked_for_user,
676 posts: dtpsDiscussionPosts
677 });
678 }
679 }).catch(reject);
680 });
681}
682
683//Fetches pages list data from Canvas
684dtpsLMS.fetchPages = function (classID) {
685 return new Promise(function (resolve, reject) {
j58471992021-01-17 19:29:37 -0800686 dtpsLMS.fetchWrapper("/api/v1/courses/" + classID + "/pages?per_page=100", { headers: dtpsLMS.commonHeaders }).then(response => response.json()).then(data => {
j7940eec2020-12-28 14:00:41 -0600687 var dtpsPages = data.map(function (page) {
688 var dtpsPage = {
689 title: page.title,
690 id: page.url
691 };
692
693 return dtpsPage;
694 });
695
696 resolve(dtpsPages);
697 }).catch(reject);
698 })
699}
700
701//Fetches pages list data from Canvas
702dtpsLMS.fetchPageContent = function (classID, pageID) {
703 return new Promise(function (resolve, reject) {
j58471992021-01-17 19:29:37 -0800704 dtpsLMS.fetchWrapper("/api/v1/courses/" + classID + "/pages/" + pageID, { headers: dtpsLMS.commonHeaders }).then(response => response.json()).then(data => {
j7940eec2020-12-28 14:00:41 -0600705 //Resolve with full page object
706 var dtpsPage = {
707 title: data.title,
708 id: data.url,
709 updatedAt: data.updated_at,
710 content: data.body
711 };
712
713 //Check for page author
714 if (data.last_edited_by) {
715 dtpsPage.author = {
716 name: data.last_edited_by.display_name,
717 id: data.last_edited_by.id,
718 photoURL: data.last_edited_by.avatar_image_url
719 }
720 }
721
722 resolve(dtpsPage);
723 }).catch(reject);
724 })
725}
726
j7940eec2020-12-28 14:00:41 -0600727//Load Power+
j2fcf4e52021-03-11 14:37:26 -0800728jQuery.getScript(window.dtpsBaseURL + "/scripts/core.js");