Merge pull request #216 from pateljannat/rename-chapters-and-lessons

fix: renamed chapter and lesson doctype

community/lms/doctype/chapter_reference/chapter_reference.json

@@ -13,14 +13,14 @@
    "fieldtype": "Link",
    "in_list_view": 1,
    "label": "Chapter",
-   "options": "Chapter",
+   "options": "Course Chapter",
    "reqd": 1
   }
  ],
  "index_web_pages_for_search": 1,
  "istable": 1,
  "links": [],
- "modified": "2021-07-27 16:25:02.903245",
+ "modified": "2021-09-30 10:35:30.014950",
  "modified_by": "Administrator",
  "module": "LMS",
  "name": "Chapter Reference",

community/lms/doctype/course_chapter/course_chapter.js

@@ -0,0 +1,14 @@
+// Copyright (c) 2021, FOSS United and contributors
+// For license information, please see license.txt
+
+frappe.ui.form.on('Course Chapter', {
+	onload: function (frm) {
+    frm.set_query("lesson", "lessons", function () {
+      return {
+        filters: {
+          "chapter": frm.doc.name,
+        }
+      };
+    });
+  }
+});

community/lms/doctype/course_chapter/course_chapter.json

@@ -0,0 +1,86 @@
+{
+ "actions": [],
+ "allow_rename": 1,
+ "autoname": "format:{####} {title}",
+ "creation": "2021-05-03 05:49:08.383058",
+ "doctype": "DocType",
+ "editable_grid": 1,
+ "engine": "InnoDB",
+ "field_order": [
+  "course",
+  "title",
+  "column_break_3",
+  "description",
+  "section_break_5",
+  "lessons"
+ ],
+ "fields": [
+  {
+   "fieldname": "course",
+   "fieldtype": "Link",
+   "in_list_view": 1,
+   "label": "Course",
+   "options": "LMS Course",
+   "reqd": 1
+  },
+  {
+   "fieldname": "title",
+   "fieldtype": "Data",
+   "in_list_view": 1,
+   "label": "Title",
+   "reqd": 1
+  },
+  {
+   "fieldname": "column_break_3",
+   "fieldtype": "Column Break"
+  },
+  {
+   "fieldname": "description",
+   "fieldtype": "Small Text",
+   "label": "Description"
+  },
+  {
+   "fieldname": "section_break_5",
+   "fieldtype": "Section Break"
+  },
+  {
+   "fieldname": "lessons",
+   "fieldtype": "Table",
+   "label": "Lessons",
+   "options": "Lesson Reference"
+  }
+ ],
+ "index_web_pages_for_search": 1,
+ "links": [
+  {
+   "group": "Lessons",
+   "link_doctype": "Course Lesson",
+   "link_fieldname": "chapter"
+  }
+ ],
+ "modified": "2021-09-29 15:33:44.611228",
+ "modified_by": "Administrator",
+ "module": "LMS",
+ "name": "Course Chapter",
+ "naming_rule": "Expression",
+ "owner": "Administrator",
+ "permissions": [
+  {
+   "create": 1,
+   "delete": 1,
+   "email": 1,
+   "export": 1,
+   "print": 1,
+   "read": 1,
+   "report": 1,
+   "role": "System Manager",
+   "share": 1,
+   "write": 1
+  }
+ ],
+ "search_fields": "title",
+ "sort_field": "modified",
+ "sort_order": "DESC",
+ "title_field": "title",
+ "track_changes": 1
+}

community/lms/doctype/course_chapter/course_chapter.py

@@ -0,0 +1,8 @@
+# Copyright (c) 2021, FOSS United and contributors
+# For license information, please see license.txt
+
+# import frappe
+from frappe.model.document import Document
+
+class CourseChapter(Document):
+	pass

community/lms/doctype/course_chapter/test_course_chapter.py

@@ -0,0 +1,8 @@
+# Copyright (c) 2021, FOSS United and Contributors
+# See license.txt
+
+# import frappe
+import unittest
+
+class TestCourseChapter(unittest.TestCase):
+	pass

community/lms/doctype/course_lesson/course_lesson.js

@@ -0,0 +1,57 @@
+// Copyright (c) 2021, FOSS United and contributors
+// For license information, please see license.txt
+
+frappe.ui.form.on('Lesson', {
+  setup: function (frm) {
+    frm.trigger('setup_help');
+  },
+  setup_help(frm) {
+    frm.get_field('help').html(`
+<p>You can add some more additional content to the lesson using a special syntax. The table below mentions all types of dynamic content that you can add to the lessons and the syntax for the same.</p>
+<div class="row font-weight-bold mb-3">
+  <div class="col-sm-4">
+    Content Type
+  </div>
+  <div class="col-sm-4">
+    Syntax
+  </div>
+</div>
+
+<div class="row mb-3">
+  <div class="col-sm-4">
+    Video
+  </div>
+  <div class="col-sm-4">
+    {{ Video("url_of_source") }}
+  </div>
+</div>
+
+<div class="row mb-3">
+  <div class="col-sm-4">
+    YouTube Video
+  </div>
+  <div class="col-sm-4">
+    {{ YouTubeVideo("unique_embed_id") }}
+  </div>
+</div>
+
+<div class="row mb-3">
+  <div class="col-sm-4">
+    Exercise
+  </div>
+  <div class="col-sm-4">
+    {{ Exercise("exercise_name") }}
+  </div>
+</div>
+
+<div class="row mb-3">
+  <div class="col-sm-4">
+    Quiz
+  </div>
+  <div class="col-sm-4">
+    {{ Quiz("lms_quiz_name") }}
+  </div>
+</div>
+`);
+  }
+});

community/lms/doctype/course_lesson/course_lesson.json

@@ -0,0 +1,97 @@
+{
+ "actions": [],
+ "allow_rename": 1,
+ "autoname": "format:{####} {title}",
+ "creation": "2021-05-03 06:21:12.995984",
+ "doctype": "DocType",
+ "editable_grid": 1,
+ "engine": "InnoDB",
+ "field_order": [
+  "chapter",
+  "include_in_preview",
+  "column_break_4",
+  "title",
+  "index_label",
+  "section_break_6",
+  "body",
+  "help_section",
+  "help"
+ ],
+ "fields": [
+  {
+   "fieldname": "chapter",
+   "fieldtype": "Link",
+   "in_list_view": 1,
+   "label": "Course Chapter",
+   "options": "Course Chapter",
+   "reqd": 1
+  },
+  {
+   "default": "0",
+   "fieldname": "include_in_preview",
+   "fieldtype": "Check",
+   "label": "Include In Preview"
+  },
+  {
+   "fieldname": "column_break_4",
+   "fieldtype": "Column Break"
+  },
+  {
+   "fieldname": "title",
+   "fieldtype": "Data",
+   "in_list_view": 1,
+   "label": "Title",
+   "reqd": 1
+  },
+  {
+   "fieldname": "index_label",
+   "fieldtype": "Data",
+   "label": "Index Label",
+   "read_only": 1
+  },
+  {
+   "fieldname": "section_break_6",
+   "fieldtype": "Section Break"
+  },
+  {
+   "fieldname": "body",
+   "fieldtype": "Markdown Editor",
+   "label": "Body",
+   "reqd": 1
+  },
+  {
+   "fieldname": "help_section",
+   "fieldtype": "Section Break",
+   "label": "Help"
+  },
+  {
+   "fieldname": "help",
+   "fieldtype": "HTML"
+  }
+ ],
+ "index_web_pages_for_search": 1,
+ "links": [],
+ "modified": "2021-09-29 15:28:51.418015",
+ "modified_by": "Administrator",
+ "module": "LMS",
+ "name": "Course Lesson",
+ "naming_rule": "Expression",
+ "owner": "Administrator",
+ "permissions": [
+  {
+   "create": 1,
+   "delete": 1,
+   "email": 1,
+   "export": 1,
+   "print": 1,
+   "read": 1,
+   "report": 1,
+   "role": "System Manager",
+   "share": 1,
+   "write": 1
+  }
+ ],
+ "sort_field": "modified",
+ "sort_order": "DESC",
+ "track_changes": 1
+}

community/lms/doctype/course_lesson/course_lesson.py

@@ -0,0 +1,96 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2021, FOSS United and contributors
+# For license information, please see license.txt
+
+from __future__ import unicode_literals
+import frappe
+from frappe.model.document import Document
+from ...md import markdown_to_html, find_macros
+
+class CourseLesson(Document):
+    def on_update(self):
+        dynamic_documents = ["Exercise", "Quiz"]
+        for section in dynamic_documents:
+            self.update_lesson_name_in_document(section)
+
+    def update_lesson_name_in_document(self, section):
+        doctype_map= {
+            "Exercise": "Exercise",
+            "Quiz": "LMS Quiz"
+        }
+        macros = find_macros(self.body)
+        documents = [value for name, value in macros if name == section]
+        index = 1
+        for name in documents:
+            e = frappe.get_doc(doctype_map[section], name)
+            e.lesson = self.name
+            e.index_ = index
+            e.save()
+            index += 1
+        self.update_orphan_documents(doctype_map[section], documents)
+
+    def update_orphan_documents(self, doctype, documents):
+        """Updates the documents that were previously part of this lesson,
+        but not any more.
+        """
+        linked_documents = {row['name'] for row in frappe.get_all(doctype, {"lesson": self.name})}
+        active_documents = set(documents)
+        orphan_documents = linked_documents - active_documents
+        for name in orphan_documents:
+            ex = frappe.get_doc(doctype, name)
+            ex.lesson = None
+            ex.index_ = 0
+            ex.index_label = ""
+            ex.save()
+
+    def render_html(self):
+        print(self.body)
+        return markdown_to_html(self.body)
+
+    def get_exercises(self):
+        if not self.body:
+            return []
+
+        macros = find_macros(self.body)
+        exercises = [value for name, value in macros if name == "Exercise"]
+        return [frappe.get_doc("Exercise", name) for name in exercises]
+
+    def get_progress(self):
+        return frappe.db.get_value("LMS Course Progress", {"lesson": self.name, "owner": frappe.session.user}, "status")
+
+    def get_slugified_class(self):
+        if self.get_progress():
+            return ("").join([ s for s in self.get_progress().lower().split() ])
+        return
+
+@frappe.whitelist()
+def save_progress(lesson, course, status):
+    if not frappe.db.exists("LMS Batch Membership",
+            {
+                "member": frappe.session.user,
+                "course": course
+            }):
+        return
+
+    if frappe.db.exists("LMS Course Progress",
+            {
+                "lesson": lesson,
+                "owner": frappe.session.user,
+                "course": course
+            }):
+        doc = frappe.get_doc("LMS Course Progress",
+                {
+                    "lesson": lesson,
+                    "owner": frappe.session.user,
+                    "course": course
+                })
+        doc.status = status
+        doc.save(ignore_permissions=True)
+    else:
+        frappe.get_doc({
+            "doctype": "LMS Course Progress",
+            "lesson": lesson,
+            "status": status,
+        }).save(ignore_permissions=True)
+    course_details = frappe.get_doc("LMS Course", course)
+    return course_details.get_course_progress()

community/lms/doctype/course_lesson/test_course_lesson.py

@@ -0,0 +1,8 @@
+# Copyright (c) 2021, FOSS United and Contributors
+# See license.txt
+
+# import frappe
+import unittest
+
+class TestCourseLesson(unittest.TestCase):
+	pass

community/lms/doctype/exercise/exercise.json

@@ -78,7 +78,7 @@
    "fieldtype": "Link",
    "in_list_view": 1,
    "label": "Lesson",
-   "options": "Lesson"
+   "options": "Course Lesson"
   },
   {
    "fieldname": "index_",
@@ -96,7 +96,7 @@
  ],
  "index_web_pages_for_search": 1,
  "links": [],
- "modified": "2021-06-01 05:22:15.656013",
+ "modified": "2021-09-29 15:27:55.585874",
  "modified_by": "Administrator",
  "module": "LMS",
  "name": "Exercise",

community/lms/doctype/exercise_submission/exercise_submission.json

@@ -53,7 +53,7 @@
    "fieldname": "lesson",
    "fieldtype": "Link",
    "label": "Lesson",
-   "options": "Lesson"
+   "options": "Course Lesson"
   },
   {
    "fieldname": "image",
@@ -94,7 +94,7 @@
  ],
  "index_web_pages_for_search": 1,
  "links": [],
- "modified": "2021-06-24 16:22:50.570845",
+ "modified": "2021-09-29 15:27:57.273879",
  "modified_by": "Administrator",
  "module": "LMS",
  "name": "Exercise Submission",

community/lms/doctype/lesson/lesson.py

@@ -55,7 +55,8 @@ class Lesson(Document):
         return [frappe.get_doc("Exercise", name) for name in exercises]
 
     def get_progress(self):
-        return frappe.db.get_value("LMS Course Progress", {"lesson": self.name, "owner": frappe.session.user}, "status")
+        return frappe.db.get_value("LMS Course Progress",
+            {"lesson": self.name, "owner": frappe.session.user}, "status")
 
     def get_slugified_class(self):
         if self.get_progress():

community/lms/doctype/lesson_reference/lesson_reference.json

@@ -13,14 +13,14 @@
    "fieldtype": "Link",
    "in_list_view": 1,
    "label": "Lesson",
-   "options": "Lesson",
+   "options": "Course Lesson",
    "reqd": 1
   }
  ],
  "index_web_pages_for_search": 1,
  "istable": 1,
  "links": [],
- "modified": "2021-08-31 10:44:42.048232",
+ "modified": "2021-09-30 10:35:47.832547",
  "modified_by": "Administrator",
  "module": "LMS",
  "name": "Lesson Reference",

community/lms/doctype/lms_batch_membership/lms_batch_membership.json

@@ -72,7 +72,7 @@
    "fieldname": "current_lesson",
    "fieldtype": "Link",
    "label": "Current Lesson",
-   "options": "Lesson"
+   "options": "Course Lesson"
   },
   {
    "fetch_from": "member.username",
@@ -84,7 +84,7 @@
  ],
  "index_web_pages_for_search": 1,
  "links": [],
- "modified": "2021-08-04 17:10:42.708479",
+ "modified": "2021-09-29 15:27:58.765399",
  "modified_by": "Administrator",
  "module": "LMS",
  "name": "LMS Batch Membership",

community/lms/doctype/lms_course/lms_course.json

@@ -148,7 +148,7 @@
  "links": [
   {
    "group": "Chapters",
-   "link_doctype": "Chapter",
+   "link_doctype": "Course Chapter",
    "link_fieldname": "course"
   },
   {
@@ -167,7 +167,7 @@
    "link_fieldname": "course"
   }
  ],
- "modified": "2021-09-20 12:00:18.325579",
+ "modified": "2021-09-30 10:36:48.759994",
  "modified_by": "Administrator",
  "module": "LMS",
  "name": "LMS Course",

community/lms/doctype/lms_course/lms_course.py

@@ -153,7 +153,7 @@ class LMSCourse(Document):
         """
         chapters = []
         for row in self.chapters:
-            chapter_details = frappe.db.get_value("Chapter", row.chapter,
+            chapter_details = frappe.db.get_value("Course Chapter", row.chapter,
                                                 ["name", "title", "description"],
                                                 as_dict=True)
             chapter_details.idx = row.idx
@@ -179,7 +179,7 @@ class LMSCourse(Document):
         lesson_list = frappe.get_all("Lesson Reference", {"parent": chapter.name},
                                         ["lesson", "idx"], order_by="idx")
         for row in lesson_list:
-            lesson_details = frappe.get_doc("Lesson", row.lesson)
+            lesson_details = frappe.get_doc("Course Lesson", row.lesson)
             lesson_details.number = flt("{}.{}".format(chapter.idx, row.idx))
             lessons.append(lesson_details)
         return lessons
@@ -217,7 +217,7 @@ class LMSCourse(Document):
         if not lesson:
             return None
 
-        chapter = frappe.db.get_value("Chapters", {"chapter": lesson.parent}, ["idx"], as_dict=True)
+        chapter = frappe.db.get_value("Chapter Reference", {"chapter": lesson.parent}, ["idx"], as_dict=True)
         if not chapter:
             return None
 

community/lms/doctype/lms_course_progress/lms_course_progress.json

@@ -28,7 +28,7 @@
    "fieldtype": "Link",
    "in_list_view": 1,
    "label": "Chapter",
-   "options": "Chapter",
+   "options": "Course Chapter",
    "read_only": 1
   },
   {
@@ -36,7 +36,7 @@
    "fieldtype": "Link",
    "in_list_view": 1,
    "label": "Lesson",
-   "options": "Lesson"
+   "options": "Course Lesson"
   },
   {
    "fieldname": "status",
@@ -53,7 +53,7 @@
  ],
  "index_web_pages_for_search": 1,
  "links": [],
- "modified": "2021-06-02 13:05:31.114939",
+ "modified": "2021-09-30 13:07:54.246863",
  "modified_by": "Administrator",
  "module": "LMS",
  "name": "LMS Course Progress",

community/lms/doctype/lms_quiz/lms_quiz.json

@@ -28,13 +28,13 @@
    "fieldname": "lesson",
    "fieldtype": "Link",
    "label": "Lesson",
-   "options": "Lesson",
+   "options": "Course Lesson",
    "read_only": 1
   }
  ],
  "index_web_pages_for_search": 1,
  "links": [],
- "modified": "2021-09-20 10:44:15.930892",
+ "modified": "2021-09-30 13:10:06.929357",
  "modified_by": "Administrator",
  "module": "LMS",
  "name": "LMS Quiz",

community/lms/workspace/lms/lms.json

@@ -79,7 +79,7 @@
    "hidden": 0,
    "is_query_report": 0,
    "label": "Chapter",
-   "link_to": "Chapter",
+   "link_to": "Course Chapter",
    "link_type": "DocType",
    "onboard": 0,
    "type": "Link"

community/patches.txt

@@ -12,3 +12,4 @@ community.patches.v0_0.course_instructor_update
 execute:frappe.delete_doc("DocType", "Discussion Message")
 execute:frappe.delete_doc("DocType", "Discussion Thread")
 community.patches.v0_0.rename_chapters_and_lessons_doctype
+community.patches.v0_0.rename_chapter_and_lesson_doctype #29-09-2021

community/patches/v0_0/rename_chapter_and_lesson_doctype.py

@@ -0,0 +1,40 @@
+import frappe
+
+def execute():
+    frappe.reload_doc("lms", "doctype", "course_chapter")
+    frappe.reload_doc("lms", "doctype", "course_lesson")
+
+    if not frappe.db.count("Course Chapter"):
+        move_chapters()
+
+    if not frappe.db.count("Course Lesson"):
+        move_lessons()
+
+    change_parent_for_lesson_reference()
+
+def move_chapters():
+    docs = frappe.get_all("Chapter", fields=["*"])
+    for doc in docs:
+        if frappe.db.exists("LMS Course", doc.course):
+            name = doc.name
+            doc.update({"doctype": "Course Chapter"})
+            del doc["name"]
+            new_doc = frappe.get_doc(doc)
+            new_doc.save()
+            frappe.rename_doc("Course Chapter", new_doc.name, name)
+
+def move_lessons():
+    docs = frappe.get_all("Lesson", fields=["*"])
+    for doc in docs:
+        if frappe.db.exists("Chapter", doc.chapter):
+            name = doc.name
+            doc.update({"doctype": "Course Lesson"})
+            del doc["name"]
+            new_doc = frappe.get_doc(doc)
+            new_doc.save()
+            frappe.rename_doc("Course Lesson", new_doc.name, name)
+
+def change_parent_for_lesson_reference():
+    lesson_reference = frappe.get_all("Lesson Reference", fields=["name", "parent"])
+    for reference in lesson_reference:
+        frappe.db.set_value("Lesson Reference", reference.name, "parenttype", "Course Chapter")

community/www/batch/learn.html

@@ -112,7 +112,7 @@
 {% set is_instructor = frappe.session.user == course.instructor %}
 {% set title = lesson.title + " - " + course.title %}
 {% set condition = is_instructor if is_instructor else membership %}
-{{ widgets.DiscussionMessage(doctype="Lesson", docname=lesson.name,
+{{ widgets.DiscussionMessage(doctype="Course Lesson", docname=lesson.name,
           condition=condition, button_name="Start Learning",
           redirect_to="/courses/" + course.name) }}
 {% endmacro %}

community/www/batch/learn.py

@@ -48,15 +48,6 @@ def get_current_lesson_details(lesson_number, context):
 def get_learn_url(lesson_number, course):
     return course.get_learn_url(lesson_number) and course.get_learn_url(lesson_number) + course.query_parameter
 
-def get_chapter_title(course_name, lesson_number):
-    if not lesson_number:
-        return
-    lesson_split = cstr(lesson_number).split(".")
-    chapter_index = lesson_split[0]
-    lesson_index = lesson_split[1]
-    chapter_name = frappe.db.get_value("Chapter", {"course": course_name, "index_": chapter_index}, "name")
-    return frappe.db.get_value("Lesson", {"chapter": chapter_name, "index_": lesson_index}, "title")
-
 def get_lesson_index(course, batch, user):
     lesson = batch.get_current_lesson(user)
     return lesson and course.get_lesson_index(lesson)