sporada/nopaque
1
0
Fork 0
mirror of https://gitlab.ub.uni-bielefeld.de/sfb1288inf/nopaque.git synced 2025-06-11 16:40:40 +00:00
Code Issues Projects Releases Wiki Activity

Implement flask-breadcrumbs everywhere

Browse Source
This commit is contained in:
Patrick Jentsch
2023-03-14 11:13:35 +01:00
parent bac526b927
commit c91004d6ba
38 changed files with 509 additions and 443 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
app/corpora/__init__.py
View File

@ -2,10 +2,6 @@ from flask import Blueprint
bp = Blueprint('corpora', __name__)
from . import cqi_over_socketio, routes, json_routes # noqa
from .files import bp as files_bp
bp.register_blueprint(files_bp, url_prefix='<hashid:corpus_id>/files')
from .followers import bp as followers_bp
bp.register_blueprint(followers_bp, url_prefix='<hashid:corpus_id>/followers')
from . import cqi_over_socketio, routes, json_routes
from . import files
from . import followers

10
app/corpora/files/__init__.py
View File

@ -1,8 +1,2 @@
from flask import Blueprint
template_base_dir = 'corpora/files'
bp = Blueprint('files', __name__)
from . import routes, json_routes
from .. import bp
from . import json_routes, routes

10
app/corpora/files/json_routes.py
View File

@ -8,15 +8,7 @@ from ..decorators import corpus_follower_permission_required
from . import bp
##############################################################################
# IMPORTANT NOTE: These routes are prefixed by the blueprint #
# Prefix: <hashid:corpus_id>/files #
# This implies that the corpus_id is always in the kwargs of #
# a route that is registered to this blueprint. #
##############################################################################
@bp.route('/<hashid:corpus_file_id>', methods=['DELETE'])
@bp.route('/<hashid:corpus_id>/files/<hashid:corpus_file_id>', methods=['DELETE'])
@login_required
@corpus_follower_permission_required('REMOVE_CORPUS_FILE')
@content_negotiation(produces='application/json')

36
app/corpora/files/routes.py
View File

@ -1,29 +1,34 @@
from flask import (
abort,
flash,
Markup,
redirect,
render_template,
send_from_directory
send_from_directory,
url_for
)
from flask_login import current_user, login_required
from flask_breadcrumbs import register_breadcrumb
from flask_login import login_required
import os
from app import db
from app.models import Corpus, CorpusFile, CorpusStatus
from ..decorators import corpus_follower_permission_required
from . import bp, template_base_dir
from ..utils import corpus_endpoint_arguments_constructor as corpus_eac
from . import bp
from .forms import CreateCorpusFileForm, UpdateCorpusFileForm
from .utils import (
corpus_file_dynamic_list_constructor as corpus_file_dlc
)
##############################################################################
# IMPORTANT NOTE: These routes are prefixed by the blueprint #
# Prefix: <hashid:corpus_id>/files #
# This implies that the corpus_id is always in the kwargs of #
# a route that is registered to this blueprint. #
##############################################################################
@bp.route('/<hashid:corpus_id>/files')
@register_breadcrumb(bp, '.entity.files', 'Files', endpoint_arguments_constructor=corpus_eac)
@login_required
def corpus_files(corpus_id):
return redirect(url_for('.corpus', corpus_id=corpus_id, _anchor='files'))
@bp.route('/create', methods=['GET', 'POST'])
@bp.route('/<hashid:corpus_id>/files/create', methods=['GET', 'POST'])
@register_breadcrumb(bp, '.entity.files.create', 'Create', endpoint_arguments_constructor=corpus_eac)
@login_required
@corpus_follower_permission_required('ADD_CORPUS_FILE')
def create_corpus_file(corpus_id):
@ -58,14 +63,15 @@ def create_corpus_file(corpus_id):
flash(f'Corpus File "{corpus_file.filename}" added', category='corpus')
return '', 201, {'Location': corpus.url}
return render_template(
f'{template_base_dir}/create_corpus_file.html.j2',
'corpora/files/create_corpus_file.html.j2',
corpus=corpus,
form=form,
title='Add corpus file'
)
@bp.route('/<hashid:corpus_file_id>', methods=['GET', 'POST'])
@bp.route('/<hashid:corpus_id>/files/<hashid:corpus_file_id>', methods=['GET', 'POST'])
@register_breadcrumb(bp, '.entity.files.entity', '', dynamic_list_constructor=corpus_file_dlc)
@login_required
@corpus_follower_permission_required('UPDATE_CORPUS_FILE')
def corpus_file(corpus_id, corpus_file_id):
@ -79,7 +85,7 @@ def corpus_file(corpus_id, corpus_file_id):
flash(f'Corpus file "{corpus_file.filename}" updated', category='corpus')
return redirect(corpus_file.corpus.url)
return render_template(
f'{template_base_dir}/corpus_file.html.j2',
'corpora/files/corpus_file.html.j2',
corpus=corpus_file.corpus,
corpus_file=corpus_file,
form=form,
@ -87,7 +93,7 @@ def corpus_file(corpus_id, corpus_file_id):
)
@bp.route('/<hashid:corpus_file_id>/download')
@bp.route('/<hashid:corpus_id>/files/<hashid:corpus_file_id>/download')
@login_required
@corpus_follower_permission_required('VIEW')
def download_corpus_file(corpus_id, corpus_file_id):

15
app/corpora/files/utils.py Normal file
View File

@ -0,0 +1,15 @@
from flask import request, url_for
from app.models import CorpusFile
from ..utils import corpus_endpoint_arguments_constructor as corpus_eac
def corpus_file_dynamic_list_constructor():
corpus_id = request.view_args['corpus_id']
corpus_file_id = request.view_args['corpus_file_id']
corpus_file = CorpusFile.query.filter_by(corpus_id=corpus_id, id=corpus_file_id).first_or_404()
return [
{
'text': f'{corpus_file.author}: {corpus_file.title} ({corpus_file.publishing_year})',
'url': url_for('.corpus_file', corpus_id=corpus_id, corpus_file_id=corpus_file_id)
}
]

5
app/corpora/followers/__init__.py
View File

@ -1,5 +1,2 @@
from flask import Blueprint
bp = Blueprint('followers', __name__)
from .. import bp
from . import json_routes

14
app/corpora/followers/json_routes.py
View File

@ -12,15 +12,7 @@ from ..decorators import corpus_owner_or_admin_required
from . import bp
##############################################################################
# IMPORTANT NOTE: These routes are prefixed by the blueprint #
# Prefix: <hashid:corpus_id>/followers #
# This implies that the corpus_id is always in the kwargs of #
# a route that is registered to this blueprint. #
##############################################################################
@bp.route('', methods=['POST'])
@bp.route('/<hashid:corpus_id>/followers', methods=['POST'])
@login_required
@corpus_owner_or_admin_required
@content_negotiation(consumes='application/json', produces='application/json')
@ -42,7 +34,7 @@ def create_corpus_followers(corpus_id):
return response
@bp.route('/<hashid:follower_id>/role', methods=['PUT'])
@bp.route('/<hashid:corpus_id>/followers/<hashid:follower_id>/role', methods=['PUT'])
@login_required
@corpus_owner_or_admin_required
@content_negotiation(consumes='application/json', produces='application/json')
@ -65,7 +57,7 @@ def update_corpus_follower_role(corpus_id, follower_id):
return response
@bp.route('/<hashid:follower_id>', methods=['DELETE'])
@bp.route('/<hashid:corpus_id>/followers/<hashid:follower_id>', methods=['DELETE'])
@login_required
@content_negotiation(produces='application/json')
def delete_corpus_follower(corpus_id, follower_id):

15
app/corpora/routes.py
View File

@ -1,4 +1,5 @@
from flask import abort, flash, redirect, render_template, url_for
from flask_breadcrumbs import register_breadcrumb
from flask_login import current_user, login_required
from .decorators import corpus_follower_permission_required
from app import db
@ -10,15 +11,21 @@ from app.models import (
)
from . import bp
from .forms import CreateCorpusForm
from .utils import (
corpus_endpoint_arguments_constructor as corpus_eac,
corpus_dynamic_list_constructor as corpus_dlc
)
@bp.route('')
@register_breadcrumb(bp, '.', '<i class="nopaque-icons left">I</i>My Corpora')
@login_required
def corpora():
return redirect(url_for('main.dashboard', _anchor='corpora'))
@bp.route('/create', methods=['GET', 'POST'])
@register_breadcrumb(bp, '.create', 'Create')
@login_required
def create_corpus():
form = CreateCorpusForm()
@ -42,6 +49,7 @@ def create_corpus():
@bp.route('/<hashid:corpus_id>')
@register_breadcrumb(bp, '.entity', '', dynamic_list_constructor=corpus_dlc)
@login_required
def corpus(corpus_id):
corpus = Corpus.query.get_or_404(corpus_id)
@ -54,7 +62,7 @@ def corpus(corpus_id):
corpus=corpus,
corpus_follower_roles=corpus_follower_roles,
users = users,
title='Corpus'
title=corpus.title
)
if current_user.is_following_corpus(corpus) or corpus.is_public:
cfa = CorpusFollowerAssociation.query.filter_by(corpus_id=corpus_id, follower_id=current_user.id).first_or_404()
@ -66,12 +74,13 @@ def corpus(corpus_id):
corpus_files=corpus_files,
cfa=cfa,
owner=owner,
title='Corpus',
title=corpus.title
)
abort(403)
@bp.route('/<hashid:corpus_id>/analyse')
@register_breadcrumb(bp, '.entity.analyse', 'Analyse', endpoint_arguments_constructor=corpus_eac)
@login_required
@corpus_follower_permission_required('VIEW')
def analyse_corpus(corpus_id):
@ -95,12 +104,14 @@ def follow_corpus(corpus_id, token):
@bp.route('/import', methods=['GET', 'POST'])
@register_breadcrumb(bp, '.import', 'Import')
@login_required
def import_corpus():
abort(503)
@bp.route('/<hashid:corpus_id>/export')
@register_breadcrumb(bp, '.entity.export', 'Export', endpoint_arguments_constructor=corpus_eac)
@login_required
def export_corpus(corpus_id):
abort(503)

17
app/corpora/utils.py Normal file
View File

@ -0,0 +1,17 @@
from flask import request, url_for
from app.models import Corpus
def corpus_endpoint_arguments_constructor():
return {'corpus_id': request.view_args['corpus_id']}
def corpus_dynamic_list_constructor():
corpus_id = request.view_args['corpus_id']
corpus = Corpus.query.get(corpus_id)
return [
{
'text': f'<i class="material-icons left">book</i>{corpus.title}',
'url': url_for('.corpus', corpus_id=corpus_id)
}
]