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 MAX_HOME_LP_ITEMS = 10
  41
  42 # make tags lowercase and use dashes in place of spaces.
  43 # uppercase tags will be included by the lowercase form.
  44 FEATURED_TAG = "featured"
  45 LATEST_LP_VIDEO_TAG = "libreplanet-2016-video"
  46
  47
  48 _log = logging.getLogger(__name__)
  49
  50 # This is the function that gets called when the setup
  51 # hook fires.
  52 def setup_plugin():
  53     _log.info("Setting up Libreplanet...")
  54
  55     # Register the template path.
  56     register_template_path(os.path.join(PLUGIN_DIR, 'templates'))
  57
  58 def lp_media_for_type(db, type, tag=None, max_items=MAX_HOME_ITEMS):
  59     if (tag == None):
  60         cursor = MediaEntry.query
  61     else:
  62         cursor = media_entries_for_tag_slug(db, tag)
  63
  64     return cursor.\
  65         filter((MediaEntry.media_type == type)
  66                & (MediaEntry.state == u'processed')).\
  67         order_by(MediaEntry.created.desc()).\
  68         limit(max_items)
  69
  70 @user_not_banned
  71 def frontpage_view(request):
  72     images          = lp_media_for_type(request.db, u'mediagoblin.media_types.image')
  73     videos          = lp_media_for_type(request.db, u'mediagoblin.media_types.video')
  74
  75     lp2016_videos   = lp_media_for_type(request.db, u'mediagoblin.media_types.video', LATEST_LP_VIDEO_TAG, MAX_HOME_LP_ITEMS)
  76
  77     featured_images = lp_media_for_type(request.db, u'mediagoblin.media_types.image', FEATURED_TAG, MAX_HOME_FEATURED_ITEMS)
  78     featured_videos = lp_media_for_type(request.db, u'mediagoblin.media_types.video', FEATURED_TAG, MAX_HOME_FEATURED_ITEMS)
  79
  80     return render_to_response(
  81         request, 'libreplanet/root.html',
  82         {'images': images,
  83          'videos': videos,
  84          'lp2016_videos': lp2016_videos,
  85          'featured_images': featured_images,
  86          'featured_videos': featured_videos,
  87          'allow_registration': mg_globals.app_config["allow_registration"]})
  88
  89 def frontpage_view_hook():
  90     return frontpage_view
  91
  92 register_routes([('all-videos', '/videos',
  93                   'mediagoblin.plugins.libreplanet.views:video_listing'),
  94                  ('all-photos', '/photos',
  95                   'mediagoblin.plugins.libreplanet.views:image_listing'),
  96
  97                  ('featured-videos', '/videos/featured',
  98                   'mediagoblin.plugins.libreplanet.views:featured_video_listing'),
  99                  ('featured-photos', '/photos/featured',
 100                   'mediagoblin.plugins.libreplanet.views:featured_image_listing')
 101              ])
 102
 103 # This is a dict that specifies which hooks this plugin uses.
 104 # This one only uses one hook: setup.
 105 hooks = {
 106     'setup': setup_plugin,
 107     'frontpage_view': frontpage_view_hook
 108 }