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