From 61098535bea7cfbc4bff3d82f8e9317d04898cee Mon Sep 17 00:00:00 2001 From: dameyer Date: Sun, 2 Oct 2022 23:47:15 +0200 Subject: [PATCH 01/19] Update gitignore. --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 76c4e06b..14a22fe1 100644 --- a/.gitignore +++ b/.gitignore @@ -39,3 +39,4 @@ __pycache__ # Virtual environment venv +.idea From 9802fdd175028c5e75c41358b935dd9c6e29c743 Mon Sep 17 00:00:00 2001 From: dameyer Date: Sun, 2 Oct 2022 23:49:14 +0200 Subject: [PATCH 02/19] Add form and template for adding a model. --- app/contributions/forms.py | 75 +++++++++++++++++++ app/contributions/routes.py | 11 ++- .../contributions/contribute.html.j2 | 32 ++++++++ 3 files changed, 116 insertions(+), 2 deletions(-) create mode 100644 app/contributions/forms.py create mode 100644 app/templates/contributions/contribute.html.j2 diff --git a/app/contributions/forms.py b/app/contributions/forms.py new file mode 100644 index 00000000..f00e49c3 --- /dev/null +++ b/app/contributions/forms.py @@ -0,0 +1,75 @@ +from flask_wtf import FlaskForm +from wtforms import ( + BooleanField, + PasswordField, + StringField, + SubmitField, + SelectMultipleField, + ValidationError, FieldList, IntegerField +) +from wtforms.validators import InputRequired, Email, EqualTo, Length, Regexp +from app.models import User + + +class ContributionForm(FlaskForm): + + # The id field will be generated on insert. + # The user_id will be retrieved from the user who is performing this operation. + + # title = db.Column(db.String(64)) + title = StringField( + 'Title', + validators=[InputRequired(), Length(max=64)] + ) + + # description = db.Column(db.String(255)) + description = StringField( + 'Description', + validators=[InputRequired(), Length(max=255)] + ) + + # version = db.Column(db.String(16)) + version = StringField( + 'Version', + validators=[InputRequired(), Length(max=16)] + ) + + # compatible_service_versions = db.Column(ContainerColumn(list, 255)) + compatible_service_versions = SelectMultipleField( + 'Compatible Service Versions', + choices=["asd", "blub", "bla"] + ) + + # publisher = db.Column(db.String(128)) + publisher = StringField( + 'Publisher', + validators=[InputRequired(), Length(max=128)] + ) + + # publisher_url = db.Column(db.String(512)) + publisher_url = StringField( + 'Publisher URL', + validators=[InputRequired(), Length(max=512)] + ) + + # publishing_url = db.Column(db.String(512)) + publishing_url = StringField( + 'Publishing URL', + validators=[InputRequired(), Length(max=512)] + ) + + # publishing_year = db.Column(db.Integer) + publishing_year = IntegerField( + 'Publishing year', + validators=[InputRequired()] + ) + + # shared = db.Column(db.Boolean, default=False) + shared = BooleanField( + 'Shared', + validators=[InputRequired()] + ) + + submit = SubmitField() + + diff --git a/app/contributions/routes.py b/app/contributions/routes.py index 80c6a82d..34d54d41 100644 --- a/app/contributions/routes.py +++ b/app/contributions/routes.py @@ -1,7 +1,9 @@ +from flask import render_template from flask_login import login_required from app.decorators import permission_required from app.models import Permission from . import bp +from .forms import ContributionForm @bp.before_request @@ -11,6 +13,11 @@ def before_request(): pass -@bp.route('') +@bp.route('', methods=['GET', 'POST']) def contributions(): - pass + form = ContributionForm(prefix='contribution-form') + return render_template( + 'contributions/contribute.html.j2', + form=form, + title='Contribution' + ) diff --git a/app/templates/contributions/contribute.html.j2 b/app/templates/contributions/contribute.html.j2 new file mode 100644 index 00000000..6789e1f8 --- /dev/null +++ b/app/templates/contributions/contribute.html.j2 @@ -0,0 +1,32 @@ +{% extends "base.html.j2" %} +{% import "materialize/wtf.html.j2" as wtf %} + + +{% block page_content %} +
+
+
+

{{ title }}

+

+ In order to add a new model, please fill in the form below. +

+ +
+
+ {{ form.hidden_tag() }} + {{ wtf.render_field(form.title) }} + {{ wtf.render_field(form.description) }} + {{ wtf.render_field(form.publisher) }} + {{ wtf.render_field(form.publisher_url) }} + {{ wtf.render_field(form.publishing_url) }} + {{ wtf.render_field(form.publishing_year) }} + {{ wtf.render_field(form.shared) }} + {{ wtf.render_field(form.version) }} + {{ wtf.render_field(form.compatible_service_versions) }} + {{ wtf.render_field(form.submit, class_='width-100', material_icon='send') }} + +
+
+
+
+{% endblock page_content %} \ No newline at end of file From 236d3e7ee40cfaf757549e6e6255b26fec3fa21d Mon Sep 17 00:00:00 2001 From: Patrick Jentsch Date: Wed, 12 Oct 2022 10:23:05 +0200 Subject: [PATCH 03/19] Rename tables for pipeline models --- ...=> TesseractOCRPipelineModel.defaults.yml} | 0 app/api/auth.py | 1 - app/api/jobs.py | 12 ++-- app/api/schemas.py | 13 +++- app/api/users.py | 2 +- app/cli.py | 15 +++-- app/daemon/job_utils.py | 8 +-- app/models.py | 35 ++++++----- app/services/forms.py | 8 +-- app/services/routes.py | 16 ++--- .../services/tesseract_ocr_pipeline.html.j2 | 4 +- .../services/transkribus_htr_pipeline.html.j2 | 4 +- migrations/versions/63b2cc26a01f_.py | 59 +++++++++++++++++++ nopaque.py | 8 +-- 14 files changed, 127 insertions(+), 58 deletions(-) rename app/{TesseractOCRModel.defaults.yml => TesseractOCRPipelineModel.defaults.yml} (100%) create mode 100644 migrations/versions/63b2cc26a01f_.py diff --git a/app/TesseractOCRModel.defaults.yml b/app/TesseractOCRPipelineModel.defaults.yml similarity index 100% rename from app/TesseractOCRModel.defaults.yml rename to app/TesseractOCRPipelineModel.defaults.yml diff --git a/app/api/auth.py b/app/api/auth.py index afda3a30..398052f5 100644 --- a/app/api/auth.py +++ b/app/api/auth.py @@ -1,4 +1,3 @@ -from flask import current_app from flask_httpauth import HTTPBasicAuth, HTTPTokenAuth from werkzeug.exceptions import Forbidden, Unauthorized from app.models import User diff --git a/app/api/jobs.py b/app/api/jobs.py index e730f2e6..2eaecd3f 100644 --- a/app/api/jobs.py +++ b/app/api/jobs.py @@ -4,8 +4,8 @@ from apifairy.decorators import body, other_responses from flask import abort, Blueprint from werkzeug.exceptions import InternalServerError from app import db, hashids -from app.models import Job, JobInput, JobStatus, TesseractOCRModel -from .schemas import EmptySchema, JobSchema, SpaCyNLPPipelineJobSchema, TesseractOCRPipelineJobSchema, TesseractOCRModelSchema +from app.models import Job, JobInput, JobStatus, TesseractOCRPipelineModel +from .schemas import EmptySchema, JobSchema, SpaCyNLPPipelineJobSchema, TesseractOCRPipelineJobSchema, TesseractOCRPipelineModelSchema from .auth import auth_error_responses, token_auth @@ -14,8 +14,8 @@ job_schema = JobSchema() jobs_schema = JobSchema(many=True) spacy_nlp_pipeline_job_schema = SpaCyNLPPipelineJobSchema() tesseract_ocr_pipeline_job_schema = TesseractOCRPipelineJobSchema() -tesseract_ocr_model_schema = TesseractOCRModelSchema() -tesseract_ocr_models_schema = TesseractOCRModelSchema(many=True) +tesseract_ocr_pipeline_model_schema = TesseractOCRPipelineModelSchema() +tesseract_ocr_pipeline_models_schema = TesseractOCRPipelineModelSchema(many=True) @bp.route('', methods=['GET']) @@ -60,11 +60,11 @@ def create_tesseract_ocr_pipeline_job(args): @bp.route('/tesseract-ocr-pipeline/models', methods=['GET']) @authenticate(token_auth) -@response(tesseract_ocr_models_schema) +@response(tesseract_ocr_pipeline_models_schema) @other_responses(auth_error_responses) def get_tesseract_ocr_models(): """Get all Tesseract OCR Models""" - return TesseractOCRModel.query.all() + return TesseractOCRPipelineModel.query.all() @bp.route('/', methods=['DELETE']) diff --git a/app/api/schemas.py b/app/api/schemas.py index 394b1ebb..9474bd1a 100644 --- a/app/api/schemas.py +++ b/app/api/schemas.py @@ -3,7 +3,14 @@ from marshmallow import validate, validates, ValidationError from marshmallow.decorators import post_dump from app import ma from app.auth import USERNAME_REGEX -from app.models import Job, JobStatus, TesseractOCRModel, Token, User, UserSettingJobStatusMailNotificationLevel +from app.models import ( + Job, + JobStatus, + TesseractOCRPipelineModel, + Token, + User, + UserSettingJobStatusMailNotificationLevel +) from app.services import SERVICES @@ -21,9 +28,9 @@ class TokenSchema(ma.SQLAlchemySchema): refresh_token = ma.String() -class TesseractOCRModelSchema(ma.SQLAlchemySchema): +class TesseractOCRPipelineModelSchema(ma.SQLAlchemySchema): class Meta: - model = TesseractOCRModel + model = TesseractOCRPipelineModel ordered = True hashid = ma.String(data_key='id', dump_only=True) diff --git a/app/api/users.py b/app/api/users.py index fc180df0..c9ea5d39 100644 --- a/app/api/users.py +++ b/app/api/users.py @@ -1,7 +1,7 @@ from apifairy import authenticate, body, response from apifairy.decorators import other_responses -from flask import abort, Blueprint, current_app +from flask import abort, Blueprint from werkzeug.exceptions import InternalServerError from app import db from app.email import create_message, send diff --git a/app/cli.py b/app/cli.py index d9b4fdf0..bfaf8754 100644 --- a/app/cli.py +++ b/app/cli.py @@ -2,7 +2,12 @@ from flask import current_app from flask_migrate import upgrade import click import os -from app.models import Role, User, TesseractOCRModel, TranskribusHTRModel +from app.models import ( + Role, + User, + TesseractOCRPipelineModel, + TranskribusHTRPipelineModel +) def _make_default_dirs(): @@ -35,10 +40,10 @@ def register(app): Role.insert_defaults() current_app.logger.info('Insert/Update default users') User.insert_defaults() - current_app.logger.info('Insert/Update default TesseractOCRModels') - TesseractOCRModel.insert_defaults() - current_app.logger.info('Insert/Update default TranskribusHTRModels') - TranskribusHTRModel.insert_defaults() + current_app.logger.info('Insert/Update default TesseractOCRPipelineModels') + TesseractOCRPipelineModel.insert_defaults() + current_app.logger.info('Insert/Update default TranskribusHTRPipelineModels') + TranskribusHTRPipelineModel.insert_defaults() @app.cli.group() def converter(): diff --git a/app/daemon/job_utils.py b/app/daemon/job_utils.py index 38d6c48b..0f74f3a0 100644 --- a/app/daemon/job_utils.py +++ b/app/daemon/job_utils.py @@ -3,8 +3,8 @@ from app.models import ( Job, JobResult, JobStatus, - TesseractOCRModel, - TranskribusHTRModel + TesseractOCRPipelineModel, + TranskribusHTRPipelineModel ) from datetime import datetime from flask import current_app @@ -61,7 +61,7 @@ def _create_job_service(job): if 'binarization' in job.service_args and job.service_args['binarization']: command += ' --binarize' elif job.service == 'transkribus-htr-pipeline': - transkribus_htr_model = TranskribusHTRModel.query.get(job.service_args['model']) + transkribus_htr_model = TranskribusHTRPipelineModel.query.get(job.service_args['model']) command += f' -m {transkribus_htr_model.transkribus_model_id}' readcoop_username = current_app.config.get('NOPAQUE_READCOOP_USERNAME') command += f' --readcoop-username "{readcoop_username}"' @@ -96,7 +96,7 @@ def _create_job_service(job): else: job.status = JobStatus.FAILED return - model = TesseractOCRModel.query.get(model_id) + model = TesseractOCRPipelineModel.query.get(model_id) if model is None: job.status = JobStatus.FAILED return diff --git a/app/models.py b/app/models.py index 21a64d35..beab7d6e 100644 --- a/app/models.py +++ b/app/models.py @@ -23,7 +23,6 @@ from app.email import create_message TRANSKRIBUS_HTR_MODELS = \ json.loads(requests.get('https://transkribus.eu/TrpServer/rest/models/text', params={'docType': 'handwritten'}).content)['trpModelMetadata'] # noqa - ############################################################################## # enums # ############################################################################## @@ -274,14 +273,14 @@ class User(HashidMixin, UserMixin, db.Model): last_seen = db.Column(db.DateTime()) # Backrefs: role: Role # Relationships - tesseract_ocr_models = db.relationship( - 'TesseractOCRModel', + tesseract_ocr_pipeline_models = db.relationship( + 'TesseractOCRPipelineModel', backref='user', cascade='all, delete-orphan', lazy='dynamic' ) - transkribus_htr_models = db.relationship( - 'TranskribusHTRModel', + transkribus_htr_pipeline_models = db.relationship( + 'TranskribusHTRPipelineModel', backref='user', cascade='all, delete-orphan', lazy='dynamic' @@ -342,7 +341,7 @@ class User(HashidMixin, UserMixin, db.Model): db.session.refresh(user) try: os.mkdir(user.path) - os.mkdir(os.path.join(user.path, 'tesseract_ocr_models')) + os.mkdir(os.path.join(user.path, 'tesseract_ocr_pipeline_models')) os.mkdir(os.path.join(user.path, 'corpora')) os.mkdir(os.path.join(user.path, 'jobs')) except OSError as e: @@ -518,14 +517,14 @@ class User(HashidMixin, UserMixin, db.Model): x.hashid: x.to_json(relationships=True) for x in self.jobs } - _json['tesseract_ocr_models'] = { + _json['tesseract_ocr_pipeline_models'] = { x.hashid: x.to_json(relationships=True) - for x in self.tesseract_ocr_models + for x in self.tesseract_ocr_pipeline_models } return _json -class TesseractOCRModel(FileMixin, HashidMixin, db.Model): - __tablename__ = 'tesseract_ocr_models' +class TesseractOCRPipelineModel(FileMixin, HashidMixin, db.Model): + __tablename__ = 'tesseract_ocr_pipeline_models' # Primary key id = db.Column(db.Integer, primary_key=True) # Foreign keys @@ -546,7 +545,7 @@ class TesseractOCRModel(FileMixin, HashidMixin, db.Model): def path(self): return os.path.join( self.user.path, - 'tesseract_ocr_models', + 'tesseract_ocr_pipeline_models', str(self.id) ) @@ -555,12 +554,12 @@ class TesseractOCRModel(FileMixin, HashidMixin, db.Model): nopaque_user = User.query.filter_by(username='nopaque').first() defaults_file = os.path.join( os.path.dirname(os.path.abspath(__file__)), - 'TesseractOCRModel.defaults.yml' + 'TesseractOCRPipelineModel.defaults.yml' ) with open(defaults_file, 'r') as f: defaults = yaml.safe_load(f) for m in defaults: - model = TesseractOCRModel.query.filter_by(title=m['title'], version=m['version']).first() # noqa + model = TesseractOCRPipelineModel.query.filter_by(title=m['title'], version=m['version']).first() # noqa if model is not None: model.compatible_service_versions = m['compatible_service_versions'] model.description = m['description'] @@ -572,7 +571,7 @@ class TesseractOCRModel(FileMixin, HashidMixin, db.Model): model.title = m['title'] model.version = m['version'] continue - model = TesseractOCRModel( + model = TesseractOCRPipelineModel( compatible_service_versions=m['compatible_service_versions'], description=m['description'], publisher=m['publisher'], @@ -623,8 +622,8 @@ class TesseractOCRModel(FileMixin, HashidMixin, db.Model): return _json -class TranskribusHTRModel(HashidMixin, db.Model): - __tablename__ = 'transkribus_htr_models' +class TranskribusHTRPipelineModel(HashidMixin, db.Model): + __tablename__ = 'transkribus_htr_pipeline_models' # Primary key id = db.Column(db.Integer, primary_key=True) # Foreign keys @@ -643,12 +642,12 @@ class TranskribusHTRModel(HashidMixin, db.Model): # and 'docType' in m and m['docType'] == 'handwritten' # ] for m in TRANSKRIBUS_HTR_MODELS: - model = TranskribusHTRModel.query.filter_by(transkribus_model_id=m['modelId']).first() # noqa + model = TranskribusHTRPipelineModel.query.filter_by(transkribus_model_id=m['modelId']).first() # noqa if model is not None: model.shared = True model.transkribus_model_id = m['modelId'] continue - model = TranskribusHTRModel( + model = TranskribusHTRPipelineModel( transkribus_model_id=m['modelId'], shared=True, user=nopaque_user, diff --git a/app/services/forms.py b/app/services/forms.py index 008e0d0a..ea1c1e70 100644 --- a/app/services/forms.py +++ b/app/services/forms.py @@ -12,8 +12,8 @@ from wtforms import ( from wtforms.validators import InputRequired, Length from app.models import ( TRANSKRIBUS_HTR_MODELS, - TesseractOCRModel, - TranskribusHTRModel + TesseractOCRPipelineModel, + TranskribusHTRPipelineModel ) from . import SERVICES @@ -77,7 +77,7 @@ class CreateTesseractOCRPipelineJobForm(CreateJobBaseForm): if 'disabled' in self.binarization.render_kw: del self.binarization.render_kw['disabled'] models = [ - x for x in TesseractOCRModel.query.filter().all() + x for x in TesseractOCRPipelineModel.query.filter().all() if version in x.compatible_service_versions and (x.shared == True or x.user == current_user) ] self.model.choices = [('', 'Choose your option')] @@ -119,7 +119,7 @@ class CreateTranskribusHTRPipelineJobForm(CreateJobBaseForm): if 'disabled' in self.binarization.render_kw: del self.binarization.render_kw['disabled'] models = [ - x for x in TranskribusHTRModel.query.filter().all() + x for x in TranskribusHTRPipelineModel.query.filter().all() if x.shared == True or x.user == current_user ] self.model.choices = [('', 'Choose your option')] diff --git a/app/services/routes.py b/app/services/routes.py index 913acbb7..4f019525 100644 --- a/app/services/routes.py +++ b/app/services/routes.py @@ -5,9 +5,9 @@ from app.models import ( Job, JobInput, JobStatus, - TesseractOCRModel, + TesseractOCRPipelineModel, TRANSKRIBUS_HTR_MODELS, - TranskribusHTRModel + TranskribusHTRPipelineModel ) from . import bp, SERVICES from .forms import ( @@ -95,14 +95,14 @@ def tesseract_ocr_pipeline(): message = Markup(f'Job "{job.title}" created') flash(message, 'job') return {}, 201, {'Location': job.url} - tesseract_ocr_models = [ - x for x in TesseractOCRModel.query.all() + tesseract_ocr_pipeline_models = [ + x for x in TesseractOCRPipelineModel.query.all() if version in x.compatible_service_versions and (x.shared == True or x.user == current_user) ] return render_template( 'services/tesseract_ocr_pipeline.html.j2', form=form, - tesseract_ocr_models=tesseract_ocr_models, + tesseract_ocr_pipeline_models=tesseract_ocr_pipeline_models, title=service_manifest['name'] ) @@ -145,8 +145,8 @@ def transkribus_htr_pipeline(): message = Markup(f'Job "{job.title}" created') flash(message, 'job') return {}, 201, {'Location': job.url} - transkribus_htr_models = [ - x for x in TranskribusHTRModel.query.all() + transkribus_htr_pipeline_models = [ + x for x in TranskribusHTRPipelineModel.query.all() if x.shared == True or x.user == current_user ] return render_template( @@ -154,7 +154,7 @@ def transkribus_htr_pipeline(): form=form, title=service_manifest['name'], TRANSKRIBUS_HTR_MODELS=TRANSKRIBUS_HTR_MODELS, - transkribus_htr_models=transkribus_htr_models + transkribus_htr_pipeline_models=transkribus_htr_pipeline_models ) diff --git a/app/templates/services/tesseract_ocr_pipeline.html.j2 b/app/templates/services/tesseract_ocr_pipeline.html.j2 index c38c3965..982265bc 100644 --- a/app/templates/services/tesseract_ocr_pipeline.html.j2 +++ b/app/templates/services/tesseract_ocr_pipeline.html.j2 @@ -160,8 +160,8 @@ - {% for m in tesseract_ocr_models %} - + {% for m in tesseract_ocr_pipeline_models %} + {{ m.title }} {% if m.description == '' %} Description is not available. diff --git a/app/templates/services/transkribus_htr_pipeline.html.j2 b/app/templates/services/transkribus_htr_pipeline.html.j2 index 7aedbd4f..79519f3a 100644 --- a/app/templates/services/transkribus_htr_pipeline.html.j2 +++ b/app/templates/services/transkribus_htr_pipeline.html.j2 @@ -157,8 +157,8 @@

Transkribus HTR Pipeline models

    - {% for m in transkribus_htr_models %} -
  • + {% for m in transkribus_htr_pipeline_models %} +
  • {% for m_info in TRANSKRIBUS_HTR_MODELS if m_info['modelId'] == m.transkribus_model_id %}
    widgets{{ m_info.name }}
    diff --git a/migrations/versions/63b2cc26a01f_.py b/migrations/versions/63b2cc26a01f_.py new file mode 100644 index 00000000..5876ed3c --- /dev/null +++ b/migrations/versions/63b2cc26a01f_.py @@ -0,0 +1,59 @@ +"""Rename pipeline model tables + +Revision ID: 63b2cc26a01f +Revises: 260b57d5f4e7 +Create Date: 2022-10-11 14:32:13.227364 + +""" +from alembic import op +from flask import current_app +import os +from app.models import User + +# revision identifiers, used by Alembic. +revision = '63b2cc26a01f' +down_revision = '260b57d5f4e7' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + users = User.query.all() + for user in users: + old_tesseract_ocr_pipeline_model_path = os.path.join( + user.path, + 'tesseract_ocr_models' + ) + new_tesseract_ocr_pipeline_model_path = os.path.join( + user.path, + 'tesseract_ocr_pipeline_models' + ) + os.rename( + old_tesseract_ocr_pipeline_model_path, + new_tesseract_ocr_pipeline_model_path + ) + op.rename_table('tesseract_ocr_models', 'tesseract_ocr_pipeline_models') + op.rename_table('transkribus_htr_models', 'transkribus_htr_pipeline_models') + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + users = User.query.all() + for user in users: + old_tesseract_ocr_pipeline_model_path = os.path.join( + user.path, + 'tesseract_ocr_models' + ) + new_tesseract_ocr_pipeline_model_path = os.path.join( + user.path, + 'tesseract_ocr_pipeline_models' + ) + os.rename( + new_tesseract_ocr_pipeline_model_path, + old_tesseract_ocr_pipeline_model_path + ) + op.rename_table('tesseract_ocr_pipeline_models', 'tesseract_ocr_models') + op.rename_table('transkribus_htr_pipeline_models', 'transkribus_htr_models') + # ### end Alembic commands ### diff --git a/nopaque.py b/nopaque.py index 96746d97..457add2c 100644 --- a/nopaque.py +++ b/nopaque.py @@ -12,8 +12,8 @@ from app.models import ( JobResult, Permission, Role, - TesseractOCRModel, - TranskribusHTRModel, + TesseractOCRPipelineModel, + TranskribusHTRPipelineModel, User ) # noqa from flask import Flask # noqa @@ -42,8 +42,8 @@ def make_shell_context() -> Dict[str, Any]: 'JobResult': JobResult, 'Permission': Permission, 'Role': Role, - 'TesseractOCRModel': TesseractOCRModel, - 'TranskribusHTRModel': TranskribusHTRModel, + 'TesseractOCRPipelineModel': TesseractOCRPipelineModel, + 'TranskribusHTRPipelineModel': TranskribusHTRPipelineModel, 'User': User } From f96bac93f28ed27b691230fd836c6aee6b8dce92 Mon Sep 17 00:00:00 2001 From: Inga Kirschnick Date: Wed, 12 Oct 2022 14:05:01 +0200 Subject: [PATCH 04/19] Optical code adjustments --- app/static/js/CorpusAnalysis/QueryBuilder.js | 125 +++++++++++-------- 1 file changed, 70 insertions(+), 55 deletions(-) diff --git a/app/static/js/CorpusAnalysis/QueryBuilder.js b/app/static/js/CorpusAnalysis/QueryBuilder.js index 256dadd2..e221e19b 100644 --- a/app/static/js/CorpusAnalysis/QueryBuilder.js +++ b/app/static/js/CorpusAnalysis/QueryBuilder.js @@ -164,14 +164,20 @@ class ConcordanceQueryBuilder { } + + + // ########################################################################## + // #################### General Functions ################################### + // ########################################################################## + //#region General Functions - closeQueryBuilderModal(closeInstance){ + closeQueryBuilderModal(closeInstance) { let instance = M.Modal.getInstance(closeInstance); instance.close(); } - showPositionalAttrArea(){ + showPositionalAttrArea() { this.elements.positionalAttrArea.classList.remove('hide'); this.elements.wordBuilder.classList.remove("hide"); this.elements.inputOptions.classList.remove("hide"); @@ -194,7 +200,7 @@ class ConcordanceQueryBuilder { this.elements.positionalAttr.value = "word"; } - showStructuralAttrArea(){ + showStructuralAttrArea() { this.elements.positionalAttrArea.classList.add('hide'); this.elements.structuralAttrArea.classList.remove('hide'); } @@ -207,15 +213,15 @@ class ConcordanceQueryBuilder { let chipColor = 'style="background-color:#'; // Sets chip color, depending on the type of element - if (dataType === 'start-sentence' || dataType === 'end-sentence'){ + if (dataType === 'start-sentence' || dataType === 'end-sentence') { chipColor += 'FD9720'; - }else if (dataType === "start-empty-entity" || dataType === "start-entity" || dataType === "end-entity"){ + } else if (dataType === "start-empty-entity" || dataType === "start-entity" || dataType === "end-entity") { chipColor += 'A6E22D'; - }else if (dataType === "text-annotation"){ + } else if (dataType === "text-annotation") { chipColor += '2FBBAB'; - }else if (dataType === "token"){ + } else if (dataType === "token") { chipColor += '28B3D1'; - }else { + } else { chipColor = ''; } @@ -232,9 +238,9 @@ class ConcordanceQueryBuilder { buttonElement.addEventListener("click", () => {this.deleteAttr(buttonElement);}); // Ensures that metadata is always at the end of the query: - if(this.elements.yourQuery.lastChild === null || this.elements.yourQuery.lastChild.dataset.type !== "text-annotation"){ + if (this.elements.yourQuery.lastChild === null || this.elements.yourQuery.lastChild.dataset.type !== "text-annotation") { this.elements.yourQuery.appendChild(buttonElement); - }else if (this.elements.yourQuery.lastChild.dataset.type === "text-annotation"){ + } else if (this.elements.yourQuery.lastChild.dataset.type === "text-annotation") { this.elements.yourQuery.insertBefore(buttonElement, this.elements.yourQuery.lastChild); } @@ -242,14 +248,14 @@ class ConcordanceQueryBuilder { this.queryPreviewBuilder(); // Opens a hint about the possible functions for editing the query when the first chip is added. It is displayed for 5 seconds and then deleted. - if (this.elements.yourQuery.classList.contains("tooltipped")){ + if (this.elements.yourQuery.classList.contains("tooltipped")) { let tooltipInstance = M.Tooltip.getInstance(this.elements.yourQuery); tooltipInstance.tooltipEl.style.background = "#98ACD2"; tooltipInstance.tooltipEl.style.borderTop = "solid 4px #0064A3" tooltipInstance.tooltipEl.style.padding = "10px"; tooltipInstance.tooltipEl.style.color = "black"; - if (tooltipInstance !== undefined){ + if (tooltipInstance !== undefined) { setTimeout(() => { tooltipInstance.open(); setTimeout(() => { @@ -261,23 +267,23 @@ class ConcordanceQueryBuilder { } } - //#region Drag&Drop Events - dragStartHandler(event){ + //#region Drag&Drop Events + dragStartHandler(event) { this.elements.dropButton = event.target; let targetChip = ` -
    - Drop here -
    +
    + Drop here +
    `.trim(); let childNodes = this.elements.yourQuery.querySelectorAll("div:not(.target)"); setTimeout(() => { - for (let element of childNodes){ - if(element === event.target){ + for (let element of childNodes) { + if (element === event.target) { continue; - }else if (element === event.target.nextSibling){ + } else if (element === event.target.nextSibling) { continue; - }else { + } else { element.insertAdjacentHTML("beforebegin", targetChip) } } @@ -285,37 +291,37 @@ class ConcordanceQueryBuilder { },0); } - dragOverHandler(event){ + dragOverHandler(event) { event.preventDefault(); } - dragEnterHandler(event){ + dragEnterHandler(event) { event.preventDefault(); event.target.style.borderStyle = "solid dotted"; } - dragLeaveHandler(event){ + dragLeaveHandler(event) { event.preventDefault(); event.target.style.borderStyle = "hidden"; } - dragEndHandler(event){ + dragEndHandler(event) { let targets = document.querySelectorAll('.target'); - for (let target of targets){ + for (let target of targets) { target.remove(); } } - dropHandler(event){ + dropHandler(event) { let dropzone = event.target; - for (let i = 0; i < dropzone.parentElement.childNodes.length; i++){ - if (dropzone === dropzone.parentElement.childNodes[i]){ + for (let i = 0; i < dropzone.parentElement.childNodes.length; i++) { + if (dropzone === dropzone.parentElement.childNodes[i]) { nodeIndex = i; } } - for (let i = 0; i < dropzone.parentElement.childNodes.length; i++){ - if (this.elements.dropButton === dropzone.parentElement.childNodes[i]){ + for (let i = 0; i < dropzone.parentElement.childNodes.length; i++) { + if (this.elements.dropButton === dropzone.parentElement.childNodes[i]) { draggedElementIndex = i; } } @@ -325,15 +331,15 @@ class ConcordanceQueryBuilder { } //#endregion Drag&Drop Events - queryPreviewBuilder(){ + queryPreviewBuilder() { this.elements.yourQueryContent = []; for (let element of this.elements.yourQuery.childNodes) { let queryElement = decodeURI(element.dataset.query); - if (queryElement.includes("<")){ + if (queryElement.includes("<")) { queryElement = queryElement.replace("<", "<"); } - if (queryElement.includes(">")){ + if (queryElement.includes(">")) { queryElement = queryElement.replace(">", ">"); } if (queryElement !== "undefined") { @@ -351,7 +357,7 @@ class ConcordanceQueryBuilder { this.elements.yourQuery.removeChild(attr); this.elements.counter -= 1; - if(this.elements.counter === 0){ + if (this.elements.counter === 0) { this.elements.queryContainer.classList.add("hide"); } @@ -362,10 +368,10 @@ class ConcordanceQueryBuilder { this.elements.yourQueryContent = []; for (let element of this.elements.yourQuery.childNodes) { - let queryElement = decodeURI(element.dataset.query); - if (queryElement !== "undefined"){ - this.elements.yourQueryContent.push(queryElement); - } + let queryElement = decodeURI(element.dataset.query); + if (queryElement !== "undefined") { + this.elements.yourQueryContent.push(queryElement); + } } let queryString = this.elements.yourQueryContent.join(' '); @@ -373,7 +379,6 @@ class ConcordanceQueryBuilder { this.elements.concordanceQueryBuilder.classList.add('modal-close'); this.elements.extFormQuery.value = queryString; - } clearAll() { @@ -411,6 +416,13 @@ class ConcordanceQueryBuilder { //#endregion General Functions + + + + // ########################################################################## + // ############## Token Attribute Builder Functions ######################### + // ########################################################################## + //#region Token Attribute Builder Functions //#region General functions of the Token Builder @@ -441,7 +453,7 @@ class ConcordanceQueryBuilder { } } - hideEverything(){ + hideEverything() { this.elements.wordBuilder.classList.add("hide"); this.elements.lemmaBuilder.classList.add("hide"); @@ -472,11 +484,7 @@ class ConcordanceQueryBuilder { this.elements.tokenQuery.appendChild(buttonElement); } - deleteTokenAttr(attr){ - // let tokenQuery = this.elements.tokenQuery.childNodes; - // console.log(tokenQuery); - // console.log(this.elements.tokenQuery); - console.log(this.elements.tokenQuery.childNodes.length); + deleteTokenAttr(attr) { if (this.elements.tokenQuery.childNodes.length < 2) { this.elements.tokenQuery.removeChild(attr); this.wordBuilder(); @@ -493,22 +501,22 @@ class ConcordanceQueryBuilder { this.elements.cancelBool = false; let emptyTokenCheck = false; - if (this.elements.ignoreCase.checked){ + if (this.elements.ignoreCase.checked) { c = ' %c'; - }else{ + } else { c = ''; } - for (let element of this.elements.tokenQuery.childNodes){ + for (let element of this.elements.tokenQuery.childNodes) { tokenQueryContent += ' ' + element.firstChild.data + ' '; tokenQueryText += decodeURI(element.dataset.tokentext); - if (element.innerText.indexOf("empty token") !== -1){ + if (element.innerText.indexOf("empty token") !== -1) { emptyTokenCheck = true; } } - if (this.elements.tokenQueryFilled === false){ + if (this.elements.tokenQueryFilled === false) { switch (this.elements.positionalAttr.value) { case "word": if (this.elements.wordInput.value === "") { @@ -562,7 +570,7 @@ class ConcordanceQueryBuilder { } // cancelBool looks in disableTokenSubmit() whether a value is passed. If the input fields/dropdowns are empty (cancelBool === true), no token is added. - if (this.elements.cancelBool === false){ + if (this.elements.cancelBool === false) { // Square brackets are added only if it is not an empty token (where they are already present). if (emptyTokenCheck === false) { tokenQueryText = '[' + tokenQueryText + ']'; @@ -813,9 +821,9 @@ class ConcordanceQueryBuilder { let tokenQueryText; let c; - if (this.elements.ignoreCase.checked){ + if (this.elements.ignoreCase.checked) { c = ' %c'; - }else{ + } else { c = ''; } @@ -859,10 +867,17 @@ class ConcordanceQueryBuilder { //#endregion Token Attribute Builder Functions + + + + // ########################################################################## + // ############ Structural Attribute Builder Functions ###################### + // ########################################################################## + //#region Structural Attribute Builder Functions addSentence() { this.hideEverything(); - if(this.elements.sentence.text === 'End Sentence') { + if (this.elements.sentence.text === 'End Sentence') { this.buttonfactory('end-sentence', 'Sentence End', ''); this.elements.sentence.innerHTML = 'Sentence'; } else { From 2e45db10cab6e185eb17b6f0fbb153cb0ee876f3 Mon Sep 17 00:00:00 2001 From: Inga Kirschnick Date: Wed, 12 Oct 2022 14:08:42 +0200 Subject: [PATCH 05/19] Optical adjustments 2.0 --- app/static/js/CorpusAnalysis/QueryBuilder.js | 540 +++++++++---------- 1 file changed, 270 insertions(+), 270 deletions(-) diff --git a/app/static/js/CorpusAnalysis/QueryBuilder.js b/app/static/js/CorpusAnalysis/QueryBuilder.js index e221e19b..42dc9968 100644 --- a/app/static/js/CorpusAnalysis/QueryBuilder.js +++ b/app/static/js/CorpusAnalysis/QueryBuilder.js @@ -8,31 +8,31 @@ class ConcordanceQueryBuilder { counter: 0, yourQueryContent: [], queryContent:[], - concordanceQueryBuilder: document.querySelector("#concordance-query-builder"), - concordanceQueryBuilderButton: document.querySelector("#concordance-query-builder-button"), - closeQueryBuilder: document.querySelector("#close-query-builder"), + concordanceQueryBuilder: document.querySelector('#concordance-query-builder'), + concordanceQueryBuilderButton: document.querySelector('#concordance-query-builder-button'), + closeQueryBuilder: document.querySelector('#close-query-builder'), queryBuilderTutorialModal: document.querySelector('#query-builder-tutorial-modal'), //#region QueryBuilder Elements positionalAttrButton: document.querySelector('#positional-attr-button'), positionalAttrArea: document.querySelector('#positional-attr'), - positionalAttr: document.querySelector("#token-attr"), + positionalAttr: document.querySelector('#token-attr'), structuralAttrButton: document.querySelector('#structural-attr-button'), - structuralAttrArea: document.querySelector("#structural-attr"), + structuralAttrArea: document.querySelector('#structural-attr'), queryContainer: document.querySelector('#query-container'), - buttonPreparer: document.querySelector("#button-preparer"), - yourQuery: document.querySelector("#your-query"), - insertQueryButton: document.querySelector("#insert-query-button"), + buttonPreparer: document.querySelector('#button-preparer'), + yourQuery: document.querySelector('#your-query'), + insertQueryButton: document.querySelector('#insert-query-button'), queryPreview: document.querySelector('#query-preview'), - tokenQuery: document.querySelector("#token-query"), - tokenBuilderContent: document.querySelector("#token-builder-content"), - tokenSubmitButton: document.querySelector("#token-submit"), + tokenQuery: document.querySelector('#token-query'), + tokenBuilderContent: document.querySelector('#token-builder-content'), + tokenSubmitButton: document.querySelector('#token-submit'), extFormQuery: document.querySelector('#concordance-extension-form-query'), - dropButton: "", + dropButton: '', queryBuilderTutorialInfoIcon: document.querySelector('#query-builder-tutorial-info-icon'), - tokenTutorialInfoIcon: document.querySelector("#token-tutorial-info-icon"), + tokenTutorialInfoIcon: document.querySelector('#token-tutorial-info-icon'), editTokenTutorialInfoIcon: document.querySelector('#edit-options-tutorial-info-icon'), structuralAttributeTutorialInfoIcon: document.querySelector('#add-structural-attribute-tutorial-info-icon'), generalOptionsQueryBuilderTutorialInfoIcon: document.querySelector('#general-options-query-builder-tutorial-info-icon'), @@ -42,73 +42,73 @@ class ConcordanceQueryBuilder { //#region Strucutral Attributes - sentence:document.querySelector("#sentence"), - entity: document.querySelector("#entity"), - textAnnotation: document.querySelector("#text-annotation"), + sentence:document.querySelector('#sentence'), + entity: document.querySelector('#entity'), + textAnnotation: document.querySelector('#text-annotation'), - entityBuilder: document.querySelector("#entity-builder"), - englishEntType: document.querySelector("#english-ent-type"), - germanEntType: document.querySelector("#german-ent-type"), - emptyEntity: document.querySelector("#empty-entity"), + entityBuilder: document.querySelector('#entity-builder'), + englishEntType: document.querySelector('#english-ent-type'), + germanEntType: document.querySelector('#german-ent-type'), + emptyEntity: document.querySelector('#empty-entity'), entityAnyType: false, - textAnnotationBuilder: document.querySelector("#text-annotation-builder"), - textAnnotationOptions: document.querySelector("#text-annotation-options"), - textAnnotationInput: document.querySelector("#text-annotation-input"), - textAnnotationSubmit: document.querySelector("#text-annotation-submit"), + textAnnotationBuilder: document.querySelector('#text-annotation-builder'), + textAnnotationOptions: document.querySelector('#text-annotation-options'), + textAnnotationInput: document.querySelector('#text-annotation-input'), + textAnnotationSubmit: document.querySelector('#text-annotation-submit'), noValueMetadataMessage: document.querySelector('#no-value-metadata-message'), //#endregion Structural Attributes //#region Token Attributes tokenQueryFilled: false, - lemma: document.querySelector("#lemma"), - emptyToken: document.querySelector("#empty-token"), - word: document.querySelector("#word"), - lemma: document.querySelector("#lemma"), - pos: document.querySelector("#pos"), - simplePosButton: document.querySelector("#simple-pos-button"), - incidenceModifiers: document.querySelector("[data-target='incidence-modifiers']"), - or: document.querySelector("#or"), - and: document.querySelector("#and"), + lemma: document.querySelector('#lemma'), + emptyToken: document.querySelector('#empty-token'), + word: document.querySelector('#word'), + lemma: document.querySelector('#lemma'), + pos: document.querySelector('#pos'), + simplePosButton: document.querySelector('#simple-pos-button'), + incidenceModifiers: document.querySelector('[data-target="incidence-modifiers"]'), + or: document.querySelector('#or'), + and: document.querySelector('#and'), //#region Word and Lemma Elements - wordBuilder: document.querySelector("#word-builder"), - lemmaBuilder: document.querySelector("#lemma-builder"), - inputOptions: document.querySelector("#input-options"), - incidenceModifiersButton: document.querySelector("#incidence-modifiers-button"), + wordBuilder: document.querySelector('#word-builder'), + lemmaBuilder: document.querySelector('#lemma-builder'), + inputOptions: document.querySelector('#input-options'), + incidenceModifiersButton: document.querySelector('#incidence-modifiers-button'), conditionContainer: document.querySelector('#condition-container'), - wordInput: document.querySelector("#word-input"), - lemmaInput: document.querySelector("#lemma-input"), - ignoreCaseCheckbox : document.querySelector("#ignore-case-checkbox"), - ignoreCase: document.querySelector("input[type='checkbox']"), - wildcardChar: document.querySelector("#wildcard-char"), - optionGroup: document.querySelector("#option-group"), + wordInput: document.querySelector('#word-input'), + lemmaInput: document.querySelector('#lemma-input'), + ignoreCaseCheckbox : document.querySelector('#ignore-case-checkbox'), + ignoreCase: document.querySelector('input[type="checkbox"]'), + wildcardChar: document.querySelector('#wildcard-char'), + optionGroup: document.querySelector('#option-group'), //#endregion Word and Lemma Elements //#region posBuilder Elements - englishPosBuilder: document.querySelector("#english-pos-builder"), - englishPos: document.querySelector("#english-pos"), - germanPosBuilder: document.querySelector("#german-pos-builder"), - germanPos: document.querySelector("#german-pos"), + englishPosBuilder: document.querySelector('#english-pos-builder'), + englishPos: document.querySelector('#english-pos'), + germanPosBuilder: document.querySelector('#german-pos-builder'), + germanPos: document.querySelector('#german-pos'), //#endregion posBuilder Elements //#region simple_posBuilder Elements - simplePosBuilder: document.querySelector("#simplepos-builder"), - simplePos: document.querySelector("#simple-pos"), + simplePosBuilder: document.querySelector('#simplepos-builder'), + simplePos: document.querySelector('#simple-pos'), //#endregion simple_posBuilder Elements //#region incidence modifiers - oneOrMore: document.querySelector("#one-or-more"), - zeroOrMore: document.querySelector("#zero-or-more"), - zeroOrOne: document.querySelector("#zero-or-one"), - exactlyN: document.querySelector("#exactlyN"), - betweenNM: document.querySelector("#betweenNM"), - nInput: document.querySelector("#n-input"), - nSubmit: document.querySelector("#n-submit"), - nmInput: document.querySelector("#n-m-input"), - mInput: document.querySelector("#m-input"), - nmSubmit: document.querySelector("#n-m-submit"), + oneOrMore: document.querySelector('#one-or-more'), + zeroOrMore: document.querySelector('#zero-or-more'), + zeroOrOne: document.querySelector('#zero-or-one'), + exactlyN: document.querySelector('#exactlyN'), + betweenNM: document.querySelector('#betweenNM'), + nInput: document.querySelector('#n-input'), + nSubmit: document.querySelector('#n-submit'), + nmInput: document.querySelector('#n-m-input'), + mInput: document.querySelector('#m-input'), + nmSubmit: document.querySelector('#n-m-submit'), //#endregion incidence modifiers cancelBool: false, @@ -116,48 +116,48 @@ class ConcordanceQueryBuilder { //#endregion Token Attributes } - this.elements.closeQueryBuilder.addEventListener("click", () => {this.closeQueryBuilderModal(this.elements.concordanceQueryBuilder);}); - this.elements.concordanceQueryBuilderButton.addEventListener("click", () => {this.clearAll();}); - this.elements.insertQueryButton.addEventListener("click", () => {this.insertQuery();}); - this.elements.positionalAttrButton.addEventListener("click", () => {this.showPositionalAttrArea();}); - this.elements.structuralAttrButton.addEventListener("click", () => {this.showStructuralAttrArea();}); + this.elements.closeQueryBuilder.addEventListener('click', () => {this.closeQueryBuilderModal(this.elements.concordanceQueryBuilder);}); + this.elements.concordanceQueryBuilderButton.addEventListener('click', () => {this.clearAll();}); + this.elements.insertQueryButton.addEventListener('click', () => {this.insertQuery();}); + this.elements.positionalAttrButton.addEventListener('click', () => {this.showPositionalAttrArea();}); + this.elements.structuralAttrButton.addEventListener('click', () => {this.showStructuralAttrArea();}); //#region Structural Attribute Event Listeners - this.elements.sentence.addEventListener("click", () => {this.addSentence();}); - this.elements.entity.addEventListener("click", () => {this.addEntity();}); - this.elements.textAnnotation.addEventListener("click", () => {this.addTextAnnotation();}); + this.elements.sentence.addEventListener('click', () => {this.addSentence();}); + this.elements.entity.addEventListener('click', () => {this.addEntity();}); + this.elements.textAnnotation.addEventListener('click', () => {this.addTextAnnotation();}); - this.elements.englishEntType.addEventListener("change", () => {this.englishEntTypeHandler();}); - this.elements.germanEntType.addEventListener("change", () => {this.germanEntTypeHandler();}); - this.elements.emptyEntity.addEventListener("click", () => {this.emptyEntityButton();}); + this.elements.englishEntType.addEventListener('change', () => {this.englishEntTypeHandler();}); + this.elements.germanEntType.addEventListener('change', () => {this.germanEntTypeHandler();}); + this.elements.emptyEntity.addEventListener('click', () => {this.emptyEntityButton();}); - this.elements.textAnnotationSubmit.addEventListener("click", () => {this.textAnnotationSubmitHandler();}); + this.elements.textAnnotationSubmit.addEventListener('click', () => {this.textAnnotationSubmitHandler();}); //#endregion //#region Token Attribute Event Listeners - this.elements.queryBuilderTutorialInfoIcon.addEventListener("click", () => {this.tutorialIconHandler('#query-builder-tutorial-start');}); - this.elements.tokenTutorialInfoIcon.addEventListener("click", () => {this.tutorialIconHandler('#add-new-token-tutorial');}); - this.elements.editTokenTutorialInfoIcon.addEventListener("click", () => {this.tutorialIconHandler('#edit-options-tutorial');}); - this.elements.structuralAttributeTutorialInfoIcon.addEventListener("click", () => {this.tutorialIconHandler('#add-structural-attribute-tutorial');}); - this.elements.generalOptionsQueryBuilderTutorialInfoIcon.addEventListener("click", () => {this.tutorialIconHandler('#general-options-query-builder');}); + this.elements.queryBuilderTutorialInfoIcon.addEventListener('click', () => {this.tutorialIconHandler('#query-builder-tutorial-start');}); + this.elements.tokenTutorialInfoIcon.addEventListener('click', () => {this.tutorialIconHandler('#add-new-token-tutorial');}); + this.elements.editTokenTutorialInfoIcon.addEventListener('click', () => {this.tutorialIconHandler('#edit-options-tutorial');}); + this.elements.structuralAttributeTutorialInfoIcon.addEventListener('click', () => {this.tutorialIconHandler('#add-structural-attribute-tutorial');}); + this.elements.generalOptionsQueryBuilderTutorialInfoIcon.addEventListener('click', () => {this.tutorialIconHandler('#general-options-query-builder');}); - this.elements.positionalAttr.addEventListener("change", () => {this.tokenTypeSelector();}); - this.elements.tokenSubmitButton.addEventListener("click", () => {this.addToken();}); + this.elements.positionalAttr.addEventListener('change', () => {this.tokenTypeSelector();}); + this.elements.tokenSubmitButton.addEventListener('click', () => {this.addToken();}); - this.elements.ignoreCase.addEventListener("change", () => {this.inputOptionHandler(this.elements.ignoreCase);}); - this.elements.wildcardChar.addEventListener("click", () => {this.inputOptionHandler(this.elements.wildcardChar);}); - this.elements.optionGroup.addEventListener("click", () => {this.inputOptionHandler(this.elements.optionGroup);}); + this.elements.ignoreCase.addEventListener('change', () => {this.inputOptionHandler(this.elements.ignoreCase);}); + this.elements.wildcardChar.addEventListener('click', () => {this.inputOptionHandler(this.elements.wildcardChar);}); + this.elements.optionGroup.addEventListener('click', () => {this.inputOptionHandler(this.elements.optionGroup);}); - this.elements.oneOrMore.addEventListener("click", () => {this.incidenceModifiersHandler(this.elements.oneOrMore);}); - this.elements.zeroOrMore.addEventListener("click", () => {this.incidenceModifiersHandler(this.elements.zeroOrMore);}); - this.elements.zeroOrOne.addEventListener("click", () => {this.incidenceModifiersHandler(this.elements.zeroOrOne);}); - this.elements.nSubmit.addEventListener("click", () => {this.nSubmitHandler();}); - this.elements.nmSubmit.addEventListener("click", () => {this.nmSubmitHandler();}); + this.elements.oneOrMore.addEventListener('click', () => {this.incidenceModifiersHandler(this.elements.oneOrMore);}); + this.elements.zeroOrMore.addEventListener('click', () => {this.incidenceModifiersHandler(this.elements.zeroOrMore);}); + this.elements.zeroOrOne.addEventListener('click', () => {this.incidenceModifiersHandler(this.elements.zeroOrOne);}); + this.elements.nSubmit.addEventListener('click', () => {this.nSubmitHandler();}); + this.elements.nmSubmit.addEventListener('click', () => {this.nmSubmitHandler();}); - this.elements.or.addEventListener("click", () => {this.orHandler();}); - this.elements.and.addEventListener("click", () => {this.andHandler();}); + this.elements.or.addEventListener('click', () => {this.orHandler();}); + this.elements.and.addEventListener('click', () => {this.andHandler();}); //#endregion Token Attribute Event Listeners @@ -179,11 +179,11 @@ class ConcordanceQueryBuilder { showPositionalAttrArea() { this.elements.positionalAttrArea.classList.remove('hide'); - this.elements.wordBuilder.classList.remove("hide"); - this.elements.inputOptions.classList.remove("hide"); + this.elements.wordBuilder.classList.remove('hide'); + this.elements.inputOptions.classList.remove('hide'); this.elements.incidenceModifiersButton.classList.remove('hide'); - this.elements.conditionContainer.classList.remove("hide"); - this.elements.ignoreCaseCheckbox.classList.remove("hide"); + this.elements.conditionContainer.classList.remove('hide'); + this.elements.ignoreCaseCheckbox.classList.remove('hide'); this.elements.structuralAttrArea.classList.add('hide'); this.elements.lemmaBuilder.classList.add('hide'); this.elements.englishPosBuilder.classList.add('hide'); @@ -192,12 +192,12 @@ class ConcordanceQueryBuilder { this.elements.tokenQueryFilled = false; - window.location.href = "#token-builder-content"; + window.location.href = '#token-builder-content'; // Resets materialize select field to default value let SelectInstance = M.FormSelect.getInstance(this.elements.positionalAttr); - SelectInstance.input.value = "word"; - this.elements.positionalAttr.value = "word"; + SelectInstance.input.value = 'word'; + this.elements.positionalAttr.value = 'word'; } showStructuralAttrArea() { @@ -207,7 +207,7 @@ class ConcordanceQueryBuilder { buttonfactory(dataType, prettyText, queryText) { - window.location.href = "#query-container"; + window.location.href = '#query-container'; this.elements.counter += 1; queryText = encodeURI(queryText); let chipColor = 'style="background-color:#'; @@ -215,45 +215,45 @@ class ConcordanceQueryBuilder { // Sets chip color, depending on the type of element if (dataType === 'start-sentence' || dataType === 'end-sentence') { chipColor += 'FD9720'; - } else if (dataType === "start-empty-entity" || dataType === "start-entity" || dataType === "end-entity") { + } else if (dataType === 'start-empty-entity' || dataType === 'start-entity' || dataType === 'end-entity') { chipColor += 'A6E22D'; - } else if (dataType === "text-annotation") { + } else if (dataType === 'text-annotation') { chipColor += '2FBBAB'; - } else if (dataType === "token") { + } else if (dataType === 'token') { chipColor += '28B3D1'; } else { chipColor = ''; } - // Creates a chip with the previously selected element. Is first created in the "BuilderElement" and populated with an EventListener, then moved to "yourQuery". + // Creates a chip with the previously selected element. Is first created in the 'BuilderElement' and populated with an EventListener, then moved to 'yourQuery'. let builderElement = document.createElement('div'); builderElement.innerHTML +=` -
    +
    ${prettyText} - close + close
    `.trim(); let buttonElement = builderElement.firstElementChild; - buttonElement.addEventListener("click", () => {this.deleteAttr(buttonElement);}); + buttonElement.addEventListener('click', () => {this.deleteAttr(buttonElement);}); // Ensures that metadata is always at the end of the query: - if (this.elements.yourQuery.lastChild === null || this.elements.yourQuery.lastChild.dataset.type !== "text-annotation") { + if (this.elements.yourQuery.lastChild === null || this.elements.yourQuery.lastChild.dataset.type !== 'text-annotation') { this.elements.yourQuery.appendChild(buttonElement); - } else if (this.elements.yourQuery.lastChild.dataset.type === "text-annotation") { + } else if (this.elements.yourQuery.lastChild.dataset.type === 'text-annotation') { this.elements.yourQuery.insertBefore(buttonElement, this.elements.yourQuery.lastChild); } - this.elements.queryContainer.classList.remove("hide"); + this.elements.queryContainer.classList.remove('hide'); this.queryPreviewBuilder(); // Opens a hint about the possible functions for editing the query when the first chip is added. It is displayed for 5 seconds and then deleted. - if (this.elements.yourQuery.classList.contains("tooltipped")) { + if (this.elements.yourQuery.classList.contains('tooltipped')) { let tooltipInstance = M.Tooltip.getInstance(this.elements.yourQuery); - tooltipInstance.tooltipEl.style.background = "#98ACD2"; - tooltipInstance.tooltipEl.style.borderTop = "solid 4px #0064A3" - tooltipInstance.tooltipEl.style.padding = "10px"; - tooltipInstance.tooltipEl.style.color = "black"; + tooltipInstance.tooltipEl.style.background = '#98ACD2'; + tooltipInstance.tooltipEl.style.borderTop = 'solid 4px #0064A3' + tooltipInstance.tooltipEl.style.padding = '10px'; + tooltipInstance.tooltipEl.style.color = 'black'; if (tooltipInstance !== undefined) { setTimeout(() => { @@ -263,7 +263,7 @@ class ConcordanceQueryBuilder { }, 5000); }, 500); } - this.elements.yourQuery.classList.remove("tooltipped"); + this.elements.yourQuery.classList.remove('tooltipped'); } } @@ -271,11 +271,11 @@ class ConcordanceQueryBuilder { dragStartHandler(event) { this.elements.dropButton = event.target; let targetChip = ` -
    +
    Drop here
    `.trim(); - let childNodes = this.elements.yourQuery.querySelectorAll("div:not(.target)"); + let childNodes = this.elements.yourQuery.querySelectorAll('div:not(.target)'); setTimeout(() => { for (let element of childNodes) { @@ -284,10 +284,10 @@ class ConcordanceQueryBuilder { } else if (element === event.target.nextSibling) { continue; } else { - element.insertAdjacentHTML("beforebegin", targetChip) + element.insertAdjacentHTML('beforebegin', targetChip) } } - childNodes[childNodes.length-1].insertAdjacentHTML("afterend", targetChip); + childNodes[childNodes.length-1].insertAdjacentHTML('afterend', targetChip); },0); } @@ -297,12 +297,12 @@ class ConcordanceQueryBuilder { dragEnterHandler(event) { event.preventDefault(); - event.target.style.borderStyle = "solid dotted"; + event.target.style.borderStyle = 'solid dotted'; } dragLeaveHandler(event) { event.preventDefault(); - event.target.style.borderStyle = "hidden"; + event.target.style.borderStyle = 'hidden'; } dragEndHandler(event) { @@ -336,19 +336,19 @@ class ConcordanceQueryBuilder { for (let element of this.elements.yourQuery.childNodes) { let queryElement = decodeURI(element.dataset.query); - if (queryElement.includes("<")) { - queryElement = queryElement.replace("<", "<"); + if (queryElement.includes('<')) { + queryElement = queryElement.replace('<', '<'); } - if (queryElement.includes(">")) { - queryElement = queryElement.replace(">", ">"); + if (queryElement.includes('>')) { + queryElement = queryElement.replace('>', '>'); } - if (queryElement !== "undefined") { + if (queryElement !== 'undefined') { this.elements.yourQueryContent.push(queryElement); } } let queryString = this.elements.yourQueryContent.join(' '); - queryString += ";"; + queryString += ';'; this.elements.queryPreview.innerHTML = queryString; } @@ -358,7 +358,7 @@ class ConcordanceQueryBuilder { this.elements.counter -= 1; if (this.elements.counter === 0) { - this.elements.queryContainer.classList.add("hide"); + this.elements.queryContainer.classList.add('hide'); } this.queryPreviewBuilder(); @@ -369,20 +369,20 @@ class ConcordanceQueryBuilder { for (let element of this.elements.yourQuery.childNodes) { let queryElement = decodeURI(element.dataset.query); - if (queryElement !== "undefined") { + if (queryElement !== 'undefined') { this.elements.yourQueryContent.push(queryElement); } } let queryString = this.elements.yourQueryContent.join(' '); - queryString += ";"; + queryString += ';'; this.elements.concordanceQueryBuilder.classList.add('modal-close'); this.elements.extFormQuery.value = queryString; } clearAll() { - // Everything is reset. After 5 seconds for 5 seconds (with "instance"), a message is displayed indicating that further information can be obtained via the question mark icon + // Everything is reset. After 5 seconds for 5 seconds (with 'instance'), a message is displayed indicating that further information can be obtained via the question mark icon let instance = M.Tooltip.getInstance(this.elements.queryBuilderTutorialInfoIcon); this.hideEverything(); @@ -429,22 +429,22 @@ class ConcordanceQueryBuilder { tokenTypeSelector() { this.hideEverything(); switch (this.elements.positionalAttr.value) { - case "word": + case 'word': this.wordBuilder(); break; - case "lemma": + case 'lemma': this.lemmaBuilder(); break; - case "english-pos": + case 'english-pos': this.englishPosHandler(); break; - case "german-pos": + case 'german-pos': this.germanPosHandler(); break; - case "simple-pos-button": + case 'simple-pos-button': this.simplePosBuilder(); break; - case "empty-token": + case 'empty-token': this.emptyTokenHandler(); break; default: @@ -455,17 +455,17 @@ class ConcordanceQueryBuilder { hideEverything() { - this.elements.wordBuilder.classList.add("hide"); - this.elements.lemmaBuilder.classList.add("hide"); - this.elements.ignoreCaseCheckbox.classList.add("hide"); - this.elements.inputOptions.classList.add("hide"); - this.elements.incidenceModifiersButton.classList.add("hide"); - this.elements.conditionContainer.classList.add("hide"); - this.elements.englishPosBuilder.classList.add("hide"); - this.elements.germanPosBuilder.classList.add("hide"); - this.elements.simplePosBuilder.classList.add("hide"); - this.elements.entityBuilder.classList.add("hide"); - this.elements.textAnnotationBuilder.classList.add("hide"); + this.elements.wordBuilder.classList.add('hide'); + this.elements.lemmaBuilder.classList.add('hide'); + this.elements.ignoreCaseCheckbox.classList.add('hide'); + this.elements.inputOptions.classList.add('hide'); + this.elements.incidenceModifiersButton.classList.add('hide'); + this.elements.conditionContainer.classList.add('hide'); + this.elements.englishPosBuilder.classList.add('hide'); + this.elements.germanPosBuilder.classList.add('hide'); + this.elements.simplePosBuilder.classList.add('hide'); + this.elements.entityBuilder.classList.add('hide'); + this.elements.textAnnotationBuilder.classList.add('hide'); } @@ -475,12 +475,12 @@ class ConcordanceQueryBuilder { let buttonElement; builderElement = document.createElement('div'); builderElement.innerHTML = ` -
    +
    ${prettyText} - close + close
    `; buttonElement = builderElement.firstElementChild; - buttonElement.addEventListener("click", () => {this.deleteTokenAttr(buttonElement);}); + buttonElement.addEventListener('click', () => {this.deleteTokenAttr(buttonElement);}); this.elements.tokenQuery.appendChild(buttonElement); } @@ -496,8 +496,8 @@ class ConcordanceQueryBuilder { addToken() { let c; - let tokenQueryContent = ""; //for ButtonFactory(prettyText) - let tokenQueryText = ""; //for ButtonFactory(queryText) + let tokenQueryContent = ''; //for ButtonFactory(prettyText) + let tokenQueryText = ''; //for ButtonFactory(queryText) this.elements.cancelBool = false; let emptyTokenCheck = false; @@ -511,55 +511,55 @@ class ConcordanceQueryBuilder { for (let element of this.elements.tokenQuery.childNodes) { tokenQueryContent += ' ' + element.firstChild.data + ' '; tokenQueryText += decodeURI(element.dataset.tokentext); - if (element.innerText.indexOf("empty token") !== -1) { + if (element.innerText.indexOf('empty token') !== -1) { emptyTokenCheck = true; } } if (this.elements.tokenQueryFilled === false) { switch (this.elements.positionalAttr.value) { - case "word": - if (this.elements.wordInput.value === "") { + case 'word': + if (this.elements.wordInput.value === '') { this.disableTokenSubmit(); } else { tokenQueryContent += `word=${this.elements.wordInput.value}${c}`; - tokenQueryText += `word="${this.elements.wordInput.value}"${c}`; + tokenQueryText += `word='${this.elements.wordInput.value}'${c}`; this.elements.wordInput.value = ''; } break; - case "lemma": - if (this.elements.lemmaInput.value === "") { + case 'lemma': + if (this.elements.lemmaInput.value === '') { this.disableTokenSubmit(); } else { tokenQueryContent += `lemma=${this.elements.lemmaInput.value}${c}`; - tokenQueryText += `lemma="${this.elements.lemmaInput.value}"${c}`; + tokenQueryText += `lemma='${this.elements.lemmaInput.value}'${c}`; this.elements.lemmaInput.value = ''; } break; - case "english-pos": - if (this.elements.englishPos.value === "default") { + case 'english-pos': + if (this.elements.englishPos.value === 'default') { this.disableTokenSubmit(); } else { tokenQueryContent += `pos=${this.elements.englishPos.value}`; - tokenQueryText += `pos="${this.elements.englishPos.value}"`; + tokenQueryText += `pos='${this.elements.englishPos.value}'`; this.elements.englishPos.value = ''; } break; - case "german-pos": - if (this.elements.germanPos.value === "default") { + case 'german-pos': + if (this.elements.germanPos.value === 'default') { this.disableTokenSubmit(); } else { tokenQueryContent += `pos=${this.elements.germanPos.value}`; - tokenQueryText += `pos="${this.elements.germanPos.value}"`; + tokenQueryText += `pos='${this.elements.germanPos.value}'`; this.elements.germanPos.value = ''; } break; - case "simple-pos-button": - if (this.elements.simplePos.value === "default") { + case 'simple-pos-button': + if (this.elements.simplePos.value === 'default') { this.disableTokenSubmit(); } else { tokenQueryContent += `simple_pos=${this.elements.simplePos.value}`; - tokenQueryText += `simple_pos="${this.elements.simplePos.value}"`; + tokenQueryText += `simple_pos='${this.elements.simplePos.value}'`; this.elements.simplePos.value = ''; } break; @@ -578,17 +578,17 @@ class ConcordanceQueryBuilder { this.buttonfactory('token', tokenQueryContent, tokenQueryText); this.hideEverything(); this.elements.positionalAttrArea.classList.add('hide'); - this.elements.tokenQuery.innerHTML = ""; + this.elements.tokenQuery.innerHTML = ''; } } disableTokenSubmit() { this.elements.cancelBool = true; - this.elements.tokenSubmitButton.classList.add("red"); + this.elements.tokenSubmitButton.classList.add('red'); this.elements.noValueMessage.classList.remove('hide'); setTimeout(() => { - this.elements.tokenSubmitButton.classList.remove("red"); + this.elements.tokenSubmitButton.classList.remove('red'); }, 500); setTimeout(() => { this.elements.noValueMessage.classList.add('hide'); @@ -600,75 +600,75 @@ class ConcordanceQueryBuilder { //#region Dropdown Select Handler wordBuilder() { this.hideEverything(); - this.elements.wordInput.value = ""; - this.elements.wordBuilder.classList.remove("hide"); - this.elements.inputOptions.classList.remove("hide"); + this.elements.wordInput.value = ''; + this.elements.wordBuilder.classList.remove('hide'); + this.elements.inputOptions.classList.remove('hide'); this.elements.incidenceModifiersButton.classList.remove('hide'); - this.elements.conditionContainer.classList.remove("hide"); - this.elements.ignoreCaseCheckbox.classList.remove("hide"); + this.elements.conditionContainer.classList.remove('hide'); + this.elements.ignoreCaseCheckbox.classList.remove('hide'); // Resets materialize select field to default value let SelectInstance = M.FormSelect.getInstance(this.elements.positionalAttr); - SelectInstance.input.value = "word"; - this.elements.positionalAttr.value = "word"; + SelectInstance.input.value = 'word'; + this.elements.positionalAttr.value = 'word'; } lemmaBuilder() { this.hideEverything(); - this.elements.lemmaBuilder.classList.remove("hide"); - this.elements.inputOptions.classList.remove("hide"); + this.elements.lemmaBuilder.classList.remove('hide'); + this.elements.inputOptions.classList.remove('hide'); this.elements.incidenceModifiersButton.classList.remove('hide'); - this.elements.conditionContainer.classList.remove("hide"); - this.elements.ignoreCaseCheckbox.classList.remove("hide"); + this.elements.conditionContainer.classList.remove('hide'); + this.elements.ignoreCaseCheckbox.classList.remove('hide'); } englishPosHandler() { this.hideEverything(); - this.elements.englishPosBuilder.classList.remove("hide"); + this.elements.englishPosBuilder.classList.remove('hide'); this.elements.incidenceModifiersButton.classList.remove('hide'); - this.elements.conditionContainer.classList.remove("hide"); + this.elements.conditionContainer.classList.remove('hide'); // Resets materialize select dropdown let selectInstance = M.FormSelect.getInstance(this.elements.englishPos); - selectInstance.input.value = "English pos tagset"; - this.elements.englishPos.value = "default"; + selectInstance.input.value = 'English pos tagset'; + this.elements.englishPos.value = 'default'; } germanPosHandler() { this.hideEverything(); - this.elements.germanPosBuilder.classList.remove("hide"); + this.elements.germanPosBuilder.classList.remove('hide'); this.elements.incidenceModifiersButton.classList.remove('hide'); - this.elements.conditionContainer.classList.remove("hide"); + this.elements.conditionContainer.classList.remove('hide'); // Resets materialize select dropdown let selectInstance = M.FormSelect.getInstance(this.elements.germanPos); - selectInstance.input.value = "German pos tagset"; - this.elements.germanPos.value = "default"; + selectInstance.input.value = 'German pos tagset'; + this.elements.germanPos.value = 'default'; } simplePosBuilder() { this.hideEverything(); - this.elements.simplePosBuilder.classList.remove("hide"); + this.elements.simplePosBuilder.classList.remove('hide'); this.elements.incidenceModifiersButton.classList.remove('hide'); - this.elements.conditionContainer.classList.remove("hide"); + this.elements.conditionContainer.classList.remove('hide'); this.elements.simplePos.selectedIndex = 0; // Resets materialize select dropdown let selectInstance = M.FormSelect.getInstance(this.elements.simplePos); - selectInstance.input.value = "simple_pos tagset"; - this.elements.simplePos.value = "default"; + selectInstance.input.value = 'simple_pos tagset'; + this.elements.simplePos.value = 'default'; } emptyTokenHandler() { - this.tokenButtonfactory("empty token", "[]"); + this.tokenButtonfactory('empty token', '[]'); this.elements.tokenQueryFilled = true; this.hideEverything(); this.elements.incidenceModifiersButton.classList.remove('hide'); } //#endregion Dropdown Select Handler - //#region Options to edit your token - Wildcard Charakter, Option Group, Incidence Modifiers, Ignore Case, "and", "or" + //#region Options to edit your token - Wildcard Charakter, Option Group, Incidence Modifiers, Ignore Case, 'and', 'or' inputOptionHandler(elem) { let input; @@ -695,35 +695,35 @@ class ConcordanceQueryBuilder { instance.close(); switch (this.elements.positionalAttr.value) { - case "word": - this.elements.wordInput.value += " {" + this.elements.nInput.value + "}"; + case 'word': + this.elements.wordInput.value += ' {' + this.elements.nInput.value + '}'; break; - case "lemma": - this.elements.lemmaInput.value += " {" + this.elements.nInput.value + "}"; + case 'lemma': + this.elements.lemmaInput.value += ' {' + this.elements.nInput.value + '}'; break; - case "english-pos": + case 'english-pos': this.elements.tokenQueryFilled = true; - this.tokenButtonfactory(`pos=${this.elements.englishPos.value}`, `pos="${this.elements.englishPos.value}"`); - this.tokenButtonfactory("{" + this.elements.nInput.value + "}", "{" + this.elements.nInput.value + "}"); - this.elements.englishPosBuilder.classList.add("hide"); - this.elements.incidenceModifiersButton.classList.add("hide"); + this.tokenButtonfactory(`pos=${this.elements.englishPos.value}`, `pos='${this.elements.englishPos.value}'`); + this.tokenButtonfactory('{' + this.elements.nInput.value + '}', '{' + this.elements.nInput.value + '}'); + this.elements.englishPosBuilder.classList.add('hide'); + this.elements.incidenceModifiersButton.classList.add('hide'); break; - case "german-pos": + case 'german-pos': this.elements.tokenQueryFilled = true; - this.tokenButtonfactory(`pos=${this.elements.germanPos.value}`, `pos="${this.elements.germanPos.value}"`); - this.tokenButtonfactory("{" + this.elements.nInput.value + "}", "{" + this.elements.nInput.value + "}"); - this.elements.germanPosBuilder.classList.add("hide"); - this.elements.incidenceModifiersButton.classList.add("hide"); + this.tokenButtonfactory(`pos=${this.elements.germanPos.value}`, `pos='${this.elements.germanPos.value}'`); + this.tokenButtonfactory('{' + this.elements.nInput.value + '}', '{' + this.elements.nInput.value + '}'); + this.elements.germanPosBuilder.classList.add('hide'); + this.elements.incidenceModifiersButton.classList.add('hide'); break; - case "simple-pos-button": + case 'simple-pos-button': this.elements.tokenQueryFilled = true; - this.tokenButtonfactory(`simple_pos=${this.elements.simplePos.value}`, `simple_pos="${this.elements.simplePos.value}"`); - this.tokenButtonfactory("{" + this.elements.nInput.value + "}", "{" + this.elements.nInput.value + "}"); - this.elements.simplePosBuilder.classList.add("hide"); - this.elements.incidenceModifiersButton.classList.add("hide"); + this.tokenButtonfactory(`simple_pos=${this.elements.simplePos.value}`, `simple_pos='${this.elements.simplePos.value}'`); + this.tokenButtonfactory('{' + this.elements.nInput.value + '}', '{' + this.elements.nInput.value + '}'); + this.elements.simplePosBuilder.classList.add('hide'); + this.elements.incidenceModifiersButton.classList.add('hide'); break; - case "empty-token": - this.tokenButtonfactory("{" + this.elements.nInput.value + "}", "{" + this.elements.nInput.value + "}"); + case 'empty-token': + this.tokenButtonfactory('{' + this.elements.nInput.value + '}', '{' + this.elements.nInput.value + '}'); break; default: break; @@ -736,34 +736,34 @@ class ConcordanceQueryBuilder { instance.close(); switch (this.elements.positionalAttr.value) { - case "word": + case 'word': this.elements.wordInput.value += `{${this.elements.nmInput.value}, ${this.elements.mInput.value}}`; break; - case "lemma": + case 'lemma': this.elements.lemmaInput.value += `{${this.elements.nmInput.value}, ${this.elements.mInput.value}}`; break; - case "english-pos": + case 'english-pos': this.elements.tokenQueryFilled = true; - this.tokenButtonfactory(`pos=${this.elements.englishPos.value}`, `pos="${this.elements.englishPos.value}"`); + this.tokenButtonfactory(`pos=${this.elements.englishPos.value}`, `pos='${this.elements.englishPos.value}'`); this.tokenButtonfactory(`{${this.elements.nmInput.value}, ${this.elements.mInput.value}}`, `{${this.elements.nmInput.value}, ${this.elements.mInput.value}}`); - this.elements.englishPosBuilder.classList.add("hide"); - this.elements.incidenceModifiersButton.classList.add("hide"); + this.elements.englishPosBuilder.classList.add('hide'); + this.elements.incidenceModifiersButton.classList.add('hide'); break; - case "german-pos": + case 'german-pos': this.elements.tokenQueryFilled = true; - this.tokenButtonfactory(`pos=${this.elements.germanPos.value}`, `pos="${this.elements.germanPos.value}"`); + this.tokenButtonfactory(`pos=${this.elements.germanPos.value}`, `pos='${this.elements.germanPos.value}'`); this.tokenButtonfactory(`{${this.elements.nmInput.value}, ${this.elements.mInput.value}}`, `{${this.elements.nmInput.value}, ${this.elements.mInput.value}}`); - this.elements.germanPosBuilder.classList.add("hide"); - this.elements.incidenceModifiersButton.classList.add("hide"); + this.elements.germanPosBuilder.classList.add('hide'); + this.elements.incidenceModifiersButton.classList.add('hide'); break; - case "simple-pos-button": + case 'simple-pos-button': this.elements.tokenQueryFilled = true; - this.tokenButtonfactory(`simple_pos=${this.elements.simplePos.value}`, `simple_pos="${this.elements.simplePos.value}"`); + this.tokenButtonfactory(`simple_pos=${this.elements.simplePos.value}`, `simple_pos='${this.elements.simplePos.value}'`); this.tokenButtonfactory(`{${this.elements.nmInput.value}, ${this.elements.mInput.value}}`, `{${this.elements.nmInput.value}, ${this.elements.mInput.value}}`); - this.elements.simplePosBuilder.classList.add("hide"); - this.elements.incidenceModifiersButton.classList.add("hide"); + this.elements.simplePosBuilder.classList.add('hide'); + this.elements.incidenceModifiersButton.classList.add('hide'); break; - case "empty-token": + case 'empty-token': this.tokenButtonfactory(`{${this.elements.nmInput.value}, ${this.elements.mInput.value}}`, `{${this.elements.nmInput.value}, ${this.elements.mInput.value}}`); break; default: @@ -773,25 +773,25 @@ class ConcordanceQueryBuilder { incidenceModifiersHandler(elem) { // For word and lemma, the incidence modifiers are inserted in the input field. For the others, one or two chips are created which contain the respective value of the token and the incidence modifier. - if (this.elements.positionalAttr.value === "empty-token") { + if (this.elements.positionalAttr.value === 'empty-token') { this.tokenButtonfactory(elem.innerText, elem.dataset.token); - } else if (this.elements.positionalAttr.value === "english-pos") { - this.tokenButtonfactory(`pos=${this.elements.englishPos.value}`, `pos="${this.elements.englishPos.value}"`); + } else if (this.elements.positionalAttr.value === 'english-pos') { + this.tokenButtonfactory(`pos=${this.elements.englishPos.value}`, `pos='${this.elements.englishPos.value}'`); this.tokenButtonfactory(elem.innerText, elem.dataset.token); - this.elements.englishPosBuilder.classList.add("hide"); - this.elements.incidenceModifiersButton.classList.add("hide"); + this.elements.englishPosBuilder.classList.add('hide'); + this.elements.incidenceModifiersButton.classList.add('hide'); this.elements.tokenQueryFilled = true; - } else if (this.elements.positionalAttr.value === "german-pos") { - this.tokenButtonfactory(`pos=${this.elements.germanPos.value}`, `pos="${this.elements.germanPos.value}"`); + } else if (this.elements.positionalAttr.value === 'german-pos') { + this.tokenButtonfactory(`pos=${this.elements.germanPos.value}`, `pos='${this.elements.germanPos.value}'`); this.tokenButtonfactory(elem.innerText, elem.dataset.token); - this.elements.germanPosBuilder.classList.add("hide"); - this.elements.incidenceModifiersButton.classList.add("hide"); + this.elements.germanPosBuilder.classList.add('hide'); + this.elements.incidenceModifiersButton.classList.add('hide'); this.elements.tokenQueryFilled = true; - } else if (this.elements.positionalAttr.value === "simple-pos-button") { - this.tokenButtonfactory(`simple_pos=${this.elements.simplePos.value}`, `simple_pos="${this.elements.simplePos.value}"`); + } else if (this.elements.positionalAttr.value === 'simple-pos-button') { + this.tokenButtonfactory(`simple_pos=${this.elements.simplePos.value}`, `simple_pos='${this.elements.simplePos.value}'`); this.tokenButtonfactory(elem.innerText, elem.dataset.token); - this.elements.simplePosBuilder.classList.add("hide"); - this.elements.incidenceModifiersButton.classList.add("hide"); + this.elements.simplePosBuilder.classList.add('hide'); + this.elements.incidenceModifiersButton.classList.add('hide'); this.elements.tokenQueryFilled = true; } else { let input; @@ -808,11 +808,11 @@ class ConcordanceQueryBuilder { } orHandler() { - this.conditionHandler("or", " | "); + this.conditionHandler('or', ' | '); } andHandler() { - this.conditionHandler("and", " & "); + this.conditionHandler('and', ' & '); } conditionHandler(conditionText, conditionQueryContent) { @@ -828,29 +828,29 @@ class ConcordanceQueryBuilder { } switch (this.elements.positionalAttr.value) { - case "word": + case 'word': tokenQueryContent = `word=${this.elements.wordInput.value}${c}`; - tokenQueryText = `word="${this.elements.wordInput.value}"${c}`; + tokenQueryText = `word='${this.elements.wordInput.value}'${c}`; this.elements.wordInput.value = ''; break; - case "lemma": + case 'lemma': tokenQueryContent = `lemma=${this.elements.lemmaInput.value}${c}`; - tokenQueryText = `word="${this.elements.lemmaInput.value}"${c}`; + tokenQueryText = `word='${this.elements.lemmaInput.value}'${c}`; this.elements.lemmaInput.value = ''; break; - case "english-pos": + case 'english-pos': tokenQueryContent = `pos=${this.elements.englishPos.value}`; - tokenQueryText = `pos="${this.elements.englishPos.value}"`; + tokenQueryText = `pos='${this.elements.englishPos.value}'`; this.elements.englishPos.value = ''; break; - case "german-pos": + case 'german-pos': tokenQueryContent = `pos=${this.elements.germanPos.value}`; - tokenQueryText = `pos="${this.elements.germanPos.value}"`; + tokenQueryText = `pos='${this.elements.germanPos.value}'`; this.elements.germanPos.value = ''; break; - case "simple-pos-button": + case 'simple-pos-button': tokenQueryContent = `simple_pos=${this.elements.simplePos.value}`; - tokenQueryText = `simple_pos="${this.elements.simplePos.value}"`; + tokenQueryText = `simple_pos='${this.elements.simplePos.value}'`; this.elements.simplePos.value = ''; break; default: @@ -863,7 +863,7 @@ class ConcordanceQueryBuilder { this.wordBuilder(); } - //#endregion Options to edit your token - Wildcard Charakter, Option Group, Incidence Modifiers, Ignore Case, "and", "or" + //#endregion Options to edit your token - Wildcard Charakter, Option Group, Incidence Modifiers, Ignore Case, 'and', 'or' //#endregion Token Attribute Builder Functions @@ -899,33 +899,33 @@ class ConcordanceQueryBuilder { this.elements.entity.innerHTML = 'Entity'; } else { this.hideEverything(); - this.elements.entityBuilder.classList.remove("hide"); - window.location.href = "#entity-builder"; + this.elements.entityBuilder.classList.remove('hide'); + window.location.href = '#entity-builder'; } } englishEntTypeHandler() { - this.buttonfactory('start-entity', 'Entity Type=' + this.elements.englishEntType.value, ''); + this.buttonfactory('start-entity', 'Entity Type=' + this.elements.englishEntType.value, ''); this.elements.entity.innerHTML = 'End Entity'; this.hideEverything(); this.elements.entityAnyType = false; // Resets materialize select dropdown let SelectInstance = M.FormSelect.getInstance(this.elements.englishEntType); - SelectInstance.input.value = "English ent_type"; - this.elements.englishEntType.value = "default"; + SelectInstance.input.value = 'English ent_type'; + this.elements.englishEntType.value = 'default'; } germanEntTypeHandler() { - this.buttonfactory('start-entity', 'Entity Type=' + this.elements.germanEntType.value, ''); + this.buttonfactory('start-entity', 'Entity Type=' + this.elements.germanEntType.value, ''); this.elements.entity.innerHTML = 'End Entity'; this.hideEverything(); this.elements.entityAnyType = false; // Resets materialize select dropdown let SelectInstance = M.FormSelect.getInstance(this.elements.germanEntType); - SelectInstance.input.value = "German ent_type"; - this.elements.germanEntType.value = "default"; + SelectInstance.input.value = 'German ent_type'; + this.elements.germanEntType.value = 'default'; } emptyEntityButton() { @@ -937,14 +937,14 @@ class ConcordanceQueryBuilder { addTextAnnotation() { this.hideEverything(); - this.elements.textAnnotationBuilder.classList.remove("hide"); - window.location.href = "#text-annotation-builder"; + this.elements.textAnnotationBuilder.classList.remove('hide'); + window.location.href = '#text-annotation-builder'; // Resets materialize select dropdown let SelectInstance = M.FormSelect.getInstance(this.elements.textAnnotationOptions); - SelectInstance.input.value = "address"; - this.elements.textAnnotationOptions.value = "address"; - this.elements.textAnnotationInput.value= ""; + SelectInstance.input.value = 'address'; + this.elements.textAnnotationOptions.value = 'address'; + this.elements.textAnnotationInput.value= ''; } textAnnotationSubmitHandler() { @@ -958,7 +958,7 @@ class ConcordanceQueryBuilder { this.elements.noValueMetadataMessage.classList.add('hide'); }, 3000); } else { - let queryText = `:: match.text_${this.elements.textAnnotationOptions.value}="${this.elements.textAnnotationInput.value}"`; + let queryText = `:: match.text_${this.elements.textAnnotationOptions.value}='${this.elements.textAnnotationInput.value}'`; this.buttonfactory('text-annotation', `${this.elements.textAnnotationOptions.value}=${this.elements.textAnnotationInput.value}`, queryText); this.hideEverything(); } From dc3709decbe6e82428f437195fcf99f6628c1e13 Mon Sep 17 00:00:00 2001 From: Patrick Jentsch Date: Wed, 12 Oct 2022 15:10:55 +0200 Subject: [PATCH 06/19] Remove the TranskribusHTRPipelineModel and fetch data on request. --- app/cli.py | 5 +- app/daemon/job_utils.py | 7 +-- app/models.py | 55 +------------------ app/services/forms.py | 13 +---- app/services/routes.py | 27 +++++---- .../services/transkribus_htr_pipeline.html.j2 | 12 ++-- migrations/versions/a3b727e3ff71_.py | 35 ++++++++++++ nopaque.py | 2 - 8 files changed, 64 insertions(+), 92 deletions(-) create mode 100644 migrations/versions/a3b727e3ff71_.py diff --git a/app/cli.py b/app/cli.py index bfaf8754..54226707 100644 --- a/app/cli.py +++ b/app/cli.py @@ -5,8 +5,7 @@ import os from app.models import ( Role, User, - TesseractOCRPipelineModel, - TranskribusHTRPipelineModel + TesseractOCRPipelineModel ) @@ -42,8 +41,6 @@ def register(app): User.insert_defaults() current_app.logger.info('Insert/Update default TesseractOCRPipelineModels') TesseractOCRPipelineModel.insert_defaults() - current_app.logger.info('Insert/Update default TranskribusHTRPipelineModels') - TranskribusHTRPipelineModel.insert_defaults() @app.cli.group() def converter(): diff --git a/app/daemon/job_utils.py b/app/daemon/job_utils.py index 0f74f3a0..32def73d 100644 --- a/app/daemon/job_utils.py +++ b/app/daemon/job_utils.py @@ -3,8 +3,7 @@ from app.models import ( Job, JobResult, JobStatus, - TesseractOCRPipelineModel, - TranskribusHTRPipelineModel + TesseractOCRPipelineModel ) from datetime import datetime from flask import current_app @@ -61,8 +60,8 @@ def _create_job_service(job): if 'binarization' in job.service_args and job.service_args['binarization']: command += ' --binarize' elif job.service == 'transkribus-htr-pipeline': - transkribus_htr_model = TranskribusHTRPipelineModel.query.get(job.service_args['model']) - command += f' -m {transkribus_htr_model.transkribus_model_id}' + transkribus_htr_pipeline_model_id = job.service_args['model'] + command += f' -m {transkribus_htr_pipeline_model_id}' readcoop_username = current_app.config.get('NOPAQUE_READCOOP_USERNAME') command += f' --readcoop-username "{readcoop_username}"' readcoop_password = current_app.config.get('NOPAQUE_READCOOP_PASSWORD') diff --git a/app/models.py b/app/models.py index beab7d6e..18188b49 100644 --- a/app/models.py +++ b/app/models.py @@ -1,5 +1,6 @@ from datetime import datetime, timedelta from enum import Enum, IntEnum +import re from flask import current_app, url_for from flask_hashids import HashidMixin from flask_login import UserMixin @@ -20,9 +21,6 @@ from app.converters.vrt import normalize_vrt_file from app.email import create_message -TRANSKRIBUS_HTR_MODELS = \ - json.loads(requests.get('https://transkribus.eu/TrpServer/rest/models/text', params={'docType': 'handwritten'}).content)['trpModelMetadata'] # noqa - ############################################################################## # enums # ############################################################################## @@ -279,12 +277,6 @@ class User(HashidMixin, UserMixin, db.Model): cascade='all, delete-orphan', lazy='dynamic' ) - transkribus_htr_pipeline_models = db.relationship( - 'TranskribusHTRPipelineModel', - backref='user', - cascade='all, delete-orphan', - lazy='dynamic' - ) corpora = db.relationship( 'Corpus', backref='user', @@ -622,51 +614,6 @@ class TesseractOCRPipelineModel(FileMixin, HashidMixin, db.Model): return _json -class TranskribusHTRPipelineModel(HashidMixin, db.Model): - __tablename__ = 'transkribus_htr_pipeline_models' - # Primary key - id = db.Column(db.Integer, primary_key=True) - # Foreign keys - user_id = db.Column(db.Integer, db.ForeignKey('users.id')) - # Fields - shared = db.Column(db.Boolean, default=False) - transkribus_model_id = db.Column(db.Integer) - # Backrefs: user: User - - @staticmethod - def insert_defaults(): - nopaque_user = User.query.filter_by(username='nopaque').first() - # models = [ - # m for m in TRANSKRIBUS_HTR_MODELS if True - # and 'creator' in m and m['creator'] == 'Transkribus Team' - # and 'docType' in m and m['docType'] == 'handwritten' - # ] - for m in TRANSKRIBUS_HTR_MODELS: - model = TranskribusHTRPipelineModel.query.filter_by(transkribus_model_id=m['modelId']).first() # noqa - if model is not None: - model.shared = True - model.transkribus_model_id = m['modelId'] - continue - model = TranskribusHTRPipelineModel( - transkribus_model_id=m['modelId'], - shared=True, - user=nopaque_user, - ) - db.session.add(model) - db.session.commit() - - def to_json(self, backrefs=False, relationships=False): - _json = { - 'id': self.hashid, - 'user_id': self.user.hashid, - 'shared': self.shared, - 'transkribus_model_id': self.transkribus_model_id, - } - if backrefs: - _json['user'] = self.user.to_json(backrefs=True) - return _json - - class JobInput(FileMixin, HashidMixin, db.Model): __tablename__ = 'job_inputs' # Primary key diff --git a/app/services/forms.py b/app/services/forms.py index ea1c1e70..5c0af906 100644 --- a/app/services/forms.py +++ b/app/services/forms.py @@ -10,11 +10,7 @@ from wtforms import ( ValidationError ) from wtforms.validators import InputRequired, Length -from app.models import ( - TRANSKRIBUS_HTR_MODELS, - TesseractOCRPipelineModel, - TranskribusHTRPipelineModel -) +from app.models import TesseractOCRPipelineModel from . import SERVICES @@ -107,6 +103,7 @@ class CreateTranskribusHTRPipelineJobForm(CreateJobBaseForm): raise ValidationError('PDF files only!') def __init__(self, *args, **kwargs): + transkribus_htr_pipeline_models = kwargs.pop('transkribus_htr_pipeline_models', []) service_manifest = SERVICES['transkribus-htr-pipeline'] version = kwargs.pop('version', service_manifest['latest_version']) super().__init__(*args, **kwargs) @@ -118,12 +115,8 @@ class CreateTranskribusHTRPipelineJobForm(CreateJobBaseForm): if 'binarization' in service_info['methods']: if 'disabled' in self.binarization.render_kw: del self.binarization.render_kw['disabled'] - models = [ - x for x in TranskribusHTRPipelineModel.query.filter().all() - if x.shared == True or x.user == current_user - ] self.model.choices = [('', 'Choose your option')] - self.model.choices += [(x.hashid, [y['name'] for y in TRANSKRIBUS_HTR_MODELS if y['modelId'] == x.transkribus_model_id ][0]) for x in models] + self.model.choices += [(x['modelId'], x['name']) for x in transkribus_htr_pipeline_models] self.model.default = '' self.version.choices = [(x, x) for x in service_manifest['versions']] self.version.data = version diff --git a/app/services/routes.py b/app/services/routes.py index 4f019525..b34d0619 100644 --- a/app/services/routes.py +++ b/app/services/routes.py @@ -1,13 +1,12 @@ -from flask import abort, current_app, flash, Markup, render_template, request +from flask import abort, current_app, flash, make_response, Markup, render_template, request from flask_login import current_user, login_required +import requests from app import db, hashids from app.models import ( Job, JobInput, JobStatus, - TesseractOCRPipelineModel, - TRANSKRIBUS_HTR_MODELS, - TranskribusHTRPipelineModel + TesseractOCRPipelineModel ) from . import bp, SERVICES from .forms import ( @@ -117,7 +116,18 @@ def transkribus_htr_pipeline(): version = request.args.get('version', service_manifest['latest_version']) if version not in service_manifest['versions']: abort(404) - form = CreateTranskribusHTRPipelineJobForm(prefix='create-job-form', version=version) + r = requests.get( + 'https://transkribus.eu/TrpServer/rest/models/text', + headers={'Accept': 'application/json'} + ) + if r.status_code != 200: + abort(500) + transkribus_htr_pipeline_models = r.json()['trpModelMetadata'] + form = CreateTranskribusHTRPipelineJobForm( + transkribus_htr_pipeline_models=transkribus_htr_pipeline_models, + prefix='create-job-form', + version=version + ) if form.is_submitted(): if not form.validate(): response = {'errors': form.errors} @@ -129,7 +139,7 @@ def transkribus_htr_pipeline(): service=service, service_args={ 'binarization': form.binarization.data, - 'model': hashids.decode(form.model.data) + 'model': form.model.data }, service_version=form.version.data, user=current_user @@ -145,15 +155,10 @@ def transkribus_htr_pipeline(): message = Markup(f'Job "{job.title}" created') flash(message, 'job') return {}, 201, {'Location': job.url} - transkribus_htr_pipeline_models = [ - x for x in TranskribusHTRPipelineModel.query.all() - if x.shared == True or x.user == current_user - ] return render_template( 'services/transkribus_htr_pipeline.html.j2', form=form, title=service_manifest['name'], - TRANSKRIBUS_HTR_MODELS=TRANSKRIBUS_HTR_MODELS, transkribus_htr_pipeline_models=transkribus_htr_pipeline_models ) diff --git a/app/templates/services/transkribus_htr_pipeline.html.j2 b/app/templates/services/transkribus_htr_pipeline.html.j2 index 79519f3a..d54d9906 100644 --- a/app/templates/services/transkribus_htr_pipeline.html.j2 +++ b/app/templates/services/transkribus_htr_pipeline.html.j2 @@ -156,15 +156,13 @@