Added course log api

lms/djangoapps/instructor/views/course_log.py

@@ -0,0 +1,243 @@
+import logging
+import json
+
+from bson.json_util import dumps
+from django.contrib.auth.models import User
+from django.views.decorators.csrf import csrf_exempt
+from common.djangoapps.util.json_request import JsonResponse
+from opaque_keys.edx.keys import CourseKey
+from xmodule.modulestore import ModuleStoreEnum
+from xmodule.modulestore.django import modulestore
+from django.views.decorators.clickjacking import xframe_options_exempt
+from itertools import chain
+
+
+log = logging.getLogger(__name__)
+@xframe_options_exempt
+@csrf_exempt
+def extras_get_course_log(request, course_id):
+    use_case = request.GET.get("analytics", None)
+    if use_case:
+        course_log = get_course_unit_log_analytics(course_id)
+    else:
+        course_log = get_course_structure(course_id)
+    json_data = dumps(course_log)
+    json_data = json.loads(json_data)
+    return JsonResponse(json_data)
+    #return HttpResponse(json_data, content_type="application/json")
+    #return render(request, 'course_log.html', context =  course_log)
+
+def get_course_unit_log_analytics(course_id):
+	course_log = {}
+	try:
+		course_key = CourseKey.from_string(course_id)
+		split_modulestore = modulestore()._get_modulestore_by_type(ModuleStoreEnum.Type.split)
+		active_version_collection = split_modulestore.db_connection.course_index
+		structure_collection = split_modulestore.db_connection.structures
+		course = list(active_version_collection.find({"org" : course_key.org, "course" : course_key.course, "run" : course_key.run}))
+
+		course_structure  = list(structure_collection.find({"_id" : course[0]["versions"]["published-branch"]}, {"blocks" : 1}))
+		data = []
+
+		for i in course_structure[0]["blocks"]:
+			if "display_name" in i["fields"] and i["block_type"] in ["vertical"]:
+				log.info(i)
+				log.info(i["edit_info"]["edited_by"])
+				log.info(User.objects)
+				u = User.objects.get(id = i["edit_info"]["edited_by"])
+				subsection_name = get_subsection_name(i["block_id"], course_structure)
+				section_name = get_section_name(subsection_name[1], course_structure)
+				data.append({"unit_name" : i["fields"]["display_name"], "edited_by_email" : u.email, "edited_by_name" : u.first_name, "edited_on" : i["edit_info"]["edited_on"], "subsection_name": subsection_name[0],"section_name" : section_name, "block_type": i["block_type"], "block_id": i["block_id"], "unit_type": i["fields"]["children"][0][0] if i["fields"]["children"] else ""})
+
+		course_log = sorted(data, key = lambda k:k['edited_on'], reverse=True)
+		#course_log = json.loads(dumps(course_log))
+	except Exception as e:
+		log.error(e)
+
+	return {"course_log" : course_log}
+
+def get_subsection_name(id, course_structure):
+	for i in course_structure[0]["blocks"]:
+		if i["block_type"] in ["sequential"]:
+			if id in chain(*i["fields"]["children"]):
+				return [i["fields"]["display_name"], i["block_id"]]
+
+def get_section_name(id, course_structure):
+	for i in course_structure[0]["blocks"]:
+		if i["block_type"] in ["chapter"]:
+			if id in chain(*i["fields"]["children"]):
+				return i["fields"]["display_name"]
+
+# def get_course_unit_log(course_id):
+#     course_key = CourseKey.from_string(course_id)
+#     split_modulestore = modulestore()._get_modulestore_by_type(ModuleStoreEnum.Type.split)
+#     active_version_collection = split_modulestore.db_connection.course_index
+#     structure_collection = split_modulestore.db_connection.structures
+#     course_definition = active_version_collection.find({"org" : course_key.org, "course" : course_key.course, "run" : course_key.run})
+
+#     published_version  = structure_collection.find_one({"_id" : course_definition[0]["versions"]["published-branch"]})
+
+#     #fetch all previous versions
+#     all_previous_versions = [] 
+#     document = published_version
+
+#     while True:
+#         previous_version_id = document["previous_version"]
+#         document = structure_collection.find_one({"_id": previous_version_id})
+
+#         if not document:
+#             break
+
+#         all_previous_versions.append(document)
+
+#     all_previous_versions = sorted(all_previous_versions, key=lambda x: x.get("edited_on", 0))
+
+#     data = get_course_history(course_definition, published_version, all_previous_versions)    
+#     return data
+
+
+# def get_course_history(course_definition, published_version, all_previous_versions):
+#     course_logs = {"last_updated_on" : conver_utc_ist(published_version["edited_on"]), 
+#             "components" : {}, "section_details" : {}, "subsection_details" : {}, "unit_details" : {}}
+
+#     course_logs["latest_published_componenets"] = [block["block_id"] for block in published_version["blocks"] if block["block_type"] not in ("course", "course_info", "about",  "chapter", "vertical", "sequential")]
+
+#     for version in all_previous_versions:
+#         course_logs = process_course_logs(version, course_logs)
+
+#     course_logs = process_course_logs(published_version, course_logs)
+
+#     return course_logs
+
+# def process_course_logs(version, course_logs):
+
+#     components_list = []
+
+#     for block in version["blocks"]:
+
+#         if block["block_type"] not in ("course", "course_info", "about",  "chapter", "vertical", "sequential", "static_tab"):
+#             block_id = block["block_id"]
+
+#             components_list.append(block_id)
+
+#             parents_list, parents_names = find_block_parents(version, block_id)
+
+#             edited_on = conver_utc_ist(block['edit_info']['edited_on'])
+#             user_obj = User.objects.get(id = block["edit_info"]["edited_by"])
+
+#             if block_id not in course_logs["components"]:
+#                 status = "Created"
+#                 course_logs["components"][block_id] = {"block_type" : block["block_type"].replace("_"," ").title(), "edited_info" : []}
+
+#             else:
+
+#                 previous_block_info = course_logs["components"][block_id]["edited_info"][-1]
+
+#                 if block["definition"] != previous_block_info["definition"]:
+#                     status = "Edited"
+
+#                 elif block["definition"] == previous_block_info["definition"] and previous_block_info["fields"] != block["fields"]:
+#                     status = "Edited"
+
+#                 elif parents_list != previous_block_info["parents_list"]:
+#                     #add another obj as Moved Out with reference to -1 obj
+#                     course_logs["components"][block_id]["edited_info"].append({ "definition" : block["definition"], "fields" : block["fields"],
+#                                                                                 "parents_list" : previous_block_info["parents_list"],
+#                                                                                 "parents_names" : previous_block_info["parents_names"],
+#                                                                                 "edited_on" : edited_on, "edited_by" : user_obj.first_name,
+#                                                                                 "status" : "Moved Out"})
+#                     status = "Moved In"
+#                 else:
+#                     continue
+
+#             course_logs["components"][block_id]["edited_info"].append({ "definition" : block["definition"], "fields" : block["fields"],
+#                                                                         "parents_list" : parents_list, "parents_names" : parents_names,
+#                                                                         "edited_on" : edited_on, "edited_by" : user_obj.first_name, 
+#                                                                         "status" : status})
+
+#     #Check for Deleted Blocks
+#     if components_list:
+#         deleted_blocks = list(set(course_logs["components"].keys()) - set(components_list))
+
+#         for d_block_id in deleted_blocks:
+#             previous_block_info = course_logs["components"][d_block_id]["edited_info"][-1]
+
+#             if previous_block_info["status"] != "Deleted" and d_block_id not in course_logs["latest_published_componenets"]: 
+#                 user_obj = User.objects.get(id = version["edited_by"])
+#                 course_logs["components"][d_block_id]["edited_info"].append({ "definition" : previous_block_info["definition"],
+#                                                                               "fields" : previous_block_info["fields"],
+#                                                                               "parents_list" : previous_block_info["parents_list"], 
+#                                                                               "parents_names" : previous_block_info["parents_names"],
+#                                                                               "edited_on" : conver_utc_ist(version["edited_on"]),
+#                                                                               "edited_by" : user_obj.first_name, "status" : "Deleted"})
+#     return course_logs
+
+# def find_block_parents(version, block_id):
+
+#     for block in version["blocks"]:
+#         if block["block_type"] == "vertical" and block_id in [i[-1] for i in block["fields"]["children"]]:
+#             unit_name = block["fields"]["display_name"]
+#             unit_id = block["block_id"]
+#             break
+
+#     for block in version["blocks"]:
+#         if block["block_type"] == "sequential" and unit_id in [i[-1] for i in block["fields"]["children"]]:
+#             subsection_name = block["fields"]["display_name"]
+#             subsection_id = block["block_id"]
+#             break
+
+#     for block in version["blocks"]:
+#         if block["block_type"] == "chapter" and subsection_id in [i[-1] for i in block["fields"]["children"]]:
+#             section_name = block["fields"]["display_name"]
+#             section_id = block["block_id"]
+#             break
+
+#     return [section_id, subsection_id, unit_id], [section_name, subsection_name, unit_name]
+
+
+# def conver_utc_ist(utc_datetime):
+#     utc_timezone = pytz.timezone('UTC')
+#     ist_timezone = pytz.timezone('Asia/Kolkata')
+#     edited_info_ist = utc_datetime.astimezone(ist_timezone)
+#     formated_ist = edited_info_ist.strftime("%b %d,%Y %H:%M:%S")
+#     return formated_ist
+
+def get_course_structure(course_id):
+	course_key = CourseKey.from_string(course_id)
+	split_modulestore = modulestore()._get_modulestore_by_type(ModuleStoreEnum.Type.split)
+	active_version_collection = split_modulestore.db_connection.course_index
+	structure_collection = split_modulestore.db_connection.structures
+	course = list(active_version_collection.find({"org" : course_key.org, "course" : course_key.course, "run" : course_key.run}))
+
+	course_structure  = list(structure_collection.find({"_id" : course[0]["versions"]["published-branch"]}, {"blocks" : 1}))
+	data = {}
+	for i in course_structure[0]["blocks"]:
+		if "display_name" in i["fields"] and i["block_type"] in ["vertical"]:
+			u = User.objects.get(id = i["edit_info"]["edited_by"])
+			subsection_name = get_subsection_name(i["block_id"], course_structure)
+			section_name = get_section_name(subsection_name[1], course_structure)
+			#log.info(i)
+			data[i["block_id"]] = {"unit_name" : i["fields"]["display_name"], "edited_by_email" : u.email, "edited_by_name" : u.first_name, "edited_on" : i["edit_info"]["edited_on"], "subsection_name": subsection_name[0],"section_name" : section_name}
+			if i['fields']['children']:
+				data[i["block_id"]]["block_type"] = i['fields']['children'][0][0]
+
+	#sorted_data = sorted(data.items(), key=lambda x: x[1]["edited_on"], reverse=True)
+	return data
+
+# #VK-Start
+# @csrf_exempt
+# def get_course_block_structure(request, course_id):
+# 	EDX_API_KEY = configuration_helpers.get_value("EDX_API_KEY", "")
+# 	secret = request.POST.get("secret", None)
+# 	if secret is None:
+# 		log.info("No Secret Key available")
+# 		return JsonResponse({})
+# 	if secret == EDX_API_KEY:
+# 		course_key = CourseKey.from_string(course_id)
+# 		course_usage_key = modulestore().make_course_usage_key(course_key)
+# 		structure = get_course_outline_block_tree(request, course_id)
+# 		return JsonResponse({"structure": structure})
+# 	else:
+# 		log.info("Wrong API KEY")
+# 		return JsonResponse({})
+# #VK-End

lms/urls.py

@@ -50,7 +50,7 @@
 from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers
 from openedx.core.djangoapps.user_authn.views.login import redirect_to_lms_login
 from openedx.features.enterprise_support.api import enterprise_enabled
-
+from lms.djangoapps.instructor.views import course_log as instructor_course_log_views
 RESET_COURSE_DEADLINES_NAME = 'reset_course_deadlines'
 RENDER_XBLOCK_NAME = 'render_xblock'
 RENDER_VIDEO_XBLOCK_NAME = 'render_public_video_xblock'
@@ -543,7 +543,13 @@
         instructor_dashboard_views.instructor_dashboard_2,
         name='instructor_dashboard',
     ),
-
+    re_path(
+        r'^extras/{}/get_course_log'.format(
+            settings.COURSE_ID_PATTERN,
+            ),
+        instructor_course_log_views.extras_get_course_log,
+        name  = 'extras_get_course_log'
+    ),
     re_path(
         r'^courses/{}/set_course_mode_price$'.format(
             settings.COURSE_ID_PATTERN,