nopaque/app/corpora/views.py

from flask import (abort, current_app, flash, make_response, redirect, request,
                   render_template, url_for, send_from_directory)
from flask_login import current_user, login_required
from . import corpora
from . import tasks
from .forms import (AddCorpusFileForm, AddCorpusForm, EditCorpusFileForm,
                    QueryDownloadForm, QueryForm, DisplayOptionsForm,
                    InspectDisplayOptionsForm)
from .. import db
from ..models import Corpus, CorpusFile
import os


@corpora.route('/add', methods=['GET', 'POST'])
@login_required
def add_corpus():
    add_corpus_form = AddCorpusForm()
    if add_corpus_form.validate_on_submit():
        corpus = Corpus(creator=current_user,
                        description=add_corpus_form.description.data,
                        status='unprepared', title=add_corpus_form.title.data)
        db.session.add(corpus)
        db.session.commit()
        dir = os.path.join(current_app.config['NOPAQUE_STORAGE'],
                           str(corpus.user_id), 'corpora', str(corpus.id))
        try:
            os.makedirs(dir)
        except OSError:
            flash('[ERROR]: Could not add corpus!')
            corpus.delete()
        else:
            corpus_url = url_for('corpora.corpus', corpus_id=corpus.id)
            flash('<i class="left material-icons">book</i>'
                  '[<a href="{}">{}</a>] added'.format(corpus_url,
                                                       corpus.title))
            return redirect(url_for('corpora.corpus', corpus_id=corpus.id))
    return render_template('corpora/add_corpus.html.j2',
                           add_corpus_form=add_corpus_form,
                           title='Add corpus')


@corpora.route('/<int:corpus_id>')
@login_required
def corpus(corpus_id):
    corpus = Corpus.query.get_or_404(corpus_id)
    if not (corpus.creator == current_user or current_user.is_administrator()):
        abort(403)
    return render_template('corpora/corpus.html.j2', corpus=corpus,
                           title='Corpus')


@corpora.route('/<int:corpus_id>/analyse')
@login_required
def analyse_corpus(corpus_id):
    corpus = Corpus.query.get_or_404(corpus_id)
    if corpus.status == 'prepared':
        corpus.status = 'start analysis'
        db.session.commit()
    display_options_form = DisplayOptionsForm(
        prefix='display-options-form',
        result_context=request.args.get('context', 20),
        results_per_page=request.args.get('results_per_page', 30))
    query_form = QueryForm(prefix='query-form',
                           query=request.args.get('query'))
    query_download_form = QueryDownloadForm(prefix='query-download-form')
    inspect_display_options_form = InspectDisplayOptionsForm(
        prefix='inspect-display-options-form')
    return render_template(
        'corpora/analyse_corpus.html.j2',
        corpus_id=corpus_id,
        display_options_form=display_options_form,
        query_form=query_form,
        query_download_form=query_download_form,
        inspect_display_options_form=inspect_display_options_form,
        title='Corpus analysis')


@corpora.route('/<int:corpus_id>/delete')
@login_required
def delete_corpus(corpus_id):
    corpus = Corpus.query.get_or_404(corpus_id)
    if not (corpus.creator == current_user or current_user.is_administrator()):
        abort(403)
    tasks.delete_corpus(corpus_id)
    flash('Corpus deleted!')
    return redirect(url_for('main.dashboard'))


@corpora.route('/<int:corpus_id>/files/add', methods=['GET', 'POST'])
@login_required
def add_corpus_file(corpus_id):
    corpus = Corpus.query.get_or_404(corpus_id)
    if not (corpus.creator == current_user or current_user.is_administrator()):
        abort(403)
    add_corpus_file_form = AddCorpusFileForm(corpus,
                                             prefix='add-corpus-file-form')
    if add_corpus_file_form.is_submitted():
        if not add_corpus_file_form.validate():
            return make_response(add_corpus_file_form.errors, 400)
        # Save the file
        dir = os.path.join(str(corpus.user_id), 'corpora', str(corpus.id))
        add_corpus_file_form.file.data.save(
            os.path.join(current_app.config['NOPAQUE_STORAGE'], dir,
                         add_corpus_file_form.file.data.filename))
        corpus_file = CorpusFile(
            address=add_corpus_file_form.address.data,
            author=add_corpus_file_form.author.data,
            booktitle=add_corpus_file_form.booktitle.data,
            chapter=add_corpus_file_form.chapter.data,
            corpus=corpus,
            dir=dir,
            editor=add_corpus_file_form.editor.data,
            filename=add_corpus_file_form.file.data.filename,
            institution=add_corpus_file_form.institution.data,
            journal=add_corpus_file_form.journal.data,
            pages=add_corpus_file_form.pages.data,
            publisher=add_corpus_file_form.publisher.data,
            publishing_year=add_corpus_file_form.publishing_year.data,
            school=add_corpus_file_form.school.data,
            title=add_corpus_file_form.title.data)
        db.session.add(corpus_file)
        corpus.status = 'unprepared'
        db.session.commit()
        flash('Corpus file added!')
        return make_response(
            {'redirect_url': url_for('corpora.corpus', corpus_id=corpus.id)},
            201)
    return render_template('corpora/add_corpus_file.html.j2',
                           corpus=corpus,
                           add_corpus_file_form=add_corpus_file_form,
                           title='Add corpus file')


@corpora.route('/<int:corpus_id>/files/<int:corpus_file_id>/delete')
@login_required
def delete_corpus_file(corpus_id, corpus_file_id):
    corpus_file = CorpusFile.query.get_or_404(corpus_file_id)
    if not corpus_file.corpus_id == corpus_id:
        abort(404)
    if not (corpus_file.corpus.creator == current_user
            or current_user.is_administrator()):
        abort(403)
    tasks.delete_corpus_file(corpus_file_id)
    flash('Corpus file deleted!')
    return redirect(url_for('corpora.corpus', corpus_id=corpus_id))


@corpora.route('/<int:corpus_id>/files/<int:corpus_file_id>/download')
@login_required
def download_corpus_file(corpus_id, corpus_file_id):
    corpus_file = CorpusFile.query.get_or_404(corpus_file_id)
    if not corpus_file.corpus_id == corpus_id:
        abort(404)
    if not (corpus_file.corpus.creator == current_user
            or current_user.is_administrator()):
        abort(403)
    dir = os.path.join(current_app.config['NOPAQUE_STORAGE'],
                       corpus_file.dir)
    return send_from_directory(as_attachment=True, directory=dir,
                               filename=corpus_file.filename)


@corpora.route('/<int:corpus_id>/files/<int:corpus_file_id>/edit',
               methods=['GET', 'POST'])
@login_required
def edit_corpus_file(corpus_id, corpus_file_id):
    corpus = Corpus.query.get_or_404(corpus_id)
    corpus_file = CorpusFile.query.get_or_404(corpus_file_id)
    if not corpus_file.corpus_id == corpus_id:
        abort(404)
    if not (corpus_file.corpus.creator == current_user
            or current_user.is_administrator()):
        abort(403)
    edit_corpus_file_form = EditCorpusFileForm(prefix='edit-corpus-file-form')
    if edit_corpus_file_form.validate_on_submit():
        corpus_file.address = edit_corpus_file_form.address.data
        corpus_file.author = edit_corpus_file_form.author.data
        corpus_file.booktitle = edit_corpus_file_form.booktitle.data
        corpus_file.chapter = edit_corpus_file_form.chapter.data
        corpus_file.editor = edit_corpus_file_form.editor.data
        corpus_file.institution = edit_corpus_file_form.institution.data
        corpus_file.journal = edit_corpus_file_form.journal.data
        corpus_file.pages = edit_corpus_file_form.pages.data
        corpus_file.publisher = edit_corpus_file_form.publisher.data
        corpus_file.publishing_year = \
            edit_corpus_file_form.publishing_year.data
        corpus_file.school = edit_corpus_file_form.school.data
        corpus_file.title = edit_corpus_file_form.title.data
        corpus.status = 'unprepared'
        db.session.commit()
        flash('Corpus file edited!')
        return redirect(url_for('corpora.corpus', corpus_id=corpus_id))
    # If no form is submitted or valid, fill out fields with current values
    edit_corpus_file_form.address.data = corpus_file.address
    edit_corpus_file_form.author.data = corpus_file.author
    edit_corpus_file_form.booktitle.data = corpus_file.booktitle
    edit_corpus_file_form.chapter.data = corpus_file.chapter
    edit_corpus_file_form.editor.data = corpus_file.editor
    edit_corpus_file_form.institution.data = corpus_file.institution
    edit_corpus_file_form.journal.data = corpus_file.journal
    edit_corpus_file_form.pages.data = corpus_file.pages
    edit_corpus_file_form.publisher.data = corpus_file.publisher
    edit_corpus_file_form.publishing_year.data = corpus_file.publishing_year
    edit_corpus_file_form.school.data = corpus_file.school
    edit_corpus_file_form.title.data = corpus_file.title
    return render_template('corpora/edit_corpus_file.html.j2',
                           corpus_file=corpus_file, corpus=corpus,
                           edit_corpus_file_form=edit_corpus_file_form,
                           title='Edit corpus file')


@corpora.route('/<int:corpus_id>/prepare')
@login_required
def prepare_corpus(corpus_id):
    corpus = Corpus.query.get_or_404(corpus_id)
    if not (corpus.creator == current_user or current_user.is_administrator()):
        abort(403)
    if corpus.files.all():
        tasks.build_corpus(corpus_id)
        flash('Corpus gets build now.')
    else:
        flash('Can not build corpus, please add corpus file(s).')
    return redirect(url_for('corpora.corpus', corpus_id=corpus_id))