enlight-lms/lms/www/batch/learn.py

import frappe
from frappe import _
from frappe.utils import cstr, flt
from lms.lms.md import markdown_to_html

from lms.lms.utils import (
	get_lesson_url,
	has_course_moderator_role,
	is_instructor,
	has_course_evaluator_role,
)
from lms.www.utils import (
	get_common_context,
	redirect_to_lesson,
	get_current_lesson_details,
)


def get_context(context):
	get_common_context(context)

	chapter_index = frappe.form_dict.get("chapter")
	lesson_index = frappe.form_dict.get("lesson")
	class_name = frappe.form_dict.get("class")

	if class_name:
		context.class_info = frappe._dict(
			{
				"name": class_name,
				"title": frappe.db.get_value("LMS Batch", class_name, "title"),
			}
		)

	lesson_number = f"{chapter_index}.{lesson_index}"
	context.lesson_number = lesson_number
	context.lesson_index = lesson_index
	context.chapter = frappe.db.get_value(
		"Chapter Reference", {"idx": chapter_index, "parent": context.course.name}, "chapter"
	)

	if not chapter_index or not lesson_index:
		index_ = "1.1"
		redirect_to_lesson(context.course, index_)

	context.lesson = get_current_lesson_details(lesson_number, context)
	context.instructor = is_instructor(context.course.name)
	context.is_moderator = has_course_moderator_role()
	context.is_evaluator = has_course_evaluator_role()

	if context.lesson.instructor_notes:
		context.instructor_notes = markdown_to_html(context.lesson.instructor_notes)

	context.show_lesson = (
		context.membership
		or (context.lesson and context.lesson.include_in_preview)
		or context.instructor
		or context.is_moderator
		or context.is_evaluator
	)

	if not context.lesson:
		context.lesson = frappe._dict()

	if frappe.form_dict.get("edit"):
		if not context.instructor and not context.is_moderator:
			raise frappe.PermissionError(_("You do not have permission to access this page."))
		context.lesson.edit_mode = True
	else:
		neighbours = get_neighbours(lesson_number, context.lessons)
		context.next_url = get_url(neighbours["next"], context.course)
		context.prev_url = get_url(neighbours["prev"], context.course)

	meta_info = (
		context.lesson.title + " - " + context.course.title
		if context.lesson.title
		else "New Lesson"
	)
	context.metatags = {
		"title": meta_info,
		"keywords": meta_info,
		"description": meta_info,
	}

	context.page_extensions = get_page_extensions(context)
	context.page_context = {
		"course": context.course.name,
		"batch_old": context.batch_old,
		"lesson": context.lesson.name if context.lesson.name else "New Lesson",
		"is_member": context.membership is not None,
	}


def get_url(lesson_number, course):
	return (
		get_lesson_url(course.name, lesson_number)
		and get_lesson_url(course.name, lesson_number) + course.query_parameter
	)


def get_page_extensions(context):
	default_value = ["lms.plugins.PageExtension"]
	classnames = frappe.get_hooks("lms_lesson_page_extensions") or default_value
	extensions = [frappe.get_attr(name)() for name in classnames]
	for e in extensions:
		e.set_context(context)
	return extensions

class LessonBookmark:
	"""
	This represents a simple data structure to represent a lesson bookmark.
	"""
	def __init__(self, lesson_number: str) -> None:
		self.__test_param_or_raise_exception(lesson_number)
		_lesson_number = f"{lesson_number}." if not "." in lesson_number else lesson_number
		first, second = _lesson_number.split(".")

		self.__value = (int(first), int(second) or 0)	# second would be "" if `lesson_number` is something like "7"

	def __eq__(self, other: object) -> bool:
		if isinstance(other, self.__class__):
			return self.__value == other.value
		return NotImplemented
	
	def __gt__(self, other: object) -> bool:
		if isinstance(other, self.__class__):
			return self.__value > other.value
		return False

	def __repr__(self) -> str:
		return f"{self.__value[0]}.{self.__value[1]}"
	
	def __test_param_or_raise_exception(self, string: str) -> None:
		"""
		Tests that a given string is in the format "n" or "n.n" where n is a numeric
		character. If the string does not match the expected format, `TypeError` is
		raised.
		"""
		import re
		import sys
		expected_format = r'^\d+\.?\d*$'

		try:
			if not re.match(expected_format, string):
				raise TypeError("""Expected a 'str' in the format 'n' or 'n.n' where n 
				   is a numeric character. Example: '7' or '7.10""")
		except TypeError as e:
			tb = sys.exc_info()[2]
			raise TypeError("""Expected a 'str' in the format 'n' or 'n.n' where n 
				   is a numeric character. Example: '7' or '7.10""").with_traceback(tb)
	
	@property
	def value(self):
		return self.__value
	
	@property
	def readable_value(self):
		return self.__repr__()


def get_neighbours(current, lessons):
	current = flt(current)
	numbers = sorted(lesson.number for lesson in lessons)
	index = numbers.index(current)
	return {
		"prev": numbers[index - 1] if index - 1 >= 0 else None,
		"next": numbers[index + 1] if index + 1 < len(numbers) else None,
	}