From 195a5151abd1ba7b5bab71653c560c056a44badf Mon Sep 17 00:00:00 2001
From: =?utf8?q?Stefan=20K=C3=B6gl?= <stefan@skoegl.net>
Date: Tue, 10 Jun 2014 19:40:57 +0200
Subject: [PATCH] get Flattr / licensed podcasts from PostgreSQL

---
 .../general/_design/podcasts/views/flattr/map.js   |  22 ----
 .../_design/podcasts/views/flattr/reduce.js        |   1 -
 .../general/_design/podcasts/views/license/map.js  |  22 ----
 .../_design/podcasts/views/license/reduce.js       |   1 -
 doc/dev/couchdb-views.rst                          |   1 -
 mygpo/db/couchdb/podcast.py                        |  69 -------------
 .../templates/directory/license-podcasts.html      |  14 +--
 mygpo/directory/templates/directory/licenses.html  |   2 +-
 mygpo/directory/templates/flattr-podcasts.html     |   4 +-
 mygpo/directory/views.py                           | 111 ++++++++++-----------
 .../podcasts/migrations/0003_auto_20140610_1752.py |  44 ++++++++
 mygpo/podcasts/models.py                           |  19 +++-
 12 files changed, 124 insertions(+), 186 deletions(-)
 delete mode 100644 couchdb/general/_design/podcasts/views/flattr/map.js
 delete mode 100644 couchdb/general/_design/podcasts/views/flattr/reduce.js
 delete mode 100644 couchdb/general/_design/podcasts/views/license/map.js
 delete mode 100644 couchdb/general/_design/podcasts/views/license/reduce.js
 create mode 100644 mygpo/podcasts/migrations/0003_auto_20140610_1752.py

diff --git a/couchdb/general/_design/podcasts/views/flattr/map.js b/couchdb/general/_design/podcasts/views/flattr/map.js
deleted file mode 100644
index f9a9b9a3..00000000
--- a/couchdb/general/_design/podcasts/views/flattr/map.js
+++ /dev/null
@@ -1,22 +0,0 @@
-function(doc)
-{
-    if (doc.doc_type == 'Podcast')
-    {
-        if(doc.flattr_url)
-        {
-            emit(null, null);
-        }
-    }
-    else if(doc.doc_type == 'PodcastGroup')
-    {
-        for(var n in doc.podcasts)
-        {
-            var podcast = doc.podcasts[n];
-            if (podcast.flattr_url)
-            {
-                emit(null, null);
-                return;
-            }
-        }
-    }
-}
diff --git a/couchdb/general/_design/podcasts/views/flattr/reduce.js b/couchdb/general/_design/podcasts/views/flattr/reduce.js
deleted file mode 100644
index c866cd72..00000000
--- a/couchdb/general/_design/podcasts/views/flattr/reduce.js
+++ /dev/null
@@ -1 +0,0 @@
-_count
diff --git a/couchdb/general/_design/podcasts/views/license/map.js b/couchdb/general/_design/podcasts/views/license/map.js
deleted file mode 100644
index 1157005e..00000000
--- a/couchdb/general/_design/podcasts/views/license/map.js
+++ /dev/null
@@ -1,22 +0,0 @@
-function(doc)
-{
-    if (doc.doc_type == 'Podcast')
-    {
-        if(doc.license)
-        {
-            emit(doc.license, null);
-        }
-    }
-    else if(doc.doc_type == 'PodcastGroup')
-    {
-        for(var n in doc.podcasts)
-        {
-            var podcast = doc.podcasts[n];
-            if (podcast.license)
-            {
-                emit(podcast.license, null);
-                return;
-            }
-        }
-    }
-}
diff --git a/couchdb/general/_design/podcasts/views/license/reduce.js b/couchdb/general/_design/podcasts/views/license/reduce.js
deleted file mode 100644
index c866cd72..00000000
--- a/couchdb/general/_design/podcasts/views/license/reduce.js
+++ /dev/null
@@ -1 +0,0 @@
-_count
diff --git a/doc/dev/couchdb-views.rst b/doc/dev/couchdb-views.rst
index 8c7c2ed1..1f6d65f9 100644
--- a/doc/dev/couchdb-views.rst
+++ b/doc/dev/couchdb-views.rst
@@ -76,7 +76,6 @@ Doc-Types: Podcast, PodcastGroup, PodcastSubscriberData
 * `podcasts/by_slug <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/by_slug>`_
 * `podcasts/by_tag <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/by_tag>`_
 * `podcasts/by_url <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/by_url>`_
-* `podcasts/flattr <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/flattr>`_
 * `podcasts/groups_by_oldid <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/groups_by_oldid>`_
 * `podcasts/podcasts_groups <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/podcasts_groups>`_
 * `podcasts/subscriber_data <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/subscriber_data>`_
diff --git a/mygpo/db/couchdb/podcast.py b/mygpo/db/couchdb/podcast.py
index 92946603..aab11e18 100644
--- a/mygpo/db/couchdb/podcast.py
+++ b/mygpo/db/couchdb/podcast.py
@@ -408,75 +408,6 @@ def podcasts_need_update(limit=100):
             yield podcast
 
 
-@cache_result(timeout=60*60)
-def get_flattr_podcasts(offset=0, limit=20):
-    """ returns all podcasts that contain Flattr payment URLs """
-
-    r = Podcast.view('podcasts/flattr',
-            skip         = offset,
-            limit        = limit,
-            classes      = [Podcast, PodcastGroup],
-            include_docs = True,
-            reduce       = False,
-        )
-
-    podcasts = list(r)
-
-    for podcast in podcasts:
-        if podcast.needs_update:
-            incomplete_obj.send_robust(sender=podcast)
-
-    return podcasts
-
-
-@cache_result(timeout=60*60)
-def get_flattr_podcast_count():
-    """ returns the number of podcasts that contain Flattr payment URLs """
-    db = get_main_database()
-    r = get_single_result(db, 'podcasts/flattr')
-    return r['value']
-
-
-@cache_result(timeout=60*60)
-def get_license_podcasts(offset=0, limit=20, license_url=None):
-    """ returns a page of podcasts w/ license information """
-
-    kwargs = {}
-    if license_url:
-        kwargs['key'] = license_url
-
-    r = Podcast.view('podcasts/license',
-            skip = offset,
-            limit = limit,
-            classes = [Podcast, PodcastGroup],
-            include_docs = True,
-            reduce = False,
-            **kwargs
-    )
-
-    podcasts = list(r)
-
-    for podcast in podcasts:
-        if podcast.needs_update:
-            incomplete_obj.send_robust(sender=podcast)
-
-    return podcasts
-
-
-@cache_result(timeout=60*60)
-def get_license_podcast_count(license_url=None):
-    """ returns the number of podcasts that contain license information """
-
-    kwargs = {}
-    if license_url:
-        kwargs['key'] = license_url
-
-    db = get_main_database()
-    r = get_single_result(db, 'podcasts/license', **kwargs)
-
-    return r['value'] if r else 0
-
-
 def subscriberdata_for_podcast(podcast_id):
 
     if not podcast_id:
diff --git a/mygpo/directory/templates/directory/license-podcasts.html b/mygpo/directory/templates/directory/license-podcasts.html
index 8b4ec9ab..af1adf1b 100644
--- a/mygpo/directory/templates/directory/license-podcasts.html
+++ b/mygpo/directory/templates/directory/license-podcasts.html
@@ -10,10 +10,10 @@
 {% block mainmenu %}{{ "/directory/+license"|main_menu }}{% endblock %}
 {% block sectionmenu %}{{ "/directory/+license"|section_menu }}{% endblock %}
 
-{% block title %}{% blocktrans with license_url|license_name as licensename %}Podcasts with License {{ licensename }}{% endblocktrans %}{% endblock %}
+{% block title %}{% blocktrans with view.license_url|license_name as licensename %}Podcasts with License {{ licensename }}{% endblocktrans %}{% endblock %}
 
 {% block header %}
-   <h1>{% blocktrans with license_url|license_name as licensename %}Podcasts with License {{ licensename }}{% endblocktrans %}</h1>
+   <h1>{% blocktrans with view.license_url|license_name as licensename %}Podcasts with License {{ licensename }}{% endblocktrans %}</h1>
 {% endblock %}
 
 {% block content %}
@@ -24,7 +24,7 @@
     {% trans "License overview" %}
    </a>
 
-   <a class="btn btn-default" href="{{ license_url }}">
+   <a class="btn btn-default" href="{{ view.license_url }}">
     <i class="icon-external-link"></i>
     {% trans "View License" %}
    </a>
@@ -42,7 +42,7 @@
     <td>
      {% podcast_group_link podcast %}
     </td>
-    <td>{% vertical_bar podcast.subscriber_count max_subscribers %}</td>
+    <td>{% vertical_bar podcast.subscriber_count view.max_subscribers %}</td>
    </tr>
   {% empty %}
    <tr>
@@ -54,16 +54,16 @@
   </table>
 
   <ul class="pagination">
- {% for page in page_list %}
+ {% for page in view.page_list %}
   <li>
    {% if page == "..." %}
     <span>{{ page }}</span>
    {% else %}
 
      {% if page == current_page %}
-      <a href="{% url "license-podcasts-url" license_url|urlencode %}?page={{ page }}"><strong>{{ page }}</strong></a>
+      <a href="{% url "license-podcasts-url" view.license_url %}?page={{ page }}"><strong>{{ page }}</strong></a>
      {% else %}
-      <a href="{% url "license-podcasts-url" license_url|urlencode %}?page={{ page }}">{{ page }}</a>
+      <a href="{% url "license-podcasts-url" view.license_url %}?page={{ page }}">{{ page }}</a>
      {% endif %}
    {% endif %}
   </li>
diff --git a/mygpo/directory/templates/directory/licenses.html b/mygpo/directory/templates/directory/licenses.html
index 7e991f1e..03542c1d 100644
--- a/mygpo/directory/templates/directory/licenses.html
+++ b/mygpo/directory/templates/directory/licenses.html
@@ -26,7 +26,7 @@
   {% for license, count in view.licenses %}
     <tr>
      <td>
-      <a href="{% url "license-podcasts-url" license|urlencode %}">
+      <a href="{% url "license-podcasts-url" license %}">
        {{ license|license_name }}
       </a>
       <a href="{{ license }}">
diff --git a/mygpo/directory/templates/flattr-podcasts.html b/mygpo/directory/templates/flattr-podcasts.html
index b22e8dd6..5d84c633 100644
--- a/mygpo/directory/templates/flattr-podcasts.html
+++ b/mygpo/directory/templates/flattr-podcasts.html
@@ -30,7 +30,7 @@
     <td>
      {% podcast_group_link podcast %}
     </td>
-    <td>{% vertical_bar podcast.subscriber_count max_subscribers %}</td>
+    <td>{% vertical_bar podcast.subscriber_count view.max_subscribers %}</td>
    </tr>
   {% empty %}
    <tr>
@@ -42,7 +42,7 @@
   </table>
 
   <ul class="pagination">
- {% for page in page_list %}
+ {% for page in view.page_list %}
   <li>
    {% if page == "..." %}
     <span>{{ page }}</span>
diff --git a/mygpo/directory/views.py b/mygpo/directory/views.py
index d73c12c7..3b90ffe2 100644
--- a/mygpo/directory/views.py
+++ b/mygpo/directory/views.py
@@ -11,6 +11,7 @@ from django.db.models import Count
 from django.contrib.sites.models import RequestSite
 from django.views.decorators.cache import cache_control
 from django.views.decorators.vary import vary_on_cookie
+from django.views.generic import ListView
 from django.utils.decorators import method_decorator
 from django.views.generic.base import View, TemplateView
 from django.contrib.auth.decorators import login_required
@@ -33,9 +34,7 @@ from mygpo.data.feeddownloader import PodcastUpdater, NoEpisodesException
 from mygpo.data.tasks import update_podcasts
 from mygpo.db.couchdb.user import get_user_by_id
 from mygpo.db.couchdb.podcast import podcasts_by_id, \
-         podcasts_to_dict, podcast_for_url, \
-         get_flattr_podcasts, get_flattr_podcast_count, get_license_podcasts, \
-         get_license_podcast_count
+         podcasts_to_dict, podcast_for_url
 from mygpo.db.couchdb.directory import category_for_tag
 from mygpo.db.couchdb.podcastlist import random_podcastlists, \
          podcastlist_count, podcastlists_by_rating
@@ -344,54 +343,41 @@ class AddPodcastStatus(TemplateView):
             })
 
 
-class PodcastListView(TemplateView):
+class PodcastListView(ListView):
     """ A generic podcast list view """
 
-    @method_decorator(cache_control(private=True))
-    @method_decorator(vary_on_cookie)
-    def get(self, request, page_size=20, **kwargs):
-
-        page = self.get_page(request)
-        podcasts = self.get_podcasts( (page-1) * page_size, page_size, **kwargs)
-        podcast_count = self.get_podcast_count(**kwargs)
-
-        context = kwargs
-        context.update({
-            'podcasts': podcasts,
-            'page_list': self.get_page_list(page, page_size, podcast_count),
-            'current_page': page,
-            'max_subscribers': self.get_max_subscribers(podcasts),
-        })
-
-        context.update(self.other_context(request))
-
-        return self.render_to_response(context)
-
-
-    def get_podcasts(self, offset, limit):
-        """ must return a list of podcasts """
-        raise NotImplemented
-
-    def get_podcast_count():
-        """ must return the total number of podcasts """
-        raise NotImplemented
-
-    def other_context(self, request, **kwargs):
-        """ can return a dict of additional context data """
-        return {}
-
-    def get_page(self, request):
-        # Make sure page request is an int. If not, deliver first page.
-        try:
-            return int(request.GET.get('page', '1'))
-        except ValueError:
-            return 1
-
-    def get_page_list(self, page, page_size, podcast_count):
-        num_pages = int(ceil(podcast_count / page_size))
-        return get_page_list(1, num_pages, page, 15)
+    paginate_by = 15
+    context_object_name = 'podcasts'
 
-    def get_max_subscribers(self, podcasts):
+    @method_decorator(vary_on_cookie)
+    @method_decorator(cache_control(private=True))
+    def dispatch(self, *args, **kwargs):
+        """ Only used for applying decorators """
+        return super(PodcastListView, self).dispatch(*args, **kwargs)
+
+    @property
+    def _page(self):
+        """ The current page
+
+        There seems to be no other pre-defined method for getting the current
+        page, see
+        https://docs.djangoproject.com/en/dev/ref/class-based-views/mixins-multiple-object/#multipleobjectmixin
+        """
+        return self.get_context_data()['page_obj']
+
+    def page_list(self, page_size=15):
+        """ Return a list of pages, eg [1, 2, 3, '...', 6, 7, 8] """
+        page = self._page
+        return get_page_list(1,
+                             page.paginator.num_pages,
+                             page.number,
+                             page.paginator.per_page,
+                            )
+
+    def max_subscribers(self):
+        """ Maximum subscribers of the podcasts on this page """
+        page = self._page
+        podcasts = page.object_list
         return max([p.subscriber_count() for p in podcasts] + [0])
 
 
@@ -399,23 +385,29 @@ class FlattrPodcastList(PodcastListView):
     """ Lists podcasts that have Flattr payment URLs """
 
     template_name = 'flattr-podcasts.html'
-    get_podcasts = staticmethod(get_flattr_podcasts)
-    get_podcast_count = staticmethod(get_flattr_podcast_count)
 
-    def other_context(self, request):
-        user = request.user
-        return {
-            'flattr_auth': user.is_authenticated() and
-                           bool(user.get_wksetting(FLATTR_TOKEN))
-        }
+    def get_queryset(self):
+        return Podcast.objects.flattr()
+
+    def get_context_data(self, num=100):
+        context = super(FlattrPodcastList, self).get_context_data()
+        context['flattr_auth'] = (self.request.user.is_authenticated()
+                   #  and bool(self.request.user.get_wksetting(FLATTR_TOKEN))
+                        )
+        return context
 
 
 class LicensePodcastList(PodcastListView):
     """ Lists podcasts with a given license """
 
     template_name = 'directory/license-podcasts.html'
-    get_podcasts = staticmethod(get_license_podcasts)
-    get_podcast_count = staticmethod(get_license_podcast_count)
+
+    def get_queryset(self):
+        return Podcast.objects.license(self.license_url)
+
+    @property
+    def license_url(self):
+        return self.kwargs['license_url']
 
 
 class LicenseList(TemplateView):
@@ -428,4 +420,5 @@ class LicenseList(TemplateView):
         query = Podcast.objects.exclude(license__isnull=True)
         values = query.values("license").annotate(Count("id")).order_by()
 
-        return Counter({l['license']: l['id__count'] for l in values})
+        counter = Counter({l['license']: l['id__count'] for l in values})
+        return counter.most_common()
diff --git a/mygpo/podcasts/migrations/0003_auto_20140610_1752.py b/mygpo/podcasts/migrations/0003_auto_20140610_1752.py
new file mode 100644
index 00000000..34819376
--- /dev/null
+++ b/mygpo/podcasts/migrations/0003_auto_20140610_1752.py
@@ -0,0 +1,44 @@
+# encoding: utf8
+from __future__ import unicode_literals
+
+from django.db import models, migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('podcasts', '0002_auto_20140609_0916'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='podcast',
+            name='license',
+            field=models.CharField(max_length=100, null=True, db_index=True),
+        ),
+        migrations.AlterField(
+            model_name='podcast',
+            name='flattr_url',
+            field=models.URLField(max_length=1000, null=True, db_index=True),
+        ),
+        migrations.AlterField(
+            model_name='episode',
+            name='flattr_url',
+            field=models.URLField(max_length=1000, null=True, db_index=True),
+        ),
+        migrations.AlterField(
+            model_name='podcast',
+            name='language',
+            field=models.CharField(max_length=10, null=True, db_index=True),
+        ),
+        migrations.AlterField(
+            model_name='episode',
+            name='language',
+            field=models.CharField(max_length=10, null=True, db_index=True),
+        ),
+        migrations.AlterField(
+            model_name='episode',
+            name='license',
+            field=models.CharField(max_length=100, null=True, db_index=True),
+        ),
+    ]
diff --git a/mygpo/podcasts/models.py b/mygpo/podcasts/models.py
index bd7dceb1..55b0bae0 100644
--- a/mygpo/podcasts/models.py
+++ b/mygpo/podcasts/models.py
@@ -91,7 +91,8 @@ class LicenseModel(models.Model):
 
 class FlattrModel(models.Model):
     # A Flattr payment URL
-    flattr_url = models.URLField(null=True, blank=False, max_length=1000)
+    flattr_url = models.URLField(null=True, blank=False, max_length=1000,
+                                 db_index=True)
 
     class Meta:
         abstract = True
@@ -198,6 +199,18 @@ class PodcastQuerySet(models.QuerySet):
         minimum quality of the results """
         return self.exclude(title='').order_by('?')
 
+    def flattr(self):
+        """ Podcasts providing Flattr information """
+        return self.exclude(flattr_url__isnull=True)
+
+    def license(self, license_url=None):
+        """ Podcasts with any / the given license """
+        if license_url:
+            return self.filter(license=license_url)
+        else:
+            return self.exclude(license__isnull=True)
+
+
 
 class Podcast(UUIDModel, TitleModel, DescriptionModel, LinkModel,
         LanguageModel, LastUpdateModel, UpdateInfoModel, LicenseModel,
@@ -223,6 +236,10 @@ class Podcast(UUIDModel, TitleModel, DescriptionModel, LinkModel,
 
     objects = PodcastQuerySet.as_manager()
 
+    def subscriber_count(self):
+        # TODO: implement
+        return 0
+
     def __str__(self):
         return self.title.encode('ascii', errors='replace')
 
-- 
2.11.4.GIT