scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 1 | from __future__ import unicode_literals |
scmmishra | babb68d | 2018-11-19 16:13:21 +0530 | [diff] [blame] | 2 | import erpnext.education.utils as utils |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 3 | import frappe |
| 4 | |
scmmishra | 1192529 | 2018-11-20 17:38:01 +0530 | [diff] [blame] | 5 | # LMS Utils to Update State for Vue Store |
| 6 | @frappe.whitelist() |
| 7 | def get_program_enrollments(): |
| 8 | try: |
| 9 | student = frappe.get_doc("Student", utils.get_current_student()) |
| 10 | return student.get_program_enrollments() |
| 11 | except: |
| 12 | return None |
| 13 | |
| 14 | @frappe.whitelist() |
| 15 | def get_all_course_enrollments(): |
| 16 | student = utils.get_current_student() |
| 17 | if student == None: |
| 18 | return None |
| 19 | try: |
| 20 | student = frappe.get_doc("Student", student) |
| 21 | return student.get_all_course_enrollments() |
| 22 | except: |
| 23 | return None |
| 24 | |
| 25 | # Vue Client Functions |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 26 | @frappe.whitelist(allow_guest=True) |
| 27 | def get_portal_details(): |
scmmishra | babb68d | 2018-11-19 16:13:21 +0530 | [diff] [blame] | 28 | """ |
| 29 | Returns portal details from Education Settings Doctype. This contains the Title and Description for LMS amoung other things. |
| 30 | """ |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 31 | settings = frappe.get_doc("Education Settings") |
| 32 | title = settings.portal_title |
| 33 | description = settings.description |
| 34 | return dict(title=title, description=description) |
| 35 | |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 36 | @frappe.whitelist(allow_guest=True) |
| 37 | def get_featured_programs(): |
| 38 | featured_program_names = frappe.get_all("Program", filters={"is_published": True, "is_featured": True}) |
| 39 | if featured_program_names: |
scmmishra | babb68d | 2018-11-19 16:13:21 +0530 | [diff] [blame] | 40 | featured_list = [utils.get_program(program['name']) for program in featured_program_names] |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 41 | return featured_list |
| 42 | else: |
| 43 | return None |
| 44 | |
scmmishra | 85c2fee | 2018-11-14 14:23:06 +0530 | [diff] [blame] | 45 | @frappe.whitelist(allow_guest=True) |
| 46 | def get_all_programs(): |
| 47 | program_names = frappe.get_all("Program", filters={"is_published": True}) |
| 48 | if program_names: |
scmmishra | babb68d | 2018-11-19 16:13:21 +0530 | [diff] [blame] | 49 | featured_list = [utils.get_program(program['name']) for program in program_names] |
scmmishra | 85c2fee | 2018-11-14 14:23:06 +0530 | [diff] [blame] | 50 | return featured_list |
| 51 | else: |
| 52 | return None |
| 53 | |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 54 | @frappe.whitelist(allow_guest=True) |
| 55 | def get_program_details(program_name): |
| 56 | try: |
| 57 | program = frappe.get_doc('Program', program_name) |
| 58 | return program |
| 59 | except: |
| 60 | return None |
| 61 | |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 62 | # Functions to get program & course details |
| 63 | @frappe.whitelist(allow_guest=True) |
| 64 | def get_courses(program_name): |
| 65 | program = frappe.get_doc('Program', program_name) |
| 66 | courses = program.get_course_list() |
scmmishra | fdbabde | 2018-11-22 15:33:30 +0530 | [diff] [blame] | 67 | return courses |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 68 | |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 69 | @frappe.whitelist() |
| 70 | def get_next_content(content, content_type, course): |
| 71 | if frappe.session.user == "Guest": |
| 72 | return None |
| 73 | course_doc = frappe.get_doc("Course", course) |
| 74 | content_list = [{'content_type':item.content_type, 'content':item.content} for item in course_doc.get_all_children()] |
| 75 | current_index = content_list.index({'content': content, 'content_type': content_type}) |
| 76 | try: |
scmmishra | 1192529 | 2018-11-20 17:38:01 +0530 | [diff] [blame] | 77 | # print(content_list[current_index + 1]) |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 78 | return content_list[current_index + 1] |
| 79 | except IndexError: |
| 80 | return None |
| 81 | |
| 82 | def get_quiz_with_answers(quiz_name): |
| 83 | try: |
| 84 | quiz = frappe.get_doc("Quiz", quiz_name).get_questions() |
| 85 | quiz_output = [{'name':question.name, 'question':question.question, 'options':[{'name': option.name, 'option':option.option, 'is_correct':option.is_correct} for option in question.options]} for question in quiz] |
| 86 | return quiz_output |
| 87 | except: |
| 88 | frappe.throw("Quiz {0} does not exist".format(quiz_name)) |
| 89 | return None |
| 90 | |
| 91 | @frappe.whitelist() |
| 92 | def get_quiz_without_answers(quiz_name): |
| 93 | try: |
| 94 | quiz = frappe.get_doc("Quiz", quiz_name).get_questions() |
| 95 | quiz_output = [{'name':question.name, 'question':question.question, 'options':[{'name': option.name, 'option':option.option} for option in question.options]} for question in quiz] |
| 96 | return quiz_output |
| 97 | except: |
| 98 | frappe.throw("Quiz {0} does not exist".format(quiz_name)) |
| 99 | return None |
| 100 | |
| 101 | @frappe.whitelist() |
| 102 | def evaluate_quiz(enrollment, quiz_response, quiz_name): |
| 103 | """LMS Function: Evaluates a simple multiple choice quiz. |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 104 | :param quiz_response: contains user selected choices for a quiz in the form of a string formatted as a dictionary. The function uses `json.loads()` to convert it to a python dictionary. |
| 105 | """ |
scmmishra | babb68d | 2018-11-19 16:13:21 +0530 | [diff] [blame] | 106 | |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 107 | import json |
| 108 | quiz_response = json.loads(quiz_response) |
| 109 | quiz = frappe.get_doc("Quiz", quiz_name) |
| 110 | answers, score, status = quiz.evaluate(quiz_response, quiz_name) |
| 111 | |
| 112 | result = {k: ('Correct' if v else 'Wrong') for k,v in answers.items()} |
| 113 | result_data = [] |
| 114 | for key in answers: |
| 115 | item = {} |
| 116 | item['question'] = key |
| 117 | item['quiz_result'] = result[key] |
| 118 | try: |
| 119 | item['selected_option'] = frappe.get_value('Options', quiz_response[key], 'option') |
| 120 | except: |
| 121 | item['selected_option'] = "Unattempted" |
| 122 | result_data.append(item) |
| 123 | # result_data = [{'question': key, 'selected_option': frappe.get_value('Options', quiz_response[key], 'option'), 'quiz_result': result[key]} for key in answers] |
| 124 | |
| 125 | add_quiz_activity(enrollment, quiz_name, result_data, score, status) |
| 126 | return(score) |
| 127 | |
scmmishra | babb68d | 2018-11-19 16:13:21 +0530 | [diff] [blame] | 128 | def add_quiz_activity(enrollment, quiz_name, result_data, score, status): |
| 129 | quiz_activity = frappe.get_doc({ |
| 130 | "doctype": "Quiz Activity", |
| 131 | "enrollment": enrollment, |
| 132 | "quiz": quiz_name, |
| 133 | "activity_date": frappe.utils.datetime.datetime.now(), |
| 134 | "result": result_data, |
| 135 | "score": score, |
| 136 | "status": status |
| 137 | }) |
| 138 | quiz_activity.save() |
| 139 | frappe.db.commit() |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 140 | |
| 141 | @frappe.whitelist() |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 142 | def enroll_in_program(program_name): |
scmmishra | babb68d | 2018-11-19 16:13:21 +0530 | [diff] [blame] | 143 | if(not utils.get_current_student()): |
scmmishra | 082e3c9 | 2018-11-23 17:16:22 +0530 | [diff] [blame] | 144 | utils.create_student() |
scmmishra | babb68d | 2018-11-19 16:13:21 +0530 | [diff] [blame] | 145 | student = frappe.get_doc("Student", utils.get_current_student()) |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 146 | program_enrollment = student.enroll_in_program(program_name) |
scmmishra | babb68d | 2018-11-19 16:13:21 +0530 | [diff] [blame] | 147 | utils.enroll_all_courses_in_program(program_enrollment, student) |
scmmishra | 0a4902f | 2018-11-15 11:16:53 +0530 | [diff] [blame] | 148 | return program_name |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 149 | |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 150 | # Academty Activity |
| 151 | @frappe.whitelist() |
scmmishra | a592f70 | 2018-11-20 18:37:01 +0530 | [diff] [blame] | 152 | def add_activity(course, content_type, content): |
| 153 | enrollment = utils.get_course_enrollment(course) |
| 154 | if(utils.check_activity_exists(enrollment.name, content_type, content)): |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 155 | pass |
| 156 | else: |
| 157 | activity = frappe.get_doc({ |
| 158 | "doctype": "Course Activity", |
scmmishra | a592f70 | 2018-11-20 18:37:01 +0530 | [diff] [blame] | 159 | "enrollment": enrollment.name, |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 160 | "content_type": content_type, |
| 161 | "content": content, |
| 162 | "activity_date": frappe.utils.datetime.datetime.now() |
| 163 | }) |
| 164 | activity.save() |
| 165 | frappe.db.commit() |
| 166 | |
scmmishra | babb68d | 2018-11-19 16:13:21 +0530 | [diff] [blame] | 167 | def get_course_progress(course_enrollment): |
| 168 | course = frappe.get_doc('Course', course_enrollment.course) |
scmmishra | 1192529 | 2018-11-20 17:38:01 +0530 | [diff] [blame] | 169 | contents = course.get_contents() |
| 170 | progress = [] |
scmmishra | fdbabde | 2018-11-22 15:33:30 +0530 | [diff] [blame] | 171 | for content in contents: |
scmmishra | 1192529 | 2018-11-20 17:38:01 +0530 | [diff] [blame] | 172 | if content.doctype in ('Article', 'Video'): |
| 173 | status = check_content_completion(content.name, content.doctype, course_enrollment.name) |
| 174 | progress.append({'content': content.name, 'content_type': content.doctype, 'is_complete': status}) |
| 175 | elif content.doctype == 'Quiz': |
scmmishra | a592f70 | 2018-11-20 18:37:01 +0530 | [diff] [blame] | 176 | status, score, result = check_quiz_completion(content, course_enrollment.name) |
| 177 | progress.append({'content': content.name, 'content_type': content.doctype, 'is_complete': status, 'score': score, 'result': result}) |
scmmishra | 1192529 | 2018-11-20 17:38:01 +0530 | [diff] [blame] | 178 | return progress |
scmmishra | 35bf561 | 2018-11-13 16:36:22 +0530 | [diff] [blame] | 179 | |
scmmishra | 1192529 | 2018-11-20 17:38:01 +0530 | [diff] [blame] | 180 | def check_content_completion(content_name, content_type, enrollment_name): |
| 181 | activity = frappe.get_list("Course Activity", filters={'enrollment': enrollment_name, 'content_type': content_type, 'content': content_name}) |
| 182 | if activity: |
| 183 | return True |
| 184 | else: |
| 185 | return False |
| 186 | |
| 187 | def check_quiz_completion(quiz, enrollment_name): |
| 188 | attempts = frappe.get_list("Quiz Activity", filters={'enrollment': enrollment_name, 'quiz': quiz.name}, fields=["name", "activity_date", "score", "status"]) |
scmmishra | a592f70 | 2018-11-20 18:37:01 +0530 | [diff] [blame] | 189 | status = bool(len(attempts) == quiz.max_attempts) |
| 190 | score = None |
| 191 | result = None |
scmmishra | fdbabde | 2018-11-22 15:33:30 +0530 | [diff] [blame] | 192 | if attempts: |
| 193 | if quiz.grading_basis == 'Last Highest Score': |
| 194 | attempts = sorted(attempts, key = lambda i: int(i.score), reverse=True) |
| 195 | score = attempts[0]['score'] |
| 196 | result = attempts[0]['status'] |
| 197 | if result == 'Pass': |
| 198 | status = True |
scmmishra | a592f70 | 2018-11-20 18:37:01 +0530 | [diff] [blame] | 199 | return status, score, result |
scmmishra | fdbabde | 2018-11-22 15:33:30 +0530 | [diff] [blame] | 200 | |
| 201 | @frappe.whitelist() |
| 202 | def get_course_meta(course_name): |
| 203 | course_enrollment = utils.get_course_enrollment(course_name) |
scmmishra | a592f70 | 2018-11-20 18:37:01 +0530 | [diff] [blame] | 204 | # course_enrollment = frappe.get_doc("Course Enrollment", course_enrollment_name) |
| 205 | progress = get_course_progress(course_enrollment) |
scmmishra | a592f70 | 2018-11-20 18:37:01 +0530 | [diff] [blame] | 206 | count = sum([act['is_complete'] for act in progress]) |
scmmishra | a592f70 | 2018-11-20 18:37:01 +0530 | [diff] [blame] | 207 | if count == 0: |
| 208 | return {'flag':'Start Course', 'content_type': progress[0]['content_type'], 'content': progress[0]['content']} |
| 209 | elif count == len(progress): |
| 210 | return {'flag':'Complete', 'content_type': progress[0]['content_type'], 'content': progress[0]['content']} |
| 211 | elif count < len(progress): |
| 212 | next_item = next(item for item in progress if item['is_complete']==False) |
| 213 | return {'flag':'Continue', 'content_type': next_item['content_type'], 'content': next_item['content']} |
| 214 | |