nopaque/app/corpora/routes.py

372 lines
12 KiB
Python
Raw Normal View History

2023-02-10 08:37:31 +00:00
from datetime import datetime, timedelta
from flask import (
abort,
current_app,
flash,
2022-09-02 11:07:30 +00:00
Markup,
redirect,
render_template,
request,
send_from_directory,
url_for
)
2020-04-06 12:12:22 +00:00
from flask_login import current_user, login_required
2022-09-02 11:07:30 +00:00
from threading import Thread
2023-02-10 08:37:31 +00:00
import jwt
2020-04-06 12:12:22 +00:00
import os
from app import db, hashids
from app.models import Corpus, CorpusFile, CorpusStatus, CorpusFollowerAssociation, User
2022-09-02 11:07:30 +00:00
from . import bp
from .forms import ChangeCorpusSettingsForm, CreateCorpusFileForm, CreateCorpusForm, UpdateCorpusFileForm
2022-11-29 14:28:10 +00:00
@bp.route('')
@login_required
def corpora():
query = Corpus.query.filter(
(Corpus.user_id == current_user.id) | (Corpus.is_public == True)
)
corpora = [c.to_json_serializeable() for c in query.all()]
return render_template('corpora/corpora.html.j2', corpora=corpora, title='Corpora')
2020-04-06 12:12:22 +00:00
2022-09-02 11:07:30 +00:00
@bp.route('/create', methods=['GET', 'POST'])
2020-04-06 12:12:22 +00:00
@login_required
2022-09-02 11:07:30 +00:00
def create_corpus():
form = CreateCorpusForm()
if form.validate_on_submit():
2020-04-06 12:12:22 +00:00
try:
2022-09-02 11:07:30 +00:00
corpus = Corpus.create(
title=form.title.data,
description=form.description.data,
user=current_user
)
except OSError:
abort(500)
db.session.commit()
2022-09-02 11:07:30 +00:00
message = Markup(
f'Corpus "<a href="{corpus.url}">{corpus.title}</a>" created'
2021-11-16 14:23:57 +00:00
)
2022-09-02 11:07:30 +00:00
flash(message, 'corpus')
return redirect(corpus.url)
return render_template(
2022-09-02 11:07:30 +00:00
'corpora/create_corpus.html.j2',
form=form,
2022-09-02 11:07:30 +00:00
title='Create corpus'
)
@bp.route('/<hashid:corpus_id>', methods=['GET', 'POST'])
2020-04-06 12:12:22 +00:00
@login_required
def corpus(corpus_id):
corpus = Corpus.query.get_or_404(corpus_id)
2023-02-09 10:05:27 +00:00
if not (corpus.user == current_user
or current_user.is_administrator()
or current_user.is_following_corpus(corpus)
or corpus.is_public):
2020-04-06 12:12:22 +00:00
abort(403)
corpus_settings_form = ChangeCorpusSettingsForm(
data=corpus.to_json_serializeable(),
prefix='corpus-settings-form'
)
if corpus_settings_form.validate_on_submit():
corpus.is_public = corpus_settings_form.is_public.data
db.session.commit()
flash('Your changes have been saved')
return redirect(url_for('.corpus', corpus_id=corpus.id))
2023-02-10 08:37:31 +00:00
now = datetime.utcnow()
payload = {
'iat': now,
'iss': current_app.config['SERVER_NAME'],
'sub': corpus.hashid
}
token = jwt.encode(
payload,
current_app.config['SECRET_KEY'],
algorithm='HS256'
)
if corpus.user == current_user:
2023-02-09 10:05:27 +00:00
return render_template(
'corpora/corpus.html.j2',
corpus=corpus,
2023-02-10 08:37:31 +00:00
token=token,
2023-02-09 10:05:27 +00:00
title='Corpus'
)
else:
2023-02-09 11:02:00 +00:00
corpus_files = [x.to_json_serializeable() for x in corpus.files]
2023-02-09 10:05:27 +00:00
return render_template(
'corpora/corpus_public.html.j2',
corpus=corpus,
2023-02-09 11:02:00 +00:00
corpus_files=corpus_files,
2023-02-09 10:05:27 +00:00
title='Corpus'
)
2023-02-10 08:37:31 +00:00
@bp.route('/share/<token>', methods=['GET', 'POST'])
def share_corpus(token):
try:
payload = jwt.decode(
token,
current_app.config['SECRET_KEY'],
algorithms=['HS256'],
issuer=current_app.config['SERVER_NAME'],
options={'require': ['iat', 'iss', 'sub']}
)
except jwt.PyJWTError:
return False
corpus_hashid = payload.get('sub')
corpus_id = hashids.decode(corpus_hashid)
return redirect(url_for('.corpus', corpus_id=corpus_id))
2023-02-09 15:22:37 +00:00
@bp.route('/<hashid:corpus_id>/enable_is_public', methods=['POST'])
@login_required
def enable_corpus_is_public(corpus_id):
corpus = Corpus.query.get_or_404(corpus_id)
if not (corpus.user == current_user or current_user.is_administrator()):
abort(403)
corpus.is_public = True
db.session.commit()
return '', 204
2023-02-09 15:22:37 +00:00
@bp.route('/<hashid:corpus_id>/disable_is_public', methods=['POST'])
@login_required
def disable_corpus_is_public(corpus_id):
corpus = Corpus.query.get_or_404(corpus_id)
if not (corpus.user == current_user or current_user.is_administrator()):
abort(403)
corpus.is_public = False
db.session.commit()
return '', 204
2022-11-29 14:28:10 +00:00
2022-09-02 11:07:30 +00:00
@bp.route('/<hashid:corpus_id>', methods=['DELETE'])
@login_required
def delete_corpus(corpus_id):
def _delete_corpus(app, corpus_id):
with app.app_context():
corpus = Corpus.query.get(corpus_id)
corpus.delete()
db.session.commit()
corpus = Corpus.query.get_or_404(corpus_id)
2023-02-09 10:05:27 +00:00
if not (corpus.user == current_user or current_user.is_administrator()):
2022-09-02 11:07:30 +00:00
abort(403)
thread = Thread(
target=_delete_corpus,
args=(current_app._get_current_object(), corpus_id)
)
thread.start()
return {}, 202
2021-11-30 15:22:16 +00:00
@bp.route('/<hashid:corpus_id>/analyse')
2021-11-16 14:23:57 +00:00
@login_required
def analyse_corpus(corpus_id):
corpus = Corpus.query.get_or_404(corpus_id)
2023-02-09 10:05:27 +00:00
if not (corpus.user == current_user
or current_user.is_administrator()
or current_user.is_following_corpus(corpus)
or corpus.is_public):
2022-11-29 14:28:10 +00:00
abort(403)
2021-11-16 14:23:57 +00:00
return render_template(
'corpora/analyse_corpus.html.j2',
corpus=corpus,
title=f'Analyse Corpus {corpus.title}'
)
2022-09-02 11:07:30 +00:00
@bp.route('/<hashid:corpus_id>/build', methods=['POST'])
@login_required
def build_corpus(corpus_id):
2022-09-02 11:07:30 +00:00
def _build_corpus(app, corpus_id):
with app.app_context():
corpus = Corpus.query.get(corpus_id)
corpus.build()
db.session.commit()
2020-04-06 12:12:22 +00:00
corpus = Corpus.query.get_or_404(corpus_id)
2023-02-09 10:05:27 +00:00
if not (corpus.user == current_user or current_user.is_administrator()):
2020-04-06 12:12:22 +00:00
abort(403)
2022-09-02 11:07:30 +00:00
# Check if the corpus has corpus files
if not corpus.files.all():
response = {'errors': {'message': 'Corpus file(s) required'}}
return response, 409
thread = Thread(
target=_build_corpus,
args=(current_app._get_current_object(), corpus_id)
)
thread.start()
return {}, 202
2020-04-06 12:12:22 +00:00
2022-09-02 11:07:30 +00:00
@bp.route('/<hashid:corpus_id>/files/create', methods=['GET', 'POST'])
@login_required
2022-09-02 11:07:30 +00:00
def create_corpus_file(corpus_id):
corpus = Corpus.query.get_or_404(corpus_id)
2023-02-09 10:05:27 +00:00
if not (corpus.user == current_user or current_user.is_administrator()):
abort(403)
form = CreateCorpusFileForm()
2022-09-02 11:07:30 +00:00
if form.is_submitted():
if not form.validate():
response = {'errors': form.errors}
return response, 400
try:
corpus_file = CorpusFile.create(
form.vrt.data,
address=form.address.data,
author=form.author.data,
booktitle=form.booktitle.data,
chapter=form.chapter.data,
editor=form.editor.data,
institution=form.institution.data,
journal=form.journal.data,
pages=form.pages.data,
publisher=form.publisher.data,
publishing_year=form.publishing_year.data,
school=form.school.data,
title=form.title.data,
mimetype='application/vrt+xml',
corpus=corpus
)
2022-10-11 09:32:50 +00:00
except (AttributeError, OSError):
2022-09-02 11:07:30 +00:00
abort(500)
corpus.status = CorpusStatus.UNPREPARED
db.session.commit()
message = Markup(
'Corpus file'
f'"<a href="{corpus_file.url}">{corpus_file.filename}</a>" added'
)
flash(message, category='corpus')
return {}, 201, {'Location': corpus.url}
return render_template(
'corpora/create_corpus_file.html.j2',
corpus=corpus,
form=form,
title='Add corpus file'
)
2022-11-29 14:28:10 +00:00
@bp.route('/<hashid:corpus_id>/files/<hashid:corpus_file_id>', methods=['GET', 'POST'])
@login_required
def corpus_file(corpus_id, corpus_file_id):
2022-11-29 14:28:10 +00:00
corpus_file = CorpusFile.query.filter_by(corpus_id = corpus_id, id=corpus_file_id).first_or_404()
2022-09-02 11:07:30 +00:00
if not (corpus_file.corpus.user == current_user or current_user.is_administrator()):
abort(403)
form = UpdateCorpusFileForm(data=corpus_file.to_json_serializeable())
if form.validate_on_submit():
form.populate_obj(corpus_file)
if db.session.is_modified(corpus_file):
2022-09-02 11:07:30 +00:00
corpus_file.corpus.status = CorpusStatus.UNPREPARED
db.session.commit()
message = Markup(f'Corpus file "<a href="{corpus_file.url}">{corpus_file.filename}</a>" updated')
flash(message, category='corpus')
2022-09-02 11:07:30 +00:00
return redirect(corpus_file.corpus.url)
return render_template(
'corpora/corpus_file.html.j2',
corpus=corpus_file.corpus,
corpus_file=corpus_file,
form=form,
title='Edit corpus file'
)
2022-09-02 11:07:30 +00:00
@bp.route('/<hashid:corpus_id>/files/<hashid:corpus_file_id>', methods=['DELETE'])
2020-04-06 12:12:22 +00:00
@login_required
def delete_corpus_file(corpus_id, corpus_file_id):
2022-09-02 11:07:30 +00:00
def _delete_corpus_file(app, corpus_file_id):
with app.app_context():
corpus_file = CorpusFile.query.get(corpus_file_id)
corpus_file.delete()
db.session.commit()
2022-11-29 14:28:10 +00:00
corpus_file = CorpusFile.query.filter_by(corpus_id = corpus_id, id=corpus_file_id).first_or_404()
2022-09-02 11:07:30 +00:00
if not (corpus_file.corpus.user == current_user or current_user.is_administrator()):
2020-04-06 12:12:22 +00:00
abort(403)
2022-09-02 11:07:30 +00:00
thread = Thread(
target=_delete_corpus_file,
args=(current_app._get_current_object(), corpus_file_id)
)
2022-09-02 11:07:30 +00:00
thread.start()
return {}, 202
2020-04-06 12:12:22 +00:00
2021-11-30 15:22:16 +00:00
@bp.route('/<hashid:corpus_id>/files/<hashid:corpus_file_id>/download')
2020-04-06 12:12:22 +00:00
@login_required
def download_corpus_file(corpus_id, corpus_file_id):
2022-11-29 14:28:10 +00:00
corpus_file = CorpusFile.query.filter_by(corpus_id = corpus_id, id=corpus_file_id).first_or_404()
2022-09-02 11:07:30 +00:00
if not (corpus_file.corpus.user == current_user or current_user.is_administrator()):
2020-04-06 12:12:22 +00:00
abort(403)
return send_from_directory(
2022-09-02 11:07:30 +00:00
os.path.dirname(corpus_file.path),
os.path.basename(corpus_file.path),
as_attachment=True,
2022-04-12 14:11:24 +00:00
attachment_filename=corpus_file.filename,
2022-09-02 11:07:30 +00:00
mimetype=corpus_file.mimetype
)
2022-09-02 11:07:30 +00:00
@bp.route('/import', methods=['GET', 'POST'])
@login_required
def import_corpus():
abort(503)
@bp.route('/<hashid:corpus_id>/export')
@login_required
def export_corpus(corpus_id):
abort(503)
2023-02-02 08:14:50 +00:00
@bp.route('/<hashid:corpus_id>/follow', methods=['GET', 'POST'])
@login_required
def follow_corpus(corpus_id):
corpus = Corpus.query.get_or_404(corpus_id)
user_hashid = request.args.get('user_id')
if user_hashid is None:
user = current_user
else:
if not current_user.is_administrator():
abort(403)
else:
user_id = hashids.decode(user_hashid)
user = User.query.get_or_404(user_id)
if not user.is_following_corpus(corpus):
user.follow_corpus(corpus)
db.session.commit()
2023-02-10 08:37:31 +00:00
flash(f'You are following {corpus.title} now', category='corpus')
return {}, 202
2023-02-02 08:14:50 +00:00
@bp.route('/<hashid:corpus_id>/unfollow', methods=['GET', 'POST'])
@login_required
def unfollow_corpus(corpus_id):
corpus = Corpus.query.get_or_404(corpus_id)
user_hashid = request.args.get('user_id')
if user_hashid is None:
user = current_user
else:
if not current_user.is_administrator():
abort(403)
else:
user_id = hashids.decode(user_hashid)
user = User.query.get_or_404(user_id)
if user.is_following_corpus(corpus):
user.unfollow_corpus(corpus)
db.session.commit()
2023-02-10 08:37:31 +00:00
flash(f'You are not following {corpus.title} anymore', category='corpus')
return {}, 202
@bp.route('/add_permission/<hashid:corpus_id>/<hashid:user_id>/<int:permission>')
def add_permission(corpus_id, user_id, permission):
a = CorpusFollowerAssociation.query.filter_by(followed_corpus_id=corpus_id, following_user_id=user_id).first_or_404()
a.add_permission(permission)
db.session.commit()
return 'ok'
@bp.route('/remove_permission/<hashid:corpus_id>/<hashid:user_id>/<int:permission>')
def remove_permission(corpus_id, user_id, permission):
a = CorpusFollowerAssociation.query.filter_by(followed_corpus_id=corpus_id, following_user_id=user_id).first_or_404()
a.remove_permission(permission)
db.session.commit()
return 'ok'
2023-02-07 15:06:09 +00:00