fix: api and orm

feat: Invite based membership

community/hooks.py

@@ -143,7 +143,8 @@ primary_rules = [
     {"from_route": "/courses/<course>/<batch>/members", "to_route": "batch/members"},
     {"from_route": "/courses/<course>/<batch>/discuss", "to_route": "batch/discuss"},
     {"from_route": "/courses/<course>/<batch>/about", "to_route": "batch/about"},
-    {"from_route": "/courses/<course>/<batch>/progress", "to_route": "batch/progress"}
+    {"from_route": "/courses/<course>/<batch>/progress", "to_route": "batch/progress"},
+    {"from_route": "/courses/<course>/<batch>/join", "to_route": "batch/join"}
 ]
 
 # Any frappe default URL is blocked by profile-rules, add it here to unblock it

community/lms/api.py

@@ -43,7 +43,7 @@ def save_current_lesson(batch_name, lesson_name):
         doctype="LMS Batch Membership",
         filters={
             "batch": batch_name,
-            "member_email": frappe.session.user
+            "member": frappe.session.user
         },
         fieldname="name")
     if not name:

community/lms/doctype/exercise/exercise.py

@@ -55,5 +55,6 @@ class Exercise(Document):
             image=image,
             solution=code)
         doc.insert(ignore_permissions=True)
+
         return doc
 

community/lms/doctype/exercise_submission/exercise_submission.py

@@ -1,8 +1,13 @@
 # Copyright (c) 2021, FOSS United and contributors
 # For license information, please see license.txt
 
-# import frappe
+import frappe
 from frappe.model.document import Document
+from ..lesson.lesson import update_progress
 
 class ExerciseSubmission(Document):
-	pass
+
+    def after_insert(self):
+        course_details = frappe.get_doc("LMS Course", self.course)
+        if not (course_details.is_mentor(frappe.session.user) or frappe.flags.in_test):
+            update_progress(self.lesson)

community/lms/doctype/lesson/lesson.py

@@ -43,3 +43,65 @@ class Lesson(Document):
         The return value would be like 1.2, 2.1 etc.
         It will be None if there is no next lesson.
         """
+
+    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, batch):
+    if not frappe.db.exists("LMS Batch Membership",
+            {
+                "member": frappe.session.user,
+                "batch": batch
+            }):
+        return
+    if frappe.db.exists("LMS Course Progress",
+            {
+                "lesson": lesson,
+                "owner": frappe.session.user
+            }):
+        return
+
+    lesson_details = frappe.get_doc("Lesson", lesson)
+    dynamic_content = frappe.db.count("LMS Section",
+                        filters={
+                            "type": ["not in", ["example", "text"]],
+                            "parent": lesson_details.name
+                        })
+
+    status = "Complete"
+    if dynamic_content:
+        status = "Partially Complete"
+
+    frappe.get_doc({
+        "doctype": "LMS Course Progress",
+        "lesson": lesson_details.name,
+        "status": status
+    }).save(ignore_permissions=True)
+
+def update_progress(lesson):
+    user = frappe.session.user
+    if not all_dynamic_content_submitted(lesson, user):
+        return
+    if frappe.db.exists("LMS Course Progress", {"lesson": lesson, "owner": user}):
+        course_progress = frappe.get_doc("LMS Course Progress", {"lesson": lesson, "owner": user})
+        course_progress.status = "Complete"
+        course_progress.save()
+
+def all_dynamic_content_submitted(lesson, user):
+    exercise_names = frappe.get_list("Exercise", {"lesson": lesson}, ["name"], pluck="name")
+    all_exercises_submitted = False
+    print(exercise_names)
+    query = {
+        "exercise": ["in", exercise_names],
+        "owner": user
+    }
+    if frappe.db.count("Exercise Submission", query) == len(exercise_names):
+        all_exercises_submitted = True
+
+    return all_exercises_submitted

community/lms/doctype/lms_course_progress/lms_course_progress.js

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

community/lms/doctype/lms_course_progress/lms_course_progress.json

@@ -0,0 +1,78 @@
+{
+ "actions": [],
+ "creation": "2021-05-31 17:20:13.388453",
+ "doctype": "DocType",
+ "editable_grid": 1,
+ "engine": "InnoDB",
+ "field_order": [
+  "status",
+  "column_break_3",
+  "lesson",
+  "chapter",
+  "course"
+ ],
+ "fields": [
+  {
+   "fetch_from": "chapter.course",
+   "fieldname": "course",
+   "fieldtype": "Link",
+   "in_list_view": 1,
+   "in_standard_filter": 1,
+   "label": "Course",
+   "options": "LMS Course",
+   "read_only": 1
+  },
+  {
+   "fetch_from": "lesson.chapter",
+   "fieldname": "chapter",
+   "fieldtype": "Link",
+   "in_list_view": 1,
+   "label": "Chapter",
+   "options": "Chapter",
+   "read_only": 1
+  },
+  {
+   "fieldname": "lesson",
+   "fieldtype": "Link",
+   "in_list_view": 1,
+   "label": "Lesson",
+   "options": "Lesson"
+  },
+  {
+   "fieldname": "status",
+   "fieldtype": "Select",
+   "in_list_view": 1,
+   "in_standard_filter": 1,
+   "label": "Status",
+   "options": "Complete\nPartially Complete\nIncomplete"
+  },
+  {
+   "fieldname": "column_break_3",
+   "fieldtype": "Column Break"
+  }
+ ],
+ "index_web_pages_for_search": 1,
+ "links": [],
+ "modified": "2021-06-02 13:05:31.114939",
+ "modified_by": "Administrator",
+ "module": "LMS",
+ "name": "LMS Course Progress",
+ "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_progress/lms_course_progress.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 LMSCourseProgress(Document):
+	pass

community/lms/doctype/lms_course_progress/test_lms_course_progress.py

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

community/lms/web_form/add_a_new_batch/add_a_new_batch.json

@@ -19,7 +19,7 @@
  "is_standard": 1,
  "login_required": 1,
  "max_attachment_size": 0,
- "modified": "2021-04-30 11:22:18.188712",
+ "modified": "2021-06-02 15:52:06.383260",
  "modified_by": "Administrator",
  "module": "LMS",
  "name": "add-a-new-batch",
@@ -38,13 +38,13 @@
   {
    "allow_read_on_all_link_options": 0,
    "fieldname": "course",
-   "fieldtype": "Data",
+   "fieldtype": "Link",
-   "hidden": 0,
+   "hidden": 1,
    "label": "Course",
    "max_length": 0,
    "max_value": 0,
-   "options": "",
+   "options": "LMS Course",
-   "read_only": 1,
+   "read_only": 0,
    "reqd": 0,
    "show_in_filter": 0
   },

community/lms/widgets/ChapterTeaser.html

@@ -8,6 +8,9 @@
       {% for lesson in chapter.get_lessons() %}
       <div class="lesson-teaser">
         <a {% if show_link %} class="anchor_style" href="{{ batch.get_learn_url(course.get_lesson_index(lesson.name)) }}" {% endif %}>{{ lesson.title }}</a>
+        {% if show_progress and not course.is_mentor(frappe.session.user) and lesson.get_progress() %}
+        <a class="pull-right badge p-1 {{ lesson.get_slugified_class() }}"> <img class="progress-image" src="/assets/community/images/Vector.png"> {{ lesson.get_progress() }}</a>
+        {% endif %}
       </div>
       {% endfor %}
     </div>

community/lms/widgets/CourseOutline.html

@@ -1,5 +1,5 @@
 <h2>Course Outline</h2>
 
 {% for chapter in course.get_chapters() %}
-{{ widgets.ChapterTeaser(index=loop.index, chapter=chapter, course=course, batch=batch, show_link=show_link)}}
+{{ widgets.ChapterTeaser(index=loop.index, chapter=chapter, course=course, batch=batch, show_link=show_link, show_progress=show_progress)}}
 {% endfor %}

community/lms/widgets/RenderBatch.html

@@ -0,0 +1,29 @@
+<div class="batch">
+  <div class="batch-details">
+    <div>Session every {{batch.sessions_on}}</div>
+    <div>{{frappe.utils.format_time(batch.start_time, "short")}} -
+      {{frappe.utils.format_time(batch.end_time, "short")}}
+    </div>
+    <div>Starting {{frappe.utils.format_date(batch.start_date, "medium")}}</div>
+    <div class="course-type" style="color: #888; padding: 10px 0px;">mentors</div>
+
+    {% for m in batch.get_mentors() %}
+    <div>
+      {{ widgets.Avatar(member=m, avatar_class="avatar-medium" ) }}
+      <span class="instructor-title">{{m.full_name}}</span>
+    </div>
+    {% endfor %}
+  </div>
+  {% if can_manage or can_join %}
+  <div class="cta">
+    <div class="">
+      {% if can_manage %}
+      <a href="/courses/{{course.name}}/{{batch.name}}/home" class="btn btn-primary">Manage</a>
+      {% elif can_join %}
+      <button class="join-batch btn btn-primary" data-batch="{{ batch.name | urlencode }}"
+        data-course="{{ course.name | urlencode }}">Join this Batch</button>
+      {% endif %}
+    </div>
+  </div>
+  {% endif %}
+</div>

community/public/css/style.css

@@ -211,3 +211,63 @@ section {
   background: #eee;
   border: 2px solid #ddd;
 }
+
+
+.page-card {
+	max-width: 360px;
+	padding: 15px;
+	margin: 70px auto;
+	border: 1px solid #d1d8dd;
+	border-radius: 4px;
+	background-color: #fff;
+	box-shadow: 0px 3px 6px rgba(0, 0, 0, 0.1);
+}
+.page-card .page-card-head {
+	padding: 10px 15px;
+	margin: -15px;
+	margin-bottom: 15px;
+	border-bottom: 1px solid #d1d8dd;
+}
+.page-card .page-card-head .indicator {
+	color: #36414C;
+	font-size: 14px;
+}
+.page-card .page-card-head .indicator::before {
+	margin: 0 6px 0.5px 0px;
+}
+.page-card .btn {
+	margin-top: 30px;
+}
+
+.partiallycomplete {
+  background: #FEF4E2;
+  color: #976417;
+}
+
+.partiallycomplete img {
+  background: #976417;
+}
+
+.complete {
+  background: #EAF5EE;
+  color: #38A160;
+}
+
+.complete img {
+  background: #38A160;
+}
+
+.incomplete {
+  background: #FEECEC;
+  color: #E24C4C;
+}
+
+.incomplete img {
+  background: #E24C4C;
+}
+
+.progress-image {
+  margin-right: 3px;
+  border-radius: 50px;
+  padding: 5px;
+}

community/public/css/style.less

@@ -254,6 +254,7 @@ section.lightgray {
     background-color: rgba(255, 255, 255, 0);
     max-height: 300px;
     white-space: pre-wrap;
+    word-wrap: break-word;
     margin: 0px;
     margin-left: 20px;
     padding: 4px;
@@ -284,7 +285,7 @@ section.lightgray {
 }
 
 .lesson-teaser {
-  line-height: 35px;
+  line-height: 40px;
 }
 
 #hero h1 {

community/www/batch/home.html

@@ -1,46 +1,60 @@
 {% extends "templates/base.html" %}
 {% block title %} Batch {% endblock %}
+
 {% block head_include %}
 <meta name="description" content="Courses" />
 <meta name="keywords" content="" />
-
 <link rel="stylesheet" href="/assets/frappe/css/font-awesome.css">
 {% endblock %}
 
 {% block content %}
+{% set invite_link = frappe.utils.get_url() + "/courses/" + course.name + "/" + batch.name + "/join" %}
 <div class="container mt-5">
   {{ widgets.BatchTabs(course=course, batch=batch) }}
+  <div>
     <h1 class="mt-5">{{ batch.title }}</h1>
+  </div>
   <div class="course-details">
-    {{ widgets.CourseOutline(course=course, batch=batch, show_link=True) }}
+    {{ widgets.CourseOutline(course=course, batch=batch, show_link=True, show_progress=True) }}
   </div>
-  <div class="col-lg-4 col-md-12">
+  <div class="w-25">
     <h2>Batch Schedule</h2>
-    {{ BatchDetails(batch) }}
+    {{ widgets.RenderBatch(course=course, batch=batch) }}
   </div>
+
+  {% if batch.description %}
   <h2>Batch Details</h2>
   {{ frappe.utils.md_to_html(batch.description) }}
+  {% endif %}
 
+  {% if course.is_mentor(frappe.session.user) %}
+  <div class="">
+    <h2> Invite Members </h2>
+    <a href="" class="anchor_style mr-5" id="invite-link" data-link="{{ invite_link }}">Get Batch Invitation
+      Link</a>
+    <small id="copy-message" class="text-muted pull-right" style="display: none;">Copied to Clipboard.</small>
+  </div>
+  {% endif %}
 
 </div>
+
+<script>
+  frappe.ready(() => {
+    $("#invite-link").click((e) => {
+      e.preventDefault();
+      var link_element = $("#invite-link");
+      var input_element = document.createElement("input");
+      input_element.value = link_element.attr("data-link")
+      document.body.appendChild(input_element);
+      input_element.select();
+      document.execCommand("copy");
+      input_element.remove();
+      $("#copy-message").slideDown(function () {
+        setTimeout(function () {
+          $("#copy-message").slideUp();
+        }, 5000);
+      });
+    })
+  })
+</script>
 {% endblock %}
-
-{% macro BatchDetails(batch) %}
-<div class="batch">
-  <div class="batch-details">
-    <div>Session every {{batch.sessions_on}}</div>
-    <div>{{frappe.utils.format_time(batch.start_time, "short")}} -
-      {{frappe.utils.format_time(batch.end_time, "short")}}
-    </div>
-    <div>Starting {{frappe.utils.format_date(batch.start_date, "medium")}}</div>
-    <div class="course-type" style="color: #888; padding: 10px 0px;">mentors</div>
-
-    {% for m in batch.get_mentors() %}
-    <div>
-      {{ widgets.Avatar(member=m, avatar_class="avatar-medium" ) }}
-      <span class="instructor-title">{{m.full_name}}</span>
-    </div>
-    {% endfor %}
-  </div>
-</div>
-{% endmacro %}

community/www/batch/join.html

@@ -0,0 +1,74 @@
+% extends "templates/base.html" %}
+{% block title %}Join a Course{% endblock %}
+
+{% block head_include %}
+<meta name="description" content="Join a Course"/>
+<meta name="keywords" content="" />
+{% endblock %}
+
+{% block content %}
+{% if frappe.session.user == "Guest" %}
+
+<div class="page-card">
+  <div class='page-card-head'>
+    <span class='indicator blue password-box'>Login Required</span>
+  </div>
+  <div class=''>Please log in to confirm to join the course {{ batch.course_title }}.</div>
+  <a type="submit" id="login" class="btn btn-primary w-100"
+    href="/login?redirect-to=/courses/{{ batch.course }}/{{ batch.name }}/join">{{_("Login")}}</a>
+</div>
+
+{% elif already_a_member %}
+
+<div class="page-card">
+  <div class='page-card-head'>
+    <span class='indicator blue password-box'>Already a member</span>
+  </div>
+  <div class=''>You are already a member of the batch {{ batch.title }} for the course {{ batch.course_title }}.
+  </div>
+  <a type="submit" id="batch-home" class="btn btn-primary w-100" href="/courses/{{batch.course}}/{{batch.name}}/home">{{_("Go to Batch Home")}}</a>
+</div>
+
+{% else %}
+
+<div class="page-card">
+  <div class='page-card-head'>
+    <span class='indicator blue password-box'>Confirm your membership</span>
+  </div>
+  <div>Please provide your confirmation to be a part of the batch {{ batch.title }} for the course
+    {{ batch.course_title }}.
+  </div>
+  <a type="submit" id="confirm" class="btn btn-primary w-100" data-batch="{{ batch.name | urlencode }}"
+    data-course="{{ batch.course | urlencode }}">{{_("Confirm")}}</a>
+</div>
+
+{% endif %}
+
+<script>
+  frappe.ready(() => {
+    var confirm_element = $("#confirm");
+    var batch = decodeURIComponent(confirm_element.attr("data-batch"));
+    var course = decodeURIComponent(confirm_element.attr("data-course"));
+
+    confirm_element.click((e) => {
+      frappe.call({
+        "method": "community.lms.doctype.lms_batch_membership.lms_batch_membership.create_membership",
+        "args": {
+          "batch": batch
+        },
+        "callback": (data) => {
+          if (data.message == "OK") {
+            frappe.msgprint({
+              message: __("You are now a member of this batch!"),
+              clear: true
+            });
+            setTimeout(function () {
+              window.location.href = "/courses/" + course + "/" + batch + "/home";
+            }, 2000);
+          }
+        }
+      })
+    })
+  })
+</script>
+{% endblock %}

community/www/batch/join.py

@@ -0,0 +1,8 @@
+import frappe
+
+def get_context(context):
+    context.no_cache = 1
+    batch_name = frappe.form_dict["batch"]
+    context.batch = frappe.get_doc("LMS Batch", batch_name)
+    context.already_a_member = context.batch.is_member(frappe.session.user)
+    context.batch.course_title = frappe.db.get_value("LMS Course", context.batch.course, "title")

community/www/batch/learn.html

@@ -28,7 +28,7 @@
   {{ widgets.BatchTabs(course=course, batch=batch) }}
   <div class="lesson-page">
 
-    <h2>{{ lesson.title }}</h2>
+    <h2 class="title {% if course.is_mentor(frappe.session.user) %} is_mentor {% endif %}" data-name="{{ lesson.name }}" data-batch="{{ batch.name }}">{{ lesson.title }}</h2>
 
     {% for s in lesson.get_sections() %}
     <div class="section section-{{ s.type }}">

community/www/batch/learn.js

@@ -0,0 +1,11 @@
+frappe.ready(() => {
+  if (!$(".title").hasClass("is_mentor")) {
+    frappe.call({
+      method: "community.lms.doctype.lesson.lesson.save_progress",
+      args: {
+        lesson: $(".title").attr("data-name"),
+        batch: $(".title").attr("data-batch")
+      }
+    })
+  }
+})

community/www/courses/course.html

@@ -64,36 +64,6 @@
 {% endif %}
 {% endmacro %}
 
-{% macro RenderBatch(batch, can_manage=False) %}
-<div class="batch">
-  <div class="batch-details">
-    <div>Session every {{batch.sessions_on}}</div>
-    <div>{{frappe.utils.format_time(batch.start_time, "short")}} -
-      {{frappe.utils.format_time(batch.end_time, "short")}}
-    </div>
-    <div>Starting {{frappe.utils.format_date(batch.start_date, "medium")}}</div>
-    <div class="course-type" style="color: #888; padding: 10px 0px;">mentors</div>
-
-    {% for m in batch.get_mentors() %}
-    <div>
-      {{ widgets.Avatar(member=m, avatar_class="avatar-medium" ) }}
-      <span class="instructor-title">{{m.full_name}}</span>
-    </div>
-    {% endfor %}
-  </div>
-  <div class="cta">
-    <div class="">
-      {% if can_manage %}
-      <a href="/courses/{{course.name}}/{{batch.name}}/home" class="btn btn-primary">Manage</a>
-      {% else %}
-      <button class="join-batch btn btn-primary" data-batch="{{ batch.name | urlencode }}"
-        data-course="{{ course.name | urlencode }}">Join this Batch</button>
-      {% endif %}
-    </div>
-  </div>
-</div>
-{% endmacro %}
-
 {% macro BatchSectionForMentors(course, mentor_batches) %}
 <h2>Your Batches</h2>
 
@@ -105,7 +75,7 @@
 <div class="row">
   {% for batch in mentor_batches %}
   <div class="col-lg-4 col-md-6">
-    {{ RenderBatch(batch, can_manage=True) }}
+    {{ widgets.RenderBatch(course=course, batch=batch, can_manage=True) }}
   </div>
   {% endfor %}
 </div>
@@ -127,7 +97,7 @@
 <div class="row">
   {% for batch in upcoming_batches %}
   <div class="col-lg-4 col-md-6">
-    {{ RenderBatch(batch, can_manage=False) }}
+    {{ widgets.RenderBatch(course=course, batch=batch, can_join=True) }}
   </div>
   {% endfor %}
 </div>

community/www/courses/learn/index.js

@@ -1,3 +0,0 @@
-frappe.ready(() => {
-	
-})

community/www/home/index.html

@@ -10,8 +10,8 @@
 <section id="hero">
   <div class="container">
     <div class="jumbotron">
-      <h1 class="display-4">Guided online courses, with a <br />mentor at your back.</h1>
+      <h1 class="display-4">Guided online programming courses, with a <br />mentor at your back.</h1>
-      <p class="lead">Hands-on online courses designed by experts, delivered by passionate mentors.</p>
+      <p class="lead">Hands-on programming courses designed by experts, delivered by passionate mentors.</p>
       {{ widgets.RequestInvite() }}
     </div>
   </div>