import frappe from frappe.utils import flt, cint from school.lms.utils import slugify from school.lms.md import markdown_to_html def get_common_context(context): context.no_cache = 1 try: batch_name = frappe.form_dict["batch"] except KeyError: batch_name = None course = frappe.db.get_value("LMS Course", frappe.form_dict["course"], ["name", "title", "video_link"], as_dict=True) if not course: context.template = "www/404.html" return context.course = course context.lessons = get_lessons(course.name) membership = get_membership(course.name, frappe.session.user, batch_name) context.membership = membership if membership: batch = get_batch(course.name, membership.batch) if batch: context.batch = batch context.course.query_parameter = "?batch=" + membership.batch if membership and membership.batch else "" context.livecode_url = get_livecode_url() def get_livecode_url(): return frappe.db.get_single_value("LMS Settings", "livecode_url") def redirect_to_lesson(course, index_="1.1"): frappe.local.flags.redirect_location = get_lesson_url(course.name, index_) + course.query_parameter raise frappe.Redirect def get_membership(course, member, batch=None): filters = { "member": member, "course": course } if batch: filters["batch"] = batch membership = frappe.db.get_value("LMS Batch Membership", filters, ["name", "batch", "current_lesson", "member_type", "progress"], as_dict=True) if membership and membership.batch: membership.batch_title = frappe.db.get_value("LMS Batch", membership.batch, "title") return membership def get_chapters(course): """Returns all chapters of this course. """ chapters = frappe.get_all("Chapter Reference", {"parent": course}, ["idx", "chapter"], order_by="idx") for chapter in chapters: chapter_details = frappe.db.get_value("Course Chapter", { "name": chapter.chapter }, ["name", "title", "description"], as_dict=True) chapter.update(chapter_details) return chapters def get_lessons(course, chapter=None): """ If chapter is passed, returns lessons of only that chapter. Else returns lessons of all chapters of the course """ lessons = [] if chapter: return get_lesson_details(chapter) for chapter in get_chapters(course): lesson = get_lesson_details(chapter) lessons += lesson return lessons def get_lesson_details(chapter): lessons = [] lesson_list = frappe.get_all("Lesson Reference", {"parent": chapter.name}, ["lesson", "idx"], order_by="idx") for row in lesson_list: lesson_details = frappe.db.get_value("Course Lesson", row.lesson, ["name", "title", "include_in_preview", "body"], as_dict=True) lesson_details.number = flt("{}.{}".format(chapter.idx, row.idx)) lessons.append(lesson_details) return lessons def get_tags(course): tags = frappe.db.get_value("LMS Course", course, "tags") return tags.split(",") if tags else [] def get_instructors(course): instructor_details = [] instructors = frappe.get_all("Course Instructor", {"parent": course}, ["instructor"], order_by="idx") if not instructors: instructors = frappe.db.get_value("LMS Course", course, "owner").split(" ") for instructor in instructors: instructor_details.append(frappe.db.get_value("User", instructor.instructor, ["name", "username", "full_name", "user_image"], as_dict=True)) return instructor_details def get_students(course, batch=None): """Returns (email, full_name, username) of all the students of this batch as a list of dict. """ filters = { "course": course, "member_type": "Student" } if batch: filters["batch"] = batch return frappe.get_all( "LMS Batch Membership", filters, ["member"]) def get_average_rating(course): ratings = [review.rating for review in get_reviews(course)] if not len(ratings): return None return sum(ratings)/len(ratings) def get_reviews(course): reviews = frappe.get_all("LMS Course Review", { "course": course }, ["review", "rating", "owner"], order_by= "creation desc") out_of_ratings = frappe.db.get_all("DocField", { "parent": "LMS Course Review", "fieldtype": "Rating" }, ["options"]) out_of_ratings = (len(out_of_ratings) and out_of_ratings[0].options) or 5 for review in reviews: review.rating = review.rating * out_of_ratings review.owner_details = frappe.db.get_value("User", review.owner, ["name", "username", "full_name", "user_image"], as_dict=True) return reviews def is_certified(course): certificate = frappe.get_all("LMS Certification", { "student": frappe.session.user, "course": course }) if len(certificate): return certificate[0].name return def get_lesson_index(lesson_name): """Returns the {chapter_index}.{lesson_index} for the lesson. """ lesson = frappe.db.get_value("Lesson Reference", {"lesson": lesson_name}, ["idx", "parent"], as_dict=True) if not lesson: return None chapter = frappe.db.get_value("Chapter Reference", {"chapter": lesson.parent}, ["idx"], as_dict=True) if not chapter: return None return f"{chapter.idx}.{lesson.idx}" def get_lesson_url(course, lesson_number): if not lesson_number: return return f"/courses/{course}/learn/{lesson_number}" def get_batch(course, batch_name): return frappe.get_all("LMS Batch", {"name": batch_name, "course": course}) def get_slugified_chapter_title(chapter): return slugify(chapter) def get_progress(course, lesson): return frappe.db.get_value("LMS Course Progress", { "course": course, "owner": frappe.session.user, "lesson": lesson }, ["status"]) def render_html(body): return markdown_to_html(body) def is_mentor(course, email): """Checks if given user is a mentor for this course. """ if not email: return False return frappe.db.count("LMS Course Mentor Mapping", { "course": course, "mentor": email }) def is_cohort_staff(course, user_email): """Returns True if the user is either a mentor or a staff for one or more active cohorts of this course. """ staff = { "doctype": "Cohort Staff", "course": course, "email": user_email } mentor = { "doctype": "Cohort Mentor", "course": course, "email": user_email } return frappe.db.exists(staff) or frappe.db.exists(mentor) def get_mentors(course): """Returns the list of all mentors for this course. """ course_mentors = [] mentors = frappe.get_all("LMS Course Mentor Mapping", {"course": course}, ["mentor"]) for mentor in mentors: member = frappe.db.get_value("User", mentor.mentor, ["name", "username", "full_name", "user_image"]) member.batch_count = frappe.db.count("LMS Batch Membership", { "member": member.name, "member_type": "Mentor" }) course_mentors.append(member) return course_mentors def is_eligible_to_review(course, membership): """ Checks if user is eligible to review the course """ if not membership: return False if frappe.db.count("LMS Course Review", { "course": course, "owner": frappe.session.user }): return False return True def get_course_progress(course, member=None): """ Returns the course progress of the session user """ lesson_count = len(get_lessons(course)) if not lesson_count: return 0 completed_lessons = frappe.db.count("LMS Course Progress", { "course": course, "owner": member or frappe.session.user, "status": "Complete" }) precision = cint(frappe.db.get_default("float_precision")) or 3 return flt(((completed_lessons/lesson_count) * 100), precision)