adding a "join the FSF" button at the top of pages
[mediagoblin-libreplanet.git] / mediagoblin_libreplanet / __init__.py
CommitLineData
724f8731
DT
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
17import logging
18import os
19
20from mediagoblin import mg_globals
a0364380 21from mediagoblin.tools.pluginapi import get_config, register_template_path, register_routes, register_template_hooks
724f8731 22from mediagoblin.db.models import MediaEntry
e39ca90b 23from mediagoblin.db.util import media_entries_for_tag_slug
724f8731
DT
24from mediagoblin.tools.pagination import Pagination
25from mediagoblin.tools.response import render_to_response
2530cc8e 26from mediagoblin.tools.licenses import SORTED_LICENSES, SUPPORTED_LICENSES, License
724f8731
DT
27from mediagoblin.decorators import uses_pagination, user_not_banned
28
2530cc8e
DT
29# Add CC BY-SA 4.0 to licenses
30cc_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/")
33SORTED_LICENSES.insert(1, cc_by_sa_4)
34SUPPORTED_LICENSES[cc_by_sa_4.uri] = cc_by_sa_4
35
724f8731 36PLUGIN_DIR = os.path.dirname(__file__)
ae3cb218 37
7c3fc209
AE
38MAX_HOME_ITEMS_DEFAULT = 10
39
40MAX_HOME_ALL_VIDEO_ITEMS = 10
41MAX_HOME_ALL_PHOTO_ITEMS = 20
2cfcf16b 42MAX_HOME_FEATURED_ITEMS = 10
88cb2585
AE
43MAX_HOME_LP_ITEMS = 10
44
a356d743
AE
45# make tags lowercase and use dashes in place of spaces.
46# uppercase tags will be included by the lowercase form.
ae3cb218 47FEATURED_TAG = "featured"
a356d743
AE
48LATEST_LP_VIDEO_TAG = "libreplanet-2016-video"
49
724f8731
DT
50
51_log = logging.getLogger(__name__)
52
53# This is the function that gets called when the setup
54# hook fires.
55def 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
7c3fc209 61def lp_media_for_type(db, type, tag=None, max_items=MAX_HOME_ITEMS_DEFAULT):
2fba5967
AE
62 if (tag == None):
63 cursor = MediaEntry.query
64 else:
e39ca90b 65 cursor = media_entries_for_tag_slug(db, tag)
2fba5967
AE
66
67 return cursor.\
b1c32b81
DT
68 filter((MediaEntry.media_type == type)
69 & (MediaEntry.state == u'processed')).\
724f8731 70 order_by(MediaEntry.created.desc()).\
2cfcf16b 71 limit(max_items)
724f8731
DT
72
73@user_not_banned
74def frontpage_view(request):
7c3fc209
AE
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)
88cb2585 77
bfedf48a 78 lp2016_videos = lp_media_for_type(request.db, u'mediagoblin.media_types.video', LATEST_LP_VIDEO_TAG, MAX_HOME_LP_ITEMS)
88cb2585 79
ae3cb218
AE
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)
724f8731
DT
82
83 return render_to_response(
84 request, 'libreplanet/root.html',
85 {'images': images,
86 'videos': videos,
bfedf48a 87 'lp2016_videos': lp2016_videos,
26712623
AE
88 'featured_images': featured_images,
89 'featured_videos': featured_videos,
724f8731
DT
90 'allow_registration': mg_globals.app_config["allow_registration"]})
91
92def frontpage_view_hook():
93 return frontpage_view
94
95register_routes([('all-videos', '/videos',
7f884782 96 'mediagoblin.plugins.libreplanet.views:video_listing'),
724f8731 97 ('all-photos', '/photos',
35fd7d3b 98 'mediagoblin.plugins.libreplanet.views:image_listing'),
c8265415 99
86b9f47d 100 ('featured-videos', '/videos/featured',
35fd7d3b 101 'mediagoblin.plugins.libreplanet.views:featured_video_listing'),
86b9f47d 102 ('featured-photos', '/photos/featured',
3d204960 103 'mediagoblin.plugins.libreplanet.views:featured_image_listing')
724f8731
DT
104 ])
105
106# This is a dict that specifies which hooks this plugin uses.
107# This one only uses one hook: setup.
108hooks = {
109 'setup': setup_plugin,
110 'frontpage_view': frontpage_view_hook
111}
a0364380
AE
112
113register_template_hooks(
114 {'header_extra': "/mediagoblin/plugins/libreplanet/templates/libreplanet/join.html"}
115)
116