scmmishra | 1778b59 | 2018-10-30 18:25:49 +0530 | [diff] [blame] | 1 | from __future__ import unicode_literals |
| 2 | import frappe |
scmmishra | 1778b59 | 2018-10-30 18:25:49 +0530 | [diff] [blame] | 3 | |
scmmishra | 9c642ac | 2018-11-01 17:17:49 +0530 | [diff] [blame] | 4 | # Functions to get homepage details |
scmmishra | bcafe84 | 2018-11-03 14:48:42 +0530 | [diff] [blame] | 5 | @frappe.whitelist(allow_guest=True) |
scmmishra | 1778b59 | 2018-10-30 18:25:49 +0530 | [diff] [blame] | 6 | def get_portal_details(): |
| 7 | settings = frappe.get_doc("Education Settings") |
| 8 | title = settings.portal_title |
| 9 | description = settings.description |
| 10 | return dict(title=title, description=description) |
| 11 | |
scmmishra | bcafe84 | 2018-11-03 14:48:42 +0530 | [diff] [blame] | 12 | @frappe.whitelist(allow_guest=True) |
scmmishra | 1778b59 | 2018-10-30 18:25:49 +0530 | [diff] [blame] | 13 | def get_featured_programs(): |
scmmishra | bcafe84 | 2018-11-03 14:48:42 +0530 | [diff] [blame] | 14 | featured_program_names = frappe.get_all("Program", filters={"is_published": True, "is_featured": True}) |
scmmishra | 1778b59 | 2018-10-30 18:25:49 +0530 | [diff] [blame] | 15 | featured_list = [program["name"] for program in featured_program_names] |
| 16 | if featured_list: |
| 17 | return featured_list |
| 18 | else: |
| 19 | return None |
| 20 | |
scmmishra | 9c642ac | 2018-11-01 17:17:49 +0530 | [diff] [blame] | 21 | # Functions to get program & course details |
scmmishra | bcafe84 | 2018-11-03 14:48:42 +0530 | [diff] [blame] | 22 | @frappe.whitelist(allow_guest=True) |
scmmishra | 1778b59 | 2018-10-30 18:25:49 +0530 | [diff] [blame] | 23 | def get_program_details(program_name): |
| 24 | try: |
| 25 | program = frappe.get_doc('Program', program_name) |
| 26 | return program |
| 27 | except: |
| 28 | return None |
scmmishra | 9c642ac | 2018-11-01 17:17:49 +0530 | [diff] [blame] | 29 | |
scmmishra | bcafe84 | 2018-11-03 14:48:42 +0530 | [diff] [blame] | 30 | @frappe.whitelist(allow_guest=True) |
scmmishra | 9c642ac | 2018-11-01 17:17:49 +0530 | [diff] [blame] | 31 | def get_courses(program_name): |
| 32 | program = frappe.get_doc('Program', program_name) |
| 33 | courses = program.get_course_list() |
| 34 | return courses |
| 35 | |
| 36 | @frappe.whitelist() |
| 37 | def get_starting_content(course_name): |
| 38 | course = frappe.get_doc('Course', course_name) |
| 39 | content = course.course_content[0].content |
| 40 | content_type = course.course_content[0].content_type |
| 41 | return dict(content=content, content_type=content_type) |
| 42 | |
| 43 | |
| 44 | # Functions to get content details |
| 45 | @frappe.whitelist() |
| 46 | def get_content(content_name, content_type): |
| 47 | try: |
| 48 | content = frappe.get_doc(content_type, content_name) |
| 49 | return content |
| 50 | except: |
| 51 | frappe.throw("{0} with name {1} does not exist".format(content_type, content_name)) |
| 52 | return None |
| 53 | |
| 54 | @frappe.whitelist() |
| 55 | def get_next_content(content, content_type, course): |
| 56 | course_doc = frappe.get_doc("Course", course) |
| 57 | content_list = [{'content_type':item.content_type, 'content':item.content} for item in course_doc.get_all_children()] |
| 58 | current_index = content_list.index({'content': content, 'content_type': content_type}) |
| 59 | try: |
| 60 | return content_list[current_index + 1] |
| 61 | except IndexError: |
scmmishra | 3741844 | 2018-11-01 19:50:47 +0530 | [diff] [blame] | 62 | return None |
| 63 | |
| 64 | def get_quiz_with_answers(quiz_name): |
| 65 | try: |
| 66 | quiz = frappe.get_doc("Quiz", quiz_name).get_questions() |
| 67 | 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] |
| 68 | return quiz_output |
| 69 | except: |
| 70 | frappe.throw("Quiz {0} does not exist".format(quiz_name)) |
| 71 | return None |
| 72 | |
| 73 | @frappe.whitelist() |
| 74 | def get_quiz_without_answers(quiz_name): |
| 75 | try: |
| 76 | quiz = frappe.get_doc("Quiz", quiz_name).get_questions() |
| 77 | quiz_output = [{'name':question.name, 'question':question.question, 'options':[{'name': option.name, 'option':option.option} for option in question.options]} for question in quiz] |
| 78 | return quiz_output |
| 79 | except: |
| 80 | frappe.throw("Quiz {0} does not exist".format(quiz_name)) |
scmmishra | f7029f0 | 2018-11-02 13:15:49 +0530 | [diff] [blame] | 81 | return None |
| 82 | |
| 83 | @frappe.whitelist() |
scmmishra | 0187b18 | 2018-11-05 12:16:02 +0530 | [diff] [blame] | 84 | def evaluate_quiz(enrollment, quiz_response, quiz_name): |
scmmishra | ef9a75e | 2018-11-02 16:35:46 +0530 | [diff] [blame] | 85 | """LMS Function: Evaluates a simple multiple choice quiz. |
scmmishra | f7029f0 | 2018-11-02 13:15:49 +0530 | [diff] [blame] | 86 | |
| 87 | |
| 88 | :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. |
scmmishra | f7029f0 | 2018-11-02 13:15:49 +0530 | [diff] [blame] | 89 | """ |
| 90 | import json |
scmmishra | f7029f0 | 2018-11-02 13:15:49 +0530 | [diff] [blame] | 91 | quiz_response = json.loads(quiz_response) |
scmmishra | 0187b18 | 2018-11-05 12:16:02 +0530 | [diff] [blame] | 92 | print(quiz_response) |
scmmishra | ef9a75e | 2018-11-02 16:35:46 +0530 | [diff] [blame] | 93 | quiz = frappe.get_doc("Quiz", quiz_name) |
scmmishra | 0187b18 | 2018-11-05 12:16:02 +0530 | [diff] [blame] | 94 | answers, score, status = quiz.evaluate(quiz_response, quiz_name) |
| 95 | print("-----------------") |
| 96 | print(answers) |
| 97 | |
| 98 | result = {k: ('Correct' if v else 'Wrong') for k,v in answers.items()} |
| 99 | result_data = [] |
| 100 | for key in answers: |
| 101 | item = {} |
| 102 | item['question'] = key |
| 103 | item['quiz_result'] = result[key] |
| 104 | try: |
| 105 | item['selected_option'] = frappe.get_value('Options', quiz_response[key], 'option') |
| 106 | except: |
| 107 | item['selected_option'] = "Unattempted" |
| 108 | result_data.append(item) |
| 109 | # result_data = [{'question': key, 'selected_option': frappe.get_value('Options', quiz_response[key], 'option'), 'quiz_result': result[key]} for key in answers] |
| 110 | |
| 111 | add_quiz_activity(enrollment, quiz_name, result_data, score, status) |
scmmishra | ef9a75e | 2018-11-02 16:35:46 +0530 | [diff] [blame] | 112 | return(score) |
scmmishra | bcafe84 | 2018-11-03 14:48:42 +0530 | [diff] [blame] | 113 | |
| 114 | @frappe.whitelist() |
scmmishra | 73a31ec | 2018-11-03 19:31:53 +0530 | [diff] [blame] | 115 | def get_completed_courses(email=frappe.session.user): |
scmmishra | 76222f7 | 2018-11-05 11:02:14 +0530 | [diff] [blame] | 116 | print("Get completed course ", email) |
scmmishra | 73a31ec | 2018-11-03 19:31:53 +0530 | [diff] [blame] | 117 | try: |
scmmishra | 73a31ec | 2018-11-03 19:31:53 +0530 | [diff] [blame] | 118 | student = frappe.get_doc("Student", get_student_id(email)) |
| 119 | return student.get_completed_courses() |
| 120 | except: |
| 121 | return None |
scmmishra | 8b8db54 | 2018-11-03 18:03:24 +0530 | [diff] [blame] | 122 | |
| 123 | @frappe.whitelist() |
| 124 | def get_continue_data(program_name): |
| 125 | program = frappe.get_doc("Program", program_name) |
| 126 | courses = program.get_all_children() |
| 127 | continue_data = get_starting_content(courses[0].course) |
| 128 | continue_data['course'] = courses[0].course |
| 129 | return continue_data |
| 130 | |
| 131 | def create_student(student_name=frappe.session.user): |
| 132 | student = frappe.get_doc({ |
| 133 | "doctype": "Student", |
| 134 | "first_name": student_name, |
| 135 | "student_email_id": student_name, |
| 136 | }) |
| 137 | student.save() |
| 138 | frappe.db.commit() |
| 139 | return student_name |
| 140 | |
| 141 | @frappe.whitelist() |
scmmishra | 73a31ec | 2018-11-03 19:31:53 +0530 | [diff] [blame] | 142 | def enroll_all_courses_in_program(program_enrollment, student): |
| 143 | course_list = [course.name for course in get_courses(program_enrollment.program)] |
| 144 | for course_name in course_list: |
| 145 | student.enroll_in_course(course_name=course_name, program_enrollment=program_enrollment.name) |
| 146 | |
| 147 | @frappe.whitelist() |
| 148 | def enroll_in_program(program_name, student_email_id): |
scmmishra | 8b8db54 | 2018-11-03 18:03:24 +0530 | [diff] [blame] | 149 | if(not get_student_id(student_email_id)): |
| 150 | create_student(student_email_id) |
| 151 | student = frappe.get_doc("Student", get_student_id(student_email_id)) |
scmmishra | 73a31ec | 2018-11-03 19:31:53 +0530 | [diff] [blame] | 152 | program_enrollment = student.enroll_in_program(program_name) |
| 153 | enroll_all_courses_in_program(program_enrollment, student) |
scmmishra | 8b8db54 | 2018-11-03 18:03:24 +0530 | [diff] [blame] | 154 | |
scmmishra | 73a31ec | 2018-11-03 19:31:53 +0530 | [diff] [blame] | 155 | @frappe.whitelist() |
scmmishra | 8b8db54 | 2018-11-03 18:03:24 +0530 | [diff] [blame] | 156 | def get_student_id(email=None): |
| 157 | """Returns student user name, example EDU-STU-2018-00001 (Based on the naming series). |
| 158 | |
| 159 | :param user: a user email address |
| 160 | """ |
| 161 | try: |
| 162 | return frappe.get_all('Student', filters={'student_email_id': email}, fields=['name'])[0].name |
| 163 | except IndexError: |
scmmishra | 73a31ec | 2018-11-03 19:31:53 +0530 | [diff] [blame] | 164 | return None |
| 165 | |
| 166 | @frappe.whitelist() |
| 167 | def get_program_enrollments(email=frappe.session.user): |
| 168 | try: |
| 169 | student = frappe.get_doc("Student", get_student_id(email)) |
| 170 | return student.get_program_enrollments() |
| 171 | except: |
| 172 | return None |
| 173 | |
| 174 | @frappe.whitelist() |
| 175 | def get_course_enrollments(email=frappe.session.user): |
| 176 | try: |
| 177 | student = frappe.get_doc("Student", get_student_id(email)) |
| 178 | return student.get_course_enrollments() |
| 179 | except: |
scmmishra | 1a04f77 | 2018-11-03 20:43:59 +0530 | [diff] [blame] | 180 | return None |
| 181 | |
| 182 | @frappe.whitelist() |
| 183 | def add_activity(enrollment, content_type, content): |
scmmishra | 76222f7 | 2018-11-05 11:02:14 +0530 | [diff] [blame] | 184 | if(check_activity_exists(enrollment, content_type, content)): |
| 185 | pass |
| 186 | else: |
| 187 | activity = frappe.get_doc({ |
| 188 | "doctype": "Course Activity", |
| 189 | "enrollment": enrollment, |
| 190 | "content_type": content_type, |
| 191 | "content": content, |
| 192 | "activity_date": frappe.utils.datetime.datetime.now() |
| 193 | }) |
| 194 | activity.save() |
| 195 | frappe.db.commit() |
| 196 | |
| 197 | def check_activity_exists(enrollment, content_type, content): |
| 198 | activity = frappe.get_all("Course Activity", filters={'enrollment': enrollment, 'content_type': content_type, 'content': content}) |
scmmishra | 0187b18 | 2018-11-05 12:16:02 +0530 | [diff] [blame] | 199 | return bool(activity) |
scmmishra | 76222f7 | 2018-11-05 11:02:14 +0530 | [diff] [blame] | 200 | |
scmmishra | 0187b18 | 2018-11-05 12:16:02 +0530 | [diff] [blame] | 201 | def add_quiz_activity(enrollment, quiz_name, result_data, score, status): |
| 202 | quiz_activity = frappe.get_doc({ |
| 203 | "doctype": "Quiz Activity", |
| 204 | "enrollment": enrollment, |
| 205 | "quiz": quiz_name, |
| 206 | "result": result_data, |
| 207 | "score": score, |
| 208 | "status": status |
| 209 | }) |
| 210 | quiz_activity.save() |
| 211 | print(quiz_activity) |
| 212 | frappe.db.commit() |