mediagoblin_libreplanet/__init__.py

   1 # MediaGoblin for LibrePlanet
   2 # Copyright (C) 2015 David Thompson <davet@gnu.org>
   3 #
   4 # This program is free software: you can redistribute it and/or modify
   5 # it under the terms of the GNU Affero General Public License as published by
   6 # the Free Software Foundation, either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU Affero General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Affero General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 import logging
  18 import os
  19
  20 from mediagoblin import mg_globals
  21 from mediagoblin.tools.pluginapi import get_config, register_template_path, register_routes
  22 from mediagoblin.db.models import MediaEntry
  23 from mediagoblin.db.util import media_entries_for_tag_slug
  24 from mediagoblin.tools.pagination import Pagination
  25 from mediagoblin.tools.response import render_to_response
  26 from mediagoblin.tools.licenses import SORTED_LICENSES, SUPPORTED_LICENSES, License
  27 from mediagoblin.decorators import uses_pagination, user_not_banned
  28
  29 # Add CC BY-SA 4.0 to licenses
  30 cc_by_sa_4 = License("CC BY-SA 4.0",
  31                      "Creative Commons Attribution-ShareAlike 4.0 International",
  32                      "https://creativecommons.org/licenses/by-sa/4.0/")
  33 SORTED_LICENSES.insert(1, cc_by_sa_4)
  34 SUPPORTED_LICENSES[cc_by_sa_4.uri] = cc_by_sa_4
  35
  36 PLUGIN_DIR = os.path.dirname(__file__)
  37
  38 MAX_HOME_ITEMS = 20
  39 MAX_HOME_FEATURED_ITEMS = 10
  40 FEATURED_TAG = "featured"
  41
  42 _log = logging.getLogger(__name__)
  43
  44 # This is the function that gets called when the setup
  45 # hook fires.
  46 def setup_plugin():
  47     _log.info("Setting up Libreplanet...")
  48
  49     # Register the template path.
  50     register_template_path(os.path.join(PLUGIN_DIR, 'templates'))
  51
  52 def lp_media_for_type(db, type, tag=None, max_items=MAX_HOME_ITEMS):
  53     if (tag == None):
  54         cursor = MediaEntry.query
  55     else:
  56         cursor = media_entries_for_tag_slug(db, tag)
  57
  58     return cursor.\
  59         filter((MediaEntry.media_type == type)
  60                & (MediaEntry.state == u'processed')).\
  61         order_by(MediaEntry.created.desc()).\
  62         limit(max_items)
  63
  64 @user_not_banned
  65 def frontpage_view(request):
  66     images          = lp_media_for_type(request.db, u'mediagoblin.media_types.image')
  67     videos          = lp_media_for_type(request.db, u'mediagoblin.media_types.video')
  68     featured_images = lp_media_for_type(request.db, u'mediagoblin.media_types.image', FEATURED_TAG, MAX_HOME_FEATURED_ITEMS)
  69     featured_videos = lp_media_for_type(request.db, u'mediagoblin.media_types.video', FEATURED_TAG, MAX_HOME_FEATURED_ITEMS)
  70
  71     return render_to_response(
  72         request, 'libreplanet/root.html',
  73         {'images': images,
  74          'videos': videos,
  75          'featured_images': featured_images,
  76          'featured_videos': featured_videos,
  77          'allow_registration': mg_globals.app_config["allow_registration"]})
  78
  79 def frontpage_view_hook():
  80     return frontpage_view
  81
  82 register_routes([('all-videos', '/videos',
  83                   'mediagoblin.plugins.libreplanet.views:video_listing'),
  84                  ('all-photos', '/photos',
  85                   'mediagoblin.plugins.libreplanet.views:image_listing'),
  86                  ('all-photos', '/videos/featured',
  87                   'mediagoblin.plugins.libreplanet.views:featured_video_listing'),
  88                  ('all-photos', '/photos/featured',
  89                   'mediagoblin.plugins.libreplanet.views:featured_image_listing')
  90              ])
  91
  92 # This is a dict that specifies which hooks this plugin uses.
  93 # This one only uses one hook: setup.
  94 hooks = {
  95     'setup': setup_plugin,
  96     'frontpage_view': frontpage_view_hook
  97 }