kallithea Changeset - 68e802950fe4

Changeset - 68e802950fe4

Parent rev.

Child rev.

[Not reviewed]

default

0 2 1

Mads Kiilerich - 6 years ago 2019-12-19 21:23:33
mads@kiilerich.com

feeds: introduce kallithea.lib.feeds to encapsulate webhelpers.feedgenerator

3 files changed with 97 insertions and 52 deletions:

kallithea/controllers/feed.py

kallithea/controllers/journal.py

kallithea/lib/feeds.py

0 comments (0 inline, 0 general)

kallithea/controllers/feed.py

➞

Show inline comments

@@ @@ -29,29 +29,25 @@ Original author and date, and relevant c @@
 import logging
 from beaker.cache import cache_region
 from tg import response
 from tg import tmpl_context as c
 from tg.i18n import ugettext as _
 from webhelpers.feedgenerator import Atom1Feed, Rss201rev2Feed
 from kallithea import CONFIG
 from kallithea.lib import feeds
 from kallithea.lib import helpers as h
 from kallithea.lib.auth import HasRepoPermissionLevelDecorator, LoginRequired
 from kallithea.lib.base import BaseRepoController
 from kallithea.lib.diffs import DiffProcessor
 from kallithea.lib.utils2 import safe_int, safe_unicode, str2bool
 log = logging.getLogger(__name__)
 language = 'en-us'
 ttl = "5"
 class FeedController(BaseRepoController):
     @LoginRequired(allow_default_user=True)
     @HasRepoPermissionLevelDecorator('read')
     def _before(self, *args, **kwargs):
         super(FeedController, self)._before(*args, **kwargs)
@@ @@ -99,42 +95,40 @@ class FeedController(BaseRepoController) @@
         if str2bool(CONFIG.get('rss_include_diff', False)):
             desc_msg.append('\n\n')
             desc_msg.append(raw_diff)
         desc_msg.append('</pre>')
         return [safe_unicode(chunk) for chunk in desc_msg]
-    def _feed(self, repo_name, kind, feed_factory):
+    def _feed(self, repo_name, feeder):
         """Produce a simple feed"""
         @cache_region('long_term', '_get_feed_from_cache')
         def _get_feed_from_cache(*_cache_keys):  # parameters are not really used - only as caching key
-            feed = feed_factory(
+            header = dict(
                 title=_('%s %s feed') % (c.site_name, repo_name),
                 link=h.canonical_url('summary_home', repo_name=repo_name),
                 description=_('Changes on %s repository') % repo_name,
                 language=language,
                 ttl=ttl,  # rss only
+            )
             rss_items_per_page = safe_int(CONFIG.get('rss_items_per_page', 20))
             entries=[]
             for cs in reversed(list(c.db_repo_scm_instance[-rss_items_per_page:])):
                 feed.add_item(title=self._get_title(cs),
                               link=h.canonical_url('changeset_home', repo_name=repo_name,
                                        revision=cs.raw_id),
                               author_email=cs.author_email,
                               author_name=cs.author_name,
                               description=''.join(self.__get_desc(cs)),
                               pubdate=cs.date,
+                              )
                 entries.append(dict(
                     title=self._get_title(cs),
                     link=h.canonical_url('changeset_home', repo_name=repo_name, revision=cs.raw_id),
                     author_email=cs.author_email,
                     author_name=cs.author_name,
                     description=''.join(self.__get_desc(cs)),
                     pubdate=cs.date,
                 ))
             return feeder.render(header, entries)
             response.content_type = feed.mime_type
             return feed.writeString('utf-8')
         return _get_feed_from_cache(repo_name, kind, c.db_repo.changeset_cache.get('raw_id'))
         response.content_type = feeder.content_type
         return _get_feed_from_cache(repo_name, feeder.__name__)
     def atom(self, repo_name):
         """Produce a simple atom-1.0 feed"""
-        return self._feed(repo_name, 'ATOM', Atom1Feed)
+        return self._feed(repo_name, feeds.AtomFeed)
     def rss(self, repo_name):
         """Produce an rss2 feed via feedgenerator module"""
         return self._feed(repo_name, 'RSS', Rss201rev2Feed)
         """Produce a simple rss2 feed"""
         return self._feed(repo_name, feeds.RssFeed)

kallithea/controllers/journal.py

➞

Show inline comments

@@ @@ -20,29 +20,28 @@ Journal controller @@
 This file was forked by the Kallithea project in July 2014.
 Original author and date, and relevant copyright and licensing information is below:
 :created_on: Nov 21, 2010
 :author: marcink
 :copyright: (c) 2013 RhodeCode GmbH, and others.
 :license: GPLv3, see LICENSE.md for more details.
 """
 import logging
 import traceback
 from itertools import groupby
 from sqlalchemy import or_
 from sqlalchemy.orm import joinedload
 from tg import request, response
 from tg import tmpl_context as c
 from tg.i18n import ugettext as _
 from webhelpers.feedgenerator import Atom1Feed, Rss201rev2Feed
 from webob.exc import HTTPBadRequest
 import kallithea.lib.helpers as h
 from kallithea.controllers.admin.admin import _journal_filter
 from kallithea.lib import feeds
 from kallithea.lib.auth import LoginRequired
 from kallithea.lib.base import BaseController, render
 from kallithea.lib.page import Page
 from kallithea.lib.utils2 import AttributeDict, safe_int
 from kallithea.model.db import Repository, User, UserFollowing, UserLog
 from kallithea.model.meta import Session
@@ @@ -101,23 +100,23 @@ class JournalController(BaseController): @@
                         .order_by(UserLog.action_date.desc())
         else:
             journal = []
         return journal
     def _feed(self, repos, feed_factory, link, desc):
     def _feed(self, repos, feeder, link, desc):
         response.content_type = feeder.content_type
         journal = self._get_journal_data(repos)
-        feed = feed_factory(
+        header = dict(
             title=desc,
             link=link,
             description=desc,
             language=language,
             ttl=ttl,
+        )
         entries=[]
         for entry in journal[:feed_nr]:
             user = entry.user
             if user is None:
                 # fix deleted users
                 user = AttributeDict({'short_contact': entry.username,
                                       'email': '',
@@ @@ -127,43 +126,44 @@ class JournalController(BaseController): @@
                                     entry.repository.repo_name)
             _url = None
             if entry.repository is not None:
                 _url = h.canonical_url('changelog_home',
                            repo_name=entry.repository.repo_name)
             feed.add_item(title=title,
                           pubdate=entry.action_date,
                           link=_url or h.canonical_url(''),
                           author_email=user.email,
                           author_name=user.full_name_or_username,
                           description=action_extra())
             entries.append(dict(
                 title=title,
                 pubdate=entry.action_date,
                 link=_url or h.canonical_url(''),
                 author_email=user.email,
                 author_name=user.full_name_or_username,
                 description=action_extra(),
             ))
         response.content_type = feed.mime_type
         return feed.writeString('utf-8')
         return feeder.render(header, entries)
     def _atom_feed(self, repos, public=True):
         if public:
             link = h.canonical_url('public_journal_atom')
             desc = '%s %s %s' % (c.site_name, _('Public Journal'),
                                   'atom feed')
         else:
             link = h.canonical_url('journal_atom')
             desc = '%s %s %s' % (c.site_name, _('Journal'), 'atom feed')
-        return self._feed(repos, Atom1Feed, link, desc)
+        return self._feed(repos, feeds.AtomFeed, link, desc)
     def _rss_feed(self, repos, public=True):
         if public:
             link = h.canonical_url('public_journal_atom')
             desc = '%s %s %s' % (c.site_name, _('Public Journal'),
                                   'rss feed')
         else:
             link = h.canonical_url('journal_atom')
             desc = '%s %s %s' % (c.site_name, _('Journal'), 'rss feed')
-        return self._feed(repos, Rss201rev2Feed, link, desc)
+        return self._feed(repos, feeds.RssFeed, link, desc)
     @LoginRequired()
     def index(self):
         # Return a rendered template
         p = safe_int(request.GET.get('page'), 1)
         c.user = User.get(request.authuser.user_id)
@@ @@ -189,26 +189,22 @@ class JournalController(BaseController): @@
         c.data = repos_data
         return render('journal/journal.html')
     @LoginRequired()
     def journal_atom(self):
         """
         Produce an atom-1.0 feed via feedgenerator module
         """
         """Produce a simple atom-1.0 feed"""
         following = UserFollowing.query() \
             .filter(UserFollowing.user_id == request.authuser.user_id) \
             .options(joinedload(UserFollowing.follows_repository)) \
             .all()
         return self._atom_feed(following, public=False)
     @LoginRequired()
     def journal_rss(self):
         """
         Produce an rss feed via feedgenerator module
         """
         """Produce a simple rss2 feed"""
         following = UserFollowing.query() \
             .filter(UserFollowing.user_id == request.authuser.user_id) \
             .options(joinedload(UserFollowing.follows_repository)) \
             .all()
         return self._rss_feed(following, public=False)
@@ @@ -258,27 +254,23 @@ class JournalController(BaseController): @@
             return render('journal/journal_data.html')
         return render('journal/public_journal.html')
     @LoginRequired(allow_default_user=True)
     def public_journal_atom(self):
         """
         Produce an atom-1.0 feed via feedgenerator module
         """
         """Produce a simple atom-1.0 feed"""
         c.following = UserFollowing.query() \
             .filter(UserFollowing.user_id == request.authuser.user_id) \
             .options(joinedload(UserFollowing.follows_repository)) \
             .all()
         return self._atom_feed(c.following)
     @LoginRequired(allow_default_user=True)
     def public_journal_rss(self):
         """
         Produce an rss2 feed via feedgenerator module
         """
         """Produce a simple rss2 feed"""
         c.following = UserFollowing.query() \
             .filter(UserFollowing.user_id == request.authuser.user_id) \
             .options(joinedload(UserFollowing.follows_repository)) \
             .all()
         return self._rss_feed(c.following)

kallithea/lib/feeds.py

➞

Show inline comments

@@ new file 100644 @@
 # -*- coding: utf-8 -*-
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
+#
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
+#
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 """
 kallithea.lib.feeds
 ~~~~~~~~~~~~~~~~~~~
 Shared code for providing RSS and ATOM feeds.
 """
 import datetime
 import re
 from webhelpers import feedgenerator
 language = 'en-us'
 ttl = "5"
 class _Feeder(object):
     content_type = None
     feed_factory = None  # a webhelpers.feedgenerator
     @classmethod
     def render(cls, header, entries):
         feed = cls.feed_factory(
             language=language,
             ttl=ttl,  # rss only
             **header
+        )
         for e in entries:
             feed.add_item(**e)
         return feed.writeString('utf-8')
 class AtomFeed(_Feeder):
     content_type = 'application/atom+xml'
     feed_factory = feedgenerator.Atom1Feed
 class RssFeed(_Feeder):
     content_type = 'application/rss+xml'
     feed_factory = feedgenerator.Rss201rev2Feed

0 comments (0 inline, 0 general)