inveniosoftware / invenio-communities / 639

pending completion

Build # 639

Build Type

Pull #176

travis-ci

Committed by

web-flow

Commit Message

<a href="https://github.com/inveniosoftware/invenio-communities/commit/<a class=hub.com/inveniosoftware/invenio-communities/commit/<a class="double-link" href="https://git"><a class=hub.com/inveniosoftware/invenio-communities/commit/<a class="double-link" href="https://git"><a class=hub.com/inveniosoftware/invenio-communities/commit/49b9ec462e8e016887f26299ec6b685b2907cdf5">49b9ec462">&lt;a href=&quot;https://github.com/inveniosoftware/invenio-communities/commit/</a><a class="double-link" href="https://github.com/inveniosoftware/invenio-communities/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/inveniosoftware/invenio-communities/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/inveniosoftware/invenio-communities/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/inveniosoftware/invenio-communities/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/inveniosoftware/invenio-communities/commit/49b9ec462e8e016887f26299ec6b685b2907cdf5">49b9ec462</a><a href="https://github.com/inveniosoftware/invenio-communities/commit/49b9ec462e8e016887f26299ec6b685b2907cdf5">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/inveniosoftware/invenio-communities/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/inveniosoftware/invenio-communities/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/inveniosoftware/invenio-communities/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/inveniosoftware/invenio-communities/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/inveniosoftware/invenio-communities/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/inveniosoftware/invenio-communities/commit/49b9ec462e8e016887f26299ec6b685b2907cdf5&quot;&gt;49b9ec462&lt;/a&gt;&lt;a href=&quot;https://github.com/inveniosoftware/invenio-communities/commit/49b9ec462e8e01... (continued)

Pull Request Pull Request #176: Add reCAPTCHA and release v1.0.0a23

Run Details

8 of 8 new or added lines in 3 files covered. (100.0%)

563 of 825 relevant lines covered (68.24%)

1.36 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

33.55

/invenio_communities/views/ui.py

# -*- coding: utf-8 -*-
#
# This file is part of Invenio.
# Copyright (C) 2016-2019 CERN.
#
# Invenio is free software; you can redistribute it and/or modify it
# under the terms of the MIT License; see LICENSE file for more details.

"""Invenio module that adds support for communities."""

from __future__ import absolute_import, print_function

import copy
from functools import wraps

import bleach
from flask import Blueprint, abort, current_app, flash, jsonify, redirect, \
    render_template, request, url_for
from flask_babelex import gettext as _
from flask_login import current_user, login_required
from invenio_db import db
from invenio_indexer.api import RecordIndexer
from invenio_pidstore.resolver import Resolver
from invenio_records.api import Record

from invenio_communities.forms import CommunityForm, DeleteCommunityForm, \
    EditCommunityForm, RecaptchaCommunityForm, SearchForm
from invenio_communities.models import Community, FeaturedCommunity
from invenio_communities.proxies import current_permission_factory
from invenio_communities.utils import Pagination, render_template_to_string

blueprint = Blueprint(
    'invenio_communities',
    __name__,
    url_prefix='/communities',
    template_folder='../templates',
    static_folder='../static',
)


@blueprint.app_template_filter('sanitize_html')
def sanitize_html(value):
    """Sanitizes HTML using the bleach library."""
    return bleach.clean(
        value,
        tags=current_app.config['COMMUNITIES_ALLOWED_TAGS'],
        attributes=current_app.config['COMMUNITIES_ALLOWED_ATTRS'],
        strip=True,
    ).strip()


def pass_community(f):
    """Decorator to pass community."""
    @wraps(f)
    def inner(community_id, *args, **kwargs):
        c = Community.get(community_id)
        if c is None:
            abort(404)
        return f(c, *args, **kwargs)
    return inner


def permission_required(action):
    """Decorator to require permission."""
    def decorator(f):
        @wraps(f)
        def inner(community, *args, **kwargs):
            permission = current_permission_factory(community, action=action)
            if not permission.can():
                abort(403)
            return f(community, *args, **kwargs)
        return inner
    return decorator


@blueprint.app_template_filter('format_item')
def format_item(item, template, name='item'):
    """Render a template to a string with the provided item in context."""
    ctx = {name: item}
    return render_template_to_string(template, **ctx)


@blueprint.app_template_filter('mycommunities_ctx')
def mycommunities_ctx():
    """Helper method for return ctx used by many views."""
    return {
        'mycommunities': Community.get_by_user(current_user.get_id()).all()
    }


@blueprint.route('/', methods=['GET', ])
def index():
    """Index page with uploader and list of existing depositions."""
    ctx = mycommunities_ctx()

    p = request.args.get('p', type=str)
    so = request.args.get('so', type=str)
    page = request.args.get('page', type=int, default=1)

    so = so or current_app.config.get('COMMUNITIES_DEFAULT_SORTING_OPTION')

    communities = Community.filter_communities(p, so)
    featured_community = FeaturedCommunity.get_featured_or_none()
    form = SearchForm(p=p)
    per_page = 10
    page = max(page, 1)
    p = Pagination(page, per_page, communities.count())

    ctx.update({
        'r_from': max(p.per_page * (p.page - 1), 0),
        'r_to': min(p.per_page * p.page, p.total_count),
        'r_total': p.total_count,
        'pagination': p,
        'form': form,
        'title': _('Communities'),
        'communities': communities.slice(
            per_page * (page - 1), per_page * page).all(),
        'featured_community': featured_community,
    })

    return render_template(
        current_app.config['COMMUNITIES_INDEX_TEMPLATE'], **ctx)


@blueprint.route('/<string:community_id>/', methods=['GET'])
@pass_community
def detail(community):
    """Index page with uploader and list of existing depositions."""
    return generic_item(
        community, current_app.config['COMMUNITIES_DETAIL_TEMPLATE'])


@blueprint.route('/<string:community_id>/search', methods=['GET'])
@pass_community
def search(community):
    """Index page with uploader and list of existing depositions."""
    return generic_item(
        community,
        current_app.config['COMMUNITIES_SEARCH_TEMPLATE'],
        detail=False)


@blueprint.route('/<string:community_id>/about/', methods=['GET'])
@pass_community
def about(community):
    """Index page with uploader and list of existing depositions."""
    return generic_item(
        community, current_app.config['COMMUNITIES_ABOUT_TEMPLATE'])


def generic_item(community, template, **extra_ctx):
    """Index page with uploader and list of existing depositions."""
    # Check existence of community
    ctx = mycommunities_ctx()
    ctx.update({
        'is_owner': community.id_user == current_user.get_id(),
        'community': community,
        'detail': True,
    })
    ctx.update(extra_ctx)

    return render_template(template, **ctx)


@blueprint.route('/new/', methods=['GET', 'POST'])
@login_required
def new():
    """Create a new community."""
    if app.config.get('RECAPTCHA_PUBLIC_KEY') and \
            app.config.get('RECAPTCHA_PRIVATE_KEY'):
        form_cls = RecaptchaCommunityForm
    else:
        form_cls = CommunityForm
    form = form_cls(formdata=request.values)

    ctx = mycommunities_ctx()
    ctx.update({
        'form': form,
        'is_new': True,
        'community': None,
    })

    if form.validate_on_submit():
        data = copy.deepcopy(form.data)

        community_id = data.pop('identifier')
        del data['logo']

        community = Community.create(
            community_id, current_user.get_id(), **data)

        file = request.files.get('logo', None)
        if file:
            if not community.save_logo(file.stream, file.filename):
                form.logo.errors.append(_(
                    'Cannot add this file as a logo. Supported formats: '
                    'PNG, JPG and SVG. Max file size: 1.5 MB.'))
                db.session.rollback()
                community = None

        if community:
            db.session.commit()
            flash("Community was successfully created.", category='success')
            return redirect(url_for('.edit', community_id=community.id))

    return render_template(
        current_app.config['COMMUNITIES_NEW_TEMPLATE'],
        community_form=form,
        **ctx
    )


@blueprint.route('/<string:community_id>/edit/', methods=['GET', 'POST'])
@login_required
@pass_community
@permission_required('community-edit')
def edit(community):
    """Create or edit a community."""
    form = EditCommunityForm(formdata=request.values, obj=community)
    deleteform = DeleteCommunityForm()
    ctx = mycommunities_ctx()
    ctx.update({
        'form': form,
        'is_new': False,
        'community': community,
        'deleteform': deleteform,
    })

    if form.validate_on_submit():
        for field, val in form.data.items():
            setattr(community, field, val)

        file = request.files.get('logo', None)
        if file:
            if not community.save_logo(file.stream, file.filename):
                form.logo.errors.append(_(
                    'Cannot add this file as a logo. Supported formats: '
                    'PNG, JPG and SVG. Max file size: 1.5 MB.'))

        if not form.logo.errors:
            db.session.commit()
            flash("Community successfully edited.", category='success')
            return redirect(url_for('.edit', community_id=community.id))

    return render_template(
        current_app.config['COMMUNITIES_EDIT_TEMPLATE'],
        **ctx
    )


@blueprint.route('/<string:community_id>/delete/', methods=['POST'])
@login_required
@pass_community
@permission_required('community-delete')
def delete(community):
    """Delete a community."""
    deleteform = DeleteCommunityForm(formdata=request.values)
    ctx = mycommunities_ctx()
    ctx.update({
        'deleteform': deleteform,
        'is_new': False,
        'community': community,
    })

    if deleteform.validate_on_submit():
        community.delete()
        db.session.commit()
        flash("Community was deleted.", category='success')
        return redirect(url_for('.index'))
    else:
        flash("Community could not be deleted.", category='warning')
        return redirect(url_for('.edit', community_id=community.id))


@blueprint.route('/<string:community_id>/curate/', methods=['GET', 'POST'])
@login_required
@pass_community
@permission_required('community-curate')
def curate(community):
    """Index page with uploader and list of existing depositions.

    :param community_id: ID of the community to curate.
    """
    if request.method == 'POST':
        action = request.json.get('action')
        recid = request.json.get('recid')

        # 'recid' is mandatory
        if not recid:
            abort(400)
        if action not in ['accept', 'reject', 'remove']:
            abort(400)

        # Resolve recid to a Record
        resolver = Resolver(
            pid_type='recid', object_type='rec', getter=Record.get_record)
        pid, record = resolver.resolve(recid)

        # Perform actions
        if action == "accept":
            community.accept_record(record)
        elif action == "reject":
            community.reject_record(record)
        elif action == "remove":
            community.remove_record(record)

        record.commit()
        db.session.commit()
        RecordIndexer().index_by_id(record.id)
        return jsonify({'status': 'success'})

    ctx = {'community': community}
    return render_template(
        current_app.config['COMMUNITIES_CURATE_TEMPLATE'],
        **ctx
    )

1	# -- coding: utf-8 --
2	#
3	# This file is part of Invenio.
4	# Copyright (C) 2016-2019 CERN.
5	#
6	# Invenio is free software; you can redistribute it and/or modify it
7	# under the terms of the MIT License; see LICENSE file for more details.
8
9	"""Invenio module that adds support for communities."""	2✔
10
11	from __future__ import absolute_import, print_function	2✔
12
13	import copy	2✔
14	from functools import wraps	2✔
15
16	import bleach	2✔
17	from flask import Blueprint, abort, current_app, flash, jsonify, redirect, \	2✔
18	render_template, request, url_for
19	from flask_babelex import gettext as _	2✔
20	from flask_login import current_user, login_required	2✔
21	from invenio_db import db	2✔
22	from invenio_indexer.api import RecordIndexer	2✔
23	from invenio_pidstore.resolver import Resolver	2✔
24	from invenio_records.api import Record	2✔
25
26	from invenio_communities.forms import CommunityForm, DeleteCommunityForm, \	2✔
27	EditCommunityForm, RecaptchaCommunityForm, SearchForm
28	from invenio_communities.models import Community, FeaturedCommunity	2✔
29	from invenio_communities.proxies import current_permission_factory	2✔
30	from invenio_communities.utils import Pagination, render_template_to_string	2✔
31
32	blueprint = Blueprint(	2✔
33	'invenio_communities',
34	__name__,
35	url_prefix='/communities',
36	template_folder='../templates',
37	static_folder='../static',
38	)
39
40
41	@blueprint.app_template_filter('sanitize_html')	2✔
42	def sanitize_html(value):
43	"""Sanitizes HTML using the bleach library."""
44	return bleach.clean(	×
45	value,
46	tags=current_app.config['COMMUNITIES_ALLOWED_TAGS'],
47	attributes=current_app.config['COMMUNITIES_ALLOWED_ATTRS'],
48	strip=True,
49	).strip()
50
51
52	def pass_community(f):	2✔
53	"""Decorator to pass community."""
54	@wraps(f)	2✔
55	def inner(community_id, args, *kwargs):
56	c = Community.get(community_id)	×
57	if c is None:	×
58	abort(404)	×
59	return f(c, args, *kwargs)	×
60	return inner	2✔
61
62
63	def permission_required(action):	2✔
64	"""Decorator to require permission."""
65	def decorator(f):	2✔
66	@wraps(f)	2✔
67	def inner(community, args, *kwargs):
68	permission = current_permission_factory(community, action=action)	×
69	if not permission.can():	×
70	abort(403)	×
71	return f(community, args, *kwargs)	×
72	return inner	2✔
73	return decorator	2✔
74
75
76	@blueprint.app_template_filter('format_item')	2✔
77	def format_item(item, template, name='item'):	2✔
78	"""Render a template to a string with the provided item in context."""
79	ctx = {name: item}	×
80	return render_template_to_string(template, **ctx)	×
81
82
83	@blueprint.app_template_filter('mycommunities_ctx')	2✔
84	def mycommunities_ctx():
85	"""Helper method for return ctx used by many views."""
86	return {	×
87	'mycommunities': Community.get_by_user(current_user.get_id()).all()
88	}
89
90
91	@blueprint.route('/', methods=['GET', ])	2✔
92	def index():
93	"""Index page with uploader and list of existing depositions."""
94	ctx = mycommunities_ctx()	×
95
96	p = request.args.get('p', type=str)	×
97	so = request.args.get('so', type=str)	×
98	page = request.args.get('page', type=int, default=1)	×
99
100	so = so or current_app.config.get('COMMUNITIES_DEFAULT_SORTING_OPTION')	×
101
102	communities = Community.filter_communities(p, so)	×
103	featured_community = FeaturedCommunity.get_featured_or_none()	×
104	form = SearchForm(p=p)	×
105	per_page = 10	×
106	page = max(page, 1)	×
107	p = Pagination(page, per_page, communities.count())	×
108
109	ctx.update({	×
110	'r_from': max(p.per_page * (p.page - 1), 0),
111	'r_to': min(p.per_page * p.page, p.total_count),
112	'r_total': p.total_count,
113	'pagination': p,
114	'form': form,
115	'title': _('Communities'),
116	'communities': communities.slice(
117	per_page * (page - 1), per_page * page).all(),
118	'featured_community': featured_community,
119	})
120
121	return render_template(	×
122	current_app.config['COMMUNITIES_INDEX_TEMPLATE'], **ctx)
123
124
125	@blueprint.route('/<string:community_id>/', methods=['GET'])	2✔
126	@pass_community	2✔
127	def detail(community):
128	"""Index page with uploader and list of existing depositions."""
129	return generic_item(	×
130	community, current_app.config['COMMUNITIES_DETAIL_TEMPLATE'])
131
132
133	@blueprint.route('/<string:community_id>/search', methods=['GET'])	2✔
134	@pass_community	2✔
135	def search(community):
136	"""Index page with uploader and list of existing depositions."""
137	return generic_item(	×
138	community,
139	current_app.config['COMMUNITIES_SEARCH_TEMPLATE'],
140	detail=False)
141
142
143	@blueprint.route('/<string:community_id>/about/', methods=['GET'])	2✔
144	@pass_community	2✔
145	def about(community):
146	"""Index page with uploader and list of existing depositions."""
147	return generic_item(	×
148	community, current_app.config['COMMUNITIES_ABOUT_TEMPLATE'])
149
150
151	def generic_item(community, template, **extra_ctx):	2✔
152	"""Index page with uploader and list of existing depositions."""
153	# Check existence of community
154	ctx = mycommunities_ctx()	×
155	ctx.update({	×
156	'is_owner': community.id_user == current_user.get_id(),
157	'community': community,
158	'detail': True,
159	})
160	ctx.update(extra_ctx)	×
161
162	return render_template(template, **ctx)	×
163
164
165	@blueprint.route('/new/', methods=['GET', 'POST'])	2✔
166	@login_required	2✔
167	def new():
168	"""Create a new community."""
169	if app.config.get('RECAPTCHA_PUBLIC_KEY') and \	×
170	app.config.get('RECAPTCHA_PRIVATE_KEY'):
171	form_cls = RecaptchaCommunityForm	×
172	else:
173	form_cls = CommunityForm	×
174	form = form_cls(formdata=request.values)	×
175
176	ctx = mycommunities_ctx()	×
177	ctx.update({	×
178	'form': form,
179	'is_new': True,
180	'community': None,
181	})
182
183	if form.validate_on_submit():	×
184	data = copy.deepcopy(form.data)	×
185
186	community_id = data.pop('identifier')	×
187	del data['logo']	×
188
189	community = Community.create(	×
190	community_id, current_user.get_id(), **data)
191
192	file = request.files.get('logo', None)	×
193	if file:	×
194	if not community.save_logo(file.stream, file.filename):	×
195	form.logo.errors.append(_(	×
196	'Cannot add this file as a logo. Supported formats: '
197	'PNG, JPG and SVG. Max file size: 1.5 MB.'))
198	db.session.rollback()	×
199	community = None	×
200
201	if community:	×
202	db.session.commit()	×
203	flash("Community was successfully created.", category='success')	×
204	return redirect(url_for('.edit', community_id=community.id))	×
205
206	return render_template(	×
207	current_app.config['COMMUNITIES_NEW_TEMPLATE'],
208	community_form=form,
209	**ctx
210	)
211
212
213	@blueprint.route('/<string:community_id>/edit/', methods=['GET', 'POST'])	2✔
214	@login_required	2✔
215	@pass_community	2✔
216	@permission_required('community-edit')	2✔
217	def edit(community):
218	"""Create or edit a community."""
219	form = EditCommunityForm(formdata=request.values, obj=community)	×
220	deleteform = DeleteCommunityForm()	×
221	ctx = mycommunities_ctx()	×
222	ctx.update({	×
223	'form': form,
224	'is_new': False,
225	'community': community,
226	'deleteform': deleteform,
227	})
228
229	if form.validate_on_submit():	×
230	for field, val in form.data.items():	×
231	setattr(community, field, val)	×
232
233	file = request.files.get('logo', None)	×
234	if file:	×
235	if not community.save_logo(file.stream, file.filename):	×
236	form.logo.errors.append(_(	×
237	'Cannot add this file as a logo. Supported formats: '
238	'PNG, JPG and SVG. Max file size: 1.5 MB.'))
239
240	if not form.logo.errors:	×
241	db.session.commit()	×
242	flash("Community successfully edited.", category='success')	×
243	return redirect(url_for('.edit', community_id=community.id))	×
244
245	return render_template(	×
246	current_app.config['COMMUNITIES_EDIT_TEMPLATE'],
247	**ctx
248	)
249
250
251	@blueprint.route('/<string:community_id>/delete/', methods=['POST'])	2✔
252	@login_required	2✔
253	@pass_community	2✔
254	@permission_required('community-delete')	2✔
255	def delete(community):
256	"""Delete a community."""
257	deleteform = DeleteCommunityForm(formdata=request.values)	×
258	ctx = mycommunities_ctx()	×
259	ctx.update({	×
260	'deleteform': deleteform,
261	'is_new': False,
262	'community': community,
263	})
264
265	if deleteform.validate_on_submit():	×
266	community.delete()	×
267	db.session.commit()	×
268	flash("Community was deleted.", category='success')	×
269	return redirect(url_for('.index'))	×
270	else:
271	flash("Community could not be deleted.", category='warning')	×
272	return redirect(url_for('.edit', community_id=community.id))	×
273
274
275	@blueprint.route('/<string:community_id>/curate/', methods=['GET', 'POST'])	2✔
276	@login_required	2✔
277	@pass_community	2✔
278	@permission_required('community-curate')	2✔
279	def curate(community):
280	"""Index page with uploader and list of existing depositions.
281
282	:param community_id: ID of the community to curate.
283	"""
284	if request.method == 'POST':	×
285	action = request.json.get('action')	×
286	recid = request.json.get('recid')	×
287
288	# 'recid' is mandatory
289	if not recid:	×
290	abort(400)	×
291	if action not in ['accept', 'reject', 'remove']:	×
292	abort(400)	×
293
294	# Resolve recid to a Record
295	resolver = Resolver(	×
296	pid_type='recid', object_type='rec', getter=Record.get_record)
297	pid, record = resolver.resolve(recid)	×
298
299	# Perform actions
300	if action == "accept":	×
301	community.accept_record(record)	×
302	elif action == "reject":	×
303	community.reject_record(record)	×
304	elif action == "remove":	×
305	community.remove_record(record)	×
306
307	record.commit()	×
308	db.session.commit()	×
309	RecordIndexer().index_by_id(record.id)	×
310	return jsonify({'status': 'success'})	×
311
312	ctx = {'community': community}	×
313	return render_template(	×
314	current_app.config['COMMUNITIES_CURATE_TEMPLATE'],
315	**ctx
316	)

inveniosoftware / invenio-communities / 639

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous