Store Pageviews in DB

readthedocs/api/v2/views/footer_views.py

@@ -17,6 +17,7 @@
     highest_version,
     parse_version_failsafe,
 )
+from readthedocs.search.tasks import increase_page_view_count
 
 
 def get_version_compare_data(project, base_version=None):
@@ -210,6 +211,13 @@ def get(self, request, format=None):
             'version_supported': version.supported,
         }
 
+        # increase the page view count
+        increase_page_view_count.delay(
+            project=context['project'],
+            version=context['version'],
+            path=context['path'] if context['path'] else 'index.html'
+        )
+
         # Allow folks to hook onto the footer response for various information
         # collection, or to modify the resp_data.
         footer_response.send(

readthedocs/projects/urls/private.py

@@ -109,6 +109,10 @@
         r'^(?P<project_slug>[-\w]+)/search-analytics/$',
         private.search_analytics_view, name='projects_search_analytics',
     ),
+    url(
+        r'^(?P<project_slug>[-\w]+)/page-views/$',
+        private.page_views, name='projects_page_views',
+    ),
 ]
 
 domain_urls = [

readthedocs/projects/views/private.py

@@ -64,7 +64,7 @@
 from readthedocs.projects.utils import Echo
 from readthedocs.projects.views.base import ProjectAdminMixin, ProjectSpamMixin
 from readthedocs.projects.views.mixins import ProjectImportMixin
-from readthedocs.search.models import SearchQuery
+from readthedocs.search.models import SearchQuery, PageView
 
 from ..tasks import retry_domain_verification
 
@@ -1020,3 +1020,27 @@ def _search_analytics_csv_data(request, project_slug):
     )
     response['Content-Disposition'] = f'attachment; filename="{file_name}"'
     return response
+
+
+def page_views(request, project_slug):
+    """View for page views."""
+
+    project = get_object_or_404(
+        Project.objects.for_admin_user(request.user),
+        slug=project_slug,
+    )
+
+    top_viewed_pages = PageView.get_top_viewed_pages(project)
+    top_viewed_pages_iter = zip(
+        top_viewed_pages['pages'],
+        top_viewed_pages['view_counts']
+    )
+
+    return render(
+        request,
+        'projects/project_page_views.html',
+        {
+            'project': project,
+            'top_viewed_pages_iter': top_viewed_pages_iter,
+        },
+    )

readthedocs/search/admin.py

@@ -2,7 +2,7 @@
 
 from django.contrib import admin
 
-from .models import SearchQuery
+from .models import SearchQuery, PageView
 
 
 class SearchQueryAdmin(admin.ModelAdmin):
@@ -14,4 +14,13 @@ class SearchQueryAdmin(admin.ModelAdmin):
     list_select_related = ('project', 'version', 'version__project')
 
 
+class PageViewAdmin(admin.ModelAdmin):
+    raw_id_fields = ('project', 'version')
+    list_display = ('__str__', 'view_count')
+    search_fields = ('project__slug', 'version__slug', 'path')
+    readonly_fields = ('created', 'modified')
+    list_select_related = ('project', 'version', 'version__project')
+
+
 admin.site.register(SearchQuery, SearchQueryAdmin)
+admin.site.register(PageView, PageViewAdmin)

readthedocs/search/migrations/0002_create_pageview_model.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.23 on 2019-08-29 18:07
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+import django.db.models.deletion
+import django_extensions.db.fields
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('projects', '0044_auto_20190703_1300'),
+        ('builds', '0010_add-description-field-to-automation-rule'),
+        ('search', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='PageView',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created', django_extensions.db.fields.CreationDateTimeField(auto_now_add=True, verbose_name='created')),
+                ('modified', django_extensions.db.fields.ModificationDateTimeField(auto_now=True, verbose_name='modified')),
+                ('path', models.CharField(max_length=4096)),
+                ('view_count', models.PositiveIntegerField(default=1)),
+                ('project', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='page_views', to='projects.Project')),
+                ('version', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='page_views', to='builds.Version', verbose_name='Version')),
+            ],
+            options={
+                'ordering': ('-modified', '-created'),
+                'get_latest_by': 'modified',
+                'abstract': False,
+            },
+        ),
+    ]

readthedocs/search/models.py

@@ -1,7 +1,7 @@
 """Search Queries."""
 
 from django.db import models
-from django.db.models import Count
+from django.db.models import Count, Sum
 from django.db.models.functions import TruncDate
 from django.utils import timezone
 from django.utils.translation import ugettext_lazy as _
@@ -137,3 +137,60 @@ def generate_distribution_of_top_queries(cls, project_slug, n):
             final_data['int_data'].append(count_of_other)
 
         return final_data
+
+
+class PageView(TimeStampedModel):
+    project = models.ForeignKey(
+        Project,
+        related_name='page_views',
+        on_delete=models.CASCADE,
+    )
+    version = models.ForeignKey(
+        Version,
+        verbose_name=_('Version'),
+        related_name='page_views',
+        on_delete=models.CASCADE,
+    )
+    path = models.CharField(max_length=4096)
+    view_count = models.PositiveIntegerField(default=1)
+
+    def __str__(self):
+        return f'[{self.project.slug}:{self.version.slug}]: {self.path}'
+
+    @classmethod
+    def get_top_viewed_pages(cls, project):
+        """
+        Returns top 10 pages according to view counts.
+
+        Structure of returned data is compatible to make graphs.
+        Sample returned data::
+        {
+            'pages': ['index.html', 'contribute.html', 'sponsors.html'],
+            'view_counts': [150, 200, 143]
+        }
+        This data shows that `index.html` is the most viewed page having 150 total views,
+        followed by `contribute.html` and `sponsors.html` having 200 and
+        143 total page views respectively.
+        """
+        qs = (
+            cls.objects
+            .filter(project=project)
+            .values_list('path')
+            .annotate(total_views=Sum('view_count'))
+            .values_list('path', 'total_views')
+            .order_by('-total_views')[:10]
+        )
+
+        pages = []
+        view_counts = []
+
+        for data in qs.iterator():
+            pages.append(data[0])
+            view_counts.append(data[1])
+
+        final_data = {
+            'pages': pages,
+            'view_counts': view_counts,
+        }
+
+        return final_data

readthedocs/search/tasks.py

@@ -7,7 +7,7 @@
 
 from readthedocs.builds.models import Version
 from readthedocs.projects.models import Project
-from readthedocs.search.models import SearchQuery
+from readthedocs.search.models import SearchQuery, PageView
 from readthedocs.worker import app
 from .utils import _get_index, _get_document
 
@@ -212,3 +212,24 @@ def record_search_query(project_slug, version_slug, query, total_results, time_s
     )
     obj.created = time
     obj.save()
+
+
+@app.task(queue='web')
+def increase_page_view_count(project, version, path):
+    today_date = timezone.now().date()
+    page_view_obj = PageView.objects.filter(
+        project=project,
+        version=version,
+        path=path,
+        created__date=today_date,
+    ).first()
+
+    if page_view_obj:
+        page_view_obj.view_count += 1
+        page_view_obj.save()
+    else:
+        PageView.objects.create(
+            project=project,
+            version=version,
+            path=path,
+        )

readthedocs/templates/projects/project_edit_base.html

@@ -25,6 +25,7 @@
         <li class="{% block project-environment-variables-active %}{% endblock %}"><a href="{% url "projects_environmentvariables" project.slug %}">{% trans "Environment Variables" %}</a></li>
         <li class="{% block project-notifications-active %}{% endblock %}"><a href="{% url "projects_notifications" project.slug %}">{% trans "Notifications" %}</a></li>
         <li class="{% block project-search-analytics-active %}{% endblock %}"><a href="{% url "projects_search_analytics" project.slug %}">{% trans "Search Analytics" %}</a></li>
+        <li class="{% block project-page-views-active %}{% endblock %}"><a href="{% url "projects_page_views" project.slug %}">{% trans "Page Views" %}</a></li>
         {% if USE_PROMOS %}
           <li class="{% block project-ads-active %}{% endblock %}"><a href="{% url "projects_advertising" project.slug %}">{% trans "Advertising" %} </a></li>
         {% endif %}

readthedocs/templates/projects/project_page_views.html

@@ -0,0 +1,52 @@
+{% extends "projects/project_edit_base.html" %}
+
+{% load i18n %}
+{% load static %}
+
+{% block title %}{% trans "Page Views" %}{% endblock %}
+
+{% block nav-dashboard %} class="active"{% endblock %}
+
+{% block project-page-views-active %}active{% endblock %}
+{% block project_edit_content_header %}{% trans "Page Views" %}{% endblock %}
+
+{% block project_edit_content %}
+	<h3>{% trans "Top Viewed Pages" %}</h3>
+		<div class="module-list">
+      <div class="module-list-wrapper">
+        <ul class="long-list-overflow">
+          {% for page, count in top_viewed_pages_iter %}
+            <li class="module-item">
+              {{ page }}
+              <span class="right quiet">
+                {{ count }} {{ view|pluralize:"s" }}
+              </span>
+            </li>
+          {% empty %}
+            <li class="module-item">
+              <p class="quiet">
+                {% trans 'No date available.' %}
+              </p>
+            </li>
+          {% endfor %}
+        </ul>
+      </div>
+    </div>
+
+	<br/>
+
+	<h2>{% trans "Page Views Per Page" %}</h2>
+	<canvas id="page-views-per-page" width="400" height="150"></canvas>
+
+{% endblock %}
+
+{% block extra_scripts %}
+{% endblock %}
+
+{% block extra_links %}
+  <!-- Chart.js v2.8.0 -->
+  <link rel="stylesheet" href="{% static 'vendor/chartjs/chartjs.min.css' %}">
+{% endblock %}
+
+{% block footerjs %}
+{% endblock %}