summaryrefslogtreecommitdiff
path: root/stats
diff options
context:
space:
mode:
Diffstat (limited to 'stats')
-rw-r--r--stats/__init__.py0
-rw-r--r--stats/admin.py14
-rw-r--r--stats/apps.py5
-rw-r--r--stats/migrations/0001_initial.py42
-rw-r--r--stats/migrations/0002_release_0_29_1.py23
-rw-r--r--stats/migrations/__init__.py0
-rw-r--r--stats/models.py104
-rw-r--r--stats/templates/view_lesson_tracking.html66
-rw-r--r--stats/tests.py138
-rw-r--r--stats/urls.py12
-rw-r--r--stats/views.py61
11 files changed, 465 insertions, 0 deletions
diff --git a/stats/__init__.py b/stats/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/stats/__init__.py
diff --git a/stats/admin.py b/stats/admin.py
new file mode 100644
index 0000000..16ca528
--- /dev/null
+++ b/stats/admin.py
@@ -0,0 +1,14 @@
+# Django Imports
+from django.contrib import admin
+
+# Local Imports
+from stats.models import TrackLesson
+
+
+class TrackLessonAdmin(admin.ModelAdmin):
+ search_fields = ['user__first_name', 'user__last_name', 'user__username',
+ 'course__name', 'lesson__name']
+ readonly_fields = ["course", "user", "lesson"]
+
+
+admin.site.register(TrackLesson, TrackLessonAdmin)
diff --git a/stats/apps.py b/stats/apps.py
new file mode 100644
index 0000000..2d09b92
--- /dev/null
+++ b/stats/apps.py
@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class StatsConfig(AppConfig):
+ name = 'stats'
diff --git a/stats/migrations/0001_initial.py b/stats/migrations/0001_initial.py
new file mode 100644
index 0000000..4bbae49
--- /dev/null
+++ b/stats/migrations/0001_initial.py
@@ -0,0 +1,42 @@
+# Generated by Django 3.0.7 on 2020-11-07 13:46
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+import django.utils.timezone
+
+
+class Migration(migrations.Migration):
+
+ initial = True
+
+ dependencies = [
+ migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+ ('yaksh', '0027_release_0_28_0'),
+ ]
+
+ operations = [
+ migrations.CreateModel(
+ name='TrackLesson',
+ fields=[
+ ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+ ('current_time', models.CharField(default='00:00:00', max_length=100)),
+ ('video_duration', models.CharField(default='00:00:00', max_length=100)),
+ ('creation_time', models.DateTimeField(auto_now_add=True)),
+ ('course', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='yaksh.Course')),
+ ('lesson', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='yaksh.Lesson')),
+ ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
+ ],
+ options={
+ 'unique_together': {('user', 'course', 'lesson')},
+ },
+ ),
+ migrations.CreateModel(
+ name='LessonLog',
+ fields=[
+ ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+ ('last_access_time', models.DateTimeField(default=django.utils.timezone.now)),
+ ('track', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='stats.TrackLesson')),
+ ],
+ ),
+ ]
diff --git a/stats/migrations/0002_release_0_29_1.py b/stats/migrations/0002_release_0_29_1.py
new file mode 100644
index 0000000..44f1a54
--- /dev/null
+++ b/stats/migrations/0002_release_0_29_1.py
@@ -0,0 +1,23 @@
+# Generated by Django 3.0.7 on 2020-11-12 12:11
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('stats', '0001_initial'),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name='lessonlog',
+ name='current_time',
+ field=models.CharField(default='00:00:00', max_length=20),
+ ),
+ migrations.AddField(
+ model_name='tracklesson',
+ name='watched',
+ field=models.BooleanField(default=False),
+ ),
+ ]
diff --git a/stats/migrations/__init__.py b/stats/migrations/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/stats/migrations/__init__.py
diff --git a/stats/models.py b/stats/models.py
new file mode 100644
index 0000000..0200a80
--- /dev/null
+++ b/stats/models.py
@@ -0,0 +1,104 @@
+# Django Imports
+from django.db import models
+from django.utils import timezone
+from django.contrib.auth.models import User
+
+# Local Imports
+from yaksh.models import Course, Lesson
+
+
+def str_to_datetime(s):
+ return timezone.datetime.strptime(s, '%H:%M:%S')
+
+
+def str_to_time(s):
+ return timezone.datetime.strptime(s, '%H:%M:%S').time()
+
+
+def time_to_seconds(time):
+ return timezone.timedelta(hours=time.hour, minutes=time.minute,
+ seconds=time.second).total_seconds()
+
+
+class TrackLesson(models.Model):
+ user = models.ForeignKey(User, on_delete=models.CASCADE)
+ course = models.ForeignKey(Course, on_delete=models.CASCADE)
+ lesson = models.ForeignKey(Lesson, on_delete=models.CASCADE)
+ current_time = models.CharField(max_length=100, default="00:00:00")
+ video_duration = models.CharField(max_length=100, default="00:00:00")
+ creation_time = models.DateTimeField(auto_now_add=True)
+ watched = models.BooleanField(default=False)
+
+ class Meta:
+ unique_together = ('user', 'course', 'lesson')
+
+ def get_log_counter(self):
+ return self.lessonlog_set.count()
+
+ def get_current_time(self):
+ if self.current_time == '00:00:00':
+ return 'just started'
+ return self.current_time
+
+ def get_video_duration(self):
+ if self.video_duration == '00:00:00':
+ return 'will be available after 25% completion'
+ return self.video_duration
+
+ def set_current_time(self, ct):
+ t = timezone.datetime.strptime(ct, '%H:%M:%S').time()
+ current = timezone.datetime.strptime(self.current_time,
+ '%H:%M:%S').time()
+ if t > current:
+ self.current_time = ct
+
+ def get_percentage_complete(self):
+ if self.current_time == '00:00:00' and self.video_duration == '00:00:00':
+ return 'less than 25%'
+ duration = str_to_time(self.video_duration)
+ watch_time = str_to_time(self.current_time)
+ duration_seconds = time_to_seconds(duration)
+ watched_seconds = time_to_seconds(watch_time)
+ percentage = round((watched_seconds / duration_seconds) * 100)
+ return 'approx {0} %'.format(percentage)
+
+
+ def get_last_access_time(self):
+ lesson_logs = self.lessonlog_set
+ last_access_time = self.creation_time
+ if lesson_logs.exists():
+ last_access_time = lesson_logs.last().last_access_time
+ return last_access_time
+
+ def set_watched(self):
+ if self.current_time != '00:00:00' and self.video_duration != '00:00:00':
+ duration = str_to_time(self.video_duration)
+ watch_time = (str_to_datetime(self.current_time) + timezone.timedelta(
+ seconds=10)).time()
+ self.watched = watch_time >= duration
+
+ def get_watched(self):
+ if not self.watched:
+ self.set_watched()
+ self.save()
+ return self.watched
+
+
+ def time_spent(self):
+ if self.video_duration != '00:00:00':
+ hits = self.get_log_counter()
+ duration = str_to_time(self.video_duration)
+ hit_duration = int((time_to_seconds(duration))/4)
+ total_duration = hits * hit_duration
+ return str(timezone.timedelta(seconds=total_duration))
+ return self.get_current_time()
+
+ def __str__(self):
+ return (f"Track {self.lesson} in {self.course} "
+ f"for {self.user.get_full_name()}")
+
+
+class LessonLog(models.Model):
+ track = models.ForeignKey(TrackLesson, on_delete=models.CASCADE)
+ current_time = models.CharField(max_length=20, default="00:00:00")
+ last_access_time = models.DateTimeField(default=timezone.now)
diff --git a/stats/templates/view_lesson_tracking.html b/stats/templates/view_lesson_tracking.html
new file mode 100644
index 0000000..ef5c9ae
--- /dev/null
+++ b/stats/templates/view_lesson_tracking.html
@@ -0,0 +1,66 @@
+{% extends "manage.html" %}
+{% load static %}
+{% block title %} Lesson Views {% endblock %}
+{% block script %}
+<script type="text/javascript" src="{% static 'yaksh/js/jquery.tablesorter.min.js' %}">
+</script>
+<script type="text/javascript">
+ function get_time_in_seconds(time) {
+ var time = time.split(":");
+ var hh = parseInt(time[0]);
+ var mm = parseInt(time[1]);
+ var ss = parseInt(time[2]);
+ return hh * 3600 + mm * 60 + ss;
+ }
+
+ $(document).ready(function() {
+ $("#stats-table").tablesorter({});
+ });
+</script>
+{% endblock %}
+{% block content %}
+<div class="container">
+ {% with objects.object_list as trackings %}
+ <center>
+ <h3>Statistics for {% with trackings|first as entry %} {{entry.lesson}} {% endwith %}</h3>
+ </center>
+ <a class="btn btn-primary" href="{% url 'yaksh:lesson_statistics' course_id lesson_id %}">
+ <i class="fa fa-arrow-left"></i>&nbsp;Back
+ </a>
+ <br><br>
+ {% include "yaksh/paginator.html" %}
+ <br>
+ <h4><strong>{{total}} student(s) viewed this lesson</strong></h4>
+ <table class="table table-responsive" id="stats-table">
+ <thead>
+ <tr>
+ <th>Sr No.</th>
+ <th>Student Name&nbsp;<i class="fa fa-sort"></i></th>
+ <th>Last access on&nbsp;<i class="fa fa-sort"></i></th>
+ <th>Started on&nbsp;<i class="fa fa-sort"></i></th>
+ <th>Current Duration&nbsp;<i class="fa fa-sort"></i></th>
+ <th>Video Duration&nbsp;<i class="fa fa-sort"></i></th>
+ <th>Percentage Watched&nbsp;<i class="fa fa-sort"></i></th>
+ <th>Watched Once Completely&nbsp;<i class="fa fa-sort"></i></th>
+ <th>Total Time Spent&nbsp;<i class="fa fa-sort"></i></th>
+ </tr>
+ </thead>
+ {% for track in trackings %}
+ <tr>
+ <td>{{ forloop.counter0|add:objects.start_index }}</td>
+ <td>{{track.user.get_full_name}}</td>
+ <td>{{track.get_last_access_time}}</td>
+ <td>{{track.creation_time}}</td>
+ <td>{{track.get_current_time}}</td>
+ <td>{{track.get_video_duration}}</td>
+ <td>{{track.get_percentage_complete}}</td>
+ <td>{{track.get_watched}}</td>
+ <td>{{track.time_spent}}</td>
+ </tr>
+ {% endfor %}
+ </table>
+ {% endwith %}
+ <br>
+ {% include "yaksh/paginator.html" %}
+</div>
+{% endblock %}
diff --git a/stats/tests.py b/stats/tests.py
new file mode 100644
index 0000000..c256feb
--- /dev/null
+++ b/stats/tests.py
@@ -0,0 +1,138 @@
+# Python Imports
+import json
+
+# Django Imports
+from django.test import TestCase, Client
+from django.contrib.auth.models import User, Group
+from django.urls import reverse
+
+# Local Imports
+from stats.models import TrackLesson
+from yaksh.models import Course, Lesson, LearningUnit, LearningModule
+
+
+class TestTrackLesson(TestCase):
+ def setUp(self):
+ self.client = Client()
+ self.mod_group, created = Group.objects.get_or_create(name='moderator')
+ self.user_plaintext_pass = 'demo'
+ self.user = User.objects.create_user(
+ username='demo_user',
+ password=self.user_plaintext_pass,
+ first_name='first_name',
+ last_name='last_name',
+ email='demo@test.com',
+ )
+
+ # Create Student
+ self.student_plaintext_pass = 'demo_student'
+ self.student = User.objects.create_user(
+ username='demo_student',
+ password=self.student_plaintext_pass,
+ first_name='student_first_name',
+ last_name='student_last_name',
+ email='demo_student@test.com'
+ )
+
+ # Add to moderator group
+ self.mod_group.user_set.add(self.user)
+
+ self.course = Course.objects.create(
+ name="Test_course",
+ enrollment="Open Enrollment", creator=self.user
+ )
+ self.lesson = Lesson.objects.create(
+ name="Test_lesson", description="test description",
+ creator=self.user)
+ self.learning_unit = LearningUnit.objects.create(
+ order=0, type="lesson", lesson=self.lesson
+ )
+ self.learning_module = LearningModule.objects.create(
+ order=0, name="Test_module", description="Demo module",
+ check_prerequisite=False, creator=self.user
+ )
+ self.learning_module.learning_unit.add(self.learning_unit.id)
+ self.track = TrackLesson.objects.create(
+ user_id=self.student.id, course_id=self.course.id,
+ lesson_id=self.lesson.id
+ )
+
+ def tearDown(self):
+ self.client.logout()
+ self.mod_group.delete()
+ self.user.delete()
+ self.student.delete()
+ self.course.delete()
+ self.learning_unit.delete()
+ self.learning_module.delete()
+
+ def test_add_video_track(self):
+ self.client.login(
+ username=self.student.username,
+ password=self.student_plaintext_pass
+ )
+
+ # Student not enrolled in the course fails to add the tracking
+ response = self.client.post(
+ reverse('stats:add_tracker',
+ kwargs={"tracker_id": self.track.id}),
+ data={'video_duration': '00:05:00'}
+ )
+ self.assertEqual(response.status_code, 404)
+
+ self.course.students.add(self.student.id)
+ # No current time given in the post data
+ response = self.client.post(
+ reverse('stats:add_tracker',
+ kwargs={"tracker_id": self.track.id}),
+ data={'video_duration': '00:05:00'}
+ )
+ self.assertEqual(response.status_code, 200)
+ self.assertFalse(response.json().get('success'))
+
+ # Valid post data
+ response = self.client.post(
+ reverse('stats:add_tracker',
+ kwargs={"tracker_id": self.track.id}),
+ data={'video_duration': '00:05:00',
+ 'current_video_time': '00:01:00'}
+ )
+
+ self.assertEqual(response.status_code, 200)
+ self.assertTrue(response.json().get('success'))
+
+ def test_disallow_student_view_tracking(self):
+ self.client.login(
+ username=self.student.username,
+ password=self.student_plaintext_pass
+ )
+
+ # Fails to view the lesson data for student
+ response = self.client.get(
+ reverse('stats:view_lesson_watch_stats',
+ kwargs={"course_id": self.course.id,
+ "lesson_id": self.lesson.id})
+ )
+ self.assertEqual(response.status_code, 404)
+
+ def test_allow_moderator_view_tracking(self):
+ self.client.login(
+ username=self.user.username,
+ password=self.user_plaintext_pass
+ )
+ # Course creator can view the lesson data
+ response = self.client.get(
+ reverse('stats:view_lesson_watch_stats',
+ kwargs={"course_id": self.course.id,
+ "lesson_id": self.lesson.id})
+ )
+ response_data = response.context
+ self.assertEqual(response.status_code, 200)
+ self.assertEqual(response_data.get('total'), 1)
+ expected_tracker = list(TrackLesson.objects.filter(
+ user_id=self.student.id, course_id=self.course.id,
+ lesson_id=self.lesson.id).values_list("id", flat=True))
+ obtained_tracker = list(response_data.get(
+ 'objects').object_list.values_list("id", flat=True))
+ self.assertEqual(obtained_tracker, expected_tracker)
+
diff --git a/stats/urls.py b/stats/urls.py
new file mode 100644
index 0000000..f11148f
--- /dev/null
+++ b/stats/urls.py
@@ -0,0 +1,12 @@
+from django.urls import path
+from stats import views
+
+
+app_name = "stats"
+
+urlpatterns = [
+ path('submit/video/watch/<int:tracker_id>',
+ views.add_tracker, name='add_tracker'),
+ path('view/watch/stats/<int:course_id>/<int:lesson_id>',
+ views.view_lesson_watch_stats, name='view_lesson_watch_stats'),
+]
diff --git a/stats/views.py b/stats/views.py
new file mode 100644
index 0000000..53b7cf7
--- /dev/null
+++ b/stats/views.py
@@ -0,0 +1,61 @@
+# Django Imports
+from django.shortcuts import render, get_object_or_404
+from django.http import JsonResponse
+from django.utils import timezone
+from django.contrib.auth.decorators import login_required
+from django.core.paginator import Paginator
+from django.http import Http404
+
+# Local Imports
+from stats.models import TrackLesson, LessonLog, str_to_time, time_to_seconds
+from yaksh.models import Course
+from yaksh.decorators import email_verified
+
+
+@login_required
+@email_verified
+def add_tracker(request, tracker_id):
+ user = request.user
+ track = get_object_or_404(
+ TrackLesson.objects.select_related("course"), id=tracker_id
+ )
+ if not track.course.is_student(user):
+ raise Http404("You are not enrolled in this course")
+ context = {}
+ video_duration = request.POST.get('video_duration')
+ current_time = request.POST.get('current_video_time')
+ if current_time:
+ track.set_current_time(current_time)
+ track.video_duration = video_duration
+ LessonLog.objects.create(
+ track_id=track.id, current_time=current_time,
+ last_access_time=timezone.now()
+ )
+ track.save()
+ if not track.watched:
+ track.set_watched()
+ track.save()
+ success = True
+ else:
+ success = False
+ context = {"success": success}
+ return JsonResponse(context)
+
+
+@login_required
+@email_verified
+def view_lesson_watch_stats(request, course_id, lesson_id):
+ user = request.user
+ course = get_object_or_404(Course, pk=course_id)
+ if not course.is_creator(user) and not course.is_teacher(user):
+ raise Http404('This course does not belong to you')
+ trackings = TrackLesson.objects.get_queryset().filter(
+ course_id=course_id, lesson_id=lesson_id
+ ).order_by("id")
+ total = trackings.count()
+ paginator = Paginator(trackings, 30)
+ page = request.GET.get('page')
+ trackings = paginator.get_page(page)
+ context = {'objects': trackings, 'total': total, 'course_id': course_id,
+ 'lesson_id': lesson_id}
+ return render(request, 'view_lesson_tracking.html', context)