X-Git-Url: http://git.veekun.com/zzz-spline-frontpage.git/blobdiff_plain/475ce71bfb57fba45376c568d603007a5e52f54a..a2c8a9954d43236417b2966455589714b58132a4:/splinext/frontpage/controllers/frontpage.py diff --git a/splinext/frontpage/controllers/frontpage.py b/splinext/frontpage/controllers/frontpage.py index 959f5fb..fdb0b4c 100644 --- a/splinext/frontpage/controllers/frontpage.py +++ b/splinext/frontpage/controllers/frontpage.py @@ -1,13 +1,16 @@ +import datetime import logging from pylons import config, request, response, session, tmpl_context as c, url -from pylons.controllers.util import abort, redirect_to +from pylons.controllers.util import abort, redirect from routes import request_config from sqlalchemy.orm.exc import NoResultFound from spline.lib import helpers as h from spline.lib.base import BaseController, render from spline.lib.plugin.load import run_hooks +from spline.model import meta +from splinext.frontpage.sources import max_age_to_datetime log = logging.getLogger(__name__) @@ -16,17 +19,103 @@ class FrontPageController(BaseController): def index(self): """Magicaltastic front page. - Plugins can register things to appear on it, somehow. + Plugins can register a hook called 'frontpage_updates_' to add + updates to the front page. `` is an arbitrary string indicating + the sort of update the plugin knows how to handle; for example, + spline-forum has a `frontpage_updates_forum` hook for posting news from + a specific forum. + + Hook handlers should return a list of FrontPageUpdate objects. + + Standard hook parameters are: + `limit`, the maximum number of items that should ever be returned. + `max_age`, the number of seconds after which items expire. + `title`, a name for the source. + `icon`, an icon to show next to its name. + + `limit` and `max_age` are also global options. + + Updates are configured in the .ini like so: + + spline-frontpage.sources.foo = updatetype + spline-frontpage.sources.foo.opt1 = val1 + spline-frontpage.sources.foo.opt2 = val2 + + Note that the 'foo' name is completely arbitrary and is only used for + grouping options together. This will result in a call to: + + run_hooks('frontpage_updates_updatetype', opt1=val1, opt2=val2) + + Plugins may also respond to the `frontpage_extras` hook with other + interesting things to put on the front page. There's no way to + customize the order of these extras or which appear and which don't, at + the moment. Such hooks should return an object with at least a + `template` attribute; the template will be called with the object + passed in as its `obj` argument. Local plugins can override the fairly simple index.mako template to customize the front page layout. """ - # Hooks should return a list of FrontPageUpdate objects, making this - # return value a list of lists - updates_lol = run_hooks('frontpage_updates', limit=10) - updates = sum(updates_lol, []) - updates.sort(key=lambda obj: obj.time) - c.updates = updates[0:10] + updates = [] + global_limit = config['spline-frontpage.limit'] + global_max_age = max_age_to_datetime( + config['spline-frontpage.max_age']) + + c.sources = config['spline-frontpage.sources'] + for source in c.sources: + new_updates = source.poll(global_limit, global_max_age) + updates.extend(new_updates) + + # Little optimization: once there are global_limit items, anything + # older than the oldest cannot possibly make it onto the list. So, + # bump global_max_age to that oldest time if this is ever the case. + updates.sort(key=lambda obj: obj.time, reverse=True) + del updates[global_limit:] + + if updates and len(updates) == global_limit: + global_max_age = updates[-1].time + + # Find the oldest unseen item, to draw a divider after it. + # If this stays as None, the divider goes at the top + c.last_seen_item = None + # Could have a timestamp in the stash if this is a user, or in a cookie + # if this session has ever been logged out... + times = [] + for source in (c.user.stash, request.cookies): + try: + times.append( int(source['frontpage-last-seen-time']) ) + except (KeyError, ValueError): + pass + + if times: + last_seen_time = datetime.datetime.fromtimestamp(max(times)) + for update in updates: + if update.time > last_seen_time: + c.last_seen_item = update + else: + break + + # Save ~now~ as the last-seen time + now = datetime.datetime.now().strftime('%s') + if c.user: + c.user.stash['frontpage-last-seen-time'] = now + meta.Session.add(c.user) + else: + response.set_cookie('frontpage-last-seen-time', now) + + # Done! Feed to template + c.updates = updates + + # Hook for non-update interesting things to put on the front page. + # This hook should return objects with a 'template' attribute, and + # whatever else they need + c.extras = run_hooks('frontpage_extras') + + ret = render('/index.mako') - return render('/index.mako') + # Commit AFTER rendering the template! Committing invalidates + # everything in the session, undoing any eagerloading that may have + # been done by sources + meta.Session.commit() + return ret