Add function to import exported results and view them after the import

web/app/services/forms.py

@@ -0,0 +1,18 @@
+from flask_wtf import FlaskForm
+from werkzeug.utils import secure_filename
+from wtforms import FileField, SubmitField, ValidationError
+from wtforms.validators import DataRequired
+
+
+class ImportResultsForm(FlaskForm):
+    '''
+    Form used to import one result json file.
+    '''
+    file = FileField('File', validators=[DataRequired()])
+    submit = SubmitField()
+
+    def validate_file(self, field):
+        if not field.data.filename.lower().endswith('.json'):
+            raise ValidationError('File does not have an approved extension: '
+                                  '.json')
+        field.data.filename = secure_filename(field.data.filename)

web/app/services/tables.py

@@ -0,0 +1,65 @@
+from flask_table import Table, Col, DatetimeCol, LinkCol
+
+
+class ResultTable(Table):
+    '''
+    Declares the Table showing results. Declaration is column by column.
+    '''
+    classes = ['highlight', 'responsive-table']
+    query = Col('Query', column_html_attrs={'class': 'query'},
+                th_html_attrs={'class': 'sort',
+                               'data-sort': 'query'})
+    match_count = Col('Match count', column_html_attrs={'class':
+                                                        'match-count'},
+                      th_html_attrs={'class': 'sort',
+                                     'data-sort': 'match-count'})
+    corpus_name = Col('Corpus name', column_html_attrs={'class':
+                                                        'corpus-name'},
+                      th_html_attrs={'class': 'sort',
+                                     'data-sort': 'corpus-name'})
+    corpus_creation_date = DatetimeCol('Corpus creation date',
+                                       column_html_attrs={'class':
+                                                         'corpus-creation-  date'},  # noqa
+                                       th_html_attrs={'class': 'sort',
+                                                      'data-sort':
+                                                      'corpus-creation-date'},
+                                       datetime_format='dd/MM/yyyy, HH:mm:ss a')  # noqa
+    corpus_analysis_date = DatetimeCol('Date of result creation',
+                                       column_html_attrs={'class':
+                                                          'corpus-analysis-data'},  # noqa
+                                       th_html_attrs={'class': 'sort',
+                                                      'data-sort':
+                                                      'corpus-analysis-data'},
+                                       datetime_format='dd/MM/yyyy, HH:mm:ss a')  # noqa
+    corpus_type = Col('Result Type',
+                      column_html_attrs={'class':
+                                         'corpus-type'},
+                      th_html_attrs={'class': 'sort',
+                                     'data-sort':
+                                     'corpus-type'})
+    details = LinkCol('Details', 'results.result_details',
+                      url_kwargs=dict(result_id='id'),
+                      anchor_attrs={'class': 'waves-effect waves-light btn-floating'},  # noqa
+                      text_fallback='<i class="material-icons">info_outline</i>')  # noqa
+    inspect = LinkCol('Inspect', 'results.result_inspect',
+                      url_kwargs=dict(result_id='id'),
+                      anchor_attrs={'class': 'waves-effect waves-light btn-floating'},  # noqa
+                      text_fallback='<i class="material-icons">search</i>')  # noqa
+    # TODO: Maybe somehow fix taht there are two columns fpr two action buttons
+    # Or maybe just get rid of flask tables?
+
+
+class ResultItem(object):
+    '''
+    Describes one result item row.
+    '''
+
+    def __init__(self, query, match_count, corpus_name, corpus_creation_date,
+                 corpus_analysis_date, corpus_type, id):
+        self.query = query
+        self.match_count = match_count
+        self.corpus_name = corpus_name
+        self.corpus_creation_date = corpus_creation_date
+        self.corpus_analysis_date = corpus_analysis_date
+        self.corpus_type = corpus_type
+        self.id = id

web/app/services/views.py

@@ -1,13 +1,17 @@
 from flask import (abort, current_app, flash, make_response, render_template,
                    url_for)
 from flask_login import current_user, login_required
+from .forms import ImportResultsForm
 from werkzeug.utils import secure_filename
 from . import services
 from .. import db
 from ..jobs.forms import AddFileSetupJobForm, AddNLPJobForm, AddOCRJobForm
-from ..models import Job, JobInput
+from ..models import Job, JobInput, Result, ResultFile, User
+from .tables import ResultTable, ResultItem
 import json
 import os
+import html
+from datetime import datetime
 
 
 SERVICES = {'corpus_analysis': {'name': 'Corpus analysis'},
@@ -81,3 +85,84 @@ def service(service):
     return render_template('services/{}.html.j2'.format(service),
                            title=SERVICES[service]['name'],
                            add_job_form=add_job_form)
+
+
+@services.route('/import_results', methods=['GET', 'POST'])
+@login_required
+def import_results():
+    '''
+    View to import one json result file. Uses the ImportReultFileForm.
+    '''
+    # TODO: Build in a check if uploaded json is actually a result file and
+    # not something different
+    # Add the possibility to add several result files at once. 
+    import_results_form = ImportResultsForm(prefix='add-result-file-form')
+    if import_results_form.is_submitted():
+        if not import_results_form.validate():
+            return make_response(import_results_form.errors, 400)
+        # Save the file
+        # result creation only happens on file save to avoid creating a result
+        # object in the db everytime by just visiting the import_results page
+        result = Result(user_id=current_user.id)
+        db.session.add(result)
+        db.session.commit()
+        if not (result.creator == current_user
+                or current_user.is_administrator()):
+            abort(403)
+        dir = os.path.join(str(result.user_id),
+                           'results',
+                           'corpus_analysis_results',
+                           str(result.id))
+        abs_dir = os.path.join(current_app.config['NOPAQUE_STORAGE'], dir)
+        abs_file_path = os.path.join(abs_dir,
+                                     import_results_form.file.data.filename)
+        os.makedirs(abs_dir)
+        import_results_form.file.data.save(abs_file_path)
+        # Saves all needed metadata entries in one json field
+        with open(abs_file_path, 'r') as f:
+            corpus_metadata = json.load(f)
+        del corpus_metadata['matches']
+        del corpus_metadata['cpos_lookup']
+        result_file = ResultFile(
+            result_id=result.id,
+            dir=dir,
+            filename=import_results_form.file.data.filename)
+        result.corpus_metadata = corpus_metadata
+        db.session.add(result_file)
+        db.session.commit()
+        flash('Result file added!', 'result')
+        return make_response(
+            {'redirect_url': url_for('services.results')},
+            201)
+    return render_template('services/import_results.html.j2',
+                           import_results_form=import_results_form,
+                           title='Add corpus file')
+
+
+@services.route('/results')
+@login_required
+def results():
+    '''
+    Shows an overview of imported results.
+    '''
+    # get all results of current user
+    results = User.query.get(current_user.id).results
+    # create table row for every result#
+
+    def __p_time(time_str):
+        return datetime.strptime(time_str, '%Y-%m-%dT%H:%M:%S.%f')
+
+    items = [ResultItem(r.corpus_metadata['query'],
+                        r.corpus_metadata['match_count'],
+                        r.corpus_metadata['corpus_name'],
+                        __p_time(r.corpus_metadata['corpus_creation_date']),
+                        __p_time(r.corpus_metadata['corpus_analysis_date']),
+                        r.corpus_metadata['corpus_type'],
+                        r.id) for r in results]
+    # create table with items and save it as html
+    table = html.unescape(ResultTable(items).__html__())
+    # add class=list to table body with string replacement
+    table = table.replace('tbody', 'tbody class=list', 1)
+    return render_template('services/results.html.j2',
+                           title='Imported Results',
+                           table=table)