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, register_template_hooks
  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 three CC BY non-NC 4.0 to licenses
  30 cc_by_4 = License("CC BY 4.0",
  31                      "Creative Commons Attribution 4.0 International",
  32                      "https://creativecommons.org/licenses/by/4.0/")
  33 cc_by_sa_4 = License("CC BY-SA 4.0",
  34                      "Creative Commons Attribution-ShareAlike 4.0 International",
  35                      "https://creativecommons.org/licenses/by-sa/4.0/")
  36 cc_by_nd_4 = License("CC BY-ND 4.0",
  37                      "Creative Commons Attribution-NoDerivatives 4.0 International",
  38                      "https://creativecommons.org/licenses/by-nd/4.0/")
  39 gfdl_1_3 = License("GFDL 1.3",
  40                      "GNU Free Documentation License 1.3",
  41                      "https://www.gnu.org/licenses/fdl-1.3.en.html")
  42 SORTED_LICENSES.insert(1, cc_by_4)
  43 SORTED_LICENSES.insert(2, cc_by_sa_4)
  44 SORTED_LICENSES.insert(3, cc_by_nd_4)
  45 SORTED_LICENSES.insert(4, gfdl_1_3)
  46 SUPPORTED_LICENSES[cc_by_4.uri] = cc_by_4
  47 SUPPORTED_LICENSES[cc_by_sa_4.uri] = cc_by_sa_4
  48 SUPPORTED_LICENSES[cc_by_nd_4.uri] = cc_by_nd_4
  49 SUPPORTED_LICENSES[gfdl_1_3.uri] = gfdl_1_3
  50
  51 PLUGIN_DIR = os.path.dirname(__file__)
  52
  53 MAX_HOME_ITEMS_DEFAULT = 10
  54
  55 MAX_HOME_ALL_VIDEO_ITEMS = 10
  56 MAX_HOME_ALL_PHOTO_ITEMS = 20
  57 MAX_HOME_FEATURED_ITEMS = 10
  58 MAX_HOME_LP_ITEMS = 10
  59
  60 # make tags lowercase and use dashes in place of spaces.
  61 # uppercase tags will be included by the lowercase form.
  62 FEATURED_TAG = "featured"
  63
  64
  65 _log = logging.getLogger(__name__)
  66
  67 # This is the function that gets called when the setup
  68 # hook fires.
  69 def setup_plugin():
  70     _log.info("Setting up Libreplanet...")
  71
  72     # Register the template path.
  73     register_template_path(os.path.join(PLUGIN_DIR, 'templates'))
  74
  75 def lp_media_for_type(db, type, tag=None, max_items=MAX_HOME_ITEMS_DEFAULT):
  76     if (tag == None):
  77         cursor = MediaEntry.query
  78     else:
  79         cursor = media_entries_for_tag_slug(db, tag)
  80
  81     return cursor.\
  82         filter((MediaEntry.media_type == type)
  83                & (MediaEntry.state == u'processed')).\
  84         order_by(MediaEntry.created.desc()).\
  85         limit(max_items)
  86
  87 @user_not_banned
  88 def frontpage_view(request):
  89     images          = lp_media_for_type(request.db, u'mediagoblin.media_types.image', None, MAX_HOME_ALL_PHOTO_ITEMS)
  90     videos          = lp_media_for_type(request.db, u'mediagoblin.media_types.video', None, MAX_HOME_ALL_VIDEO_ITEMS)
  91
  92     lp2017_keynotes = lp_media_for_type(request.db, u'mediagoblin.media_types.video', "libreplanet-2017-keynote", MAX_HOME_LP_ITEMS)
  93     lp2017_videos   = lp_media_for_type(request.db, u'mediagoblin.media_types.video', "libreplanet-2017-video", MAX_HOME_LP_ITEMS)
  94
  95     lp2016_videos   = lp_media_for_type(request.db, u'mediagoblin.media_types.video', "libreplanet-2016-video", MAX_HOME_LP_ITEMS)
  96
  97     featured_images = lp_media_for_type(request.db, u'mediagoblin.media_types.image', FEATURED_TAG, MAX_HOME_FEATURED_ITEMS)
  98     featured_videos = lp_media_for_type(request.db, u'mediagoblin.media_types.video', FEATURED_TAG, MAX_HOME_FEATURED_ITEMS)
  99
 100     return render_to_response(
 101         request, 'libreplanet/root.html',
 102         {'images': images,
 103          'videos': videos,
 104          'lp2016_videos': lp2016_videos,
 105          'featured_images': featured_images,
 106          'featured_videos': featured_videos,
 107          'allow_registration': mg_globals.app_config["allow_registration"]})
 108
 109 def frontpage_view_hook():
 110     return frontpage_view
 111
 112 register_routes([('all-videos', '/videos',
 113                   'mediagoblin.plugins.libreplanet.views:video_listing'),
 114                  ('all-photos', '/photos',
 115                   'mediagoblin.plugins.libreplanet.views:image_listing'),
 116
 117                  ('featured-videos', '/videos/featured',
 118                   'mediagoblin.plugins.libreplanet.views:featured_video_listing'),
 119                  ('featured-photos', '/photos/featured',
 120                   'mediagoblin.plugins.libreplanet.views:featured_image_listing')
 121              ])
 122
 123 # This is a dict that specifies which hooks this plugin uses.
 124 # This one only uses one hook: setup.
 125 hooks = {
 126     'setup': setup_plugin,
 127     'frontpage_view': frontpage_view_hook
 128 }
 129
 130 register_template_hooks(
 131     {'header_left':  "libreplanet/banner.html",
 132      'header_extra': "libreplanet/join.html"}
 133 )
 134