feat: make it possible to enable tracking for livecode execution

Tracking of livecode execution is made possible by making the page
context with course, batch and lesson available in js.

Added a global page_context variable in js and the data for that gets
initialzied in the learn.py.

.gitignore

@@ -5,6 +5,3 @@
 tags
 community/docs/current
 community/public/dist
-__pycache__/
-*.py[cod]
-*$py.class

community/hooks.py

@@ -165,8 +165,7 @@ whitelist = [
     "/add-a-new-batch",
     "/new-sign-up",
     "/message",
-    "/about",
-    "/lms-course-review"
+    "/about"
 ]
 whitelist_rules = [{"from_route": p, "to_route": p[1:]} for p in whitelist]
 

community/lms/doctype/lesson/lesson.js

@@ -2,7 +2,47 @@
 // For license information, please see license.txt
 
 frappe.ui.form.on('Lesson', {
-	// refresh: function(frm) {
+  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">
+		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/lesson/lesson.json

@@ -13,7 +13,9 @@
   "index_",
   "index_label",
   "section_break_6",
-  "body"
+  "body",
+  "help_section",
+  "help"
  ],
  "fields": [
   {
@@ -60,11 +62,20 @@
   {
    "fieldname": "column_break_4",
    "fieldtype": "Column Break"
+  },
+  {
+   "fieldname": "help_section",
+   "fieldtype": "Section Break",
+   "label": "Help"
+  },
+  {
+   "fieldname": "help",
+   "fieldtype": "HTML"
   }
  ],
  "index_web_pages_for_search": 1,
  "links": [],
- "modified": "2021-06-23 17:59:52.946515",
+ "modified": "2021-06-29 13:34:49.077363",
  "modified_by": "Administrator",
  "module": "LMS",
  "name": "Lesson",

community/lms/doctype/lms_course/lms_course.py

@@ -199,12 +199,7 @@ class LMSCourse(Document):
         }
         if batch:
             filters["batch"] = batch
-
-        membership = frappe.db.get_value("LMS Batch Membership",
-                        filters,
-                        ["name", "batch", "current_lesson", "member_type"],
-                        as_dict=True)
-
+        membership = frappe.db.get_value("LMS Batch Membership", filters, ["name","batch", "current_lesson"], as_dict=True)
         if membership and membership.batch:
             membership.batch_title = frappe.db.get_value("LMS Batch", membership.batch, "title")
         return membership
@@ -246,32 +241,6 @@ class LMSCourse(Document):
         member_names = [m['member'] for m in memberships]
         return find_all("User", name=["IN", member_names])
 
-    def get_reviews(self):
-        reviews = frappe.get_all("LMS Course Review",
-                    {
-                        "course": self.name
-                    },
-                    ["review", "rating", "owner"],
-                    order_by= "creation desc")
-
-        for review in reviews:
-            review.owner_details = frappe.get_doc("User", review.owner)
-
-        return reviews
-
-    def is_eligibleto_review(self, membership):
-        """ Checks if user is eligible to review the course """
-        if not membership:
-            return False
-        if frappe.db.count("LMS Course Review",
-                {
-                    "course": self.name,
-                    "owner": frappe.session.user
-                }):
-            return False
-        return True
-
-
     def get_outline(self):
         return CourseOutline(self)
 

community/lms/doctype/lms_course_review/lms_course_review.js

@@ -1,8 +0,0 @@
-// Copyright (c) 2021, FOSS United and contributors
-// For license information, please see license.txt
-
-frappe.ui.form.on('LMS Course Review', {
-	// refresh: function(frm) {
-
-	// }
-});

community/lms/doctype/lms_course_review/lms_course_review.json

@@ -1,54 +0,0 @@
-{
- "actions": [],
- "creation": "2021-06-28 13:36:36.146718",
- "doctype": "DocType",
- "editable_grid": 1,
- "engine": "InnoDB",
- "field_order": [
-  "review",
-  "rating",
-  "course"
- ],
- "fields": [
-  {
-   "fieldname": "review",
-   "fieldtype": "Small Text",
-   "label": "Review"
-  },
-  {
-   "fieldname": "rating",
-   "fieldtype": "Rating",
-   "label": "Rating"
-  },
-  {
-   "fieldname": "course",
-   "fieldtype": "Link",
-   "label": "Course",
-   "options": "LMS Course"
-  }
- ],
- "index_web_pages_for_search": 1,
- "links": [],
- "modified": "2021-06-28 15:00:35.146196",
- "modified_by": "Administrator",
- "module": "LMS",
- "name": "LMS Course Review",
- "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/lms_course_review/lms_course_review.py

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

community/lms/doctype/lms_course_review/test_lms_course_review.py

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

community/lms/widgets/Reviews.html

@@ -1,61 +0,0 @@
-<div>
-  <div class="reviews-heading">
-    <div class="reviews-title">Review</div>
-    {% if course.is_eligibleto_review(membership) %}
-    <a href="/lms-course-review?new=1">
-      Provide your Feedback
-    </a>
-    {% endif %}
-  </div>
-  <div>
-    {% for review in course.get_reviews() %}
-    <div class="review-card">
-      <div class="review-content"> {{ review.review }} </div>
-      <div class="review-card-footer">
-        <div>
-          {{ widgets.Avatar(member=review.owner_details, avatar_class="avatar-medium") }} <a
-            href="/{{review.owner_details.username}}">{{ review.owner_details.full_name }}</a>
-        </div>
-        <div class="rating">
-          {% for i in [1, 2, 3, 4, 5] %}
-          <svg class="icon icon-md {% if i <= review.rating %} star-click {% endif %}" data-rating="{{ i }}">
-            <use href="#icon-star"></use>
-          </svg>
-          {% endfor %}
-        </div>
-      </div>
-    </div>
-    {% endfor %}
-  </div>
-</div>
-
-
-
-<!-- Modal -->
-<div class="modal fade" id="review-modal" tabindex="-1" role="dialog" aria-hidden="true">
-  <div class="modal-dialog" role="document">
-    <div class="modal-content">
-      <div class="modal-header">
-        <h5 class="modal-title">Modal title</h5>
-        <button type="button" class="close" data-dismiss="modal" aria-label="Close">
-          <span aria-hidden="true">&times;</span>
-        </button>
-      </div>
-      <div class="modal-body">
-        <iframe src="/lms-course-review?new=1"></iframe>
-      </div>
-      <div class="modal-footer">
-        <button type="button" class="btn btn-secondary" data-dismiss="modal">Close</button>
-        <button type="button" class="btn btn-primary">Save changes</button>
-      </div>
-    </div>
-  </div>
-</div>
-<script>
-
-  frappe.ready(() => {
-    frappe.provide('frappe.ui');
-    console.log(frappe.ui)
-  })
-
-</script>

community/lms/workspace/lms/lms.json

@@ -0,0 +1,160 @@
+{
+ "category": "Modules",
+ "charts": [],
+ "creation": "2021-06-29 13:05:28.741459",
+ "developer_mode_only": 0,
+ "disable_user_customization": 0,
+ "docstatus": 0,
+ "doctype": "Workspace",
+ "extends_another_page": 0,
+ "hide_custom": 0,
+ "icon": "education",
+ "idx": 0,
+ "is_default": 0,
+ "is_standard": 1,
+ "label": "LMS",
+ "links": [
+  {
+   "hidden": 0,
+   "is_query_report": 0,
+   "label": "LMS",
+   "link_type": "DocType",
+   "onboard": 0,
+   "type": "Card Break"
+  },
+  {
+   "hidden": 0,
+   "is_query_report": 0,
+   "label": "LMS Course",
+   "link_to": "LMS Course",
+   "link_type": "DocType",
+   "onboard": 0,
+   "type": "Link"
+  },
+  {
+   "hidden": 0,
+   "is_query_report": 0,
+   "label": "LMS Batch",
+   "link_to": "LMS Batch",
+   "link_type": "DocType",
+   "onboard": 0,
+   "type": "Link"
+  },
+  {
+   "hidden": 0,
+   "is_query_report": 0,
+   "label": "LMS Batch Membership",
+   "link_to": "LMS Batch Membership",
+   "link_type": "DocType",
+   "onboard": 0,
+   "type": "Link"
+  },
+  {
+   "hidden": 0,
+   "is_query_report": 0,
+   "label": "LMS Course Mentor Mapping",
+   "link_to": "LMS Course Mentor Mapping",
+   "link_type": "DocType",
+   "onboard": 0,
+   "type": "Link"
+  },
+  {
+   "hidden": 0,
+   "is_query_report": 0,
+   "label": "Content",
+   "link_type": "DocType",
+   "onboard": 0,
+   "type": "Card Break"
+  },
+  {
+   "hidden": 0,
+   "is_query_report": 0,
+   "label": "Chapter",
+   "link_to": "Chapter",
+   "link_type": "DocType",
+   "onboard": 0,
+   "type": "Link"
+  },
+  {
+   "hidden": 0,
+   "is_query_report": 0,
+   "label": "Lesson",
+   "link_to": "Lesson",
+   "link_type": "DocType",
+   "onboard": 0,
+   "type": "Link"
+  },
+  {
+   "hidden": 0,
+   "is_query_report": 0,
+   "label": "Exercise",
+   "link_to": "Exercise",
+   "link_type": "DocType",
+   "onboard": 0,
+   "type": "Link"
+  },
+  {
+   "hidden": 0,
+   "is_query_report": 0,
+   "label": "Exercise Submission",
+   "link_to": "Exercise Submission",
+   "link_type": "DocType",
+   "onboard": 0,
+   "type": "Link"
+  },
+  {
+   "hidden": 0,
+   "is_query_report": 0,
+   "label": "LMS Quiz",
+   "link_to": "LMS Quiz",
+   "link_type": "DocType",
+   "onboard": 0,
+   "type": "Link"
+  },
+  {
+   "hidden": 0,
+   "is_query_report": 0,
+   "label": "LMS Quiz Submission",
+   "link_to": "LMS Quiz Submission",
+   "link_type": "DocType",
+   "onboard": 0,
+   "type": "Link"
+  }
+ ],
+ "modified": "2021-06-29 15:11:07.324651",
+ "modified_by": "Administrator",
+ "module": "LMS",
+ "name": "LMS",
+ "owner": "Administrator",
+ "pin_to_bottom": 0,
+ "pin_to_top": 1,
+ "shortcuts": [
+  {
+   "color": "#29CD42",
+   "doc_view": "List",
+   "format": "{} Published",
+   "label": "Courses",
+   "link_to": "LMS Course",
+   "stats_filter": "{\"is_published\": 1}",
+   "type": "DocType"
+  },
+  {
+   "color": "#29CD42",
+   "doc_view": "List",
+   "format": "{} Active ",
+   "label": "Batches",
+   "link_to": "LMS Batch",
+   "stats_filter": "{\"status\": \"Active\"}",
+   "type": "DocType"
+  },
+  {
+   "color": "#39E4A5",
+   "doc_view": "List",
+   "format": "{} Students",
+   "label": "Memberships",
+   "link_to": "LMS Batch Membership",
+   "stats_filter": "{\"member_type\": \"Student\"}",
+   "type": "DocType"
+  }
+ ]
+}

community/templates/pages/reviews.js

@@ -1,37 +0,0 @@
-
-frappe.ready(() => {
-  $("#provide-feedback").click((e) => {
-    e.preventDefault();
-    let d = new frappe.ui.Dialog({
-      title: 'Provide your Feedback',
-      fields: [
-        {
-          label: 'Rating',
-          fieldname: 'rating',
-          fieldtype: 'Rating'
-        },
-        {
-          label: 'Review',
-          fieldname: 'review',
-          fieldtype: 'Small Text'
-        }
-      ],
-      primary_action_label: 'Submit',
-      primary_action(values) {
-        console.log(values);
-        frappe.call({
-          method: "community.lms.doctype.lms_course.lms_course",
-          args: {
-            course: "{{ course.name }}",
-            rating: values.rating,
-            review: values.review
-          },
-          callback: (data) => {
-            d.hide();
-          }
-        })
-      }
-    });
-    d.show();
-  })
-})

community/www/batch/learn.html

@@ -61,6 +61,11 @@
 
 {%- block script %}
 {{ super() }}
+
+<script type="text/javascript">
+  var page_context = {{ page_context | tojson }};
+</script>
+
 {% for ext in page_extensions %}
 {{ ext.render_footer() }}
 {% endfor %}

community/www/batch/learn.py

@@ -35,6 +35,12 @@ def get_context(context):
 
     context.page_extensions = get_page_extensions()
 
+    context.page_context = {
+        "course": context.course.name,
+        "batch": context.get("batch") and context.batch.name,
+        "lesson": context.lesson.name
+    }
+
 def get_chapter_title(course_name, lesson_number):
     if not lesson_number:
         return

community/www/courses/course.html

@@ -15,7 +15,7 @@
     </div>
     <div class="d-flex justify-content-between align-items-end">
       <h2 id="course-title" data-course="{{course.name}}">{{course.title}}</h2>
-      {% if not course.disable_self_learning and not membership %}
+      {% if not course.disable_self_learning and not course.is_mentor(frappe.session.user) %}
       <div>
         <button class="btn btn-primary join-batch" data-course="{{ course.name | urlencode }}"> Start Learning </button>
       </div>
@@ -32,7 +32,6 @@
         {{ widgets.InstructorSection(instructor=course.get_instructor()) }}
         {{ BatchSection(course) }}
         {{ widgets.CourseOutline(course=course, show_link=membership) }}
-        {{ widgets.Reviews(course=course, membership=membership) }}
       </div>
     </div>
   </div>

community/www/courses/course.py

@@ -20,5 +20,5 @@ def get_context(context):
     context.course.query_parameter = "?batch=" + membership.batch if membership and membership.batch else ""
     context.membership = membership
     if not course.is_mentor(frappe.session.user) and membership:
-        """ frappe.local.flags.redirect_location = f"/courses/{course.name}/learn"
-        raise frappe.Redirect """
+        frappe.local.flags.redirect_location = f"/courses/{course.name}/learn"
+        raise frappe.Redirect