diff --git a/.gitignore b/.gitignore index 59ada396..b7a84431 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,8 @@ logs/ !logs/dummy *.env +*.pjentsch-testing + # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] diff --git a/.vscode/settings.json b/.vscode/settings.json index 0967ef42..abafcbe3 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1 +1,23 @@ -{} +{ + "editor.rulers": [79], + "files.insertFinalNewline": true, + "python.terminal.activateEnvironment": false, + "[css]": { + "editor.tabSize": 2 + }, + "[scss]": { + "editor.tabSize": 2 + }, + "[html]": { + "editor.tabSize": 2 + }, + "[javascript]": { + "editor.tabSize": 2 + }, + "[jinja-html]": { + "editor.tabSize": 2 + }, + "[jinja-js]": { + "editor.tabSize": 2 + } +} diff --git a/app/__init__.py b/app/__init__.py index cc747a89..3a03e00b 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -4,6 +4,7 @@ from docker import DockerClient from flask import Flask from flask_apscheduler import APScheduler from flask_assets import Environment +from flask_breadcrumbs import Breadcrumbs, default_breadcrumb_root from flask_login import LoginManager from flask_mail import Mail from flask_marshmallow import Marshmallow @@ -12,10 +13,12 @@ from flask_paranoid import Paranoid from flask_socketio import SocketIO from flask_sqlalchemy import SQLAlchemy from flask_hashids import Hashids +from werkzeug.exceptions import HTTPException apifairy = APIFairy() assets = Environment() +breadcrumbs = Breadcrumbs() db = SQLAlchemy() docker_client = DockerClient() hashids = Hashids() @@ -33,7 +36,7 @@ socketio = SocketIO() def create_app(config: Config = Config) -> Flask: ''' Creates an initialized Flask (WSGI Application) object. ''' - app: Flask = Flask(__name__) + app = Flask(__name__) app.config.from_object(config) config.init_app(app) docker_client.login( @@ -44,6 +47,7 @@ def create_app(config: Config = Config) -> Flask: apifairy.init_app(app) assets.init_app(app) + breadcrumbs.init_app(app) db.init_app(app) hashids.init_app(app) login.init_app(app) @@ -55,36 +59,45 @@ def create_app(config: Config = Config) -> Flask: socketio.init_app(app, message_queue=app.config['NOPAQUE_SOCKETIO_MESSAGE_QUEUE_URI']) # noqa from .admin import bp as admin_blueprint + default_breadcrumb_root(admin_blueprint, '.admin') app.register_blueprint(admin_blueprint, url_prefix='/admin') from .api import bp as api_blueprint app.register_blueprint(api_blueprint, url_prefix='/api') from .auth import bp as auth_blueprint - app.register_blueprint(auth_blueprint, url_prefix='/auth') + default_breadcrumb_root(auth_blueprint, '.') + app.register_blueprint(auth_blueprint) from .contributions import bp as contributions_blueprint + default_breadcrumb_root(contributions_blueprint, '.contributions') app.register_blueprint(contributions_blueprint, url_prefix='/contributions') from .corpora import bp as corpora_blueprint - app.register_blueprint(corpora_blueprint, url_prefix='/corpora') + default_breadcrumb_root(corpora_blueprint, '.corpora') + app.register_blueprint(corpora_blueprint, cli_group='corpus', url_prefix='/corpora') - from .errors import bp as errors_blueprint - app.register_blueprint(errors_blueprint) + from .errors import bp as errors_bp + app.register_blueprint(errors_bp) from .jobs import bp as jobs_blueprint + default_breadcrumb_root(jobs_blueprint, '.jobs') app.register_blueprint(jobs_blueprint, url_prefix='/jobs') from .main import bp as main_blueprint - app.register_blueprint(main_blueprint, url_prefix='/') + default_breadcrumb_root(main_blueprint, '.') + app.register_blueprint(main_blueprint, cli_group=None) from .services import bp as services_blueprint + default_breadcrumb_root(services_blueprint, '.services') app.register_blueprint(services_blueprint, url_prefix='/services') from .settings import bp as settings_blueprint + default_breadcrumb_root(settings_blueprint, '.settings') app.register_blueprint(settings_blueprint, url_prefix='/settings') from .users import bp as users_blueprint + default_breadcrumb_root(users_blueprint, '.users') app.register_blueprint(users_blueprint, url_prefix='/users') return app diff --git a/app/admin/__init__.py b/app/admin/__init__.py index b5936b4c..be000a9a 100644 --- a/app/admin/__init__.py +++ b/app/admin/__init__.py @@ -1,5 +1,20 @@ from flask import Blueprint +from flask_login import login_required +from app.decorators import admin_required bp = Blueprint('admin', __name__) -from . import routes + + +@bp.before_request +@login_required +@admin_required +def before_request(): + ''' + Ensures that the routes in this package can be visited only by users with + administrator privileges (login_required and admin_required). + ''' + pass + + +from . import json_routes, routes diff --git a/app/admin/forms.py b/app/admin/forms.py index 7b468161..ea684624 100644 --- a/app/admin/forms.py +++ b/app/admin/forms.py @@ -1,13 +1,16 @@ -from app.models import Role from flask_wtf import FlaskForm -from wtforms import BooleanField, SelectField, SubmitField +from wtforms import SelectField, SubmitField +from app.models import Role -class AdminEditUserForm(FlaskForm): - confirmed = BooleanField('Confirmed') +class UpdateUserForm(FlaskForm): role = SelectField('Role') - submit = SubmitField('Submit') + submit = SubmitField() - def __init__(self, *args, **kwargs): + def __init__(self, user, *args, **kwargs): + if 'data' not in kwargs: + kwargs['data'] = {'role': user.role.hashid} + if 'prefix' not in kwargs: + kwargs['prefix'] = 'update-user-form' super().__init__(*args, **kwargs) self.role.choices = [(x.hashid, x.name) for x in Role.query.all()] diff --git a/app/admin/json_routes.py b/app/admin/json_routes.py new file mode 100644 index 00000000..9b4ca7d0 --- /dev/null +++ b/app/admin/json_routes.py @@ -0,0 +1,23 @@ +from flask import abort, request +from app import db +from app.decorators import content_negotiation +from app.models import User +from . import bp + + +@bp.route('/users//confirmed', methods=['PUT']) +@content_negotiation(consumes='application/json', produces='application/json') +def update_user_role(user_id): + confirmed = request.json + if not isinstance(confirmed, bool): + abort(400) + user = User.query.get_or_404(user_id) + user.confirmed = confirmed + db.session.commit() + response_data = { + 'message': ( + f'User "{user.username}" is now ' + f'{"confirmed" if confirmed else "unconfirmed"}' + ) + } + return response_data, 200 diff --git a/app/admin/routes.py b/app/admin/routes.py index 08f219ab..66d02f00 100644 --- a/app/admin/routes.py +++ b/app/admin/routes.py @@ -1,111 +1,146 @@ -from flask import current_app, flash, redirect, render_template, url_for -from flask_login import login_required -from threading import Thread +from flask import abort, flash, redirect, render_template, url_for +from flask_breadcrumbs import register_breadcrumb from app import db, hashids -from app.decorators import admin_required -from app.models import Role, User, UserSettingJobStatusMailNotificationLevel -from app.settings.forms import ( - EditNotificationSettingsForm +from app.models import Avatar, Corpus, Role, User +from app.users.settings.forms import ( + UpdateAvatarForm, + UpdatePasswordForm, + UpdateNotificationsForm, + UpdateAccountInformationForm, + UpdateProfileInformationForm ) -from app.users.forms import EditProfileSettingsForm from . import bp -from .forms import AdminEditUserForm - - -@bp.before_request -@login_required -@admin_required -def before_request(): - ''' - Ensures that the routes in this package can be visited only by users with - administrator privileges (login_required and admin_required). - ''' - pass +from .forms import UpdateUserForm +from app.users.utils import ( + user_endpoint_arguments_constructor as user_eac, + user_dynamic_list_constructor as user_dlc +) @bp.route('') -def index(): - return redirect(url_for('.users')) +@register_breadcrumb(bp, '.', 'admin_panel_settingsAdministration') +def admin(): + return render_template( + 'admin/admin.html.j2', + title='Administration' + ) + + +@bp.route('/corpora') +@register_breadcrumb(bp, '.corpora', 'Corpora') +def corpora(): + corpora = Corpus.query.all() + return render_template( + 'admin/corpora.html.j2', + title='Corpora', + corpora=corpora + ) @bp.route('/users') +@register_breadcrumb(bp, '.users', 'groupUsers') def users(): - users = [x.to_json_serializeable(backrefs=True) for x in User.query.all()] + users = User.query.all() return render_template( 'admin/users.html.j2', - users=users, - title='Users' + title='Users', + users=users ) @bp.route('/users/') +@register_breadcrumb(bp, '.users.entity', '', dynamic_list_constructor=user_dlc) def user(user_id): user = User.query.get_or_404(user_id) - return render_template('admin/user.html.j2', title='User', user=user) + corpora = Corpus.query.filter(Corpus.user == user).all() + return render_template( + 'admin/user.html.j2', + title=user.username, + user=user, + corpora=corpora + ) -@bp.route('/users//edit', methods=['GET', 'POST']) -def edit_user(user_id): +@bp.route('/users//settings', methods=['GET', 'POST']) +@register_breadcrumb(bp, '.users.entity.settings', 'settingsSettings') +def user_settings(user_id): user = User.query.get_or_404(user_id) - admin_edit_user_form = AdminEditUserForm( - data={'confirmed': user.confirmed, 'role': user.role.hashid}, - prefix='admin-edit-user-form' - ) - edit_profile_settings_form = EditProfileSettingsForm( - user, - data=user.to_json_serializeable(), - prefix='edit-profile-settings-form' - ) - edit_notification_settings_form = EditNotificationSettingsForm( - data=user.to_json_serializeable(), - prefix='edit-notification-settings-form' - ) - if (admin_edit_user_form.submit.data - and admin_edit_user_form.validate()): - user.confirmed = admin_edit_user_form.confirmed.data - role_id = hashids.decode(admin_edit_user_form.role.data) + update_account_information_form = UpdateAccountInformationForm(user) + update_profile_information_form = UpdateProfileInformationForm(user) + update_avatar_form = UpdateAvatarForm() + update_password_form = UpdatePasswordForm(user) + update_notifications_form = UpdateNotificationsForm(user) + update_user_form = UpdateUserForm(user) + + # region handle update profile information form + if update_profile_information_form.submit.data and update_profile_information_form.validate(): + user.about_me = update_profile_information_form.about_me.data + user.location = update_profile_information_form.location.data + user.organization = update_profile_information_form.organization.data + user.website = update_profile_information_form.website.data + user.full_name = update_profile_information_form.full_name.data + db.session.commit() + flash('Your changes have been saved') + return redirect(url_for('.user_settings', user_id=user.id)) + # endregion handle update profile information form + + # region handle update avatar form + if update_avatar_form.submit.data and update_avatar_form.validate(): + try: + Avatar.create( + update_avatar_form.avatar.data, + user=user + ) + except (AttributeError, OSError): + abort(500) + db.session.commit() + flash('Your changes have been saved') + return redirect(url_for('.user_settings', user_id=user.id)) + # endregion handle update avatar form + + # region handle update account information form + if update_account_information_form.submit.data and update_account_information_form.validate(): + user.email = update_account_information_form.email.data + user.username = update_account_information_form.username.data + db.session.commit() + flash('Profile settings updated') + return redirect(url_for('.user_settings', user_id=user.id)) + # endregion handle update account information form + + # region handle update password form + if update_password_form.submit.data and update_password_form.validate(): + user.password = update_password_form.new_password.data + db.session.commit() + flash('Your changes have been saved') + return redirect(url_for('.user_settings', user_id=user.id)) + # endregion handle update password form + + # region handle update notifications form + if update_notifications_form.submit.data and update_notifications_form.validate(): + user.setting_job_status_mail_notification_level = \ + update_notifications_form.job_status_mail_notification_level.data + db.session.commit() + flash('Your changes have been saved') + return redirect(url_for('.user_settings', user_id=user.id)) + # endregion handle update notifications form + + # region handle update user form + if update_user_form.submit.data and update_user_form.validate(): + role_id = hashids.decode(update_user_form.role.data) user.role = Role.query.get(role_id) db.session.commit() flash('Your changes have been saved') - return redirect(url_for('.edit_user', user_id=user.id)) - if (edit_profile_settings_form.submit.data - and edit_profile_settings_form.validate()): - user.email = edit_profile_settings_form.email.data - user.username = edit_profile_settings_form.username.data - db.session.commit() - flash('Your changes have been saved') - return redirect(url_for('.edit_user', user_id=user.id)) - if (edit_notification_settings_form.submit.data - and edit_notification_settings_form.validate()): - user.setting_job_status_mail_notification_level = \ - UserSettingJobStatusMailNotificationLevel[ - edit_notification_settings_form.job_status_mail_notification_level.data # noqa - ] - db.session.commit() - flash('Your changes have been saved') - return redirect(url_for('.edit_user', user_id=user.id)) + return redirect(url_for('.user_settings', user_id=user.id)) + # endregion handle update user form + return render_template( - 'admin/edit_user.html.j2', - admin_edit_user_form=admin_edit_user_form, - edit_profile_settings_form=edit_profile_settings_form, - edit_notification_settings_form=edit_notification_settings_form, - title='Edit user', + 'admin/user_settings.html.j2', + title='Settings', + update_account_information_form=update_account_information_form, + update_avatar_form=update_avatar_form, + update_notifications_form=update_notifications_form, + update_password_form=update_password_form, + update_profile_information_form=update_profile_information_form, + update_user_form=update_user_form, user=user ) - - -@bp.route('/users//delete', methods=['DELETE']) -def delete_user(user_id): - def _delete_user(app, user_id): - with app.app_context(): - user = User.query.get(user_id) - user.delete() - db.session.commit() - - User.query.get_or_404(user_id) - thread = Thread( - target=_delete_user, - args=(current_app._get_current_object(), user_id) - ) - thread.start() - return {}, 202 diff --git a/app/api/schemas.py b/app/api/schemas.py index f0792f7c..74f4cb2a 100644 --- a/app/api/schemas.py +++ b/app/api/schemas.py @@ -2,7 +2,6 @@ from apifairy.fields import FileField 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, @@ -142,7 +141,10 @@ class UserSchema(ma.SQLAlchemySchema): username = ma.auto_field( validate=[ validate.Length(min=1, max=64), - validate.Regexp(USERNAME_REGEX, error='Usernames must have only letters, numbers, dots or underscores') + validate.Regexp( + User.username_pattern, + error='Usernames must have only letters, numbers, dots or underscores' + ) ] ) email = ma.auto_field(validate=validate.Email()) diff --git a/app/auth/__init__.py b/app/auth/__init__.py index 505e7e42..6f6ba82d 100644 --- a/app/auth/__init__.py +++ b/app/auth/__init__.py @@ -1,8 +1,5 @@ from flask import Blueprint -USERNAME_REGEX = '^[A-Za-zÄÖÜäöüß0-9_.]*$' - - bp = Blueprint('auth', __name__) from . import routes diff --git a/app/auth/forms.py b/app/auth/forms.py index 6917b78b..a6ce0017 100644 --- a/app/auth/forms.py +++ b/app/auth/forms.py @@ -8,7 +8,6 @@ from wtforms import ( ) from wtforms.validators import InputRequired, Email, EqualTo, Length, Regexp from app.models import User -from . import USERNAME_REGEX class RegistrationForm(FlaskForm): @@ -22,7 +21,7 @@ class RegistrationForm(FlaskForm): InputRequired(), Length(max=64), Regexp( - USERNAME_REGEX, + User.username_pattern, message=( 'Usernames must have only letters, numbers, dots or ' 'underscores' @@ -44,8 +43,17 @@ class RegistrationForm(FlaskForm): EqualTo('password', message='Passwords must match') ] ) + terms_of_use_accepted = BooleanField( + 'I have read and accept the terms of use', + validators=[InputRequired()] + ) submit = SubmitField() + def __init__(self, *args, **kwargs): + if 'prefix' not in kwargs: + kwargs['prefix'] = 'registration-form' + super().__init__(*args, **kwargs) + def validate_email(self, field): if User.query.filter_by(email=field.data.lower()).first(): raise ValidationError('Email already registered') @@ -61,11 +69,21 @@ class LoginForm(FlaskForm): remember_me = BooleanField('Keep me logged in') submit = SubmitField() + def __init__(self, *args, **kwargs): + if 'prefix' not in kwargs: + kwargs['prefix'] = 'login-form' + super().__init__(*args, **kwargs) + class ResetPasswordRequestForm(FlaskForm): email = StringField('Email', validators=[InputRequired(), Email()]) submit = SubmitField() + def __init__(self, *args, **kwargs): + if 'prefix' not in kwargs: + kwargs['prefix'] = 'reset-password-request-form' + super().__init__(*args, **kwargs) + class ResetPasswordForm(FlaskForm): password = PasswordField( @@ -83,3 +101,8 @@ class ResetPasswordForm(FlaskForm): ] ) submit = SubmitField() + + def __init__(self, *args, **kwargs): + if 'prefix' not in kwargs: + kwargs['prefix'] = 'reset-password-form' + super().__init__(*args, **kwargs) diff --git a/app/auth/routes.py b/app/auth/routes.py index 5655d0dc..54337d69 100644 --- a/app/auth/routes.py +++ b/app/auth/routes.py @@ -1,11 +1,5 @@ -from flask import ( - abort, - flash, - redirect, - render_template, - request, - url_for -) +from flask import abort, flash, redirect, render_template, request, url_for +from flask_breadcrumbs import register_breadcrumb from flask_login import current_user, login_user, login_required, logout_user from app import db from app.email import create_message, send @@ -36,16 +30,18 @@ def before_request(): @bp.route('/register', methods=['GET', 'POST']) +@register_breadcrumb(bp, '.register', 'Register') def register(): if current_user.is_authenticated: return redirect(url_for('main.dashboard')) - form = RegistrationForm(prefix='registration-form') + form = RegistrationForm() if form.validate_on_submit(): try: user = User.create( email=form.email.data.lower(), password=form.password.data, - username=form.username.data + username=form.username.data, + terms_of_use_accepted=form.terms_of_use_accepted.data ) except OSError: flash('Internal Server Error', category='error') @@ -65,16 +61,17 @@ def register(): return redirect(url_for('.login')) return render_template( 'auth/register.html.j2', - form=form, - title='Register' + title='Register', + form=form ) @bp.route('/login', methods=['GET', 'POST']) +@register_breadcrumb(bp, '.login', 'Login') def login(): if current_user.is_authenticated: return redirect(url_for('main.dashboard')) - form = LoginForm(prefix='login-form') + form = LoginForm() if form.validate_on_submit(): user = User.query.filter((User.email == form.user.data.lower()) | (User.username == form.user.data)).first() if user and user.verify_password(form.password.data): @@ -85,7 +82,11 @@ def login(): flash('You have been logged in') return redirect(next) flash('Invalid email/username or password', category='error') - return render_template('auth/login.html.j2', form=form, title='Log in') + return render_template( + 'auth/login.html.j2', + title='Log in', + form=form + ) @bp.route('/logout') @@ -97,14 +98,18 @@ def logout(): @bp.route('/unconfirmed') +@register_breadcrumb(bp, '.unconfirmed', 'Unconfirmed') @login_required def unconfirmed(): if current_user.confirmed: return redirect(url_for('main.dashboard')) - return render_template('auth/unconfirmed.html.j2', title='Unconfirmed') + return render_template( + 'auth/unconfirmed.html.j2', + title='Unconfirmed' + ) -@bp.route('/confirm') +@bp.route('/confirm-request') @login_required def confirm_request(): if current_user.confirmed: @@ -135,11 +140,12 @@ def confirm(token): return redirect(url_for('.unconfirmed')) -@bp.route('/reset_password', methods=['GET', 'POST']) +@bp.route('/reset-password-request', methods=['GET', 'POST']) +@register_breadcrumb(bp, '.reset_password_request', 'Password Reset') def reset_password_request(): if current_user.is_authenticated: return redirect(url_for('main.dashboard')) - form = ResetPasswordRequestForm(prefix='reset-password-request-form') + form = ResetPasswordRequestForm() if form.validate_on_submit(): user = User.query.filter_by(email=form.email.data.lower()).first() if user is not None: @@ -159,16 +165,17 @@ def reset_password_request(): return redirect(url_for('.login')) return render_template( 'auth/reset_password_request.html.j2', - form=form, - title='Password Reset' + title='Password Reset', + form=form ) -@bp.route('/reset_password/', methods=['GET', 'POST']) +@bp.route('/reset-password/', methods=['GET', 'POST']) +@register_breadcrumb(bp, '.reset_password', 'Password Reset') def reset_password(token): if current_user.is_authenticated: return redirect(url_for('main.dashboard')) - form = ResetPasswordForm(prefix='reset-password-form') + form = ResetPasswordForm() if form.validate_on_submit(): if User.reset_password(token, form.password.data): db.session.commit() @@ -177,7 +184,7 @@ def reset_password(token): return redirect(url_for('main.index')) return render_template( 'auth/reset_password.html.j2', - form=form, title='Password Reset', + form=form, token=token ) diff --git a/app/cli.py b/app/cli.py deleted file mode 100644 index 826aa790..00000000 --- a/app/cli.py +++ /dev/null @@ -1,72 +0,0 @@ -from flask import current_app -from flask_migrate import upgrade -import click -import os -from app.models import ( - Role, - User, - TesseractOCRPipelineModel, - SpaCyNLPPipelineModel -) - - -def _make_default_dirs(): - base_dir = current_app.config['NOPAQUE_DATA_DIR'] - - default_directories = [ - os.path.join(base_dir, 'tmp'), - os.path.join(base_dir, 'users') - ] - for directory in default_directories: - if os.path.exists(directory): - if not os.path.isdir(directory): - raise NotADirectoryError(f'{directory} is not a directory') - else: - os.mkdir(directory) - - -def register(app): - @app.cli.command() - def deploy(): - ''' Run deployment tasks. ''' - # Make default directories - _make_default_dirs() - - # migrate database to latest revision - upgrade() - - # Insert/Update default database values - current_app.logger.info('Insert/Update default roles') - Role.insert_defaults() - current_app.logger.info('Insert/Update default users') - User.insert_defaults() - current_app.logger.info('Insert/Update default SpaCyNLPPipelineModels') - SpaCyNLPPipelineModel.insert_defaults() - current_app.logger.info('Insert/Update default TesseractOCRPipelineModels') - TesseractOCRPipelineModel.insert_defaults() - - @app.cli.group() - def converter(): - ''' Converter commands. ''' - pass - - @converter.command() - @click.argument('json_db') - @click.argument('data_dir') - def sandpaper(json_db, data_dir): - ''' Sandpaper converter ''' - from app.converters.sandpaper import convert - convert(json_db, data_dir) - - @app.cli.group() - def test(): - ''' Test commands. ''' - pass - - @test.command('run') - def run_test(): - ''' Run unit tests. ''' - from unittest import TestLoader, TextTestRunner - from unittest.suite import TestSuite - tests: TestSuite = TestLoader().discover('tests') - TextTestRunner(verbosity=2).run(tests) diff --git a/app/contributions/__init__.py b/app/contributions/__init__.py index af9747a6..3805e489 100644 --- a/app/contributions/__init__.py +++ b/app/contributions/__init__.py @@ -1,5 +1,23 @@ from flask import Blueprint +from flask_login import login_required bp = Blueprint('contributions', __name__) -from . import routes + + +@bp.before_request +@login_required +def before_request(): + ''' + Ensures that the routes in this package can only be visited by users that + are logged in. + ''' + pass + + +from . import ( + routes, + spacy_nlp_pipeline_models, + tesseract_ocr_pipeline_models, + transkribus_htr_pipeline_models +) diff --git a/app/contributions/forms.py b/app/contributions/forms.py index eb25babb..598fb7cc 100644 --- a/app/contributions/forms.py +++ b/app/contributions/forms.py @@ -1,16 +1,11 @@ -from flask import current_app from flask_wtf import FlaskForm -from flask_wtf.file import FileField, FileRequired from wtforms import ( - BooleanField, StringField, SubmitField, SelectMultipleField, - IntegerField, - ValidationError + IntegerField ) from wtforms.validators import InputRequired, Length -from app.services import SERVICES class ContributionBaseForm(FlaskForm): @@ -48,74 +43,5 @@ class ContributionBaseForm(FlaskForm): submit = SubmitField() -class CreateTesseractOCRPipelineModelForm(ContributionBaseForm): - tesseract_model_file = FileField( - 'File', - validators=[FileRequired()] - ) - - def validate_tesseract_model_file(self, field): - if not field.data.filename.lower().endswith('.traineddata'): - raise ValidationError('traineddata files only!') - - def __init__(self, *args, **kwargs): - service_manifest = SERVICES['tesseract-ocr-pipeline'] - super().__init__(*args, **kwargs) - self.compatible_service_versions.choices = [('', 'Choose your option')] - self.compatible_service_versions.choices += [ - (x, x) for x in service_manifest['versions'].keys() - ] - self.compatible_service_versions.default = '' - - -class CreateSpaCyNLPPipelineModelForm(ContributionBaseForm): - spacy_model_file = FileField( - 'File', - validators=[FileRequired()] - ) - pipeline_name = StringField( - 'Pipeline name', - validators=[InputRequired(), Length(max=64)] - ) - - def validate_spacy_model_file(self, field): - if not field.data.filename.lower().endswith('.tar.gz'): - raise ValidationError('.tar.gz files only!') - - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - service_manifest = SERVICES['spacy-nlp-pipeline'] - self.compatible_service_versions.choices = [('', 'Choose your option')] - self.compatible_service_versions.choices += [ - (x, x) for x in service_manifest['versions'].keys() - ] - self.compatible_service_versions.default = '' - - -class EditContributionBaseForm(ContributionBaseForm): +class UpdateContributionBaseForm(ContributionBaseForm): pass - -class EditTesseractOCRPipelineModelForm(EditContributionBaseForm): - def __init__(self, *args, **kwargs): - service_manifest = SERVICES['tesseract-ocr-pipeline'] - super().__init__(*args, **kwargs) - self.compatible_service_versions.choices = [('', 'Choose your option')] - self.compatible_service_versions.choices += [ - (x, x) for x in service_manifest['versions'].keys() - ] - self.compatible_service_versions.default = '' - - -class EditSpaCyNLPPipelineModelForm(EditContributionBaseForm): - pipeline_name = StringField( - 'Pipeline name', - validators=[InputRequired(), Length(max=64)] - ) - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - service_manifest = SERVICES['spacy-nlp-pipeline'] - self.compatible_service_versions.choices = [('', 'Choose your option')] - self.compatible_service_versions.choices += [ - (x, x) for x in service_manifest['versions'].keys() - ] - self.compatible_service_versions.default = '' diff --git a/app/contributions/routes.py b/app/contributions/routes.py index 3bc37eb8..82fc63ba 100644 --- a/app/contributions/routes.py +++ b/app/contributions/routes.py @@ -1,233 +1,9 @@ -from flask import ( - abort, - current_app, - flash, - Markup, - redirect, - render_template, - url_for -) -from flask_login import login_required, current_user -from threading import Thread -from app import db -from app.decorators import permission_required -from app.models import ( - Permission, - SpaCyNLPPipelineModel, - TesseractOCRPipelineModel -) +from flask import redirect, url_for +from flask_breadcrumbs import register_breadcrumb from . import bp -from .forms import ( - CreateSpaCyNLPPipelineModelForm, - CreateTesseractOCRPipelineModelForm, - EditSpaCyNLPPipelineModelForm, - EditTesseractOCRPipelineModelForm -) -@bp.before_request -@login_required -def before_request(): - pass - - -@bp.route('/') +@bp.route('') +@register_breadcrumb(bp, '.', 'new_labelMy Contributions') def contributions(): - return render_template( - 'contributions/contributions.html.j2', - title='Contributions' - ) - - -@bp.route('/tesseract-ocr-pipeline-models') -def tesseract_ocr_pipeline_models(): - return render_template( - 'contributions/tesseract_ocr_pipeline_models.html.j2', - title='Tesseract OCR Pipeline Models' - ) - - -@bp.route('/tesseract-ocr-pipeline-models/', methods=['GET', 'POST']) -def tesseract_ocr_pipeline_model(tesseract_ocr_pipeline_model_id): - tesseract_ocr_pipeline_model = TesseractOCRPipelineModel.query.get_or_404(tesseract_ocr_pipeline_model_id) - form = EditTesseractOCRPipelineModelForm( - data=tesseract_ocr_pipeline_model.to_json_serializeable(), - prefix='edit-tesseract-ocr-pipeline-model-form' - ) - if form.validate_on_submit(): - form.populate_obj(tesseract_ocr_pipeline_model) - if db.session.is_modified(tesseract_ocr_pipeline_model): - message = Markup(f'Tesseract OCR Pipeline model "{tesseract_ocr_pipeline_model.title}" updated') - flash(message) - db.session.commit() - return redirect(url_for('.tesseract_ocr_pipeline_models')) - return render_template( - 'contributions/tesseract_ocr_pipeline_model.html.j2', - form=form, - tesseract_ocr_pipeline_model=tesseract_ocr_pipeline_model, - title=f'{tesseract_ocr_pipeline_model.title} {tesseract_ocr_pipeline_model.version}' - ) - - -@bp.route('/tesseract-ocr-pipeline-models/', methods=['DELETE']) -def delete_tesseract_model(tesseract_ocr_pipeline_model_id): - def _delete_tesseract_ocr_pipeline_model(app, tesseract_ocr_pipeline_model_id): - with app.app_context(): - tesseract_ocr_pipeline_model = TesseractOCRPipelineModel.query.get(tesseract_ocr_pipeline_model_id) - tesseract_ocr_pipeline_model.delete() - db.session.commit() - - tesseract_ocr_pipeline_model = TesseractOCRPipelineModel.query.get_or_404(tesseract_ocr_pipeline_model_id) - if not (tesseract_ocr_pipeline_model.user == current_user or current_user.is_administrator()): - abort(403) - thread = Thread( - target=_delete_tesseract_ocr_pipeline_model, - args=(current_app._get_current_object(), tesseract_ocr_pipeline_model_id) - ) - thread.start() - return {}, 202 - - -@bp.route('/tesseract-ocr-pipeline-models/create', methods=['GET', 'POST']) -def create_tesseract_ocr_pipeline_model(): - form = CreateTesseractOCRPipelineModelForm(prefix='create-tesseract-ocr-pipeline-model-form') - if form.is_submitted(): - if not form.validate(): - response = {'errors': form.errors} - return response, 400 - try: - tesseract_ocr_pipeline_model = TesseractOCRPipelineModel.create( - form.tesseract_model_file.data, - compatible_service_versions=form.compatible_service_versions.data, - description=form.description.data, - publisher=form.publisher.data, - publisher_url=form.publisher_url.data, - publishing_url=form.publishing_url.data, - publishing_year=form.publishing_year.data, - is_public=False, - title=form.title.data, - version=form.version.data, - user=current_user - ) - except OSError: - abort(500) - db.session.commit() - tesseract_ocr_pipeline_model_url = url_for( - '.tesseract_ocr_pipeline_model', - tesseract_ocr_pipeline_model_id=tesseract_ocr_pipeline_model.id - ) - message = Markup(f'Tesseract OCR Pipeline model "{tesseract_ocr_pipeline_model.title}" created') - flash(message) - return {}, 201, {'Location': tesseract_ocr_pipeline_model_url} - return render_template( - 'contributions/create_tesseract_ocr_pipeline_model.html.j2', - form=form, - title='Create Tesseract OCR Pipeline Model' - ) - -@bp.route('/tesseract-ocr-pipeline-models//toggle-public-status', methods=['POST']) -@permission_required(Permission.CONTRIBUTE) -def toggle_tesseract_ocr_pipeline_model_public_status(tesseract_ocr_pipeline_model_id): - tesseract_ocr_pipeline_model = TesseractOCRPipelineModel.query.get_or_404(tesseract_ocr_pipeline_model_id) - if not (tesseract_ocr_pipeline_model.user == current_user or current_user.is_administrator()): - abort(403) - tesseract_ocr_pipeline_model.is_public = not tesseract_ocr_pipeline_model.is_public - db.session.commit() - return {}, 201 - - -@bp.route('/spacy-nlp-pipeline-models') -def spacy_nlp_pipeline_models(): - return render_template( - 'contributions/spacy_nlp_pipeline_models.html.j2', - title='SpaCy NLP Pipeline Models' - ) - - -@bp.route('/spacy-nlp-pipeline-models/', methods=['GET', 'POST']) -def spacy_nlp_pipeline_model(spacy_nlp_pipeline_model_id): - spacy_nlp_pipeline_model = SpaCyNLPPipelineModel.query.get_or_404(spacy_nlp_pipeline_model_id) - form = EditSpaCyNLPPipelineModelForm( - data=spacy_nlp_pipeline_model.to_json_serializeable(), - prefix='edit-spacy-nlp-pipeline-model-form' - ) - if form.validate_on_submit(): - form.populate_obj(spacy_nlp_pipeline_model) - if db.session.is_modified(spacy_nlp_pipeline_model): - message = Markup(f'SpaCy NLP Pipeline model "{spacy_nlp_pipeline_model.title}" updated') - flash(message) - db.session.commit() - return redirect(url_for('.spacy_nlp_pipeline_models')) - return render_template( - 'contributions/spacy_nlp_pipeline_model.html.j2', - form=form, - spacy_nlp_pipeline_model=spacy_nlp_pipeline_model, - title=f'{spacy_nlp_pipeline_model.title} {spacy_nlp_pipeline_model.version}' - ) - -@bp.route('/spacy-nlp-pipeline-models/', methods=['DELETE']) -def delete_spacy_model(spacy_nlp_pipeline_model_id): - def _delete_spacy_model(app, spacy_nlp_pipeline_model_id): - with app.app_context(): - spacy_nlp_pipeline_model = SpaCyNLPPipelineModel.query.get(spacy_nlp_pipeline_model_id) - spacy_nlp_pipeline_model.delete() - db.session.commit() - - spacy_nlp_pipeline_model = SpaCyNLPPipelineModel.query.get_or_404(spacy_nlp_pipeline_model_id) - if not (spacy_nlp_pipeline_model.user == current_user or current_user.is_administrator()): - abort(403) - thread = Thread( - target=_delete_spacy_model, - args=(current_app._get_current_object(), spacy_nlp_pipeline_model_id) - ) - thread.start() - return {}, 202 - - -@bp.route('/spacy-nlp-pipeline-models/create', methods=['GET', 'POST']) -def create_spacy_nlp_pipeline_model(): - form = CreateSpaCyNLPPipelineModelForm(prefix='create-spacy-nlp-pipeline-model-form') - if form.is_submitted(): - if not form.validate(): - response = {'errors': form.errors} - return response, 400 - try: - spacy_nlp_pipeline_model = SpaCyNLPPipelineModel.create( - form.spacy_model_file.data, - compatible_service_versions=form.compatible_service_versions.data, - description=form.description.data, - pipeline_name=form.pipeline_name.data, - publisher=form.publisher.data, - publisher_url=form.publisher_url.data, - publishing_url=form.publishing_url.data, - publishing_year=form.publishing_year.data, - is_public=False, - title=form.title.data, - version=form.version.data, - user=current_user - ) - except OSError: - abort(500) - db.session.commit() - spacy_nlp_pipeline_model_url = url_for( - '.spacy_nlp_pipeline_model', - spacy_nlp_pipeline_model_id=spacy_nlp_pipeline_model.id - ) - message = Markup(f'SpaCy NLP Pipeline model "{spacy_nlp_pipeline_model.title}" created') - flash(message) - return {}, 201, {'Location': spacy_nlp_pipeline_model_url} - return render_template( - 'contributions/create_spacy_nlp_pipeline_model.html.j2', - form=form, - title='Create SpaCy NLP Pipeline Model' - ) - -@bp.route('/spacy-nlp-pipeline-models//toggle-public-status', methods=['POST']) -@permission_required(Permission.CONTRIBUTE) -def toggle_spacy_nlp_pipeline_model_public_status(spacy_nlp_pipeline_model_id): - spacy_nlp_pipeline_model = SpaCyNLPPipelineModel.query.get_or_404(spacy_nlp_pipeline_model_id) - if not (spacy_nlp_pipeline_model.user == current_user or current_user.is_administrator()): - abort(403) - spacy_nlp_pipeline_model.is_public = not spacy_nlp_pipeline_model.is_public - db.session.commit() - return {}, 201 + return redirect(url_for('main.dashboard', _anchor='contributions')) diff --git a/app/contributions/spacy_nlp_pipeline_models/__init__.py b/app/contributions/spacy_nlp_pipeline_models/__init__.py new file mode 100644 index 00000000..e06bada9 --- /dev/null +++ b/app/contributions/spacy_nlp_pipeline_models/__init__.py @@ -0,0 +1,2 @@ +from .. import bp +from . import json_routes, routes diff --git a/app/contributions/spacy_nlp_pipeline_models/forms.py b/app/contributions/spacy_nlp_pipeline_models/forms.py new file mode 100644 index 00000000..dc3ca781 --- /dev/null +++ b/app/contributions/spacy_nlp_pipeline_models/forms.py @@ -0,0 +1,48 @@ +from flask_wtf.file import FileField, FileRequired +from wtforms import StringField, ValidationError +from wtforms.validators import InputRequired, Length +from app.services import SERVICES +from ..forms import ContributionBaseForm, UpdateContributionBaseForm + + +class CreateSpaCyNLPPipelineModelForm(ContributionBaseForm): + spacy_model_file = FileField( + 'File', + validators=[FileRequired()] + ) + pipeline_name = StringField( + 'Pipeline name', + validators=[InputRequired(), Length(max=64)] + ) + + def validate_spacy_model_file(self, field): + if not field.data.filename.lower().endswith('.tar.gz'): + raise ValidationError('.tar.gz files only!') + + def __init__(self, *args, **kwargs): + if 'prefix' not in kwargs: + kwargs['prefix'] = 'create-spacy-nlp-pipeline-model-form' + super().__init__(*args, **kwargs) + service_manifest = SERVICES['spacy-nlp-pipeline'] + self.compatible_service_versions.choices = [('', 'Choose your option')] + self.compatible_service_versions.choices += [ + (x, x) for x in service_manifest['versions'].keys() + ] + self.compatible_service_versions.default = '' + + +class UpdateSpaCyNLPPipelineModelForm(UpdateContributionBaseForm): + pipeline_name = StringField( + 'Pipeline name', + validators=[InputRequired(), Length(max=64)] + ) + def __init__(self, *args, **kwargs): + if 'prefix' not in kwargs: + kwargs['prefix'] = 'edit-spacy-nlp-pipeline-model-form' + super().__init__(*args, **kwargs) + service_manifest = SERVICES['spacy-nlp-pipeline'] + self.compatible_service_versions.choices = [('', 'Choose your option')] + self.compatible_service_versions.choices += [ + (x, x) for x in service_manifest['versions'].keys() + ] + self.compatible_service_versions.default = '' diff --git a/app/contributions/spacy_nlp_pipeline_models/json_routes.py b/app/contributions/spacy_nlp_pipeline_models/json_routes.py new file mode 100644 index 00000000..8c081ce8 --- /dev/null +++ b/app/contributions/spacy_nlp_pipeline_models/json_routes.py @@ -0,0 +1,52 @@ +from flask import abort, current_app, request +from flask_login import current_user +from threading import Thread +from app import db +from app.decorators import content_negotiation, permission_required +from app.models import SpaCyNLPPipelineModel +from .. import bp + + +@bp.route('/spacy-nlp-pipeline-models/', methods=['DELETE']) +@content_negotiation(produces='application/json') +def delete_spacy_model(spacy_nlp_pipeline_model_id): + def _delete_spacy_model(app, spacy_nlp_pipeline_model_id): + with app.app_context(): + snpm = SpaCyNLPPipelineModel.query.get(spacy_nlp_pipeline_model_id) + snpm.delete() + db.session.commit() + + snpm = SpaCyNLPPipelineModel.query.get_or_404(spacy_nlp_pipeline_model_id) + if not (snpm.user == current_user or current_user.is_administrator()): + abort(403) + thread = Thread( + target=_delete_spacy_model, + args=(current_app._get_current_object(), snpm.id) + ) + thread.start() + response_data = { + 'message': \ + f'SpaCy NLP Pipeline Model "{snpm.title}" marked for deletion' + } + return response_data, 202 + + +@bp.route('/spacy-nlp-pipeline-models//is_public', methods=['PUT']) +@permission_required('CONTRIBUTE') +@content_negotiation(consumes='application/json', produces='application/json') +def update_spacy_nlp_pipeline_model_is_public(spacy_nlp_pipeline_model_id): + is_public = request.json + if not isinstance(is_public, bool): + abort(400) + snpm = SpaCyNLPPipelineModel.query.get_or_404(spacy_nlp_pipeline_model_id) + if not (snpm.user == current_user or current_user.is_administrator()): + abort(403) + snpm.is_public = is_public + db.session.commit() + response_data = { + 'message': ( + f'SpaCy NLP Pipeline Model "{snpm.title}"' + f' is now {"public" if is_public else "private"}' + ) + } + return response_data, 200 diff --git a/app/contributions/spacy_nlp_pipeline_models/routes.py b/app/contributions/spacy_nlp_pipeline_models/routes.py new file mode 100644 index 00000000..53593cc8 --- /dev/null +++ b/app/contributions/spacy_nlp_pipeline_models/routes.py @@ -0,0 +1,77 @@ +from flask import abort, flash, redirect, render_template, url_for +from flask_breadcrumbs import register_breadcrumb +from flask_login import current_user +from app import db +from app.models import SpaCyNLPPipelineModel +from . import bp +from .forms import ( + CreateSpaCyNLPPipelineModelForm, + UpdateSpaCyNLPPipelineModelForm +) +from .utils import ( + spacy_nlp_pipeline_model_dlc as spacy_nlp_pipeline_model_dlc +) + + +@bp.route('/spacy-nlp-pipeline-models') +@register_breadcrumb(bp, '.spacy_nlp_pipeline_models', 'SpaCy NLP Pipeline Models') +def spacy_nlp_pipeline_models(): + return render_template( + 'contributions/spacy_nlp_pipeline_models/spacy_nlp_pipeline_models.html.j2', + title='SpaCy NLP Pipeline Models' + ) + + +@bp.route('/spacy-nlp-pipeline-models/create', methods=['GET', 'POST']) +@register_breadcrumb(bp, '.spacy_nlp_pipeline_models.create', 'Create') +def create_spacy_nlp_pipeline_model(): + form = CreateSpaCyNLPPipelineModelForm() + if form.is_submitted(): + if not form.validate(): + return {'errors': form.errors}, 400 + try: + snpm = SpaCyNLPPipelineModel.create( + form.spacy_model_file.data, + compatible_service_versions=form.compatible_service_versions.data, + description=form.description.data, + pipeline_name=form.pipeline_name.data, + publisher=form.publisher.data, + publisher_url=form.publisher_url.data, + publishing_url=form.publishing_url.data, + publishing_year=form.publishing_year.data, + is_public=False, + title=form.title.data, + version=form.version.data, + user=current_user + ) + except OSError: + abort(500) + db.session.commit() + flash(f'SpaCy NLP Pipeline model "{snpm.title}" created') + return {}, 201, {'Location': url_for('.spacy_nlp_pipeline_models')} + return render_template( + 'contributions/spacy_nlp_pipeline_models/create.html.j2', + title='Create SpaCy NLP Pipeline Model', + form=form + ) + + +@bp.route('/spacy-nlp-pipeline-models/', methods=['GET', 'POST']) +@register_breadcrumb(bp, '.spacy_nlp_pipeline_models.entity', '', dynamic_list_constructor=spacy_nlp_pipeline_model_dlc) +def spacy_nlp_pipeline_model(spacy_nlp_pipeline_model_id): + snpm = SpaCyNLPPipelineModel.query.get_or_404(spacy_nlp_pipeline_model_id) + if not (snpm.user == current_user or current_user.is_administrator()): + abort(403) + form = UpdateSpaCyNLPPipelineModelForm(data=snpm.to_json_serializeable()) + if form.validate_on_submit(): + form.populate_obj(snpm) + if db.session.is_modified(snpm): + flash(f'SpaCy NLP Pipeline model "{snpm.title}" updated') + db.session.commit() + return redirect(url_for('.spacy_nlp_pipeline_models')) + return render_template( + 'contributions/spacy_nlp_pipeline_models/spacy_nlp_pipeline_model.html.j2', + title=f'{snpm.title} {snpm.version}', + form=form, + spacy_nlp_pipeline_model=snpm + ) diff --git a/app/contributions/spacy_nlp_pipeline_models/utils.py b/app/contributions/spacy_nlp_pipeline_models/utils.py new file mode 100644 index 00000000..e73bbfd6 --- /dev/null +++ b/app/contributions/spacy_nlp_pipeline_models/utils.py @@ -0,0 +1,13 @@ +from flask import request, url_for +from app.models import SpaCyNLPPipelineModel + + +def spacy_nlp_pipeline_model_dlc(): + snpm_id = request.view_args['spacy_nlp_pipeline_model_id'] + snpm = SpaCyNLPPipelineModel.query.get_or_404(snpm_id) + return [ + { + 'text': f'{snpm.title} {snpm.version}', + 'url': url_for('.spacy_nlp_pipeline_model', spacy_nlp_pipeline_model_id=snpm_id) + } + ] diff --git a/app/contributions/tesseract_ocr_pipeline_models/__init__.py b/app/contributions/tesseract_ocr_pipeline_models/__init__.py new file mode 100644 index 00000000..e06bada9 --- /dev/null +++ b/app/contributions/tesseract_ocr_pipeline_models/__init__.py @@ -0,0 +1,2 @@ +from .. import bp +from . import json_routes, routes diff --git a/app/contributions/tesseract_ocr_pipeline_models/forms.py b/app/contributions/tesseract_ocr_pipeline_models/forms.py new file mode 100644 index 00000000..9a5979dd --- /dev/null +++ b/app/contributions/tesseract_ocr_pipeline_models/forms.py @@ -0,0 +1,39 @@ +from flask_wtf.file import FileField, FileRequired +from wtforms import ValidationError +from app.services import SERVICES +from ..forms import ContributionBaseForm, UpdateContributionBaseForm + + +class CreateTesseractOCRPipelineModelForm(ContributionBaseForm): + tesseract_model_file = FileField( + 'File', + validators=[FileRequired()] + ) + + def validate_tesseract_model_file(self, field): + if not field.data.filename.lower().endswith('.traineddata'): + raise ValidationError('traineddata files only!') + + def __init__(self, *args, **kwargs): + if 'prefix' not in kwargs: + kwargs['prefix'] = 'create-tesseract-ocr-pipeline-model-form' + service_manifest = SERVICES['tesseract-ocr-pipeline'] + super().__init__(*args, **kwargs) + self.compatible_service_versions.choices = [('', 'Choose your option')] + self.compatible_service_versions.choices += [ + (x, x) for x in service_manifest['versions'].keys() + ] + self.compatible_service_versions.default = '' + + +class UpdateTesseractOCRPipelineModelForm(UpdateContributionBaseForm): + def __init__(self, *args, **kwargs): + if 'prefix' not in kwargs: + kwargs['prefix'] = 'edit-tesseract-ocr-pipeline-model-form' + service_manifest = SERVICES['tesseract-ocr-pipeline'] + super().__init__(*args, **kwargs) + self.compatible_service_versions.choices = [('', 'Choose your option')] + self.compatible_service_versions.choices += [ + (x, x) for x in service_manifest['versions'].keys() + ] + self.compatible_service_versions.default = '' diff --git a/app/contributions/tesseract_ocr_pipeline_models/json_routes.py b/app/contributions/tesseract_ocr_pipeline_models/json_routes.py new file mode 100644 index 00000000..22f09e1b --- /dev/null +++ b/app/contributions/tesseract_ocr_pipeline_models/json_routes.py @@ -0,0 +1,52 @@ +from flask import abort, current_app, request +from flask_login import current_user +from threading import Thread +from app import db +from app.decorators import content_negotiation, permission_required +from app.models import TesseractOCRPipelineModel +from . import bp + + +@bp.route('/tesseract-ocr-pipeline-models/', methods=['DELETE']) +@content_negotiation(produces='application/json') +def delete_tesseract_model(tesseract_ocr_pipeline_model_id): + def _delete_tesseract_ocr_pipeline_model(app, tesseract_ocr_pipeline_model_id): + with app.app_context(): + topm = TesseractOCRPipelineModel.query.get(tesseract_ocr_pipeline_model_id) + topm.delete() + db.session.commit() + + topm = TesseractOCRPipelineModel.query.get_or_404(tesseract_ocr_pipeline_model_id) + if not (topm.user == current_user or current_user.is_administrator()): + abort(403) + thread = Thread( + target=_delete_tesseract_ocr_pipeline_model, + args=(current_app._get_current_object(), topm.id) + ) + thread.start() + response_data = { + 'message': \ + f'Tesseract OCR Pipeline Model "{topm.title}" marked for deletion' + } + return response_data, 202 + + +@bp.route('/tesseract-ocr-pipeline-models//is_public', methods=['PUT']) +@permission_required('CONTRIBUTE') +@content_negotiation(consumes='application/json', produces='application/json') +def update_tesseract_ocr_pipeline_model_is_public(tesseract_ocr_pipeline_model_id): + is_public = request.json + if not isinstance(is_public, bool): + abort(400) + topm = TesseractOCRPipelineModel.query.get_or_404(tesseract_ocr_pipeline_model_id) + if not (topm.user == current_user or current_user.is_administrator()): + abort(403) + topm.is_public = is_public + db.session.commit() + response_data = { + 'message': ( + f'Tesseract OCR Pipeline Model "{topm.title}"' + f' is now {"public" if is_public else "private"}' + ) + } + return response_data, 200 diff --git a/app/contributions/tesseract_ocr_pipeline_models/routes.py b/app/contributions/tesseract_ocr_pipeline_models/routes.py new file mode 100644 index 00000000..0f0390aa --- /dev/null +++ b/app/contributions/tesseract_ocr_pipeline_models/routes.py @@ -0,0 +1,76 @@ +from flask import abort, flash, redirect, render_template, url_for +from flask_breadcrumbs import register_breadcrumb +from flask_login import current_user +from app import db +from app.models import TesseractOCRPipelineModel +from . import bp +from .forms import ( + CreateTesseractOCRPipelineModelForm, + UpdateTesseractOCRPipelineModelForm +) +from .utils import ( + tesseract_ocr_pipeline_model_dlc as tesseract_ocr_pipeline_model_dlc +) + + +@bp.route('/tesseract-ocr-pipeline-models') +@register_breadcrumb(bp, '.tesseract_ocr_pipeline_models', 'Tesseract OCR Pipeline Models') +def tesseract_ocr_pipeline_models(): + return render_template( + 'contributions/tesseract_ocr_pipeline_models/tesseract_ocr_pipeline_models.html.j2', + title='Tesseract OCR Pipeline Models' + ) + + +@bp.route('/tesseract-ocr-pipeline-models/create', methods=['GET', 'POST']) +@register_breadcrumb(bp, '.tesseract_ocr_pipeline_models.create', 'Create') +def create_tesseract_ocr_pipeline_model(): + form = CreateTesseractOCRPipelineModelForm() + if form.is_submitted(): + if not form.validate(): + return {'errors': form.errors}, 400 + try: + topm = TesseractOCRPipelineModel.create( + form.tesseract_model_file.data, + compatible_service_versions=form.compatible_service_versions.data, + description=form.description.data, + publisher=form.publisher.data, + publisher_url=form.publisher_url.data, + publishing_url=form.publishing_url.data, + publishing_year=form.publishing_year.data, + is_public=False, + title=form.title.data, + version=form.version.data, + user=current_user + ) + except OSError: + abort(500) + db.session.commit() + flash(f'Tesseract OCR Pipeline model "{topm.title}" created') + return {}, 201, {'Location': url_for('.tesseract_ocr_pipeline_models')} + return render_template( + 'contributions/tesseract_ocr_pipeline_models/create.html.j2', + title='Create Tesseract OCR Pipeline Model', + form=form + ) + + +@bp.route('/tesseract-ocr-pipeline-models/', methods=['GET', 'POST']) +@register_breadcrumb(bp, '.tesseract_ocr_pipeline_models.entity', '', dynamic_list_constructor=tesseract_ocr_pipeline_model_dlc) +def tesseract_ocr_pipeline_model(tesseract_ocr_pipeline_model_id): + topm = TesseractOCRPipelineModel.query.get_or_404(tesseract_ocr_pipeline_model_id) + if not (topm.user == current_user or current_user.is_administrator()): + abort(403) + form = UpdateTesseractOCRPipelineModelForm(data=topm.to_json_serializeable()) + if form.validate_on_submit(): + form.populate_obj(topm) + if db.session.is_modified(topm): + flash(f'Tesseract OCR Pipeline model "{topm.title}" updated') + db.session.commit() + return redirect(url_for('.tesseract_ocr_pipeline_models')) + return render_template( + 'contributions/tesseract_ocr_pipeline_models/tesseract_ocr_pipeline_model.html.j2', + title=f'{topm.title} {topm.version}', + form=form, + tesseract_ocr_pipeline_model=topm + ) diff --git a/app/contributions/tesseract_ocr_pipeline_models/utils.py b/app/contributions/tesseract_ocr_pipeline_models/utils.py new file mode 100644 index 00000000..d0fcd758 --- /dev/null +++ b/app/contributions/tesseract_ocr_pipeline_models/utils.py @@ -0,0 +1,13 @@ +from flask import request, url_for +from app.models import TesseractOCRPipelineModel + + +def tesseract_ocr_pipeline_model_dlc(): + topm_id = request.view_args['tesseract_ocr_pipeline_model_id'] + topm = TesseractOCRPipelineModel.query.get_or_404(topm_id) + return [ + { + 'text': f'{topm.title} {topm.version}', + 'url': url_for('.tesseract_ocr_pipeline_model', tesseract_ocr_pipeline_model_id=topm_id) + } + ] diff --git a/app/contributions/transkribus_htr_pipeline_models/__init__.py b/app/contributions/transkribus_htr_pipeline_models/__init__.py new file mode 100644 index 00000000..e91268cf --- /dev/null +++ b/app/contributions/transkribus_htr_pipeline_models/__init__.py @@ -0,0 +1,2 @@ +from .. import bp +from . import routes diff --git a/app/contributions/transkribus_htr_pipeline_models/routes.py b/app/contributions/transkribus_htr_pipeline_models/routes.py new file mode 100644 index 00000000..dc698c0f --- /dev/null +++ b/app/contributions/transkribus_htr_pipeline_models/routes.py @@ -0,0 +1,7 @@ +from flask import abort +from . import bp + + +@bp.route('/transkribus_htr_pipeline_models') +def transkribus_htr_pipeline_models(): + return abort(503) diff --git a/app/converters/cli.py b/app/converters/cli.py new file mode 100644 index 00000000..a7baf465 --- /dev/null +++ b/app/converters/cli.py @@ -0,0 +1,22 @@ +import click +from . import bp +from .sandpaper import SandpaperConverter + + +@bp.cli.group('converter') +def converter(): + ''' Converter commands. ''' + pass + +@converter.group('sandpaper') +def sandpaper_converter(): + ''' Sandpaper converter commands. ''' + pass + +@sandpaper_converter.command('run') +@click.argument('json_db_file') +@click.argument('data_dir') +def run_sandpaper_converter(json_db_file, data_dir): + ''' Run the sandpaper converter. ''' + sandpaper_converter = SandpaperConverter(json_db_file, data_dir) + sandpaper_converter.run() diff --git a/app/converters/sandpaper.py b/app/converters/sandpaper.py index 2ea61d98..27f2bcc6 100644 --- a/app/converters/sandpaper.py +++ b/app/converters/sandpaper.py @@ -7,101 +7,106 @@ import os import shutil -def convert(json_db_file, data_dir): - with open(json_db_file, 'r') as f: - json_db = json.loads(f.read()) +class SandpaperConverter: + def __init__(self, json_db_file, data_dir): + self.json_db_file = json_db_file + self.data_dir = data_dir - for json_user in json_db: - if not json_user['confirmed']: - current_app.logger.info(f'Skip unconfirmed user {json_user["username"]}') - continue - user_dir = os.path.join(data_dir, str(json_user['id'])) - convert_user(json_user, user_dir) - db.session.commit() + def run(self): + with open(self.json_db_file, 'r') as f: + json_db = json.loads(f.read()) + + for json_user in json_db: + if not json_user['confirmed']: + current_app.logger.info(f'Skip unconfirmed user {json_user["username"]}') + continue + user_dir = os.path.join(self.data_dir, str(json_user['id'])) + self.convert_user(json_user, user_dir) + db.session.commit() -def convert_user(json_user, user_dir): - current_app.logger.info(f'Create User {json_user["username"]}...') - user = User( - confirmed=json_user['confirmed'], - email=json_user['email'], - last_seen=datetime.fromtimestamp(json_user['last_seen']), - member_since=datetime.fromtimestamp(json_user['member_since']), - password_hash=json_user['password_hash'], # TODO: Needs to be added manually - username=json_user['username'] - ) - db.session.add(user) - db.session.flush(objects=[user]) - db.session.refresh(user) - try: - user.makedirs() - except OSError as e: - current_app.logger.error(e) - db.session.rollback() - raise Exception('Internal Server Error') - for json_corpus in json_user['corpora'].values(): - if not json_corpus['files'].values(): - current_app.logger.info(f'Skip empty corpus {json_corpus["title"]}') - continue - corpus_dir = os.path.join(user_dir, 'corpora', str(json_corpus['id'])) - convert_corpus(json_corpus, user, corpus_dir) - current_app.logger.info('Done') - - -def convert_corpus(json_corpus, user, corpus_dir): - current_app.logger.info(f'Create Corpus {json_corpus["title"]}...') - corpus = Corpus( - user=user, - creation_date=datetime.fromtimestamp(json_corpus['creation_date']), - description=json_corpus['description'], - title=json_corpus['title'] - ) - db.session.add(corpus) - db.session.flush(objects=[corpus]) - db.session.refresh(corpus) - try: - corpus.makedirs() - except OSError as e: - current_app.logger.error(e) - db.session.rollback() - raise Exception('Internal Server Error') - for json_corpus_file in json_corpus['files'].values(): - convert_corpus_file(json_corpus_file, corpus, corpus_dir) - current_app.logger.info('Done') - - -def convert_corpus_file(json_corpus_file, corpus, corpus_dir): - current_app.logger.info(f'Create CorpusFile {json_corpus_file["title"]}...') - corpus_file = CorpusFile( - corpus=corpus, - address=json_corpus_file['address'], - author=json_corpus_file['author'], - booktitle=json_corpus_file['booktitle'], - chapter=json_corpus_file['chapter'], - editor=json_corpus_file['editor'], - filename=json_corpus_file['filename'], - institution=json_corpus_file['institution'], - journal=json_corpus_file['journal'], - mimetype='application/vrt+xml', - pages=json_corpus_file['pages'], - publisher=json_corpus_file['publisher'], - publishing_year=json_corpus_file['publishing_year'], - school=json_corpus_file['school'], - title=json_corpus_file['title'] - ) - db.session.add(corpus_file) - db.session.flush(objects=[corpus_file]) - db.session.refresh(corpus_file) - try: - shutil.copy2( - os.path.join(corpus_dir, json_corpus_file['filename']), - corpus_file.path + def convert_user(self, json_user, user_dir): + current_app.logger.info(f'Create User {json_user["username"]}...') + user = User( + confirmed=json_user['confirmed'], + email=json_user['email'], + last_seen=datetime.fromtimestamp(json_user['last_seen']), + member_since=datetime.fromtimestamp(json_user['member_since']), + password_hash=json_user['password_hash'], # TODO: Needs to be added manually + username=json_user['username'] ) - except: - current_app.logger.warning( - 'Can not convert corpus file: ' - f'{os.path.join(corpus_dir, json_corpus_file["filename"])}' - ' -> ' - f'{corpus_file.path}' + db.session.add(user) + db.session.flush(objects=[user]) + db.session.refresh(user) + try: + user.makedirs() + except OSError as e: + current_app.logger.error(e) + db.session.rollback() + raise Exception('Internal Server Error') + for json_corpus in json_user['corpora'].values(): + if not json_corpus['files'].values(): + current_app.logger.info(f'Skip empty corpus {json_corpus["title"]}') + continue + corpus_dir = os.path.join(user_dir, 'corpora', str(json_corpus['id'])) + self.convert_corpus(json_corpus, user, corpus_dir) + current_app.logger.info('Done') + + + def convert_corpus(self, json_corpus, user, corpus_dir): + current_app.logger.info(f'Create Corpus {json_corpus["title"]}...') + corpus = Corpus( + user=user, + creation_date=datetime.fromtimestamp(json_corpus['creation_date']), + description=json_corpus['description'], + title=json_corpus['title'] ) - current_app.logger.info('Done') + db.session.add(corpus) + db.session.flush(objects=[corpus]) + db.session.refresh(corpus) + try: + corpus.makedirs() + except OSError as e: + current_app.logger.error(e) + db.session.rollback() + raise Exception('Internal Server Error') + for json_corpus_file in json_corpus['files'].values(): + self.convert_corpus_file(json_corpus_file, corpus, corpus_dir) + current_app.logger.info('Done') + + + def convert_corpus_file(self, json_corpus_file, corpus, corpus_dir): + current_app.logger.info(f'Create CorpusFile {json_corpus_file["title"]}...') + corpus_file = CorpusFile( + corpus=corpus, + address=json_corpus_file['address'], + author=json_corpus_file['author'], + booktitle=json_corpus_file['booktitle'], + chapter=json_corpus_file['chapter'], + editor=json_corpus_file['editor'], + filename=json_corpus_file['filename'], + institution=json_corpus_file['institution'], + journal=json_corpus_file['journal'], + mimetype='application/vrt+xml', + pages=json_corpus_file['pages'], + publisher=json_corpus_file['publisher'], + publishing_year=json_corpus_file['publishing_year'], + school=json_corpus_file['school'], + title=json_corpus_file['title'] + ) + db.session.add(corpus_file) + db.session.flush(objects=[corpus_file]) + db.session.refresh(corpus_file) + try: + shutil.copy2( + os.path.join(corpus_dir, json_corpus_file['filename']), + corpus_file.path + ) + except: + current_app.logger.warning( + 'Can not convert corpus file: ' + f'{os.path.join(corpus_dir, json_corpus_file["filename"])}' + ' -> ' + f'{corpus_file.path}' + ) + current_app.logger.info('Done') diff --git a/app/corpora/__init__.py b/app/corpora/__init__.py index 83cecec5..34663b69 100644 --- a/app/corpora/__init__.py +++ b/app/corpora/__init__.py @@ -1,5 +1,19 @@ from flask import Blueprint +from flask_login import login_required bp = Blueprint('corpora', __name__) -from . import cqi_over_socketio, routes # noqa +bp.cli.short_help = 'Corpus commands.' + + +@bp.before_request +@login_required +def before_request(): + ''' + Ensures that the routes in this package can only be visited by users that + are logged in. + ''' + pass + + +from . import cli, cqi_over_socketio, files, followers, routes, json_routes diff --git a/app/corpora/cli.py b/app/corpora/cli.py new file mode 100644 index 00000000..67658825 --- /dev/null +++ b/app/corpora/cli.py @@ -0,0 +1,24 @@ +from app.models import Corpus, CorpusStatus +import os +import shutil +from app import db +from . import bp + + +@bp.cli.command('reset') +def reset(): + ''' Reset built corpora. ''' + status = [ + CorpusStatus.QUEUED, + CorpusStatus.BUILDING, + CorpusStatus.BUILT, + CorpusStatus.STARTING_ANALYSIS_SESSION, + CorpusStatus.RUNNING_ANALYSIS_SESSION, + CorpusStatus.CANCELING_ANALYSIS_SESSION + ] + for corpus in [x for x in Corpus.query.all() if x.status in status]: + print(f'Resetting corpus {corpus}') + shutil.rmtree(os.path.join(corpus.path, 'cwb'), ignore_errors=True) + corpus.status = CorpusStatus.UNPREPARED + corpus.num_analysis_sessions = 0 + db.session.commit() diff --git a/app/corpora/cqi_over_socketio/cqi_corpora_corpus.py b/app/corpora/cqi_over_socketio/cqi_corpora_corpus.py index 5332aade..9a976dd7 100644 --- a/app/corpora/cqi_over_socketio/cqi_corpora_corpus.py +++ b/app/corpora/cqi_over_socketio/cqi_corpora_corpus.py @@ -38,7 +38,7 @@ def cqi_corpora_corpus_query(cqi_client: cqi.CQiClient, corpus_name: str, subcor @cqi_over_socketio def cqi_corpora_corpus_update_db(cqi_client: cqi.CQiClient, corpus_name: str): corpus = Corpus.query.get(session['d']['corpus_id']) - corpus.num_tokens = cqi_client.corpora.get('CORPUS').attrs['size'] + corpus.num_tokens = cqi_client.corpora.get(corpus_name).attrs['size'] db.session.commit() diff --git a/app/corpora/decorators.py b/app/corpora/decorators.py new file mode 100644 index 00000000..1cf78feb --- /dev/null +++ b/app/corpora/decorators.py @@ -0,0 +1,33 @@ +from flask import abort +from flask_login import current_user +from functools import wraps +from app.models import Corpus, CorpusFollowerAssociation + + +def corpus_follower_permission_required(*permissions): + def decorator(f): + @wraps(f) + def decorated_function(*args, **kwargs): + corpus_id = kwargs.get('corpus_id') + corpus = Corpus.query.get_or_404(corpus_id) + if not (corpus.user == current_user or current_user.is_administrator()): + cfa = CorpusFollowerAssociation.query.filter_by(corpus_id=corpus_id, follower_id=current_user.id).first() + if cfa is None: + abort(403) + if not all([cfa.role.has_permission(p) for p in permissions]): + abort(403) + return f(*args, **kwargs) + return decorated_function + return decorator + + +def corpus_owner_or_admin_required(f): + @wraps(f) + def decorated_function(*args, **kwargs): + corpus_id = kwargs.get('corpus_id') + corpus = Corpus.query.get_or_404(corpus_id) + if not (corpus.user == current_user or current_user.is_administrator()): + abort(403) + return f(*args, **kwargs) + return decorated_function + diff --git a/app/corpora/events.py b/app/corpora/events.py new file mode 100644 index 00000000..6c32e2ba --- /dev/null +++ b/app/corpora/events.py @@ -0,0 +1,45 @@ +from flask_login import current_user +from flask_socketio import join_room +from app import hashids, socketio +from app.decorators import socketio_login_required +from app.models import Corpus + + +@socketio.on('GET /corpora/') +@socketio_login_required +def get_corpus(corpus_hashid): + corpus_id = hashids.decode(corpus_hashid) + corpus = Corpus.query.get(corpus_id) + if corpus is None: + return {'options': {'status': 404, 'statusText': 'Not found'}} + if not ( + corpus.is_public + or corpus.user == current_user + or current_user.is_administrator() + ): + return {'options': {'status': 403, 'statusText': 'Forbidden'}} + return { + 'body': corpus.to_json_serializable(), + 'options': { + 'status': 200, + 'statusText': 'OK', + 'headers': {'Content-Type: application/json'} + } + } + + +@socketio.on('SUBSCRIBE /corpora/') +@socketio_login_required +def subscribe_corpus(corpus_hashid): + corpus_id = hashids.decode(corpus_hashid) + corpus = Corpus.query.get(corpus_id) + if corpus is None: + return {'options': {'status': 404, 'statusText': 'Not found'}} + if not ( + corpus.is_public + or corpus.user == current_user + or current_user.is_administrator() + ): + return {'options': {'status': 403, 'statusText': 'Forbidden'}} + join_room(f'/corpora/{corpus.hashid}') + return {'options': {'status': 200, 'statusText': 'OK'}} diff --git a/app/corpora/files/__init__.py b/app/corpora/files/__init__.py new file mode 100644 index 00000000..e06bada9 --- /dev/null +++ b/app/corpora/files/__init__.py @@ -0,0 +1,2 @@ +from .. import bp +from . import json_routes, routes diff --git a/app/corpora/files/forms.py b/app/corpora/files/forms.py new file mode 100644 index 00000000..e6918a83 --- /dev/null +++ b/app/corpora/files/forms.py @@ -0,0 +1,54 @@ +from flask_wtf import FlaskForm +from flask_wtf.file import FileField, FileRequired +from wtforms import ( + StringField, + SubmitField, + ValidationError, + IntegerField +) +from wtforms.validators import InputRequired, Length + + +class CorpusFileBaseForm(FlaskForm): + author = StringField( + 'Author', + validators=[InputRequired(), Length(max=255)] + ) + publishing_year = IntegerField( + 'Publishing year', + validators=[InputRequired()] + ) + title = StringField( + 'Title', + validators=[InputRequired(), Length(max=255)] + ) + address = StringField('Adress', validators=[Length(max=255)]) + booktitle = StringField('Booktitle', validators=[Length(max=255)]) + chapter = StringField('Chapter', validators=[Length(max=255)]) + editor = StringField('Editor', validators=[Length(max=255)]) + institution = StringField('Institution', validators=[Length(max=255)]) + journal = StringField('Journal', validators=[Length(max=255)]) + pages = StringField('Pages', validators=[Length(max=255)]) + publisher = StringField('Publisher', validators=[Length(max=255)]) + school = StringField('School', validators=[Length(max=255)]) + submit = SubmitField() + + +class CreateCorpusFileForm(CorpusFileBaseForm): + vrt = FileField('File', validators=[FileRequired()]) + + def validate_vrt(self, field): + if not field.data.filename.lower().endswith('.vrt'): + raise ValidationError('VRT files only!') + + def __init__(self, *args, **kwargs): + if 'prefix' not in kwargs: + kwargs['prefix'] = 'create-corpus-file-form' + super().__init__(*args, **kwargs) + + +class UpdateCorpusFileForm(CorpusFileBaseForm): + def __init__(self, *args, **kwargs): + if 'prefix' not in kwargs: + kwargs['prefix'] = 'update-corpus-file-form' + super().__init__(*args, **kwargs) diff --git a/app/corpora/files/json_routes.py b/app/corpora/files/json_routes.py new file mode 100644 index 00000000..f8d5ddb4 --- /dev/null +++ b/app/corpora/files/json_routes.py @@ -0,0 +1,30 @@ +from flask import abort, current_app +from threading import Thread +from app import db +from app.decorators import content_negotiation +from app.models import CorpusFile +from ..decorators import corpus_follower_permission_required +from . import bp + + +@bp.route('//files/', methods=['DELETE']) +@corpus_follower_permission_required('MANAGE_FILES') +@content_negotiation(produces='application/json') +def delete_corpus_file(corpus_id, corpus_file_id): + def _delete_corpus_file(app, corpus_file_id): + with app.app_context(): + corpus_file = CorpusFile.query.get(corpus_file_id) + corpus_file.delete() + db.session.commit() + + corpus_file = CorpusFile.query.filter_by(corpus_id=corpus_id, id=corpus_file_id).first_or_404() + thread = Thread( + target=_delete_corpus_file, + args=(current_app._get_current_object(), corpus_file.id) + ) + thread.start() + response_data = { + 'message': f'Corpus File "{corpus_file.title}" marked for deletion', + 'category': 'corpus' + } + return response_data, 202 diff --git a/app/corpora/files/routes.py b/app/corpora/files/routes.py new file mode 100644 index 00000000..e5ad094d --- /dev/null +++ b/app/corpora/files/routes.py @@ -0,0 +1,100 @@ +from flask import ( + abort, + flash, + redirect, + render_template, + send_from_directory, + url_for +) +from flask_breadcrumbs import register_breadcrumb +import os +from app import db +from app.models import Corpus, CorpusFile, CorpusStatus +from ..decorators import corpus_follower_permission_required +from ..utils import corpus_endpoint_arguments_constructor as corpus_eac +from . import bp +from .forms import CreateCorpusFileForm, UpdateCorpusFileForm +from .utils import corpus_file_dynamic_list_constructor as corpus_file_dlc + + +@bp.route('//files') +@register_breadcrumb(bp, '.entity.files', 'Files', endpoint_arguments_constructor=corpus_eac) +def corpus_files(corpus_id): + return redirect(url_for('.corpus', _anchor='files', corpus_id=corpus_id)) + + +@bp.route('//files/create', methods=['GET', 'POST']) +@register_breadcrumb(bp, '.entity.files.create', 'Create', endpoint_arguments_constructor=corpus_eac) +@corpus_follower_permission_required('MANAGE_FILES') +def create_corpus_file(corpus_id): + corpus = Corpus.query.get_or_404(corpus_id) + form = CreateCorpusFileForm() + if form.is_submitted(): + if not form.validate(): + response = {'errors': form.errors} + return response, 400 + try: + corpus_file = CorpusFile.create( + form.vrt.data, + address=form.address.data, + author=form.author.data, + booktitle=form.booktitle.data, + chapter=form.chapter.data, + editor=form.editor.data, + institution=form.institution.data, + journal=form.journal.data, + pages=form.pages.data, + publisher=form.publisher.data, + publishing_year=form.publishing_year.data, + school=form.school.data, + title=form.title.data, + mimetype='application/vrt+xml', + corpus=corpus + ) + except (AttributeError, OSError): + abort(500) + corpus.status = CorpusStatus.UNPREPARED + db.session.commit() + flash(f'Corpus File "{corpus_file.filename}" added', category='corpus') + return '', 201, {'Location': corpus.url} + return render_template( + 'corpora/files/create.html.j2', + title='Add corpus file', + form=form, + corpus=corpus + ) + + +@bp.route('//files/', methods=['GET', 'POST']) +@register_breadcrumb(bp, '.entity.files.entity', '', dynamic_list_constructor=corpus_file_dlc) +@corpus_follower_permission_required('MANAGE_FILES') +def corpus_file(corpus_id, corpus_file_id): + corpus_file = CorpusFile.query.filter_by(corpus_id=corpus_id, id=corpus_file_id).first_or_404() + form = UpdateCorpusFileForm(data=corpus_file.to_json_serializeable()) + if form.validate_on_submit(): + form.populate_obj(corpus_file) + if db.session.is_modified(corpus_file): + corpus_file.corpus.status = CorpusStatus.UNPREPARED + db.session.commit() + flash(f'Corpus file "{corpus_file.filename}" updated', category='corpus') + return redirect(corpus_file.corpus.url) + return render_template( + 'corpora/files/corpus_file.html.j2', + title='Edit corpus file', + form=form, + corpus=corpus_file.corpus, + corpus_file=corpus_file + ) + + +@bp.route('//files//download') +@corpus_follower_permission_required('VIEW') +def download_corpus_file(corpus_id, corpus_file_id): + corpus_file = CorpusFile.query.filter_by(corpus_id=corpus_id, id=corpus_file_id).first_or_404() + return send_from_directory( + os.path.dirname(corpus_file.path), + os.path.basename(corpus_file.path), + as_attachment=True, + attachment_filename=corpus_file.filename, + mimetype=corpus_file.mimetype + ) diff --git a/app/corpora/files/utils.py b/app/corpora/files/utils.py new file mode 100644 index 00000000..2bb10285 --- /dev/null +++ b/app/corpora/files/utils.py @@ -0,0 +1,15 @@ +from flask import request, url_for +from app.models import CorpusFile +from ..utils import corpus_endpoint_arguments_constructor as corpus_eac + + +def corpus_file_dynamic_list_constructor(): + corpus_id = request.view_args['corpus_id'] + corpus_file_id = request.view_args['corpus_file_id'] + corpus_file = CorpusFile.query.filter_by(corpus_id=corpus_id, id=corpus_file_id).first_or_404() + return [ + { + 'text': f'{corpus_file.author}: {corpus_file.title} ({corpus_file.publishing_year})', + 'url': url_for('.corpus_file', corpus_id=corpus_id, corpus_file_id=corpus_file_id) + } + ] diff --git a/app/corpora/followers/__init__.py b/app/corpora/followers/__init__.py new file mode 100644 index 00000000..1dbe44f0 --- /dev/null +++ b/app/corpora/followers/__init__.py @@ -0,0 +1,2 @@ +from .. import bp +from . import json_routes diff --git a/app/corpora/followers/json_routes.py b/app/corpora/followers/json_routes.py new file mode 100644 index 00000000..db6bb635 --- /dev/null +++ b/app/corpora/followers/json_routes.py @@ -0,0 +1,76 @@ +from flask import abort, flash, jsonify, make_response, request +from flask_login import current_user +from app import db +from app.decorators import content_negotiation +from app.models import ( + Corpus, + CorpusFollowerAssociation, + CorpusFollowerRole, + User +) +from ..decorators import corpus_follower_permission_required +from . import bp + + +# @bp.route('//followers', methods=['POST']) +# @corpus_follower_permission_required('MANAGE_FOLLOWERS') +# @content_negotiation(consumes='application/json', produces='application/json') +# def create_corpus_followers(corpus_id): +# usernames = request.json +# if not (isinstance(usernames, list) or all(isinstance(u, str) for u in usernames)): +# abort(400) +# corpus = Corpus.query.get_or_404(corpus_id) +# for username in usernames: +# user = User.query.filter_by(username=username, is_public=True).first_or_404() +# user.follow_corpus(corpus) +# db.session.commit() +# response_data = { +# 'message': f'Users are now following "{corpus.title}"', +# 'category': 'corpus' +# } +# return response_data, 200 + + +# @bp.route('//followers//role', methods=['PUT']) +# @corpus_follower_permission_required('MANAGE_FOLLOWERS') +# @content_negotiation(consumes='application/json', produces='application/json') +# def update_corpus_follower_role(corpus_id, follower_id): +# role_name = request.json +# if not isinstance(role_name, str): +# abort(400) +# cfr = CorpusFollowerRole.query.filter_by(name=role_name).first() +# if cfr is None: +# abort(400) +# cfa = CorpusFollowerAssociation.query.filter_by(corpus_id=corpus_id, follower_id=follower_id).first_or_404() +# cfa.role = cfr +# db.session.commit() +# response_data = { +# 'message': f'User "{cfa.follower.username}" is now {cfa.role.name}', +# 'category': 'corpus' +# } +# return response_data, 200 + + +# @bp.route('//followers/', methods=['DELETE']) +# def delete_corpus_follower(corpus_id, follower_id): +# cfa = CorpusFollowerAssociation.query.filter_by(corpus_id=corpus_id, follower_id=follower_id).first_or_404() +# if not ( +# current_user.id == follower_id +# or current_user == cfa.corpus.user +# or CorpusFollowerAssociation.query.filter_by(corpus_id=corpus_id, follower_id=current_user.id).first().role.has_permission('MANAGE_FOLLOWERS') +# or current_user.is_administrator()): +# abort(403) +# if current_user.id == follower_id: +# flash(f'You are no longer following "{cfa.corpus.title}"', 'corpus') +# response = make_response() +# response.status_code = 204 +# else: +# response_data = { +# 'message': f'"{cfa.follower.username}" is not following "{cfa.corpus.title}" anymore', +# 'category': 'corpus' +# } +# response = jsonify(response_data) +# response.status_code = 200 +# cfa.follower.unfollow_corpus(cfa.corpus) +# db.session.commit() +# return response diff --git a/app/corpora/forms.py b/app/corpora/forms.py index 8403e621..fa8ccd05 100644 --- a/app/corpora/forms.py +++ b/app/corpora/forms.py @@ -1,13 +1,5 @@ from flask_wtf import FlaskForm -from flask_wtf.file import FileField, FileRequired -from wtforms import ( - BooleanField, - StringField, - SubmitField, - TextAreaField, - ValidationError, - IntegerField -) +from wtforms import StringField, SubmitField, TextAreaField from wtforms.validators import InputRequired, Length @@ -34,50 +26,8 @@ class UpdateCorpusForm(CorpusBaseForm): super().__init__(*args, **kwargs) -class CorpusFileBaseForm(FlaskForm): - author = StringField( - 'Author', - validators=[InputRequired(), Length(max=255)] - ) - publishing_year = IntegerField( - 'Publishing year', - validators=[InputRequired()] - ) - title = StringField( - 'Title', - validators=[InputRequired(), Length(max=255)] - ) - address = StringField('Adress', validators=[Length(max=255)]) - booktitle = StringField('Booktitle', validators=[Length(max=255)]) - chapter = StringField('Chapter', validators=[Length(max=255)]) - editor = StringField('Editor', validators=[Length(max=255)]) - institution = StringField('Institution', validators=[Length(max=255)]) - journal = StringField('Journal', validators=[Length(max=255)]) - pages = StringField('Pages', validators=[Length(max=255)]) - publisher = StringField('Publisher', validators=[Length(max=255)]) - school = StringField('School', validators=[Length(max=255)]) - submit = SubmitField() - - -class CreateCorpusFileForm(CorpusFileBaseForm): - vrt = FileField('File', validators=[FileRequired()]) - - def __init__(self, *args, **kwargs): - if 'prefix' not in kwargs: - kwargs['prefix'] = 'create-corpus-file-form' - super().__init__(*args, **kwargs) - - def validate_vrt(self, field): - if not field.data.filename.lower().endswith('.vrt'): - raise ValidationError('VRT files only!') - - -class UpdateCorpusFileForm(CorpusFileBaseForm): - def __init__(self, *args, **kwargs): - if 'prefix' not in kwargs: - kwargs['prefix'] = 'update-corpus-file-form' - super().__init__(*args, **kwargs) - - class ImportCorpusForm(FlaskForm): - pass + def __init__(self, *args, **kwargs): + if 'prefix' not in kwargs: + kwargs['prefix'] = 'import-corpus-form' + super().__init__(*args, **kwargs) diff --git a/app/corpora/json_routes.py b/app/corpora/json_routes.py new file mode 100644 index 00000000..6005fc48 --- /dev/null +++ b/app/corpora/json_routes.py @@ -0,0 +1,111 @@ +from datetime import datetime +from flask import abort, current_app, request, url_for +from flask_login import current_user +from threading import Thread +from app import db +from app.decorators import content_negotiation +from app.models import Corpus, CorpusFollowerRole +from . import bp +from .decorators import corpus_follower_permission_required, corpus_owner_or_admin_required + + +@bp.route('/', methods=['DELETE']) +@corpus_owner_or_admin_required +@content_negotiation(produces='application/json') +def delete_corpus(corpus_id): + def _delete_corpus(app, corpus_id): + with app.app_context(): + corpus = Corpus.query.get(corpus_id) + corpus.delete() + db.session.commit() + + corpus = Corpus.query.get_or_404(corpus_id) + thread = Thread( + target=_delete_corpus, + args=(current_app._get_current_object(), corpus.id) + ) + thread.start() + response_data = { + 'message': f'Corpus "{corpus.title}" marked for deletion', + 'category': 'corpus' + } + return response_data, 200 + + +@bp.route('//build', methods=['POST']) +@corpus_follower_permission_required('MANAGE_FILES') +@content_negotiation(produces='application/json') +def build_corpus(corpus_id): + def _build_corpus(app, corpus_id): + with app.app_context(): + corpus = Corpus.query.get(corpus_id) + corpus.build() + db.session.commit() + + corpus = Corpus.query.get_or_404(corpus_id) + if len(corpus.files.all()) == 0: + abort(409) + thread = Thread( + target=_build_corpus, + args=(current_app._get_current_object(), corpus_id) + ) + thread.start() + response_data = { + 'message': f'Corpus "{corpus.title}" marked for building', + 'category': 'corpus' + } + return response_data, 202 + + +# @bp.route('//generate-share-link', methods=['POST']) +# @corpus_follower_permission_required('MANAGE_FOLLOWERS') +# @content_negotiation(consumes='application/json', produces='application/json') +# def generate_corpus_share_link(corpus_id): +# data = request.json +# if not isinstance(data, dict): +# abort(400) +# expiration = data.get('expiration') +# if not isinstance(expiration, str): +# abort(400) +# role_name = data.get('role') +# if not isinstance(role_name, str): +# abort(400) +# expiration_date = datetime.strptime(expiration, '%b %d, %Y') +# cfr = CorpusFollowerRole.query.filter_by(name=role_name).first() +# if cfr is None: +# abort(400) +# corpus = Corpus.query.get_or_404(corpus_id) +# token = current_user.generate_follow_corpus_token(corpus.hashid, role_name, expiration_date) +# corpus_share_link = url_for( +# 'corpora.follow_corpus', +# corpus_id=corpus_id, +# token=token, +# _external=True +# ) +# response_data = { +# 'message': 'Corpus share link generated', +# 'category': 'corpus', +# 'corpusShareLink': corpus_share_link +# } +# return response_data, 200 + + + +# @bp.route('//is_public', methods=['PUT']) +# @corpus_owner_or_admin_required +# @content_negotiation(consumes='application/json', produces='application/json') +# def update_corpus_is_public(corpus_id): +# is_public = request.json +# if not isinstance(is_public, bool): +# abort(400) +# corpus = Corpus.query.get_or_404(corpus_id) +# corpus.is_public = is_public +# db.session.commit() +# response_data = { +# 'message': ( +# f'Corpus "{corpus.title}" is now' +# f' {"public" if is_public else "private"}' +# ), +# 'category': 'corpus' +# } +# return response_data, 200 diff --git a/app/corpora/routes.py b/app/corpora/routes.py index 4b10fa2c..b1b9142d 100644 --- a/app/corpora/routes.py +++ b/app/corpora/routes.py @@ -1,139 +1,30 @@ -from datetime import datetime -from flask import ( - abort, - current_app, - flash, - Markup, - redirect, - render_template, - request, - send_from_directory, - url_for +from flask import abort, flash, redirect, render_template, url_for +from flask_breadcrumbs import register_breadcrumb +from flask_login import current_user +from app import db +from app.models import ( + Corpus, + CorpusFollowerAssociation, + CorpusFollowerRole, + User ) -from flask_login import current_user, login_required -from threading import Thread -import jwt -import os -from app import db, hashids -from app.models import Corpus, CorpusFile, CorpusStatus, User from . import bp -from .forms import ( - CreateCorpusFileForm, - CreateCorpusForm, - UpdateCorpusFileForm +from .decorators import corpus_follower_permission_required +from .forms import CreateCorpusForm +from .utils import ( + corpus_endpoint_arguments_constructor as corpus_eac, + corpus_dynamic_list_constructor as corpus_dlc ) -# @bp.route('/share/', methods=['GET', 'POST']) -# def share_corpus(token): -# try: -# payload = jwt.decode( -# token, -# current_app.config['SECRET_KEY'], -# algorithms=['HS256'], -# issuer=current_app.config['SERVER_NAME'], -# options={'require': ['iat', 'iss', 'sub']} -# ) -# except jwt.PyJWTError: -# return False -# corpus_hashid = payload.get('sub') -# corpus_id = hashids.decode(corpus_hashid) -# return redirect(url_for('.corpus', corpus_id=corpus_id)) - - -@bp.route('//enable_is_public', methods=['POST']) -@login_required -def enable_corpus_is_public(corpus_id): - corpus = Corpus.query.get_or_404(corpus_id) - if not (corpus.user == current_user or current_user.is_administrator()): - abort(403) - corpus.is_public = True - db.session.commit() - return '', 204 - - -@bp.route('//disable_is_public', methods=['POST']) -@login_required -def disable_corpus_is_public(corpus_id): - corpus = Corpus.query.get_or_404(corpus_id) - if not (corpus.user == current_user or current_user.is_administrator()): - abort(403) - corpus.is_public = False - db.session.commit() - return '', 204 - - -# @bp.route('//follow', methods=['GET', 'POST']) -# @login_required -# def follow_corpus(corpus_id): -# corpus = Corpus.query.get_or_404(corpus_id) -# user_hashid = request.args.get('user_id') -# if user_hashid is None: -# user = current_user -# else: -# if not current_user.is_administrator(): -# abort(403) -# else: -# user_id = hashids.decode(user_hashid) -# user = User.query.get_or_404(user_id) -# if not user.is_following_corpus(corpus): -# user.follow_corpus(corpus) -# db.session.commit() -# flash(f'You are following {corpus.title} now', category='corpus') -# return {}, 202 - - -@bp.route('//unfollow', methods=['GET', 'POST']) -@login_required -def unfollow_corpus(corpus_id): - corpus = Corpus.query.get_or_404(corpus_id) - user_hashid = request.args.get('user_id') - if user_hashid is None: - user = current_user - elif current_user.is_administrator(): - user_id = hashids.decode(user_hashid) - user = User.query.get_or_404(user_id) - else: - abort(403) - if user.is_following_corpus(corpus): - user.unfollow_corpus(corpus) - db.session.commit() - flash(f'You are not following {corpus.title} anymore', category='corpus') - return {}, 202 - - -# @bp.route('/add_permission///') -# def add_permission(corpus_id, user_id, permission): -# a = CorpusFollowerAssociation.query.filter_by(followed_corpus_id=corpus_id, following_user_id=user_id).first_or_404() -# a.add_permission(permission) -# db.session.commit() -# return 'ok' - - -# @bp.route('/remove_permission///') -# def remove_permission(corpus_id, user_id, permission): -# a = CorpusFollowerAssociation.query.filter_by(followed_corpus_id=corpus_id, following_user_id=user_id).first_or_404() -# a.remove_permission(permission) -# db.session.commit() -# return 'ok' - - -@bp.route('/public') -@login_required -def public_corpora(): - corpora = [ - c.to_json_serializeable() - for c in Corpus.query.filter(Corpus.is_public == True).all() - ] - return render_template( - 'corpora/public_corpora.html.j2', - corpora=corpora, - title='Corpora' - ) +@bp.route('') +@register_breadcrumb(bp, '.', 'IMy Corpora') +def corpora(): + return redirect(url_for('main.dashboard', _anchor='corpora')) @bp.route('/create', methods=['GET', 'POST']) -@login_required +@register_breadcrumb(bp, '.create', 'Create') def create_corpus(): form = CreateCorpusForm() if form.validate_on_submit(): @@ -146,224 +37,85 @@ def create_corpus(): except OSError: abort(500) db.session.commit() - message = Markup( - f'Corpus "{corpus.title}" created' - ) - flash(message, 'corpus') + flash(f'Corpus "{corpus.title}" created', 'corpus') return redirect(corpus.url) return render_template( - 'corpora/create_corpus.html.j2', - form=form, - title='Create corpus' + 'corpora/create.html.j2', + title='Create corpus', + form=form ) -@bp.route('/', methods=['GET', 'POST']) -@login_required +@bp.route('/') +@register_breadcrumb(bp, '.entity', '', dynamic_list_constructor=corpus_dlc) def corpus(corpus_id): corpus = Corpus.query.get_or_404(corpus_id) + cfrs = CorpusFollowerRole.query.all() + # TODO: Better solution for filtering admin + users = User.query.filter(User.is_public == True, User.id != current_user.id, User.id != corpus.user.id, User.role_id < 4).all() + cfa = CorpusFollowerAssociation.query.filter_by(corpus_id=corpus_id, follower_id=current_user.id).first() + if cfa is None: + if corpus.user == current_user or current_user.is_administrator(): + cfr = CorpusFollowerRole.query.filter_by(name='Administrator').first() + else: + cfr = CorpusFollowerRole.query.filter_by(name='Anonymous').first() + else: + cfr = cfa.role if corpus.user == current_user or current_user.is_administrator(): - # now = datetime.utcnow() - # payload = { - # 'exp': now + timedelta(weeks=1), - # 'iat': now, - # 'iss': current_app.config['SERVER_NAME'], - # 'sub': corpus.hashid - # } - # token = jwt.encode( - # payload, - # current_app.config['SECRET_KEY'], - # algorithm='HS256' - # ) return render_template( 'corpora/corpus.html.j2', + title=corpus.title, corpus=corpus, - # token=token, - title='Corpus' - ) - if current_user.is_following_corpus(corpus) or corpus.is_public: - corpus_files = [x.to_json_serializeable() for x in corpus.files] - return render_template( - 'corpora/public_corpus.html.j2', - corpus=corpus, - corpus_files=corpus_files, - title='Corpus' + cfr=cfr, + cfrs=cfrs, + users = users ) + if (current_user.is_following_corpus(corpus) or corpus.is_public): + abort(404) + # cfas = CorpusFollowerAssociation.query.filter(Corpus.id == corpus_id, CorpusFollowerAssociation.follower_id != corpus.user.id).all() + # return render_template( + # 'corpora/public_corpus.html.j2', + # title=corpus.title, + # corpus=corpus, + # cfrs=cfrs, + # cfr=cfr, + # cfas=cfas, + # users = users + # ) abort(403) -@bp.route('/', methods=['DELETE']) -@login_required -def delete_corpus(corpus_id): - def _delete_corpus(app, corpus_id): - with app.app_context(): - corpus = Corpus.query.get(corpus_id) - corpus.delete() - db.session.commit() +@bp.route('//analysis') +@corpus_follower_permission_required('VIEW') +@register_breadcrumb(bp, '.entity.analysis', 'Analysis', endpoint_arguments_constructor=corpus_eac) +def analysis(corpus_id): corpus = Corpus.query.get_or_404(corpus_id) - if not (corpus.user == current_user or current_user.is_administrator()): - abort(403) - thread = Thread( - target=_delete_corpus, - args=(current_app._get_current_object(), corpus_id) - ) - thread.start() - return {}, 202 - - -@bp.route('//analyse') -@login_required -def analyse_corpus(corpus_id): - corpus = Corpus.query.get_or_404(corpus_id) - if not (corpus.user == current_user - or current_user.is_administrator() - or current_user.is_following_corpus(corpus)): - abort(403) return render_template( - 'corpora/analyse_corpus.html.j2', + 'corpora/analysis.html.j2', corpus=corpus, title=f'Analyse Corpus {corpus.title}' ) -@bp.route('//build', methods=['POST']) -@login_required -def build_corpus(corpus_id): - def _build_corpus(app, corpus_id): - with app.app_context(): - corpus = Corpus.query.get(corpus_id) - corpus.build() - db.session.commit() - - corpus = Corpus.query.get_or_404(corpus_id) - if not (corpus.user == current_user or current_user.is_administrator()): - abort(403) - # Check if the corpus has corpus files - if not corpus.files.all(): - response = {'errors': {'message': 'Corpus file(s) required'}} - return response, 409 - thread = Thread( - target=_build_corpus, - args=(current_app._get_current_object(), corpus_id) - ) - thread.start() - return {}, 202 - - -@bp.route('//files/create', methods=['GET', 'POST']) -@login_required -def create_corpus_file(corpus_id): - corpus = Corpus.query.get_or_404(corpus_id) - if not (corpus.user == current_user or current_user.is_administrator()): - abort(403) - form = CreateCorpusFileForm() - if form.is_submitted(): - if not form.validate(): - response = {'errors': form.errors} - return response, 400 - try: - corpus_file = CorpusFile.create( - form.vrt.data, - address=form.address.data, - author=form.author.data, - booktitle=form.booktitle.data, - chapter=form.chapter.data, - editor=form.editor.data, - institution=form.institution.data, - journal=form.journal.data, - pages=form.pages.data, - publisher=form.publisher.data, - publishing_year=form.publishing_year.data, - school=form.school.data, - title=form.title.data, - mimetype='application/vrt+xml', - corpus=corpus - ) - except (AttributeError, OSError): - abort(500) - corpus.status = CorpusStatus.UNPREPARED - db.session.commit() - message = Markup( - 'Corpus file' - f'"{corpus_file.filename}" added' - ) - flash(message, category='corpus') - return {}, 201, {'Location': corpus.url} - return render_template( - 'corpora/create_corpus_file.html.j2', - corpus=corpus, - form=form, - title='Add corpus file' - ) - - -@bp.route('//files/', methods=['GET', 'POST']) -@login_required -def corpus_file(corpus_id, corpus_file_id): - corpus_file = CorpusFile.query.filter_by(corpus_id = corpus_id, id=corpus_file_id).first_or_404() - if not (corpus_file.corpus.user == current_user or current_user.is_administrator()): - abort(403) - form = UpdateCorpusFileForm(data=corpus_file.to_json_serializeable()) - if form.validate_on_submit(): - form.populate_obj(corpus_file) - if db.session.is_modified(corpus_file): - corpus_file.corpus.status = CorpusStatus.UNPREPARED - db.session.commit() - message = Markup(f'Corpus file "{corpus_file.filename}" updated') - flash(message, category='corpus') - return redirect(corpus_file.corpus.url) - return render_template( - 'corpora/corpus_file.html.j2', - corpus=corpus_file.corpus, - corpus_file=corpus_file, - form=form, - title='Edit corpus file' - ) - - -@bp.route('//files/', methods=['DELETE']) -@login_required -def delete_corpus_file(corpus_id, corpus_file_id): - def _delete_corpus_file(app, corpus_file_id): - with app.app_context(): - corpus_file = CorpusFile.query.get(corpus_file_id) - corpus_file.delete() - db.session.commit() - - corpus_file = CorpusFile.query.filter_by(corpus_id = corpus_id, id=corpus_file_id).first_or_404() - if not (corpus_file.corpus.user == current_user or current_user.is_administrator()): - abort(403) - thread = Thread( - target=_delete_corpus_file, - args=(current_app._get_current_object(), corpus_file_id) - ) - thread.start() - return {}, 202 - - -@bp.route('//files//download') -@login_required -def download_corpus_file(corpus_id, corpus_file_id): - corpus_file = CorpusFile.query.filter_by(corpus_id = corpus_id, id=corpus_file_id).first_or_404() - if not (corpus_file.corpus.user == current_user or current_user.is_administrator()): - abort(403) - return send_from_directory( - os.path.dirname(corpus_file.path), - os.path.basename(corpus_file.path), - as_attachment=True, - attachment_filename=corpus_file.filename, - mimetype=corpus_file.mimetype - ) +# @bp.route('//follow/') +# def follow_corpus(corpus_id, token): +# corpus = Corpus.query.get_or_404(corpus_id) +# if current_user.follow_corpus_by_token(token): +# db.session.commit() +# flash(f'You are following "{corpus.title}" now', category='corpus') +# return redirect(url_for('corpora.corpus', corpus_id=corpus_id)) +# abort(403) @bp.route('/import', methods=['GET', 'POST']) -@login_required +@register_breadcrumb(bp, '.import', 'Import') def import_corpus(): abort(503) @bp.route('//export') -@login_required +@corpus_follower_permission_required('VIEW') +@register_breadcrumb(bp, '.entity.export', 'Export', endpoint_arguments_constructor=corpus_eac) def export_corpus(corpus_id): abort(503) diff --git a/app/corpora/utils.py b/app/corpora/utils.py new file mode 100644 index 00000000..f5319dce --- /dev/null +++ b/app/corpora/utils.py @@ -0,0 +1,17 @@ +from flask import request, url_for +from app.models import Corpus + + +def corpus_endpoint_arguments_constructor(): + return {'corpus_id': request.view_args['corpus_id']} + + +def corpus_dynamic_list_constructor(): + corpus_id = request.view_args['corpus_id'] + corpus = Corpus.query.get_or_404(corpus_id) + return [ + { + 'text': f'book{corpus.title}', + 'url': url_for('.corpus', corpus_id=corpus_id) + } + ] diff --git a/app/decorators.py b/app/decorators.py index 47e6d749..21527233 100644 --- a/app/decorators.py +++ b/app/decorators.py @@ -1,7 +1,9 @@ -from flask import abort, current_app +from flask import abort, current_app, request from flask_login import current_user from functools import wraps from threading import Thread +from typing import List, Union +from werkzeug.exceptions import NotAcceptable from app.models import Permission @@ -61,3 +63,37 @@ def background(f): thread.start() return thread return wrapped + + +def content_negotiation( + produces: Union[str, List[str], None] = None, + consumes: Union[str, List[str], None] = None +): + def decorator(f): + @wraps(f) + def decorated_function(*args, **kwargs): + provided = request.mimetype + if consumes is None: + consumeables = None + elif isinstance(consumes, str): + consumeables = {consumes} + elif isinstance(consumes, list) and all(isinstance(x, str) for x in consumes): + consumeables = {*consumes} + else: + raise TypeError() + accepted = {*request.accept_mimetypes.values()} + if produces is None: + produceables = None + elif isinstance(produces, str): + produceables = {produces} + elif isinstance(produces, list) and all(isinstance(x, str) for x in produces): + produceables = {*produces} + else: + raise TypeError() + if produceables is not None and len(produceables & accepted) == 0: + raise NotAcceptable() + if consumeables is not None and provided not in consumeables: + raise NotAcceptable() + return f(*args, **kwargs) + return decorated_function + return decorator diff --git a/app/errors/handlers.py b/app/errors/handlers.py index cc6c9268..a18979ab 100644 --- a/app/errors/handlers.py +++ b/app/errors/handlers.py @@ -1,11 +1,14 @@ -from flask import render_template, request +from flask import jsonify, render_template, request from werkzeug.exceptions import HTTPException from . import bp -@bp.errorhandler(HTTPException) -def generic_error_handler(e): - if (request.accept_mimetypes.accept_json - and not request.accept_mimetypes.accept_html): - return {'errors': {'message': e.description}}, e.code - return render_template('errors/error.html.j2', error=e), e.code +@bp.app_errorhandler(HTTPException) +def handle_http_exception(error): + ''' Generic HTTP exception handler ''' + accept_json = request.accept_mimetypes.accept_json + accept_html = request.accept_mimetypes.accept_html + if accept_json and not accept_html: + response = jsonify(str(error)) + return response, error.code + return render_template('errors/error.html.j2', error=error), error.code diff --git a/app/jobs/__init__.py b/app/jobs/__init__.py index 72244069..1350e7e1 100644 --- a/app/jobs/__init__.py +++ b/app/jobs/__init__.py @@ -1,5 +1,18 @@ from flask import Blueprint +from flask_login import login_required bp = Blueprint('jobs', __name__) -from . import routes + + +@bp.before_request +@login_required +def before_request(): + ''' + Ensures that the routes in this package can only be visited by users that + are logged in. + ''' + pass + + +from . import routes, json_routes diff --git a/app/jobs/json_routes.py b/app/jobs/json_routes.py new file mode 100644 index 00000000..7bedc726 --- /dev/null +++ b/app/jobs/json_routes.py @@ -0,0 +1,74 @@ +from flask import abort, current_app +from flask_login import current_user +from threading import Thread +import os +from app import db +from app.decorators import admin_required, content_negotiation +from app.models import Job, JobStatus +from . import bp + + +@bp.route('/', methods=['DELETE']) +@content_negotiation(produces='application/json') +def delete_job(job_id): + def _delete_job(app, job_id): + with app.app_context(): + job = Job.query.get(job_id) + job.delete() + db.session.commit() + + job = Job.query.get_or_404(job_id) + if not (job.user == current_user or current_user.is_administrator()): + abort(403) + thread = Thread( + target=_delete_job, + args=(current_app._get_current_object(), job_id) + ) + thread.start() + response_data = { + 'message': f'Job "{job.title}" marked for deletion' + } + return response_data, 202 + + +@bp.route('//log') +@admin_required +@content_negotiation(produces='application/json') +def job_log(job_id): + job = Job.query.get_or_404(job_id) + if job.status not in [JobStatus.COMPLETED, JobStatus.FAILED]: + response = {'errors': {'message': 'Job status is not completed or failed'}} + return response, 409 + with open(os.path.join(job.path, 'pipeline_data', 'logs', 'pyflow_log.txt')) as log_file: + log = log_file.read() + response_data = { + 'message': '', + 'jobLog': log + } + return response_data, 200 + + +@bp.route('//restart', methods=['POST']) +@content_negotiation(produces='application/json') +def restart_job(job_id): + def _restart_job(app, job_id): + with app.app_context(): + job = Job.query.get(job_id) + job.restart() + db.session.commit() + + job = Job.query.get_or_404(job_id) + if not (job.user == current_user or current_user.is_administrator()): + abort(403) + if job.status == JobStatus.FAILED: + response = {'errors': {'message': 'Job status is not "failed"'}} + return response, 409 + thread = Thread( + target=_restart_job, + args=(current_app._get_current_object(), job_id) + ) + thread.start() + response_data = { + 'message': f'Job "{job.title}" marked for restarting' + } + return response_data, 202 diff --git a/app/jobs/routes.py b/app/jobs/routes.py index 7dae80e1..f0480293 100644 --- a/app/jobs/routes.py +++ b/app/jobs/routes.py @@ -1,93 +1,40 @@ from flask import ( abort, - current_app, + redirect, render_template, - send_from_directory + send_from_directory, + url_for ) -from flask_login import current_user, login_required -from threading import Thread +from flask_breadcrumbs import register_breadcrumb +from flask_login import current_user import os -from app import db -from app.decorators import admin_required -from app.models import Job, JobInput, JobResult, JobStatus +from app.models import Job, JobInput, JobResult from . import bp +from .utils import job_dynamic_list_constructor as job_dlc + + +@bp.route('') +@register_breadcrumb(bp, '.', 'JMy Jobs') +def corpora(): + return redirect(url_for('main.dashboard', _anchor='jobs')) @bp.route('/') -@login_required +@register_breadcrumb(bp, '.entity', '', dynamic_list_constructor=job_dlc) def job(job_id): job = Job.query.get_or_404(job_id) if not (job.user == current_user or current_user.is_administrator()): abort(403) return render_template( 'jobs/job.html.j2', - job=job, - title='Job' + title='Job', + job=job ) -@bp.route('/', methods=['DELETE']) -@login_required -def delete_job(job_id): - def _delete_job(app, job_id): - with app.app_context(): - job = Job.query.get(job_id) - job.delete() - db.session.commit() - - job = Job.query.get_or_404(job_id) - if not (job.user == current_user or current_user.is_administrator()): - abort(403) - thread = Thread( - target=_delete_job, - args=(current_app._get_current_object(), job_id) - ) - thread.start() - return {}, 202 - - -@bp.route('//log') -@login_required -@admin_required -def job_log(job_id): - job = Job.query.get_or_404(job_id) - if job.status not in [JobStatus.COMPLETED, JobStatus.FAILED]: - response = {'errors': {'message': 'Job status is not completed or failed'}} - return response, 409 - with open(os.path.join(job.path, 'pipeline_data', 'logs', 'pyflow_log.txt')) as log_file: - log = log_file.read() - return log, 200, {'Content-Type': 'text/plain; charset=utf-8'} - - -@bp.route('//restart', methods=['POST']) -@login_required -def restart_job(job_id): - def _restart_job(app, job_id): - with app.app_context(): - job = Job.query.get(job_id) - job.restart() - db.session.commit() - - job = Job.query.get_or_404(job_id) - if not (job.user == current_user or current_user.is_administrator()): - abort(403) - if job.status == JobStatus.FAILED: - response = {'errors': {'message': 'Job status is not "failed"'}} - return response, 409 - thread = Thread( - target=_restart_job, - args=(current_app._get_current_object(), job_id) - ) - thread.start() - return {}, 202 - - @bp.route('//inputs//download') -@login_required def download_job_input(job_id, job_input_id): - job_input = JobInput.query.get_or_404(job_input_id) - if job_input.job.id != job_id: - abort(404) + job_input = JobInput.query.filter_by(job_id=job_id, id=job_input_id).first_or_404() if not (job_input.job.user == current_user or current_user.is_administrator()): abort(403) return send_from_directory( @@ -100,11 +47,8 @@ def download_job_input(job_id, job_input_id): @bp.route('//results//download') -@login_required def download_job_result(job_id, job_result_id): - job_result = JobResult.query.get_or_404(job_result_id) - if job_result.job.id != job_id: - abort(404) + job_result = JobResult.query.filter_by(job_id=job_id, id=job_result_id).first_or_404() if not (job_result.job.user == current_user or current_user.is_administrator()): abort(403) return send_from_directory( diff --git a/app/jobs/utils.py b/app/jobs/utils.py new file mode 100644 index 00000000..554db354 --- /dev/null +++ b/app/jobs/utils.py @@ -0,0 +1,13 @@ +from flask import request, url_for +from app.models import Job + + +def job_dynamic_list_constructor(): + job_id = request.view_args['job_id'] + job = Job.query.get_or_404(job_id) + return [ + { + 'text': f'{job.title}', + 'url': url_for('.job', job_id=job_id) + } + ] diff --git a/app/main/__init__.py b/app/main/__init__.py index 65630224..c9586fca 100644 --- a/app/main/__init__.py +++ b/app/main/__init__.py @@ -1,5 +1,5 @@ from flask import Blueprint -bp = Blueprint('main', __name__) -from . import routes +bp = Blueprint('main', __name__, cli_group=None) +from . import cli, routes diff --git a/app/main/cli.py b/app/main/cli.py new file mode 100644 index 00000000..0284bb88 --- /dev/null +++ b/app/main/cli.py @@ -0,0 +1,45 @@ +from flask import current_app +from flask_migrate import upgrade +import os +from app.models import ( + CorpusFollowerRole, + Role, + SpaCyNLPPipelineModel, + TesseractOCRPipelineModel, + User +) +from . import bp + + +@bp.cli.command('deploy') +def deploy(): + ''' Run deployment tasks. ''' + # Make default directories + print('Make default directories') + base_dir = current_app.config['NOPAQUE_DATA_DIR'] + default_dirs = [ + os.path.join(base_dir, 'tmp'), + os.path.join(base_dir, 'users') + ] + for dir in default_dirs: + if os.path.exists(dir): + if not os.path.isdir(dir): + raise NotADirectoryError(f'{dir} is not a directory') + else: + os.mkdir(dir) + + # migrate database to latest revision + print('Migrate database to latest revision') + upgrade() + + # Insert/Update default database values + print('Insert/Update default Roles') + Role.insert_defaults() + print('Insert/Update default Users') + User.insert_defaults() + print('Insert/Update default CorpusFollowerRoles') + CorpusFollowerRole.insert_defaults() + print('Insert/Update default SpaCyNLPPipelineModels') + SpaCyNLPPipelineModel.insert_defaults() + print('Insert/Update default TesseractOCRPipelineModels') + TesseractOCRPipelineModel.insert_defaults() diff --git a/app/main/routes.py b/app/main/routes.py index eff0dadd..3be92196 100644 --- a/app/main/routes.py +++ b/app/main/routes.py @@ -1,13 +1,16 @@ from flask import flash, redirect, render_template, url_for +from flask_breadcrumbs import register_breadcrumb from flask_login import current_user, login_required, login_user from app.auth.forms import LoginForm from app.models import Corpus, User +from sqlalchemy import or_ from . import bp -@bp.route('', methods=['GET', 'POST']) +@bp.route('/', methods=['GET', 'POST']) +@register_breadcrumb(bp, '.', 'home') def index(): - form = LoginForm(prefix='login-form') + form = LoginForm() if form.validate_on_submit(): user = User.query.filter((User.email == form.user.data.lower()) | (User.username == form.user.data)).first() if user and user.verify_password(form.password.data): @@ -16,54 +19,74 @@ def index(): return redirect(url_for('.dashboard')) flash('Invalid email/username or password', category='error') redirect(url_for('.index')) - return render_template('main/index.html.j2', form=form, title='nopaque') - - -@bp.route('/faq') -def faq(): - return render_template('main/faq.html.j2', title='Frequently Asked Questions') - - -@bp.route('/dashboard') -@login_required -def dashboard(): - # users = [ - # u.to_json_serializeable(filter_by_privacy_settings=True) for u - # in User.query.filter(User.is_public == True, User.id != current_user.id).all() - # ] - # corpora = [ - # c.to_json_serializeable() for c - # in Corpus.query.filter(Corpus.is_public == True, Corpus.user != current_user).all() - # ] return render_template( - 'main/dashboard.html.j2', - title='Dashboard', - # users=users, - # corpora=corpora + 'main/index.html.j2', + title='nopaque', + form=form ) -@bp.route('/dashboard2') +@bp.route('/faq') +@register_breadcrumb(bp, '.faq', 'Frequently Asked Questions') +def faq(): + return render_template( + 'main/faq.html.j2', + title='Frequently Asked Questions' + ) + + +@bp.route('/dashboard') +@register_breadcrumb(bp, '.dashboard', 'dashboardDashboard') @login_required -def dashboard2(): - return render_template('main/dashboard2.html.j2', title='Dashboard') +def dashboard(): + return render_template( + 'main/dashboard.html.j2', + title='Dashboard' + ) -@bp.route('/user_manual') -def user_manual(): - return render_template('main/user_manual.html.j2', title='User manual') +# @bp.route('/user_manual') +# @register_breadcrumb(bp, '.user_manual', 'helpUser manual') +# def user_manual(): +# return render_template('main/user_manual.html.j2', title='User manual') @bp.route('/news') +@register_breadcrumb(bp, '.news', 'emailNews') def news(): - return render_template('main/news.html.j2', title='News') + return render_template( + 'main/news.html.j2', + title='News' + ) @bp.route('/privacy_policy') +@register_breadcrumb(bp, '.privacy_policy', 'Private statement (GDPR)') def privacy_policy(): - return render_template('main/privacy_policy.html.j2', title='Privacy statement (GDPR)') + return render_template( + 'main/privacy_policy.html.j2', + title='Privacy statement (GDPR)' + ) @bp.route('/terms_of_use') +@register_breadcrumb(bp, '.terms_of_use', 'Terms of Use') def terms_of_use(): - return render_template('main/terms_of_use.html.j2', title='Terms of Use') + return render_template( + 'main/terms_of_use.html.j2', + title='Terms of Use' + ) + + +# @bp.route('/social-area') +# @register_breadcrumb(bp, '.social_area', 'groupSocial Area') +# @login_required +# def social_area(): +# corpora = Corpus.query.filter(Corpus.is_public == True, Corpus.user != current_user).all() +# users = User.query.filter(User.is_public == True, User.id != current_user.id).all() +# return render_template( +# 'main/social_area.html.j2', +# title='Social Area', +# corpora=corpora, +# users=users +# ) diff --git a/app/models.py b/app/models.py index 4c7a1362..a7cc77e9 100644 --- a/app/models.py +++ b/app/models.py @@ -1,16 +1,18 @@ from datetime import datetime, timedelta from enum import Enum, IntEnum -from flask import current_app, url_for +from flask import abort, current_app, url_for from flask_hashids import HashidMixin from flask_login import UserMixin from sqlalchemy.ext.associationproxy import association_proxy from time import sleep from tqdm import tqdm +from typing import Union from werkzeug.security import generate_password_hash, check_password_hash from werkzeug.utils import secure_filename import json import jwt import os +import re import requests import secrets import shutil @@ -36,6 +38,16 @@ class CorpusStatus(IntEnum): RUNNING_ANALYSIS_SESSION = 8 CANCELING_ANALYSIS_SESSION = 9 + @staticmethod + def get(corpus_status: Union['CorpusStatus', int, str]) -> 'CorpusStatus': + if isinstance(corpus_status, CorpusStatus): + return corpus_status + if isinstance(corpus_status, int): + return CorpusStatus(corpus_status) + if isinstance(corpus_status, str): + return CorpusStatus[corpus_status] + raise TypeError('corpus_status must be CorpusStatus, int, or str') + class JobStatus(IntEnum): INITIALIZING = 1 @@ -47,6 +59,16 @@ class JobStatus(IntEnum): COMPLETED = 7 FAILED = 8 + @staticmethod + def get(job_status: Union['JobStatus', int, str]) -> 'JobStatus': + if isinstance(job_status, JobStatus): + return job_status + if isinstance(job_status, int): + return JobStatus(job_status) + if isinstance(job_status, str): + return JobStatus[job_status] + raise TypeError('job_status must be JobStatus, int, or str') + class Permission(IntEnum): ''' @@ -57,6 +79,16 @@ class Permission(IntEnum): CONTRIBUTE = 2 USE_API = 4 + @staticmethod + def get(permission: Union['Permission', int, str]) -> 'Permission': + if isinstance(permission, Permission): + return permission + if isinstance(permission, int): + return Permission(permission) + if isinstance(permission, str): + return Permission[permission] + raise TypeError('permission must be Permission, int, or str') + class UserSettingJobStatusMailNotificationLevel(IntEnum): NONE = 1 @@ -69,10 +101,31 @@ class ProfilePrivacySettings(IntEnum): SHOW_LAST_SEEN = 2 SHOW_MEMBER_SINCE = 4 -class CorpusFollowPermission(IntEnum): + @staticmethod + def get(profile_privacy_setting: Union['ProfilePrivacySettings', int, str]) -> 'ProfilePrivacySettings': + if isinstance(profile_privacy_setting, ProfilePrivacySettings): + return profile_privacy_setting + if isinstance(profile_privacy_setting, int): + return ProfilePrivacySettings(profile_privacy_setting) + if isinstance(profile_privacy_setting, str): + return ProfilePrivacySettings[profile_privacy_setting] + raise TypeError('profile_privacy_setting must be ProfilePrivacySettings, int, or str') + +class CorpusFollowerPermission(IntEnum): VIEW = 1 - CONTRIBUTE = 2 - ADMINISTRATE = 4 + MANAGE_FILES = 2 + MANAGE_FOLLOWERS = 4 + MANAGE_CORPUS = 8 + + @staticmethod + def get(corpus_follower_permission: Union['CorpusFollowerPermission', int, str]) -> 'CorpusFollowerPermission': + if isinstance(corpus_follower_permission, CorpusFollowerPermission): + return corpus_follower_permission + if isinstance(corpus_follower_permission, int): + return CorpusFollowerPermission(corpus_follower_permission) + if isinstance(corpus_follower_permission, str): + return CorpusFollowerPermission[corpus_follower_permission] + raise TypeError('corpus_follower_permission must be CorpusFollowerPermission, int, or str') # endregion enums @@ -180,16 +233,19 @@ class Role(HashidMixin, db.Model): def __repr__(self): return f'' - def add_permission(self, permission): - if not self.has_permission(permission): - self.permissions += permission - - def has_permission(self, permission): - return self.permissions & permission == permission - - def remove_permission(self, permission): - if self.has_permission(permission): - self.permissions -= permission + def has_permission(self, permission: Union[Permission, int, str]): + p = Permission.get(permission) + return self.permissions & p.value == p.value + + def add_permission(self, permission: Union[Permission, int, str]): + p = Permission.get(permission) + if not self.has_permission(p): + self.permissions += p.value + + def remove_permission(self, permission: Union[Permission, int, str]): + p = Permission.get(permission) + if self.has_permission(p): + self.permissions -= p.value def reset_permissions(self): self.permissions = 0 @@ -199,8 +255,13 @@ class Role(HashidMixin, db.Model): 'id': self.hashid, 'default': self.default, 'name': self.name, - 'permissions': self.permissions + 'permissions': [ + x.name for x in Permission + if self.has_permission(x.value) + ] } + if backrefs: + pass if relationships: json_serializeable['users'] = { x.hashid: x.to_json_serializeable(relationships=True) @@ -252,6 +313,27 @@ class Token(db.Model): self.access_expiration = datetime.utcnow() self.refresh_expiration = datetime.utcnow() + def to_json_serializeable(self, backrefs=False, relationships=False): + json_serializeable = { + 'id': self.hashid, + 'access_token': self.access_token, + 'access_expiration': ( + None if self.access_expiration is None + else f'{self.access_expiration.isoformat()}Z' + ), + 'refresh_token': self.refresh_token, + 'refresh_expiration': ( + None if self.refresh_expiration is None + else f'{self.refresh_expiration.isoformat()}Z' + ) + } + if backrefs: + json_serializeable['user'] = \ + self.user.to_json_serializeable(backrefs=True) + if relationships: + pass + return json_serializeable + @staticmethod def clean(): """Remove any tokens that have been expired for more than a day.""" @@ -284,35 +366,143 @@ class Avatar(HashidMixin, FileMixin, db.Model): 'id': self.hashid, **self.file_mixin_to_json_serializeable() } + if backrefs: + json_serializeable['user'] = \ + self.user.to_json_serializeable(backrefs=True) + if relationships: + pass return json_serializeable -class CorpusFollowerAssociation(db.Model): +class CorpusFollowerRole(HashidMixin, db.Model): + __tablename__ = 'corpus_follower_roles' + # Primary key + id = db.Column(db.Integer, primary_key=True) + # Fields + name = db.Column(db.String(64), unique=True) + default = db.Column(db.Boolean, default=False, index=True) + permissions = db.Column(db.Integer, default=0) + # Relationships + corpus_follower_associations = db.relationship( + 'CorpusFollowerAssociation', + back_populates='role' + ) + + def __repr__(self): + return f'' + + def has_permission(self, permission: Union[CorpusFollowerPermission, int, str]): + perm = CorpusFollowerPermission.get(permission) + return self.permissions & perm.value == perm.value + + def add_permission(self, permission: Union[CorpusFollowerPermission, int, str]): + perm = CorpusFollowerPermission.get(permission) + if not self.has_permission(perm): + self.permissions += perm.value + + def remove_permission(self, permission: Union[CorpusFollowerPermission, int, str]): + perm = CorpusFollowerPermission.get(permission) + if self.has_permission(perm): + self.permissions -= perm.value + + def reset_permissions(self): + self.permissions = 0 + + def to_json_serializeable(self, backrefs=False, relationships=False): + json_serializeable = { + 'id': self.hashid, + 'default': self.default, + 'name': self.name, + 'permissions': [ + x.name + for x in CorpusFollowerPermission + if self.has_permission(x) + ] + } + if backrefs: + pass + if relationships: + json_serializeable['corpus_follower_association'] = { + x.hashid: x.to_json_serializeable(relationships=True) + for x in self.corpus_follower_association + } + return json_serializeable + + @staticmethod + def insert_defaults(): + roles = { + 'Anonymous': [], + 'Viewer': [ + CorpusFollowerPermission.VIEW + ], + 'Contributor': [ + CorpusFollowerPermission.VIEW, + CorpusFollowerPermission.MANAGE_FILES + ], + 'Administrator': [ + CorpusFollowerPermission.VIEW, + CorpusFollowerPermission.MANAGE_FILES, + CorpusFollowerPermission.MANAGE_FOLLOWERS, + CorpusFollowerPermission.MANAGE_CORPUS + + ] + } + default_role_name = 'Viewer' + for role_name, permissions in roles.items(): + role = CorpusFollowerRole.query.filter_by(name=role_name).first() + if role is None: + role = CorpusFollowerRole(name=role_name) + role.reset_permissions() + for permission in permissions: + role.add_permission(permission) + role.default = role.name == default_role_name + db.session.add(role) + db.session.commit() + + +class CorpusFollowerAssociation(HashidMixin, db.Model): __tablename__ = 'corpus_follower_associations' # Primary key id = db.Column(db.Integer, primary_key=True) # Foreign keys - following_user_id = db.Column(db.Integer, db.ForeignKey('users.id')) - followed_corpus_id = db.Column(db.Integer, db.ForeignKey('corpora.id')) - # Fields - permissions = db.Column(db.Integer, default=0, nullable=False) + corpus_id = db.Column(db.Integer, db.ForeignKey('corpora.id')) + follower_id = db.Column(db.Integer, db.ForeignKey('users.id')) + role_id = db.Column(db.Integer, db.ForeignKey('corpus_follower_roles.id')) # Relationships - followed_corpus = db.relationship('Corpus', back_populates='following_user_associations') - following_user = db.relationship('User', back_populates='followed_corpus_associations') + corpus = db.relationship( + 'Corpus', + back_populates='corpus_follower_associations' + ) + follower = db.relationship( + 'User', + back_populates='corpus_follower_associations' + ) + role = db.relationship( + 'CorpusFollowerRole', + back_populates='corpus_follower_associations' + ) + + def __init__(self, **kwargs): + if 'role' not in kwargs: + kwargs['role'] = CorpusFollowerRole.query.filter_by(default=True).first() + super().__init__(**kwargs) def __repr__(self): - return f'' + return f'' + + def to_json_serializeable(self, backrefs=False, relationships=False): + json_serializeable = { + 'id': self.hashid, + 'corpus': self.corpus.to_json_serializeable(backrefs=True), + 'follower': self.follower.to_json_serializeable(), + 'role': self.role.to_json_serializeable() + } + if backrefs: + pass + if relationships: + pass + return json_serializeable - def has_permission(self, permission): - return self.permissions & permission == permission - - def add_permission(self, permission): - if not self.has_permission(permission): - self.permissions += permission - - def remove_permission(self, permission): - if self.has_permission(permission): - self.permissions -= permission class User(HashidMixin, UserMixin, db.Model): __tablename__ = 'users' @@ -323,8 +513,10 @@ class User(HashidMixin, UserMixin, db.Model): # Fields email = db.Column(db.String(254), index=True, unique=True) username = db.Column(db.String(64), index=True, unique=True) + username_pattern = re.compile(r'^[A-Za-zÄÖÜäöüß0-9_.]*$') password_hash = db.Column(db.String(128)) confirmed = db.Column(db.Boolean, default=False) + terms_of_use_accepted = db.Column(db.Boolean, default=False) member_since = db.Column(db.DateTime(), default=datetime.utcnow) setting_job_status_mail_notification_level = db.Column( IntEnumColumn(UserSettingJobStatusMailNotificationLevel), @@ -351,14 +543,15 @@ class User(HashidMixin, UserMixin, db.Model): cascade='all, delete-orphan', lazy='dynamic' ) - followed_corpus_associations = db.relationship( + corpus_follower_associations = db.relationship( 'CorpusFollowerAssociation', - back_populates='following_user' + back_populates='follower', + cascade='all, delete-orphan' ) followed_corpora = association_proxy( - 'followed_corpus_associations', - 'followed_corpus', - creator=lambda c: CorpusFollowerAssociation(followed_corpus=c) + 'corpus_follower_associations', + 'corpus', + creator=lambda c: CorpusFollowerAssociation(corpus=c) ) jobs = db.relationship( 'Job', @@ -388,15 +581,15 @@ class User(HashidMixin, UserMixin, db.Model): cascade='all, delete-orphan', lazy='dynamic' ) - + def __init__(self, **kwargs): + if 'role' not in kwargs: + kwargs['role'] = ( + Role.query.filter_by(name='Administrator').first() + if kwargs['email'] == current_app.config['NOPAQUE_ADMIN'] + else Role.query.filter_by(default=True).first() + ) super().__init__(**kwargs) - if self.role is not None: - return - if self.email == current_app.config['NOPAQUE_ADMIN']: - self.role = Role.query.filter_by(name='Administrator').first() - else: - self.role = Role.query.filter_by(default=True).first() def __repr__(self): return f'' @@ -495,7 +688,7 @@ class User(HashidMixin, UserMixin, db.Model): db.session.commit() def can(self, permission): - return self.role.has_permission(permission) + return self.role is not None and self.role.has_permission(permission) def confirm(self, confirmation_token): try: @@ -506,7 +699,6 @@ class User(HashidMixin, UserMixin, db.Model): issuer=current_app.config['SERVER_NAME'], options={'require': ['exp', 'iat', 'iss', 'purpose', 'sub']} ) - current_app.logger.warning(payload) except jwt.PyJWTError: return False if payload.get('purpose') != 'user.confirm': @@ -577,42 +769,97 @@ class User(HashidMixin, UserMixin, db.Model): #region Profile Privacy settings def has_profile_privacy_setting(self, setting): - return self.profile_privacy_settings & setting == setting + s = ProfilePrivacySettings.get(setting) + return self.profile_privacy_settings & s.value == s.value def add_profile_privacy_setting(self, setting): - if not self.has_profile_privacy_setting(setting): - self.profile_privacy_settings += setting + s = ProfilePrivacySettings.get(setting) + if not self.has_profile_privacy_setting(s): + self.profile_privacy_settings += s.value def remove_profile_privacy_setting(self, setting): - if self.has_profile_privacy_setting(setting): - self.profile_privacy_settings -= setting + s = ProfilePrivacySettings.get(setting) + if self.has_profile_privacy_setting(s): + self.profile_privacy_settings -= s.value def reset_profile_privacy_settings(self): self.profile_privacy_settings = 0 #endregion Profile Privacy settings - def follow_corpus(self, corpus): - if not self.is_following_corpus(corpus): - self.followed_corpora.append(corpus) + def follow_corpus(self, corpus, role=None): + if role is None: + cfr = CorpusFollowerRole.query.filter_by(default=True).first() + else: + cfr = role + if self.is_following_corpus(corpus): + cfa = CorpusFollowerAssociation.query.filter_by(corpus=corpus, follower=self).first() + if cfa.role != cfr: + cfa.role = cfr + else: + cfa = CorpusFollowerAssociation(corpus=corpus, role=cfr, follower=self) + db.session.add(cfa) def unfollow_corpus(self, corpus): - if self.is_following_corpus(corpus): - self.followed_corpora.remove(corpus) + if not self.is_following_corpus(corpus): + return + self.followed_corpora.remove(corpus) def is_following_corpus(self, corpus): return corpus in self.followed_corpora - + + def generate_follow_corpus_token(self, corpus_hashid, role_name, expiration=7): + now = datetime.utcnow() + payload = { + 'exp': expiration, + 'iat': now, + 'iss': current_app.config['SERVER_NAME'], + 'purpose': 'User.follow_corpus', + 'role_name': role_name, + 'sub': corpus_hashid + } + return jwt.encode( + payload, + current_app.config['SECRET_KEY'], + algorithm='HS256' + ) + + def follow_corpus_by_token(self, token): + try: + payload = jwt.decode( + token, + current_app.config['SECRET_KEY'], + algorithms=['HS256'], + issuer=current_app.config['SERVER_NAME'], + options={'require': ['exp', 'iat', 'iss', 'purpose', 'role_name', 'sub']} + ) + except jwt.PyJWTError: + return False + if payload.get('purpose') != 'User.follow_corpus': + return False + corpus_hashid = payload.get('sub') + corpus_id = hashids.decode(corpus_hashid) + corpus = Corpus.query.get_or_404(corpus_id) + if corpus is None: + return False + role_name = payload.get('role_name') + role = CorpusFollowerRole.query.filter_by(name=role_name).first() + if role is None: + return False + self.follow_corpus(corpus, role) + # db.session.add(self) + return True def to_json_serializeable(self, backrefs=False, relationships=False, filter_by_privacy_settings=False): json_serializeable = { 'id': self.hashid, 'confirmed': self.confirmed, + # 'avatar': url_for('users.user_avatar', user_id=self.id), 'email': self.email, 'last_seen': ( None if self.last_seen is None - else self.last_seen.strftime('%Y-%m-%d %H:%M') + else f'{self.last_seen.isoformat()}Z' ), - 'member_since': self.member_since.strftime('%Y-%m-%d'), + 'member_since': f'{self.member_since.isoformat()}Z', 'username': self.username, 'full_name': self.full_name, 'about_me': self.about_me, @@ -621,19 +868,21 @@ class User(HashidMixin, UserMixin, db.Model): 'organization': self.organization, 'job_status_mail_notification_level': \ self.setting_job_status_mail_notification_level.name, - 'is_public': self.is_public, - 'show_email': self.has_profile_privacy_setting(ProfilePrivacySettings.SHOW_EMAIL), - 'show_last_seen': self.has_profile_privacy_setting(ProfilePrivacySettings.SHOW_LAST_SEEN), - 'show_member_since': self.has_profile_privacy_setting(ProfilePrivacySettings.SHOW_MEMBER_SINCE) + 'profile_privacy_settings': { + 'is_public': self.is_public, + 'show_email': self.has_profile_privacy_setting(ProfilePrivacySettings.SHOW_EMAIL), + 'show_last_seen': self.has_profile_privacy_setting(ProfilePrivacySettings.SHOW_LAST_SEEN), + 'show_member_since': self.has_profile_privacy_setting(ProfilePrivacySettings.SHOW_MEMBER_SINCE) + } } - json_serializeable['avatar'] = ( - None if self.avatar is None - else self.avatar.to_json_serializeable(relationships=True) - ) if backrefs: json_serializeable['role'] = \ self.role.to_json_serializeable(backrefs=True) if relationships: + json_serializeable['corpus_follower_associations'] = { + x.hashid: x.to_json_serializeable() + for x in self.corpus_follower_associations + } json_serializeable['corpora'] = { x.hashid: x.to_json_serializeable(relationships=True) for x in self.corpora @@ -650,10 +899,6 @@ class User(HashidMixin, UserMixin, db.Model): x.hashid: x.to_json_serializeable(relationships=True) for x in self.spacy_nlp_pipeline_models } - json_serializeable['followed_corpora'] = { - x.hashid: x.to_json_serializeable(relationships=True) - for x in self.followed_corpora - } if filter_by_privacy_settings: if not self.has_profile_privacy_setting(ProfilePrivacySettings.SHOW_EMAIL): @@ -786,6 +1031,8 @@ class TesseractOCRPipelineModel(FileMixin, HashidMixin, db.Model): if backrefs: json_serializeable['user'] = \ self.user.to_json_serializeable(backrefs=True) + if relationships: + pass return json_serializeable @@ -912,7 +1159,10 @@ class SpaCyNLPPipelineModel(FileMixin, HashidMixin, db.Model): **self.file_mixin_to_json_serializeable() } if backrefs: - json_serializeable['user'] = self.user.to_json_serializeable(backrefs=True) + json_serializeable['user'] = \ + self.user.to_json_serializeable(backrefs=True) + if relationships: + pass return json_serializeable @@ -971,6 +1221,8 @@ class JobInput(FileMixin, HashidMixin, db.Model): if backrefs: json_serializeable['job'] = \ self.job.to_json_serializeable(backrefs=True) + if relationships: + pass return json_serializeable @@ -1035,6 +1287,8 @@ class JobResult(FileMixin, HashidMixin, db.Model): if backrefs: json_serializeable['job'] = \ self.job.to_json_serializeable(backrefs=True) + if relationships: + pass return json_serializeable @@ -1114,7 +1368,6 @@ class Job(HashidMixin, db.Model): raise e return job - def delete(self): ''' Delete the job and its inputs and results from the database. ''' if self.status not in [JobStatus.COMPLETED, JobStatus.FAILED]: # noqa @@ -1159,8 +1412,7 @@ class Job(HashidMixin, db.Model): 'service_args': self.service_args, 'service_version': self.service_version, 'status': self.status.name, - 'title': self.title, - 'url': self.url + 'title': self.title } if backrefs: json_serializeable['user'] = \ @@ -1246,9 +1498,9 @@ class CorpusFile(FileMixin, HashidMixin, db.Model): def to_json_serializeable(self, backrefs=False, relationships=False): json_serializeable = { 'id': self.hashid, - 'url': self.url, 'address': self.address, 'author': self.author, + 'description': self.description, 'booktitle': self.booktitle, 'chapter': self.chapter, 'editor': self.editor, @@ -1267,6 +1519,8 @@ class CorpusFile(FileMixin, HashidMixin, db.Model): if backrefs: json_serializeable['corpus'] = \ self.corpus.to_json_serializeable(backrefs=True) + if relationships: + pass return json_serializeable @@ -1297,14 +1551,15 @@ class Corpus(HashidMixin, db.Model): lazy='dynamic', cascade='all, delete-orphan' ) - following_user_associations = db.relationship( + corpus_follower_associations = db.relationship( 'CorpusFollowerAssociation', - back_populates='followed_corpus' + back_populates='corpus', + cascade='all, delete-orphan' ) - following_users = association_proxy( - 'following_user_associations', - 'following_user', - creator=lambda u: CorpusFollowerAssociation(following_user=u) + followers = association_proxy( + 'corpus_follower_associations', + 'follower', + creator=lambda u: CorpusFollowerAssociation(follower=u) ) user = db.relationship('User', back_populates='corpora') # "static" attributes @@ -1315,7 +1570,7 @@ class Corpus(HashidMixin, db.Model): @property def analysis_url(self): - return url_for('corpora.analyse_corpus', corpus_id=self.id) + return url_for('corpora.analysis', corpus_id=self.id) @property def jsonpatch_path(self): @@ -1403,8 +1658,13 @@ class Corpus(HashidMixin, db.Model): 'is_public': self.is_public } if backrefs: - json_serializeable['user'] = self.user.to_json_serializeable(backrefs=True) + json_serializeable['user'] = \ + self.user.to_json_serializeable(backrefs=True) if relationships: + json_serializeable['corpus_follower_associations'] = { + x.hashid: x.to_json_serializeable() + for x in self.corpus_follower_associations + } json_serializeable['files'] = { x.hashid: x.to_json_serializeable(relationships=True) for x in self.files @@ -1424,11 +1684,27 @@ class Corpus(HashidMixin, db.Model): @db.event.listens_for(JobResult, 'after_delete') @db.event.listens_for(SpaCyNLPPipelineModel, 'after_delete') @db.event.listens_for(TesseractOCRPipelineModel, 'after_delete') -def ressource_after_delete(mapper, connection, ressource): - jsonpatch = [{'op': 'remove', 'path': ressource.jsonpatch_path}] - room = f'users.{ressource.user_hashid}' - socketio.emit('users.patch', jsonpatch, room=room) - room = f'/users/{ressource.user_hashid}' +def resource_after_delete(mapper, connection, resource): + jsonpatch = [ + { + 'op': 'remove', + 'path': resource.jsonpatch_path + } + ] + room = f'/users/{resource.user_hashid}' + socketio.emit('PATCH', jsonpatch, room=room) + + +@db.event.listens_for(CorpusFollowerAssociation, 'after_delete') +def cfa_after_delete_handler(mapper, connection, cfa): + jsonpatch_path = f'/users/{cfa.corpus.user.hashid}/corpora/{cfa.corpus.hashid}/corpus_follower_associations/{cfa.hashid}' + jsonpatch = [ + { + 'op': 'remove', + 'path': jsonpatch_path + } + ] + room = f'/users/{cfa.corpus.user.hashid}' socketio.emit('PATCH', jsonpatch, room=room) @@ -1439,14 +1715,33 @@ def ressource_after_delete(mapper, connection, ressource): @db.event.listens_for(JobResult, 'after_insert') @db.event.listens_for(SpaCyNLPPipelineModel, 'after_insert') @db.event.listens_for(TesseractOCRPipelineModel, 'after_insert') -def ressource_after_insert_handler(mapper, connection, ressource): - value = ressource.to_json_serializeable() +def resource_after_insert_handler(mapper, connection, resource): + jsonpatch_value = resource.to_json_serializeable() for attr in mapper.relationships: - value[attr.key] = {} + jsonpatch_value[attr.key] = {} jsonpatch = [ - {'op': 'add', 'path': ressource.jsonpatch_path, 'value': value} + { + 'op': 'add', + 'path': resource.jsonpatch_path, + 'value': jsonpatch_value + } ] - room = f'/users/{ressource.user_hashid}' + room = f'/users/{resource.user_hashid}' + socketio.emit('PATCH', jsonpatch, room=room) + + +@db.event.listens_for(CorpusFollowerAssociation, 'after_insert') +def cfa_after_insert_handler(mapper, connection, cfa): + jsonpatch_value = cfa.to_json_serializeable() + jsonpatch_path = f'/users/{cfa.corpus.user.hashid}/corpora/{cfa.corpus.hashid}/corpus_follower_associations/{cfa.hashid}' + jsonpatch = [ + { + 'op': 'add', + 'path': jsonpatch_path, + 'value': jsonpatch_value + } + ] + room = f'/users/{cfa.corpus.user.hashid}' socketio.emit('PATCH', jsonpatch, room=room) @@ -1457,28 +1752,29 @@ def ressource_after_insert_handler(mapper, connection, ressource): @db.event.listens_for(JobResult, 'after_update') @db.event.listens_for(SpaCyNLPPipelineModel, 'after_update') @db.event.listens_for(TesseractOCRPipelineModel, 'after_update') -def ressource_after_update_handler(mapper, connection, ressource): +def resource_after_update_handler(mapper, connection, resource): jsonpatch = [] - for attr in db.inspect(ressource).attrs: + for attr in db.inspect(resource).attrs: if attr.key in mapper.relationships: continue if not attr.load_history().has_changes(): continue + jsonpatch_path = f'{resource.jsonpatch_path}/{attr.key}' if isinstance(attr.value, datetime): - value = f'{attr.value.isoformat()}Z' + jsonpatch_value = f'{attr.value.isoformat()}Z' elif isinstance(attr.value, Enum): - value = attr.value.name + jsonpatch_value = attr.value.name else: - value = attr.value + jsonpatch_value = attr.value jsonpatch.append( { 'op': 'replace', - 'path': f'{ressource.jsonpatch_path}/{attr.key}', - 'value': value + 'path': jsonpatch_path, + 'value': jsonpatch_value } ) if jsonpatch: - room = f'/users/{ressource.user_hashid}' + room = f'/users/{resource.user_hashid}' socketio.emit('PATCH', jsonpatch, room=room) diff --git a/app/services/__init__.py b/app/services/__init__.py index 73c78b59..25955e3d 100644 --- a/app/services/__init__.py +++ b/app/services/__init__.py @@ -1,4 +1,5 @@ from flask import Blueprint +from flask_login import login_required import os import yaml @@ -9,4 +10,16 @@ with open(services_file, 'r') as f: SERVICES = yaml.safe_load(f) bp = Blueprint('services', __name__) + + +@bp.before_request +@login_required +def before_request(): + ''' + Ensures that the routes in this package can only be visited by users that + are logged in. + ''' + pass + + from . import routes # noqa diff --git a/app/services/forms.py b/app/services/forms.py index 1ad544dc..7c244f48 100644 --- a/app/services/forms.py +++ b/app/services/forms.py @@ -1,12 +1,17 @@ -from flask_login import current_user from flask_wtf import FlaskForm +from flask_login import current_user from flask_wtf.file import FileField, FileRequired -from wtforms import (BooleanField, DecimalRangeField, MultipleFileField, - SelectField, StringField, SubmitField, ValidationError) +from wtforms import ( + BooleanField, + DecimalRangeField, + MultipleFileField, + SelectField, + StringField, + SubmitField, + ValidationError +) from wtforms.validators import InputRequired, Length - from app.models import SpaCyNLPPipelineModel, TesseractOCRPipelineModel - from . import SERVICES @@ -33,6 +38,8 @@ class CreateFileSetupPipelineJobForm(CreateJobBaseForm): raise ValidationError('JPEG, PNG and TIFF files only!') def __init__(self, *args, **kwargs): + if 'prefix' not in kwargs: + kwargs['prefix'] = 'create-file-setup-pipeline-job-form' service_manifest = SERVICES['file-setup-pipeline'] version = kwargs.pop('version', service_manifest['latest_version']) super().__init__(*args, **kwargs) @@ -60,6 +67,8 @@ class CreateTesseractOCRPipelineJobForm(CreateJobBaseForm): raise ValidationError('PDF files only!') def __init__(self, *args, **kwargs): + if 'prefix' not in kwargs: + kwargs['prefix'] = 'create-tesseract-ocr-pipeline-job-form' service_manifest = SERVICES['tesseract-ocr-pipeline'] version = kwargs.pop('version', service_manifest['latest_version']) super().__init__(*args, **kwargs) @@ -75,12 +84,18 @@ class CreateTesseractOCRPipelineJobForm(CreateJobBaseForm): del self.binarization.render_kw['disabled'] if 'ocropus_nlbin_threshold' in service_info['methods']: del self.ocropus_nlbin_threshold.render_kw['disabled'] + user_models = [ + x for x in current_user.tesseract_ocr_pipeline_models.order_by(TesseractOCRPipelineModel.title).all() + ] models = [ x for x in TesseractOCRPipelineModel.query.order_by(TesseractOCRPipelineModel.title).all() if version in x.compatible_service_versions and (x.is_public == True or x.user == current_user) ] - self.model.choices = [('', 'Choose your option')] - self.model.choices += [(x.hashid, f'{x.title} [{x.version}]') for x in models] + self.model.choices = { + '': [('', 'Choose your option')], + 'Your models': [(x.hashid, f'{x.title} [{x.version}]') for x in user_models] if user_models else [(0, 'Nothing here yet...')], + 'Public models': [(x.hashid, f'{x.title} [{x.version}]') for x in models] + } self.model.default = '' self.version.choices = [(x, x) for x in service_manifest['versions']] self.version.data = version @@ -106,6 +121,8 @@ class CreateTranskribusHTRPipelineJobForm(CreateJobBaseForm): raise ValidationError('PDF files only!') def __init__(self, *args, **kwargs): + if 'prefix' not in kwargs: + kwargs['prefix'] = 'create-transkribus-htr-pipeline-job-form' transkribus_htr_pipeline_models = kwargs.pop('transkribus_htr_pipeline_models', []) service_manifest = SERVICES['transkribus-htr-pipeline'] version = kwargs.pop('version', service_manifest['latest_version']) @@ -144,6 +161,8 @@ class CreateSpacyNLPPipelineJobForm(CreateJobBaseForm): raise ValidationError('Plain text files only!') def __init__(self, *args, **kwargs): + if 'prefix' not in kwargs: + kwargs['prefix'] = 'create-spacy-nlp-pipeline-job-form' service_manifest = SERVICES['spacy-nlp-pipeline'] version = kwargs.pop('version', service_manifest['latest_version']) super().__init__(*args, **kwargs) @@ -155,12 +174,18 @@ class CreateSpacyNLPPipelineJobForm(CreateJobBaseForm): if 'methods' in service_info: if 'encoding_detection' in service_info['methods']: del self.encoding_detection.render_kw['disabled'] - models = [ - x for x in SpaCyNLPPipelineModel.query.order_by(SpaCyNLPPipelineModel.title).all() - if version in x.compatible_service_versions and (x.is_public == True or x.user == current_user) + user_models = [ + x for x in current_user.spacy_nlp_pipeline_models.order_by(SpaCyNLPPipelineModel.title).all() ] - self.model.choices = [('', 'Choose your option')] - self.model.choices += [(x.hashid, f'{x.title} [{x.version}]') for x in models] + models = [ + x for x in SpaCyNLPPipelineModel.query.filter(SpaCyNLPPipelineModel.user != current_user, SpaCyNLPPipelineModel.is_public == True).order_by(SpaCyNLPPipelineModel.title).all() + if version in x.compatible_service_versions + ] + self.model.choices = { + '': [('', 'Choose your option')], + 'Your models': [(x.hashid, f'{x.title} [{x.version}]') for x in user_models] if user_models else [(0, 'Nothing here yet...')], + 'Public models': [(x.hashid, f'{x.title} [{x.version}]') for x in 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 0fb4b168..9f4cfdc0 100644 --- a/app/services/routes.py +++ b/app/services/routes.py @@ -1,5 +1,6 @@ -from flask import abort, current_app, flash, make_response, Markup, render_template, request -from flask_login import current_user, login_required +from flask import abort, current_app, flash, Markup, redirect, render_template, request, url_for +from flask_breadcrumbs import register_breadcrumb +from flask_login import current_user import requests from app import db, hashids from app.models import ( @@ -18,8 +19,14 @@ from .forms import ( ) +@bp.route('/services') +@register_breadcrumb(bp, '.', 'Services') +def services(): + return redirect(url_for('main.dashboard')) + + @bp.route('/file-setup-pipeline', methods=['GET', 'POST']) -@login_required +@register_breadcrumb(bp, '.file_setup_pipeline', 'File Setup') def file_setup_pipeline(): service = 'file-setup-pipeline' service_manifest = SERVICES[service] @@ -54,13 +61,13 @@ def file_setup_pipeline(): return {}, 201, {'Location': job.url} return render_template( 'services/file_setup_pipeline.html.j2', - form=form, - title=service_manifest['name'] + title=service_manifest['name'], + form=form ) @bp.route('/tesseract-ocr-pipeline', methods=['GET', 'POST']) -@login_required +@register_breadcrumb(bp, '.tesseract_ocr_pipeline', 'Tesseract OCR Pipeline') def tesseract_ocr_pipeline(): service_name = 'tesseract-ocr-pipeline' service_manifest = SERVICES[service_name] @@ -100,16 +107,18 @@ def tesseract_ocr_pipeline(): x for x in TesseractOCRPipelineModel.query.all() if version in x.compatible_service_versions and (x.is_public == True or x.user == current_user) ] + user_tesseract_ocr_pipeline_models_count = len(current_user.tesseract_ocr_pipeline_models.all()) return render_template( 'services/tesseract_ocr_pipeline.html.j2', + title=service_manifest['name'], form=form, tesseract_ocr_pipeline_models=tesseract_ocr_pipeline_models, - title=service_manifest['name'] + user_tesseract_ocr_pipeline_models_count=user_tesseract_ocr_pipeline_models_count ) @bp.route('/transkribus-htr-pipeline', methods=['GET', 'POST']) -@login_required +@register_breadcrumb(bp, '.transkribus_htr_pipeline', 'Transkribus HTR Pipeline') def transkribus_htr_pipeline(): if not current_app.config.get('NOPAQUE_TRANSKRIBUS_ENABLED'): abort(404) @@ -126,10 +135,9 @@ def transkribus_htr_pipeline(): abort(500) transkribus_htr_pipeline_models = r.json()['trpModelMetadata'] transkribus_htr_pipeline_models.append({'modelId': 48513, 'name': 'Caroline Minuscle', 'language': 'lat', 'isoLanguages': ['lat']}) - print(transkribus_htr_pipeline_models[len(transkribus_htr_pipeline_models)-1]) form = CreateTranskribusHTRPipelineJobForm( - transkribus_htr_pipeline_models=transkribus_htr_pipeline_models, prefix='create-job-form', + transkribus_htr_pipeline_models=transkribus_htr_pipeline_models, version=version ) if form.is_submitted(): @@ -161,14 +169,14 @@ def transkribus_htr_pipeline(): return {}, 201, {'Location': job.url} return render_template( 'services/transkribus_htr_pipeline.html.j2', - form=form, title=service_manifest['name'], + form=form, transkribus_htr_pipeline_models=transkribus_htr_pipeline_models ) @bp.route('/spacy-nlp-pipeline', methods=['GET', 'POST']) -@login_required +@register_breadcrumb(bp, '.spacy_nlp_pipeline', 'SpaCy NLP Pipeline') def spacy_nlp_pipeline(): service = 'spacy-nlp-pipeline' service_manifest = SERVICES[service] @@ -177,6 +185,7 @@ def spacy_nlp_pipeline(): abort(404) form = CreateSpacyNLPPipelineJobForm(prefix='create-job-form', version=version) spacy_nlp_pipeline_models = SpaCyNLPPipelineModel.query.all() + user_spacy_nlp_pipeline_models_count = len(current_user.spacy_nlp_pipeline_models.all()) if form.is_submitted(): if not form.validate(): response = {'errors': form.errors} @@ -206,16 +215,17 @@ def spacy_nlp_pipeline(): return {}, 201, {'Location': job.url} return render_template( 'services/spacy_nlp_pipeline.html.j2', + title=service_manifest['name'], form=form, spacy_nlp_pipeline_models=spacy_nlp_pipeline_models, - title=service_manifest['name'] + user_spacy_nlp_pipeline_models_count=user_spacy_nlp_pipeline_models_count ) @bp.route('/corpus-analysis') -@login_required +@register_breadcrumb(bp, '.corpus_analysis', 'Corpus Analysis') def corpus_analysis(): return render_template( 'services/corpus_analysis.html.j2', - title='Corpus analysis' + title='Corpus Analysis' ) diff --git a/app/settings/__init__.py b/app/settings/__init__.py index 1dab5142..ee16889f 100644 --- a/app/settings/__init__.py +++ b/app/settings/__init__.py @@ -1,5 +1,18 @@ from flask import Blueprint +from flask_login import login_required bp = Blueprint('settings', __name__) -from . import routes # noqa + + +@bp.before_request +@login_required +def before_request(): + ''' + Ensures that the routes in this package can only be visited by users that + are logged in. + ''' + pass + + +from . import routes diff --git a/app/settings/forms.py b/app/settings/forms.py deleted file mode 100644 index e90d9dda..00000000 --- a/app/settings/forms.py +++ /dev/null @@ -1,43 +0,0 @@ -from flask_wtf import FlaskForm -from wtforms import PasswordField, SelectField, SubmitField, ValidationError -from wtforms.validators import DataRequired, EqualTo -from app.models import UserSettingJobStatusMailNotificationLevel - - -class ChangePasswordForm(FlaskForm): - password = PasswordField('Old password', validators=[DataRequired()]) - new_password = PasswordField( - 'New password', - validators=[ - DataRequired(), - EqualTo('new_password_2', message='Passwords must match') - ] - ) - new_password_2 = PasswordField( - 'New password confirmation', - validators=[ - DataRequired(), - EqualTo('new_password', message='Passwords must match') - ] - ) - submit = SubmitField() - - def __init__(self, user, *args, **kwargs): - super().__init__(*args, **kwargs) - self.user = user - - def validate_current_password(self, field): - if not self.user.verify_password(field.data): - raise ValidationError('Invalid password') - - -class EditNotificationSettingsForm(FlaskForm): - job_status_mail_notification_level = SelectField( - 'Job status mail notification level', - choices=[ - (x.name, x.name.capitalize()) - for x in UserSettingJobStatusMailNotificationLevel - ], - validators=[DataRequired()] - ) - submit = SubmitField() diff --git a/app/settings/routes.py b/app/settings/routes.py index a07869b8..837c0f6f 100644 --- a/app/settings/routes.py +++ b/app/settings/routes.py @@ -1,39 +1,12 @@ -from flask import flash, redirect, render_template, url_for -from flask_login import current_user, login_required -from app import db -from app.models import UserSettingJobStatusMailNotificationLevel +from flask import g, url_for +from flask_breadcrumbs import register_breadcrumb +from flask_login import current_user +from app.users.settings.routes import settings as settings_route from . import bp -from .forms import ChangePasswordForm, EditNotificationSettingsForm -@bp.route('', methods=['GET', 'POST']) -@login_required +@bp.route('/settings', methods=['GET', 'POST']) +@register_breadcrumb(bp, '.', 'settingsSettings') def settings(): - change_password_form = ChangePasswordForm( - current_user, - prefix='change-password-form' - ) - edit_notification_settings_form = EditNotificationSettingsForm( - data=current_user.to_json_serializeable(), - prefix='edit-notification-settings-form' - ) - # region handle change_password_form POST - if change_password_form.submit.data and change_password_form.validate(): - current_user.password = change_password_form.new_password.data - db.session.commit() - flash('Your changes have been saved') - return redirect(url_for('.settings')) - # endregion handle change_password_form POST - # region handle edit_notification_settings_form POST - if edit_notification_settings_form.submit and edit_notification_settings_form.validate(): - current_user.setting_job_status_mail_notification_level = edit_notification_settings_form.job_status_mail_notification_level.data - db.session.commit() - flash('Your changes have been saved') - return redirect(url_for('.settings')) - # endregion handle edit_notification_settings_form POST - return render_template( - 'settings/settings.html.j2', - change_password_form=change_password_form, - edit_notification_settings_form=edit_notification_settings_form, - title='Settings' - ) + g._nopaque_redirect_location_on_post = url_for('.settings') + return settings_route(current_user.id) diff --git a/app/static/css/colors.scss b/app/static/css/colors.scss index f8f04228..0e43916a 100644 --- a/app/static/css/colors.scss +++ b/app/static/css/colors.scss @@ -22,6 +22,11 @@ $color: ( "surface": #ffffff, "error": #b00020 ), + "social-area": ( + "base": #d6ae86, + "darken": #C98536, + "lighten": #EAE2DB + ), "service": ( "corpus-analysis": ( "base": #aa9cc9, @@ -108,6 +113,16 @@ $color: ( } } +@each $key, $color-code in map-get($color, "social-area") { + .social-area-color-#{$key} { + background-color: $color-code !important; + } + + .social-area-color-border-#{$key} { + border-color: $color-code !important; + } +} + @each $service-name, $color-palette in map-get($color, "service") { .service-color[data-service="#{$service-name}"] { background-color: map-get($color-palette, "base") !important; diff --git a/app/static/css/materialize/fixes.css b/app/static/css/materialize/fixes.css index b44af75f..75003a1f 100644 --- a/app/static/css/materialize/fixes.css +++ b/app/static/css/materialize/fixes.css @@ -1,3 +1,8 @@ .parallax-container .parallax { z-index: 0; } + +.autocomplete-content { + width: 100% !important; + left: 0 !important; +} diff --git a/app/static/css/style.css b/app/static/css/style.css index 7c56d3d8..e85d697e 100644 --- a/app/static/css/style.css +++ b/app/static/css/style.css @@ -19,6 +19,10 @@ height: 30px !important; } +#manual-modal .manual-chapter-title { + display: none; +} + .show-if-only-child:not(:only-child) { display: none !important; } diff --git a/app/static/images/user_avatar.png b/app/static/images/user_avatar.png index 09892098..360c0ec0 100644 Binary files a/app/static/images/user_avatar.png and b/app/static/images/user_avatar.png differ diff --git a/app/static/js/App.js b/app/static/js/App.js index 87d44d71..0741592d 100644 --- a/app/static/js/App.js +++ b/app/static/js/App.js @@ -60,6 +60,10 @@ class App { iconPrefix = 'J'; break; } + case 'settings': { + iconPrefix = 'settings'; + break; + } default: { iconPrefix = 'notifications'; break; @@ -91,7 +95,7 @@ class App { .filter((operation) => {return subRegExp.test(operation.path);}); for (let operation of subFilteredPatch) { let [match, userId, jobId] = operation.path.match(subRegExp); - this.flash(`[${this.data.users[userId].jobs[jobId].title}] New status: `, 'job'); + this.flash(`[${this.data.users[userId].jobs[jobId].title}] New status: `, 'job'); } // Apply Patch diff --git a/app/static/js/CorpusAnalysis/CorpusAnalysisApp.js b/app/static/js/CorpusAnalysis/CorpusAnalysisApp.js index 5ca7960b..f5cb8712 100644 --- a/app/static/js/CorpusAnalysis/CorpusAnalysisApp.js +++ b/app/static/js/CorpusAnalysis/CorpusAnalysisApp.js @@ -7,8 +7,6 @@ class CorpusAnalysisApp { container: document.querySelector('#corpus-analysis-app-container'), extensionTabs: document.querySelector('#corpus-analysis-app-extension-tabs'), initModal: document.querySelector('#corpus-analysis-app-init-modal'), - initError: document.querySelector('#corpus-analysis-app-init-error'), - initProgress: document.querySelector('#corpus-analysis-app-init-progress'), overview: document.querySelector('#corpus-analysis-app-overview') }; // Materialize elements @@ -27,6 +25,7 @@ class CorpusAnalysisApp { init() { this.disableActionElements(); this.elements.m.initModal.open(); + // Init data this.data.cQiClient = new CQiClient(this.settings.corpusId); this.data.cQiClient.connect() @@ -43,14 +42,17 @@ class CorpusAnalysisApp { this.elements.m.initModal.close(); }, cQiError => { - this.elements.initError.innerText = JSON.stringify(cQiError); - this.elements.initError.classList.remove('hide'); - this.elements.initProgress.classList.add('hide'); + let errorsElement = this.elements.initModal.querySelector('.errors'); + let progressElement = this.elements.initModal.querySelector('.progress'); + errorsElement.innerText = JSON.stringify(cQiError); + errorsElement.classList.remove('hide'); + progressElement.classList.add('hide'); if ('payload' in cQiError && 'code' in cQiError.payload && 'msg' in cQiError.payload) { app.flash(`${cQiError.payload.code}: ${cQiError.payload.msg}`, 'error'); } } ); + // Add event listeners for (let extensionSelectorElement of this.elements.overview.querySelectorAll('.extension-selector')) { extensionSelectorElement.addEventListener('click', () => { diff --git a/app/static/js/CorpusAnalysis/CorpusAnalysisReader.js b/app/static/js/CorpusAnalysis/CorpusAnalysisReader.js index e1c64d83..acb36fa1 100644 --- a/app/static/js/CorpusAnalysis/CorpusAnalysisReader.js +++ b/app/static/js/CorpusAnalysis/CorpusAnalysisReader.js @@ -106,41 +106,102 @@ class CorpusAnalysisReader { renderCorpusPagination() { this.clearCorpusPagination(); if (this.data.corpus.p.pages === 0) {return;} - this.elements.corpusPagination.innerHTML += ` -
  • - - first_page - -
    • - `.trim(); - this.elements.corpusPagination.innerHTML += ` -
  • - - chevron_left - -
    • - `.trim(); - for (let i = 1; i <= this.data.corpus.p.pages; i++) { - this.elements.corpusPagination.innerHTML += ` -
  • - ${i} + let pageElement; + // First page button. Disables first page button if on first page + pageElement = Utils.HTMLToElement( + ` +
  • + + first_page +
    • - `.trim(); + ` + ); + this.elements.corpusPagination.appendChild(pageElement); + // Previous page button. Disables previous page button if on first page + pageElement = Utils.HTMLToElement( + ` +
  • + + chevron_left + +
    • + ` + ); + this.elements.corpusPagination.appendChild(pageElement); + // First page as number. Hides first page button if on first page + if (this.data.corpus.p.page > 6) { + pageElement = Utils.HTMLToElement( + ` +
  • + 1 +
    • + ` + ); + this.elements.corpusPagination.appendChild(pageElement); + pageElement = Utils.HTMLToElement("
  • …
    • "); + this.elements.corpusPagination.appendChild(pageElement); } - this.elements.corpusPagination.innerHTML += ` -
  • - - chevron_right - -
    • - `.trim(); - this.elements.corpusPagination.innerHTML += ` -
  • - - last_page - -
    • - `.trim(); + + // render page buttons (5 before and 5 after current page) + for (let i = this.data.corpus.p.page -5; i <= this.data.corpus.p.page; i++) { + if (i <= 0) {continue;} + pageElement = Utils.HTMLToElement( + ` +
  • + ${i} +
    • + ` + ); + this.elements.corpusPagination.appendChild(pageElement); + }; + for (let i = this.data.corpus.p.page +1; i <= this.data.corpus.p.page +5; i++) { + if (i > this.data.corpus.p.pages) {break;} + pageElement = Utils.HTMLToElement( + ` +
  • + ${i} +
    • + ` + ); + this.elements.corpusPagination.appendChild(pageElement); + }; + // Last page as number. Hides last page button if on last page + if (this.data.corpus.p.page < this.data.corpus.p.pages - 6) { + pageElement = Utils.HTMLToElement("
  • …
    • "); + this.elements.corpusPagination.appendChild(pageElement); + pageElement = Utils.HTMLToElement( + ` +
  • + ${this.data.corpus.p.pages} +
    • + ` + ); + this.elements.corpusPagination.appendChild(pageElement); + } + // Next page button. Disables next page button if on last page + pageElement = Utils.HTMLToElement( + ` +
  • + + chevron_right + +
    • + ` + ); + this.elements.corpusPagination.appendChild(pageElement); + // Last page button. Disables last page button if on last page + pageElement = Utils.HTMLToElement( + ` +
  • + + last_page + +
    • + ` + ); + this.elements.corpusPagination.appendChild(pageElement); + for (let paginateTriggerElement of this.elements.corpusPagination.querySelectorAll('.pagination-trigger[data-target]')) { paginateTriggerElement.addEventListener('click', event => { event.preventDefault(); @@ -182,6 +243,7 @@ class CorpusAnalysisReader { return; } this.app.disableActionElements(); + window.scrollTo(top); this.elements.progress.classList.remove('hide'); this.data.corpus.o.paginate(pageNum, this.settings.perPage) .then( diff --git a/app/static/js/CorpusAnalysis/QueryBuilder.js b/app/static/js/CorpusAnalysis/QueryBuilder.js index c35e9e90..a1130c65 100644 --- a/app/static/js/CorpusAnalysis/QueryBuilder.js +++ b/app/static/js/CorpusAnalysis/QueryBuilder.js @@ -561,7 +561,6 @@ class ConcordanceQueryBuilder { if (tokenIsEmpty === false) { tokenQueryText = '[' + tokenQueryText + ']'; } - console.log(tokenQueryText); this.queryChipFactory('token', tokenQueryContent, tokenQueryText); this.hideEverything(); this.elements.positionalAttrArea.classList.add('hide'); diff --git a/app/static/js/Forms/Form.js b/app/static/js/Forms/Form.js index a9604c69..c3496e18 100644 --- a/app/static/js/Forms/Form.js +++ b/app/static/js/Forms/Form.js @@ -92,7 +92,6 @@ class Form { } if (request.status === 400) { let responseJson = JSON.parse(request.responseText); - console.log(responseJson); for (let [inputName, inputErrors] of Object.entries(responseJson.errors)) { let inputFieldElement = this.formElement .querySelector(`input[name$="${inputName}"], select[name$="${inputName}"]`) @@ -122,10 +121,11 @@ class Form { request.setRequestHeader('Accept', 'application/json'); let formData = new FormData(this.formElement); switch (this.formElement.enctype) { - case 'application/x-www-form-urlencoded': + case 'application/x-www-form-urlencoded': { let urlSearchParams = new URLSearchParams(formData); request.send(urlSearchParams); break; + } case 'multipart/form-data': { request.send(formData); break; diff --git a/app/static/js/Requests/Requests.js b/app/static/js/Requests/Requests.js new file mode 100644 index 00000000..0504d8a0 --- /dev/null +++ b/app/static/js/Requests/Requests.js @@ -0,0 +1,40 @@ +let Requests = {}; + +Requests.JSONfetch = (input, init={}) => { + return new Promise((resolve, reject) => { + let fixedInit = {}; + fixedInit.headers = {}; + fixedInit.headers['Accept'] = 'application/json'; + if (init.hasOwnProperty('body')) { + fixedInit.headers['Content-Type'] = 'application/json'; + } + fetch(input, Utils.mergeObjectsDeep(init, fixedInit)) + .then( + (response) => { + if (response.ok) { + resolve(response.clone()); + } else { + reject(response); + } + if (response.status === 204) { + return; + } + response.json() + .then( + (json) => { + let message = json.message || json; + let category = json.category || 'message'; + app.flash(message, category); + }, + (error) => { + app.flash(`[${response.status}]: ${response.statusText}`, 'error'); + } + ); + }, + (response) => { + app.flash('Something went wrong', 'error'); + reject(response); + } + ); + }); +}; diff --git a/app/static/js/Requests/admin/admin.js b/app/static/js/Requests/admin/admin.js new file mode 100644 index 00000000..77fdb6b1 --- /dev/null +++ b/app/static/js/Requests/admin/admin.js @@ -0,0 +1,20 @@ +/***************************************************************************** +* Admin * +* Fetch requests for /admin routes * +*****************************************************************************/ +Requests.admin = {}; + +Requests.admin.users = {}; + +Requests.admin.users.entity = {}; + +Requests.admin.users.entity.confirmed = {}; + +Requests.admin.users.entity.confirmed.update = (userId, value) => { + let input = `/admin/users/${userId}/confirmed`; + let init = { + method: 'PUT', + body: JSON.stringify(value) + }; + return Requests.JSONfetch(input, init); +}; diff --git a/app/static/js/Requests/contributions/contributions.js b/app/static/js/Requests/contributions/contributions.js new file mode 100644 index 00000000..2d9cf26a --- /dev/null +++ b/app/static/js/Requests/contributions/contributions.js @@ -0,0 +1,5 @@ +/***************************************************************************** +* Contributions * +* Fetch requests for /contributions routes * +*****************************************************************************/ +Requests.contributions = {}; diff --git a/app/static/js/Requests/contributions/spacy_nlp_pipeline_models.js b/app/static/js/Requests/contributions/spacy_nlp_pipeline_models.js new file mode 100644 index 00000000..e1422c1e --- /dev/null +++ b/app/static/js/Requests/contributions/spacy_nlp_pipeline_models.js @@ -0,0 +1,26 @@ +/***************************************************************************** +* SpaCy NLP Pipeline Models * +* Fetch requests for /contributions/spacy-nlp-pipeline-models routes * +*****************************************************************************/ +Requests.contributions.spacy_nlp_pipeline_models = {}; + +Requests.contributions.spacy_nlp_pipeline_models.entity = {}; + +Requests.contributions.spacy_nlp_pipeline_models.entity.delete = (spacyNlpPipelineModelId) => { + let input = `/contributions/spacy-nlp-pipeline-models/${spacyNlpPipelineModelId}`; + let init = { + method: 'DELETE' + }; + return Requests.JSONfetch(input, init); +}; + +Requests.contributions.spacy_nlp_pipeline_models.entity.isPublic = {}; + +Requests.contributions.spacy_nlp_pipeline_models.entity.isPublic.update = (spacyNlpPipelineModelId, value) => { + let input = `/contributions/spacy-nlp-pipeline-models/${spacyNlpPipelineModelId}/is_public`; + let init = { + method: 'PUT', + body: JSON.stringify(value) + }; + return Requests.JSONfetch(input, init); +}; diff --git a/app/static/js/Requests/contributions/tesseract_ocr_pipeline_models.js b/app/static/js/Requests/contributions/tesseract_ocr_pipeline_models.js new file mode 100644 index 00000000..13feb42a --- /dev/null +++ b/app/static/js/Requests/contributions/tesseract_ocr_pipeline_models.js @@ -0,0 +1,26 @@ +/***************************************************************************** +* Tesseract OCR Pipeline Models * +* Fetch requests for /contributions/tesseract-ocr-pipeline-models routes * +*****************************************************************************/ +Requests.contributions.tesseract_ocr_pipeline_models = {}; + +Requests.contributions.tesseract_ocr_pipeline_models.entity = {}; + +Requests.contributions.tesseract_ocr_pipeline_models.entity.delete = (tesseractOcrPipelineModelId) => { + let input = `/contributions/tesseract-ocr-pipeline-models/${tesseractOcrPipelineModelId}`; + let init = { + method: 'DELETE' + }; + return Requests.JSONfetch(input, init); +}; + +Requests.contributions.tesseract_ocr_pipeline_models.entity.isPublic = {}; + +Requests.contributions.tesseract_ocr_pipeline_models.entity.isPublic.update = (tesseractOcrPipelineModelId, value) => { + let input = `/contributions/tesseract-ocr-pipeline-models/${tesseractOcrPipelineModelId}/is_public`; + let init = { + method: 'PUT', + body: JSON.stringify(value) + }; + return Requests.JSONfetch(input, init); +}; diff --git a/app/static/js/Requests/corpora/corpora.js b/app/static/js/Requests/corpora/corpora.js new file mode 100644 index 00000000..55f6b899 --- /dev/null +++ b/app/static/js/Requests/corpora/corpora.js @@ -0,0 +1,46 @@ +/***************************************************************************** +* Corpora * +* Fetch requests for /corpora routes * +*****************************************************************************/ +Requests.corpora = {}; + +Requests.corpora.entity = {}; + +Requests.corpora.entity.delete = (corpusId) => { + let input = `/corpora/${corpusId}`; + let init = { + method: 'DELETE' + }; + return Requests.JSONfetch(input, init); +}; + +Requests.corpora.entity.build = (corpusId) => { + let input = `/corpora/${corpusId}/build`; + let init = { + method: 'POST', + }; + return Requests.JSONfetch(input, init); +}; + +Requests.corpora.entity.generateShareLink = (corpusId, role, expiration) => { + let input = `/corpora/${corpusId}/generate-share-link`; + let init = { + method: 'POST', + body: JSON.stringify({role: role, expiration: expiration}) + }; + return Requests.JSONfetch(input, init); +}; + +Requests.corpora.entity.isPublic = {}; + +Requests.corpora.entity.isPublic.update = (corpusId, isPublic) => { + let input = `/corpora/${corpusId}/is_public`; + let init = { + method: 'PUT', + body: JSON.stringify(isPublic) + }; + return Requests.JSONfetch(input, init); +}; + + + diff --git a/app/static/js/Requests/corpora/files.js b/app/static/js/Requests/corpora/files.js new file mode 100644 index 00000000..9ff9ba87 --- /dev/null +++ b/app/static/js/Requests/corpora/files.js @@ -0,0 +1,15 @@ +/***************************************************************************** +* Corpora * +* Fetch requests for /corpora//files routes * +*****************************************************************************/ +Requests.corpora.entity.files = {}; + +Requests.corpora.entity.files.ent = {}; + +Requests.corpora.entity.files.ent.delete = (corpusId, corpusFileId) => { + let input = `/corpora/${corpusId}/files/${corpusFileId}`; + let init = { + method: 'DELETE', + }; + return Requests.JSONfetch(input, init); +}; diff --git a/app/static/js/Requests/corpora/followers.js b/app/static/js/Requests/corpora/followers.js new file mode 100644 index 00000000..f7f7877f --- /dev/null +++ b/app/static/js/Requests/corpora/followers.js @@ -0,0 +1,35 @@ +/***************************************************************************** +* Corpora * +* Fetch requests for /corpora//followers routes * +*****************************************************************************/ +Requests.corpora.entity.followers = {}; + +Requests.corpora.entity.followers.add = (corpusId, usernames) => { + let input = `/corpora/${corpusId}/followers`; + let init = { + method: 'POST', + body: JSON.stringify(usernames) + }; + return Requests.JSONfetch(input, init); +}; + +Requests.corpora.entity.followers.entity = {}; + +Requests.corpora.entity.followers.entity.delete = (corpusId, followerId) => { + let input = `/corpora/${corpusId}/followers/${followerId}`; + let init = { + method: 'DELETE', + }; + return Requests.JSONfetch(input, init); +}; + +Requests.corpora.entity.followers.entity.role = {}; + +Requests.corpora.entity.followers.entity.role.update = (corpusId, followerId, value) => { + let input = `/corpora/${corpusId}/followers/${followerId}/role`; + let init = { + method: 'PUT', + body: JSON.stringify(value) + }; + return Requests.JSONfetch(input, init); +}; diff --git a/app/static/js/Requests/jobs/jobs.js b/app/static/js/Requests/jobs/jobs.js new file mode 100644 index 00000000..64e523db --- /dev/null +++ b/app/static/js/Requests/jobs/jobs.js @@ -0,0 +1,31 @@ +/***************************************************************************** +* Jobs * +* Fetch requests for /jobs routes * +*****************************************************************************/ +Requests.jobs = {}; + +Requests.jobs.entity = {}; + +Requests.jobs.entity.delete = (jobId) => { + let input = `/jobs/${jobId}`; + let init = { + method: 'DELETE' + }; + return Requests.JSONfetch(input, init); +} + +Requests.jobs.entity.log = (jobId) => { + let input = `/jobs/${jobId}/log`; + let init = { + method: 'GET' + }; + return Requests.JSONfetch(input, init); +} + +Requests.jobs.entity.restart = (jobId) => { + let input = `/jobs/${jobId}/restart`; + let init = { + method: 'POST' + }; + return Requests.JSONfetch(input, init); +} diff --git a/app/static/js/Requests/users/settings.js b/app/static/js/Requests/users/settings.js new file mode 100644 index 00000000..609ecb35 --- /dev/null +++ b/app/static/js/Requests/users/settings.js @@ -0,0 +1,17 @@ +/***************************************************************************** +* Settings * +* Fetch requests for /users//settings routes * +*****************************************************************************/ +Requests.users.entity.settings = {}; + +Requests.users.entity.settings.profilePrivacy = {}; + +Requests.users.entity.settings.profilePrivacy.update = (userId, profilePrivacySetting, enabled) => { + let input = `/users/${userId}/settings/profile-privacy/${profilePrivacySetting}`; + let init = { + method: 'PUT', + body: JSON.stringify(enabled) + }; + return Requests.JSONfetch(input, init); +}; + diff --git a/app/static/js/Requests/users/users.js b/app/static/js/Requests/users/users.js new file mode 100644 index 00000000..4baf4717 --- /dev/null +++ b/app/static/js/Requests/users/users.js @@ -0,0 +1,35 @@ +/***************************************************************************** +* Users * +* Fetch requests for /users routes * +*****************************************************************************/ +Requests.users = {}; + +Requests.users.entity = {}; + +Requests.users.entity.delete = (userId) => { + let input = `/users/${userId}`; + let init = { + method: 'DELETE' + }; + return Requests.JSONfetch(input, init); +}; + +Requests.users.entity.acceptTermsOfUse = () => { + let input = `/users/accept-terms-of-use`; + let init = { + method: 'POST' + }; + return Requests.JSONfetch(input, init); +}; + + +Requests.users.entity.avatar = {}; + +Requests.users.entity.avatar.delete = (userId) => { + let input = `/users/${userId}/avatar`; + let init = { + method: 'DELETE' + }; + return Requests.JSONfetch(input, init); +} + diff --git a/app/static/js/RessourceDisplays/CorpusDisplay.js b/app/static/js/ResourceDisplays/CorpusDisplay.js similarity index 80% rename from app/static/js/RessourceDisplays/CorpusDisplay.js rename to app/static/js/ResourceDisplays/CorpusDisplay.js index fd342dd4..ef9dc8b8 100644 --- a/app/static/js/RessourceDisplays/CorpusDisplay.js +++ b/app/static/js/ResourceDisplays/CorpusDisplay.js @@ -1,26 +1,11 @@ -class CorpusDisplay extends RessourceDisplay { +class CorpusDisplay extends ResourceDisplay { constructor(displayElement) { super(displayElement); this.corpusId = displayElement.dataset.corpusId; this.displayElement .querySelector('.action-button[data-action="build-request"]') .addEventListener('click', (event) => { - Utils.buildCorpusRequest(this.userId, this.corpusId); - }); - this.displayElement - .querySelector('.action-button[data-action="delete-request"]') - .addEventListener('click', (event) => { - Utils.deleteCorpusRequest(this.userId, this.corpusId); - }); - this.displayElement - .querySelector('.action-switch[data-action="toggle-is-public"]') - .addEventListener('click', (event) => { - if (event.target.tagName !== 'INPUT') {return;} - if (event.target.checked) { - Utils.enableCorpusIsPublicRequest(this.userId, this.corpusId); - } else { - Utils.disableCorpusIsPublicRequest(this.userId, this.corpusId); - } + Requests.corpora.entity.build(this.corpusId); }); } @@ -81,7 +66,7 @@ class CorpusDisplay extends RessourceDisplay { } setStatus(status) { - let elements = this.displayElement.querySelectorAll('.corpus-analyse-trigger') + let elements = this.displayElement.querySelectorAll('.action-button[data-action="analyze"]'); for (let element of elements) { if (['BUILT', 'STARTING_ANALYSIS_SESSION', 'RUNNING_ANALYSIS_SESSION', 'CANCELING_ANALYSIS_SESSION'].includes(status)) { element.classList.remove('disabled'); diff --git a/app/static/js/RessourceDisplays/JobDisplay.js b/app/static/js/ResourceDisplays/JobDisplay.js similarity index 85% rename from app/static/js/RessourceDisplays/JobDisplay.js rename to app/static/js/ResourceDisplays/JobDisplay.js index 03c5601b..6287d934 100644 --- a/app/static/js/RessourceDisplays/JobDisplay.js +++ b/app/static/js/ResourceDisplays/JobDisplay.js @@ -1,22 +1,7 @@ -class JobDisplay extends RessourceDisplay { +class JobDisplay extends ResourceDisplay { constructor(displayElement) { super(displayElement); this.jobId = this.displayElement.dataset.jobId; - this.displayElement - .querySelector('.action-button[data-action="delete-request"]') - .addEventListener('click', (event) => { - Utils.deleteJobRequest(this.userId, this.jobId); - }); - this.displayElement - .querySelector('.action-button[data-action="get-log-request"]') - .addEventListener('click', (event) => { - Utils.getJobLogRequest(this.userId, this.jobId); - }); - this.displayElement - .querySelector('.action-button[data-action="restart-request"]') - .addEventListener('click', (event) => { - Utils.restartJobRequest(this.userId, this.jobId); - }); } init(user) { diff --git a/app/static/js/RessourceDisplays/RessourceDisplay.js b/app/static/js/ResourceDisplays/ResourceDisplay.js similarity index 97% rename from app/static/js/RessourceDisplays/RessourceDisplay.js rename to app/static/js/ResourceDisplays/ResourceDisplay.js index a07c2163..24a5dec3 100644 --- a/app/static/js/RessourceDisplays/RessourceDisplay.js +++ b/app/static/js/ResourceDisplays/ResourceDisplay.js @@ -1,4 +1,4 @@ -class RessourceDisplay { +class ResourceDisplay { constructor(displayElement) { this.displayElement = displayElement; this.userId = this.displayElement.dataset.userId; diff --git a/app/static/js/ResourceLists/CorpusFileList.js b/app/static/js/ResourceLists/CorpusFileList.js index c052b2ea..9997b061 100644 --- a/app/static/js/ResourceLists/CorpusFileList.js +++ b/app/static/js/ResourceLists/CorpusFileList.js @@ -8,9 +8,15 @@ class CorpusFileList extends ResourceList { constructor(listContainerElement, options = {}) { super(listContainerElement, options); this.listjs.list.addEventListener('click', (event) => {this.onClick(event)}); + document.querySelectorAll('.selection-action-trigger[data-selection-action]').forEach((element) => { + element.addEventListener('click', (event) => {this.onSelectionAction(event)}); + }); this.isInitialized = false; + this.selectedItemIds = new Set(); this.userId = listContainerElement.dataset.userId; this.corpusId = listContainerElement.dataset.corpusId; + this.hasPermissionView = listContainerElement.dataset?.hasPermissionView == 'true' || false; + this.hasPermissionManageFiles = listContainerElement.dataset?.hasPermissionManageFiles == 'true' || false; if (this.userId === undefined || this.corpusId === undefined) {return;} app.subscribeUser(this.userId).then((response) => { app.socket.on('PATCH', (patch) => { @@ -24,19 +30,27 @@ class CorpusFileList extends ResourceList { } get item() { - return ` - - - - - - - delete - file_download - send - - - `.trim(); + return (values) => { + return ` + + + + + + + + + + delete + file_download + send + + + `.trim(); + } } get valueNames() { @@ -64,11 +78,20 @@ class CorpusFileList extends ResourceList { + - + @@ -93,6 +116,7 @@ class CorpusFileList extends ResourceList { } onClick(event) { + if (event.target.closest('.disable-on-click') !== null) {return;} let listItemElement = event.target.closest('.list-item[data-id]'); if (listItemElement === null) {return;} let itemId = listItemElement.dataset.id; @@ -100,7 +124,44 @@ class CorpusFileList extends ResourceList { let listAction = listActionElement === null ? 'view' : listActionElement.dataset.listAction; switch (listAction) { case 'delete': { - Utils.deleteCorpusFileRequest(this.userId, this.corpusId, itemId); + let values = this.listjs.get('id', itemId)[0].values(); + let modalElement = Utils.HTMLToElement( + ` +
    +
    +

    Confirm Corpus File deletion

    +

    Do you really want to delete the Corpus File ${values.title}? All files will be permanently deleted!

    +
    +
    + Cancel + Delete +
    +
    + ` + ); + document.querySelector('#modals').appendChild(modalElement); + let modal = M.Modal.init( + modalElement, + { + dismissible: false, + onCloseEnd: () => { + modal.destroy(); + modalElement.remove(); + } + } + ); + let confirmElement = modalElement.querySelector('.action-button[data-action="confirm"]'); + confirmElement.addEventListener('click', (event) => { + if (currentUserId != this.userId) { + Requests.corpora.entity.files.ent.delete(this.corpusId, itemId) + .then(() => { + window.location.reload(); + }); + } else { + Requests.corpora.entity.files.ent.delete(this.corpusId, itemId) + } + }); + modal.open(); break; } case 'download': { @@ -111,12 +172,171 @@ class CorpusFileList extends ResourceList { window.location.href = `/corpora/${this.corpusId}/files/${itemId}`; break; } + case 'select': { + if (event.target.checked) { + this.selectedItemIds.add(itemId); + } else { + this.selectedItemIds.delete(itemId); + } + this.renderingItemSelection(); + break; + } default: { break; } } } + onSelectionAction(event) { + let selectionActionElement = event.target.closest('.selection-action-trigger[data-selection-action]'); + let selectionAction = selectionActionElement.dataset.selectionAction; + let items = this.listjs.items; + let selectableItems = Array.from(items) + .filter(item => item.elm) + .map(item => item.elm.querySelector('.select-checkbox[type="checkbox"]')); + + switch (selectionAction) { + case 'select-all': { + let selectedIds = new Set(Array.from(items) + .map(item => item.values().id)) + if (event.target.checked !== undefined) { + if (event.target.checked) { + selectableItems.forEach(selectableItem => selectableItem.checked = true); + this.selectedItemIds = selectedIds; + } else { + selectableItems.forEach(checkbox => checkbox.checked = false); + this.selectedItemIds = new Set([...this.selectedItemIds].filter(id => !selectedIds.has(id))); + } + this.renderingItemSelection(); + } + break; + } + case 'delete': { + let modalElement = Utils.HTMLToElement( + ` +
    +
    +

    Confirm Corpus File deletion

    +

    Do you really want to delete the Corpus Files?

    +
      +

      All files will be permanently deleted!

      +
      +
      + Cancel + Delete +
      +
      + ` + ); + document.querySelector('#modals').appendChild(modalElement); + let itemList = document.querySelector('#selected-items-list'); + this.selectedItemIds.forEach(selectedItemId => { + let listItem = this.listjs.get('id', selectedItemId)[0].elm; + let values = this.listjs.get('id', listItem.dataset.id)[0].values(); + let itemElement = Utils.HTMLToElement(`
    • - ${values.title}
      • `); + itemList.appendChild(itemElement); + }); + let modal = M.Modal.init( + modalElement, + { + dismissible: false, + onCloseEnd: () => { + modal.destroy(); + modalElement.remove(); + } + } + ); + let confirmElement = modalElement.querySelector('.action-button[data-action="confirm"]'); + confirmElement.addEventListener('click', (event) => { + this.selectedItemIds.forEach(selectedItemId => { + if (currentUserId != this.userId) { + Requests.corpora.entity.files.ent.delete(this.corpusId, selectedItemId) + .then(() => { + window.location.reload(); + }); + } else { + Requests.corpora.entity.files.ent.delete(this.corpusId, selectedItemId); + } + }); + this.selectedItemIds.clear(); + this.renderingItemSelection(); + }); + modal.open(); + break; + } + case 'download': { + this.selectedItemIds.forEach(selectedItemId => { + let downloadLink = document.createElement('a'); + downloadLink.href = `/corpora/${this.corpusId}/files/${selectedItemId}/download`; + downloadLink.download = ''; + downloadLink.click(); + }); + selectableItems.forEach(checkbox => checkbox.checked = false); + this.selectedItemIds.clear(); + this.renderingItemSelection(); + break; + } + default: { + break; + } + } + } + + renderingItemSelection() { + let selectionActionButtons; + if (this.hasPermissionManageFiles) { + selectionActionButtons = document.querySelectorAll('.selection-action-trigger:not([data-selection-action="select-all"])'); + } else if (this.hasPermissionView) { + selectionActionButtons = document.querySelectorAll('.selection-action-trigger:not([data-selection-action="select-all"]):not([data-selection-action="delete"])'); + } + let selectableItems = this.listjs.items; + let actionButtons = []; + + Object.values(selectableItems).forEach(selectableItem => { + if (selectableItem.elm) { + let checkbox = selectableItem.elm.querySelector('.select-checkbox[type="checkbox"]'); + if (checkbox.checked) { + selectableItem.elm.classList.add('grey', 'lighten-3'); + } else { + selectableItem.elm.classList.remove('grey', 'lighten-3'); + } + let itemActionButtons = []; + if (this.hasPermissionManageFiles) { + itemActionButtons = selectableItem.elm.querySelectorAll('.list-action-trigger:not([data-list-action="select"])'); + } else if (this.hasPermissionView) { + itemActionButtons = selectableItem.elm.querySelectorAll('.list-action-trigger:not([data-list-action="select"]):not([data-list-action="delete"]):not([data-list-action="view"])'); + } + itemActionButtons.forEach(itemActionButton => { + actionButtons.push(itemActionButton); + }); + } + }); + // Hide item action buttons if > 0 item is selected and show selection action buttons + if (this.selectedItemIds.size > 0) { + selectionActionButtons.forEach(selectionActionButton => { + selectionActionButton.classList.remove('hide'); + }); + actionButtons.forEach(actionButton => { + actionButton.classList.add('hide'); + }); + } else { + selectionActionButtons.forEach(selectionActionButton => { + selectionActionButton.classList.add('hide'); + }); + actionButtons.forEach(actionButton => { + actionButton.classList.remove('hide'); + }); + } + + // Check select all checkbox if all items are selected + let selectAllCheckbox = document.querySelector('.select-all-checkbox[type="checkbox"]'); + if (selectableItems.length === this.selectedItemIds.size && selectAllCheckbox.checked === false) { + selectAllCheckbox.checked = true; + } else if (selectableItems.length !== this.selectedItemIds.size && selectAllCheckbox.checked === true) { + selectAllCheckbox.checked = false; + } + } + onPatch(patch) { let re = new RegExp(`^/users/${this.userId}/corpora/${this.corpusId}/files/([A-Za-z0-9]*)`); let filteredPatch = patch.filter(operation => re.test(operation.path)); diff --git a/app/static/js/ResourceLists/CorpusFollowerList.js b/app/static/js/ResourceLists/CorpusFollowerList.js new file mode 100644 index 00000000..ca70a6c7 --- /dev/null +++ b/app/static/js/ResourceLists/CorpusFollowerList.js @@ -0,0 +1,199 @@ +class CorpusFollowerList extends ResourceList { + static autoInit() { + for (let corpusFollowerListElement of document.querySelectorAll('.corpus-follower-list:not(.no-autoinit)')) { + new CorpusFollowerList(corpusFollowerListElement); + } + } + + constructor(listContainerElement, options = {}) { + super(listContainerElement, options); + this.listjs.on('updated', () => { + M.FormSelect.init(this.listjs.list.querySelectorAll('.list-item select')); + }); + this.listjs.list.addEventListener('change', (event) => {this.onChange(event)}); + this.listjs.list.addEventListener('click', (event) => {this.onClick(event)}); + this.isInitialized = false; + this.userId = listContainerElement.dataset.userId; + this.corpusId = listContainerElement.dataset.corpusId; + if (this.userId === undefined || this.corpusId === undefined) {return;} + app.subscribeUser(this.userId).then((response) => { + app.socket.on('PATCH', (patch) => { + if (this.isInitialized) {this.onPatch(patch);} + }); + }); + app.getUser(this.userId).then((user) => { + let corpusFollowerAssociations = Object.values(user.corpora[this.corpusId].corpus_follower_associations); + // let filteredList = corpusFollowerAssociations.filter(association => association.follower.id != currentUserId); + // this.add(filteredList); + this.add(Object.values(user.corpora[this.corpusId].corpus_follower_associations)); + this.isInitialized = true; + }); + } + + get item() { + return (values) => { + return ` + + + + + + + + `.trim(); + } + } + + get valueNames() { + return [ + {data: ['id']}, + {data: ['follower-id']}, + {name: 'follower-avatar', attr: 'src'}, + 'follower-username', + 'follower-about-me', + 'follower-full-name' + ]; + } + + initListContainerElement() { + if (!this.listContainerElement.hasAttribute('id')) { + this.listContainerElement.id = Utils.generateElementId('corpus-follower-list-'); + } + let listSearchElementId = Utils.generateElementId(`${this.listContainerElement.id}-search-`); + this.listContainerElement.innerHTML = ` +
      + search + + +
      +
      + + Filename Author Title Publishing year + delete + file_download +
      follower-avatar + +
      + +       		+
      + +
      +       		+ delete + send +
      + + + + + + + + + + +
      UsernameUser detailsRole
      +
        + `.trim(); + } + + mapResourceToValue(corpusFollowerAssociation) { + return { + 'id': corpusFollowerAssociation.id, + 'follower-id': corpusFollowerAssociation.follower.id, + 'follower-avatar': corpusFollowerAssociation.follower.avatar ? `/users/${corpusFollowerAssociation.follower.id}/avatar` : '/static/images/user_avatar.png', + 'follower-username': corpusFollowerAssociation.follower.username, + 'follower-full-name': corpusFollowerAssociation.follower.full_name ? corpusFollowerAssociation.follower.full_name : '', + 'follower-about-me': corpusFollowerAssociation.follower.about_me ? corpusFollowerAssociation.follower.about_me : '', + 'role-name': corpusFollowerAssociation.role.name + }; + } + + sort() { + this.listjs.sort('username', {order: 'desc'}); + } + + onChange(event) { + let listItemElement = event.target.closest('.list-item[data-id]'); + if (listItemElement === null) {return;} + let itemId = listItemElement.dataset.id; + let listActionElement = event.target.closest('.list-action-trigger[data-list-action]'); + if (listActionElement === null) {return;} + let listAction = listActionElement.dataset.listAction; + switch (listAction) { + case 'update-role': { + let followerId = listItemElement.dataset.followerId; + let roleName = event.target.value; + Requests.corpora.entity.followers.entity.role.update(this.corpusId, followerId, roleName); + break; + } + default: { + break; + } + } + } + + onClick(event) { + if (event.target.closest('.disable-on-click') !== null) {return;} + let listItemElement = event.target.closest('.list-item[data-id]'); + if (listItemElement === null) {return;} + let itemId = listItemElement.dataset.id; + let listActionElement = event.target.closest('.list-action-trigger[data-list-action]'); + let listAction = listActionElement === null ? 'view' : listActionElement.dataset.listAction; + switch (listAction) { + case 'unfollow-request': { + let followerId = listItemElement.dataset.followerId; + if (currentUserId != this.userId) { + Requests.corpora.entity.followers.entity.delete(this.corpusId, followerId) + .then(() => { + window.location.reload(); + }); + } else { + Requests.corpora.entity.followers.entity.delete(this.corpusId, followerId); + } + break; + } + case 'view': { + let followerId = listItemElement.dataset.followerId; + window.location.href = `/users/${followerId}`; + break; + } + default: { + break; + } + } + } + + onPatch(patch) { + let re = new RegExp(`^/users/${this.userId}/corpora/${this.corpusId}/corpus_follower_associations/([A-Za-z0-9]*)`); + let filteredPatch = patch.filter(operation => re.test(operation.path)); + for (let operation of filteredPatch) { + switch(operation.op) { + case 'add': { + let re = new RegExp(`^/users/${this.userId}/corpora/${this.corpusId}/corpus_follower_associations/([A-Za-z0-9]*)$`); + if (re.test(operation.path)) {this.add(operation.value);} + break; + } + case 'remove': { + let re = new RegExp(`^/users/${this.userId}/corpora/${this.corpusId}/corpus_follower_associations/([A-Za-z0-9]*)$`); + if (re.test(operation.path)) { + let [match, jobId] = operation.path.match(re); + this.remove(jobId); + } + break; + } + case 'replace': { + let re = new RegExp(`^/users/${this.userId}/corpora/${this.corpusId}/corpus_follower_associations/([A-Za-z0-9]*)/role$`); + if (re.test(operation.path)) { + let [match, jobId, valueName] = operation.path.match(re); + this.replace(jobId, valueName, operation.value); + } + break; + } + default: { + break; + } + } + } + } +} diff --git a/app/static/js/ResourceLists/CorpusList.js b/app/static/js/ResourceLists/CorpusList.js index bf62ebed..985ff1d1 100644 --- a/app/static/js/ResourceLists/CorpusList.js +++ b/app/static/js/ResourceLists/CorpusList.js @@ -8,7 +8,11 @@ class CorpusList extends ResourceList { constructor(listContainerElement, options = {}) { super(listContainerElement, options); this.listjs.list.addEventListener('click', (event) => {this.onClick(event)}); + document.querySelectorAll('.corpus-list-selection-action-trigger[data-selection-action]').forEach((element) => { + element.addEventListener('click', (event) => {this.onSelectionAction(event)}); + }); this.isInitialized = false + this.selectedItemIds = new Set(); this.userId = listContainerElement.dataset.userId; if (this.userId === undefined) {return;} app.subscribeUser(this.userId).then((response) => { @@ -17,24 +21,66 @@ class CorpusList extends ResourceList { }); }); app.getUser(this.userId).then((user) => { - this.add(Object.values(user.corpora)); + this.add(this.aggregateData(user)); this.isInitialized = true; }); } + aggregateData(user) { + const aggregatedData = []; + for (let corpus of Object.values(user.corpora)) { + aggregatedData.push( + { + 'id': corpus.id, + 'creation-date': corpus.creation_date, + 'description': corpus.description, + 'status': corpus.status, + 'title': corpus.title, + 'owner': user.username, + 'is-owner': true, + 'current-user-is-following': false + } + ); + } + for (let cfa of Object.values(user.corpus_follower_associations)) { + aggregatedData.push( + { + 'id': cfa.corpus.id, + 'creation-date': cfa.corpus.creation_date, + 'description': cfa.corpus.description, + 'status': cfa.corpus.status, + 'title': cfa.corpus.title, + 'owner': cfa.corpus.user.username, + 'is-owner': false, + 'current-user-is-following': true + } + ); + } + return aggregatedData; + } + // #region Mandatory getters and methods to implement get item() { - return ` - - book -
        - - - delete - send - - - `.trim(); + return (values) => { + return ` + + + + +
        + + + ${values['current-user-is-following'] ? 'visibilityFollowing' : ''} + + delete + send + + + `.trim(); + }; } get valueNames() { @@ -43,7 +89,9 @@ class CorpusList extends ResourceList { {data: ['creation-date']}, {name: 'status', attr: 'data-status'}, 'description', - 'title' + 'title', + 'owner', + 'current-user-is-following' ]; } @@ -56,15 +104,24 @@ class CorpusList extends ResourceList {
        search - +
        - + + + @@ -73,16 +130,6 @@ class CorpusList extends ResourceList { `.trim(); } - mapResourceToValue(corpus) { - return { - 'id': corpus.id, - 'creation-date': corpus.creation_date, - 'description': corpus.description, - 'status': corpus.status, - 'title': corpus.title - }; - } - sort() { this.listjs.sort('creation-date', {order: 'desc'}); } @@ -95,19 +142,202 @@ class CorpusList extends ResourceList { let listAction = listActionElement === null ? 'view' : listActionElement.dataset.listAction; switch (listAction) { case 'delete-request': { - Utils.deleteCorpusRequest(this.userId, itemId); + let values = this.listjs.get('id', itemId)[0].values(); + let modalElement = Utils.HTMLToElement( + ` +
        +
        +

        Confirm Corpus deletion

        +

        Do you really want to ${values['is-owner'] ? 'delete' : 'unfollow'} the Corpus ${values.title}? ${values['is-owner'] ? 'All files will be permanently deleted!' : ''}

        +
        +
        + Cancel + Delete +
        +
        + ` + ); + document.querySelector('#modals').appendChild(modalElement); + let modal = M.Modal.init( + modalElement, + { + dismissible: false, + onCloseEnd: () => { + modal.destroy(); + modalElement.remove(); + } + } + ); + let confirmElement = modalElement.querySelector('.action-button[data-action="confirm"]'); + confirmElement.addEventListener('click', (event) => { + if (!values['is-owner']) { + Requests.corpora.entity.followers.entity.delete(itemId, currentUserId) + .then((response) => { + window.location.reload(); + }); + } else { + Requests.corpora.entity.delete(itemId); + } + }); + modal.open(); break; } case 'view': { window.location.href = `/corpora/${itemId}`; break; } + case 'select': { + if (event.target.checked) { + this.selectedItemIds.add(itemId); + } else { + this.selectedItemIds.delete(itemId); + } + this.renderingItemSelection(); + } default: { break; } } } + onSelectionAction(event) { + let selectionActionElement = event.target.closest('.corpus-list-selection-action-trigger[data-selection-action]'); + let selectionAction = selectionActionElement.dataset.selectionAction; + let items = Array.from(this.listjs.items); + let selectableItems = Array.from(items) + .filter(item => item.elm) + .map(item => item.elm.querySelector('.select-checkbox[type="checkbox"]')); + + switch (selectionAction) { + case 'select-all': { + let selectedIds = new Set(Array.from(items) + .map(item => item.values().id)) + if (event.target.checked !== undefined) { + if (event.target.checked) { + selectableItems.forEach(selectableItem => selectableItem.checked = true); + this.selectedItemIds = selectedIds; + } else { + selectableItems.forEach(checkbox => checkbox.checked = false); + this.selectedItemIds = new Set([...this.selectedItemIds].filter(id => !selectedIds.has(id))); + } + this.renderingItemSelection(); + } + break; + } + case 'delete': { + // Saved for future use: + //

        Do you really want to unfollow this Corpora?

        + //
          + let modalElement = Utils.HTMLToElement( + ` +
          +
          +

          Confirm Corpus deletion

          +

          Do you really want to delete this Corpora? All corpora will be permanently deleted!

          +
            +
            +
            + Cancel + Delete +
            +
            + ` + ); + document.querySelector('#modals').appendChild(modalElement); + let itemDeletionList = document.querySelector('#selected-deletion-items-list'); + // let itemUnfollowList = document.querySelector('#selected-unfollow-items-list'); + this.selectedItemIds.forEach(selectedItemId => { + let listItem = this.listjs.get('id', selectedItemId)[0].elm; + let values = this.listjs.get('id', listItem.dataset.id)[0].values(); + let itemElement = Utils.HTMLToElement(`
          • - ${values.title}
            • `); + // if (!values['is-owner']) { + // itemUnfollowList.appendChild(itemElement); + // } else { + itemDeletionList.appendChild(itemElement); + // } + }); + let modal = M.Modal.init( + modalElement, + { + dismissible: false, + onCloseEnd: () => { + modal.destroy(); + modalElement.remove(); + } + } + ); + let confirmElement = modalElement.querySelector('.action-button[data-action="confirm"]'); + confirmElement.addEventListener('click', (event) => { + this.selectedItemIds.forEach(selectedItemId => { + let listItem = this.listjs.get('id', selectedItemId)[0].elm; + let values = this.listjs.get('id', listItem.dataset.id)[0].values(); + if (values['is-owner']) { + Requests.corpora.entity.delete(selectedItemId); + } else { + Requests.corpora.entity.followers.entity.delete(selectedItemId, currentUserId); + setTimeout(() => { + window.location.reload(); + }, 1000); + } + }); + this.selectedItemIds.clear(); + this.renderingItemSelection(); + + }); + modal.open(); + break; + } + default: { + break; + } + } + } + + renderingItemSelection() { + let selectionActionButtons = document.querySelectorAll('.corpus-list-selection-action-trigger:not([data-selection-action="select-all"])'); + let selectableItems = this.listjs.items; + let actionButtons = []; + + Object.values(selectableItems).forEach(selectableItem => { + if (selectableItem.elm) { + let checkbox = selectableItem.elm.querySelector('.select-checkbox[type="checkbox"]'); + if (checkbox.checked) { + selectableItem.elm.classList.add('grey', 'lighten-3'); + } else { + selectableItem.elm.classList.remove('grey', 'lighten-3'); + } + let itemActionButtons = selectableItem.elm.querySelectorAll('.list-action-trigger:not([data-list-action="select"])'); + itemActionButtons.forEach(itemActionButton => { + actionButtons.push(itemActionButton); + }); + } + }); + // Hide item action buttons if > 0 item is selected and show selection action buttons + if (this.selectedItemIds.size > 0) { + selectionActionButtons.forEach(selectionActionButton => { + selectionActionButton.classList.remove('hide'); + }); + actionButtons.forEach(actionButton => { + actionButton.classList.add('hide'); + }); + } else { + selectionActionButtons.forEach(selectionActionButton => { + selectionActionButton.classList.add('hide'); + }); + actionButtons.forEach(actionButton => { + actionButton.classList.remove('hide'); + }); + } + + // Check select all checkbox if all items are selected + let selectAllCheckbox = document.querySelector('.corpus-list-select-all-checkbox[type="checkbox"]'); + if (selectableItems.length === this.selectedItemIds.size && selectAllCheckbox.checked === false) { + selectAllCheckbox.checked = true; + } else if (selectableItems.length !== this.selectedItemIds.size && selectAllCheckbox.checked === true) { + selectAllCheckbox.checked = false; + } + } + onPatch(patch) { let re = new RegExp(`^/users/${this.userId}/corpora/([A-Za-z0-9]*)`); let filteredPatch = patch.filter(operation => re.test(operation.path)); diff --git a/app/static/js/ResourceLists/DetailledPublicCorpusList.js b/app/static/js/ResourceLists/DetailledPublicCorpusList.js new file mode 100644 index 00000000..5bfc59ff --- /dev/null +++ b/app/static/js/ResourceLists/DetailledPublicCorpusList.js @@ -0,0 +1,71 @@ +class DetailledPublicCorpusList extends CorpusList { + get item() { + return (values) => { + return ` + + + + + + + + + `.trim(); + }; + } + + get valueNames() { + return [ + {data: ['id']}, + {data: ['creation-date']}, + {name: 'status', attr: 'data-status'}, + 'description', + 'title', + 'owner', + 'current-user-is-following' + ]; + } + + initListContainerElement() { + if (!this.listContainerElement.hasAttribute('id')) { + this.listContainerElement.id = Utils.generateElementId('corpus-list-'); + } + let listSearchElementId = Utils.generateElementId(`${this.listContainerElement.id}-search-`); + this.listContainerElement.innerHTML = ` +
            + search + + +
            +
            + + Title and DescriptionOwner Status + delete +

            		${values['current-user-is-following'] ? 'visibilityFollowing' : ''} + send +
            + + + + + + + + + + + +
            Title and DescriptionOwnerStatus
            +
              + `.trim(); + } + + mapResourceToValue(corpus) { + return { + 'id': corpus.id, + 'creation-date': corpus.creation_date, + 'description': corpus.description, + 'status': corpus.status, + 'title': corpus.title, + 'owner': corpus.user.username, + 'is-owner': corpus.user.id === this.userId, + 'current-user-is-following': Object.values(corpus.corpus_follower_associations).some(association => association.follower.id === currentUserId) + }; + } +} diff --git a/app/static/js/ResourceLists/JobInputList.js b/app/static/js/ResourceLists/JobInputList.js index 7f1a5105..97a8dd14 100644 --- a/app/static/js/ResourceLists/JobInputList.js +++ b/app/static/js/ResourceLists/JobInputList.js @@ -12,11 +12,7 @@ class JobInputList extends ResourceList { this.userId = listContainerElement.dataset.userId; this.jobId = listContainerElement.dataset.jobId; if (this.userId === undefined || this.jobId === undefined) {return;} - app.subscribeUser(this.userId).then((response) => { - app.socket.on('PATCH', (patch) => { - if (this.isInitialized) {this.onPatch(patch);} - }); - }); + app.subscribeUser(this.userId); app.getUser(this.userId).then((user) => { this.add(Object.values(user.jobs[this.jobId].inputs)); this.isInitialized = true; diff --git a/app/static/js/ResourceLists/JobList.js b/app/static/js/ResourceLists/JobList.js index ff7f82b2..473ae826 100644 --- a/app/static/js/ResourceLists/JobList.js +++ b/app/static/js/ResourceLists/JobList.js @@ -7,8 +7,13 @@ class JobList extends ResourceList { constructor(listContainerElement, options = {}) { super(listContainerElement, options); + this.documentJobArea = document.querySelector('#jobs'); this.listjs.list.addEventListener('click', (event) => {this.onClick(event)}); + document.querySelectorAll('.job-list-selection-action-trigger[data-selection-action]').forEach((element) => { + element.addEventListener('click', (event) => {this.onSelectionAction(event)}); + }); this.isInitialized = false; + this.selectedItemIds = new Set(); this.userId = listContainerElement.dataset.userId; if (this.userId === undefined) {return;} app.subscribeUser(this.userId).then((response) => { @@ -24,7 +29,13 @@ class JobList extends ResourceList { get item() { return ` - + + + +
              @@ -56,15 +67,23 @@ class JobList extends ResourceList {
              search - +
              + - + @@ -93,22 +112,185 @@ class JobList extends ResourceList { if (listItemElement === null) {return;} let itemId = listItemElement.dataset.id; let listActionElement = event.target.closest('.list-action-trigger[data-list-action]'); - let listAction = listActionElement === null ? 'view' : listActionElement.dataset.listAction; + let listAction = listActionElement === null ? '' : listActionElement.dataset.listAction; switch (listAction) { case 'delete-request': { - Utils.deleteJobRequest(this.userId, itemId); + let values = this.listjs.get('id', itemId)[0].values(); + let modalElement = Utils.HTMLToElement( + ` +
              +
              +

              Confirm Job deletion

              +

              Do you really want to delete the Job ${values.title}? All files will be permanently deleted!

              +
              +
              + Cancel + Delete +
              +
              + ` + ); + document.querySelector('#modals').appendChild(modalElement); + let modal = M.Modal.init( + modalElement, + { + dismissible: false, + onCloseEnd: () => { + modal.destroy(); + modalElement.remove(); + } + } + ); + let confirmElement = modalElement.querySelector('.action-button[data-action="confirm"]'); + confirmElement.addEventListener('click', (event) => { + Requests.jobs.entity.delete(itemId); + }); + modal.open(); break; } case 'view': { window.location.href = `/jobs/${itemId}`; break; } + case 'select': { + if (event.target.checked) { + this.selectedItemIds.add(itemId); + } else { + this.selectedItemIds.delete(itemId); + } + this.renderingItemSelection(); + break; + } default: { break; } } } + onSelectionAction(event) { + let selectionActionElement = event.target.closest('.job-list-selection-action-trigger[data-selection-action]'); + let selectionAction = selectionActionElement.dataset.selectionAction; + let items = this.listjs.items; + let selectableItems = Array.from(items) + .filter(item => item.elm) + .map(item => item.elm.querySelector('.select-checkbox[type="checkbox"]')); + switch (selectionAction) { + case 'select-all': { + let selectedIds = new Set(Array.from(items) + .map(item => item.values().id)) + if (event.target.checked !== undefined) { + if (event.target.checked) { + selectableItems.forEach(selectableItem => selectableItem.checked = true); + this.selectedItemIds = selectedIds; + } else { + selectableItems.forEach(checkbox => checkbox.checked = false); + this.selectedItemIds = new Set([...this.selectedItemIds].filter(id => !selectedIds.has(id))); + } + this.renderingItemSelection(); + } + break; + } + case 'delete': { + let modalElement = Utils.HTMLToElement( + ` +
              +
              +

              Confirm Corpus File deletion

              +

              Do you really want to delete the Jobs?

              +
                +

                All files will be permanently deleted!

                +
                +
                + Cancel + Delete +
                +
                + ` + ); + document.querySelector('#modals').appendChild(modalElement); + let itemList = document.querySelector('#selected-items-list'); + this.selectedItemIds.forEach(selectedItemId => { + let listItem = this.listjs.get('id', selectedItemId)[0].elm; + let values = this.listjs.get('id', listItem.dataset.id)[0].values(); + let itemElement = Utils.HTMLToElement(`
              • - ${values.title}
                • `); + itemList.appendChild(itemElement); + }); + let modal = M.Modal.init( + modalElement, + { + dismissible: false, + onCloseEnd: () => { + modal.destroy(); + modalElement.remove(); + } + } + ); + let confirmElement = modalElement.querySelector('.action-button[data-action="confirm"]'); + confirmElement.addEventListener('click', (event) => { + this.selectedItemIds.forEach(selectedItemId => { + Requests.jobs.entity.delete(selectedItemId); + }); + this.selectedItemIds.clear(); + this.renderingItemSelection(); + }); + modal.open(); + break; + } + default: { + break; + } + } + } + + renderingItemSelection() { + let selectionActionButtons = document.querySelectorAll('.job-list-selection-action-trigger:not([data-selection-action="select-all"])'); + let selectableItems = this.listjs.items; + let actionButtons = []; + + Object.values(selectableItems).forEach(selectableItem => { + if (selectableItem.elm) { + let checkbox = selectableItem.elm.querySelector('.select-checkbox[type="checkbox"]'); + if (checkbox.checked) { + selectableItem.elm.classList.add('grey', 'lighten-3'); + } else { + selectableItem.elm.classList.remove('grey', 'lighten-3'); + } + let itemActionButtons = selectableItem.elm.querySelectorAll('.list-action-trigger:not([data-list-action="select"])'); + itemActionButtons.forEach(itemActionButton => { + actionButtons.push(itemActionButton); + }); + } + }); + + + + // Hide item action buttons if > 0 item is selected and show selection action buttons + if (this.selectedItemIds.size > 0) { + selectionActionButtons.forEach(selectionActionButton => { + selectionActionButton.classList.remove('hide'); + }); + actionButtons.forEach(actionButton => { + actionButton.classList.add('hide'); + }); + } else { + selectionActionButtons.forEach(selectionActionButton => { + selectionActionButton.classList.add('hide'); + }); + actionButtons.forEach(actionButton => { + actionButton.classList.remove('hide'); + }); + } + + // Check select all checkbox if all items are selected + let selectAllCheckbox = document.querySelector('.job-list-select-all-checkbox[type="checkbox"]'); + if (selectableItems.length === this.selectedItemIds.size && selectAllCheckbox.checked === false) { + selectAllCheckbox.checked = true; + } else if (selectableItems.length !== this.selectedItemIds.size && selectAllCheckbox.checked === true) { + selectAllCheckbox.checked = false; + } + + } + onPatch(patch) { let re = new RegExp(`^/users/${this.userId}/jobs/([A-Za-z0-9]*)`); let filteredPatch = patch.filter(operation => re.test(operation.path)); diff --git a/app/static/js/ResourceLists/PublicCorpusFileList.js b/app/static/js/ResourceLists/PublicCorpusFileList.js deleted file mode 100644 index 37a284cf..00000000 --- a/app/static/js/ResourceLists/PublicCorpusFileList.js +++ /dev/null @@ -1,15 +0,0 @@ -class PublicCorpusFileList extends CorpusFileList { - get item() { - return ` - - - - - - - - `.trim(); - } -} diff --git a/app/static/js/ResourceLists/PublicCorpusList.js b/app/static/js/ResourceLists/PublicCorpusList.js index fdb2e9ed..1ef98273 100644 --- a/app/static/js/ResourceLists/PublicCorpusList.js +++ b/app/static/js/ResourceLists/PublicCorpusList.js @@ -1,14 +1,55 @@ class PublicCorpusList extends CorpusList { get item() { - return ` - - - - - - + return (values) => { + return ` + + + + + + + `.trim(); + }; + } + + mapResourceToValue(corpus) { + return { + 'id': corpus.id, + 'creation-date': corpus.creation_date, + 'description': corpus.description, + 'status': corpus.status, + 'title': corpus.title, + 'owner': corpus.user.username, + 'is-owner': corpus.user.id === this.userId ? true : false, + 'current-user-is-following': Object.values(corpus.corpus_follower_associations).some(association => association.follower.id === currentUserId) + }; + } + + initListContainerElement() { + if (!this.listContainerElement.hasAttribute('id')) { + this.listContainerElement.id = Utils.generateElementId('corpus-list-'); + } + let listSearchElementId = Utils.generateElementId(`${this.listContainerElement.id}-search-`); + this.listContainerElement.innerHTML = ` +
                + search + + +
                +
                + + Service Title and Description Status + delete +
                - send -
                book
                		 - send -

                		${values['current-user-is-following'] ? 'visibility' : ''} + send +
                + + + + + + + + + +
                Title and DescriptionOwner
                +
                  `.trim(); } } diff --git a/app/static/js/ResourceLists/ResourceList.js b/app/static/js/ResourceLists/ResourceList.js index 7fe7dec6..3251ef2b 100644 --- a/app/static/js/ResourceLists/ResourceList.js +++ b/app/static/js/ResourceLists/ResourceList.js @@ -14,6 +14,7 @@ class ResourceList { TesseractOCRPipelineModelList.autoInit(); UserList.autoInit(); AdminUserList.autoInit(); + CorpusFollowerList.autoInit(); } static defaultOptions = { @@ -42,7 +43,8 @@ class ResourceList { } add(resources, callback) { - let values = resources.map((resource) => { + let tmp = Array.isArray(resources) ? resources : [resources]; + let values = tmp.map((resource) => { return this.mapResourceToValue(resource); }); this.listjs.add(values, (items) => { diff --git a/app/static/js/ResourceLists/SpacyNLPPipelineModelList.js b/app/static/js/ResourceLists/SpacyNLPPipelineModelList.js index b90fb06b..46d3739d 100644 --- a/app/static/js/ResourceLists/SpacyNLPPipelineModelList.js +++ b/app/static/js/ResourceLists/SpacyNLPPipelineModelList.js @@ -30,14 +30,12 @@ class SpaCyNLPPipelineModelList extends ResourceList {
                  ()
                  -
                  - + -
                  + delete @@ -80,6 +78,7 @@ class SpaCyNLPPipelineModelList extends ResourceList { Title and Description Publisher + Availability @@ -111,6 +110,7 @@ class SpaCyNLPPipelineModelList extends ResourceList { } onChange(event) { + if (event.target.tagName !== 'INPUT') {return;} let listItemElement = event.target.closest('.list-item[data-id]'); if (listItemElement === null) {return;} let itemId = listItemElement.dataset.id; @@ -118,8 +118,12 @@ class SpaCyNLPPipelineModelList extends ResourceList { if (listActionElement === null) {return;} let listAction = listActionElement.dataset.listAction; switch (listAction) { - case 'share-request': { - Utils.spaCyNLPPipelineModelToggleIsPublicRequest(this.userId, itemId); + case 'toggle-is-public': { + let newIsPublicValue = listActionElement.checked; + Requests.contributions.spacy_nlp_pipeline_models.entity.isPublic.update(itemId, newIsPublicValue) + .catch((response) => { + listActionElement.checked = !newIsPublicValue; + }); break; } default: { @@ -129,19 +133,45 @@ class SpaCyNLPPipelineModelList extends ResourceList { } onClick(event) { + if (event.target.closest('.disable-on-click') !== null) {return;} let listItemElement = event.target.closest('.list-item[data-id]'); if (listItemElement === null) {return;} let itemId = listItemElement.dataset.id; let listActionElement = event.target.closest('.list-action-trigger[data-list-action]'); - // ignore switch clicks, handle them by the onChange method instead - if (listActionElement.classList.contains('switch')) { - event.preventDefault(); - this.onChange(event); - } let listAction = listActionElement === null ? 'view' : listActionElement.dataset.listAction; switch (listAction) { case 'delete-request': { - Utils.deleteSpaCyNLPPipelineModelRequest(this.userId, itemId); + let values = this.listjs.get('id', itemId)[0].values(); + let modalElement = Utils.HTMLToElement( + ` +
                  +
                  +

                  Confirm SpaCy NLP Pipeline Model deletion

                  +

                  Do you really want to delete the SpaCy NLP Pipeline Model ${values.title}? All files will be permanently deleted!

                  +
                  +
                  + Cancel + Delete +
                  +
                  + ` + ); + document.querySelector('#modals').appendChild(modalElement); + let modal = M.Modal.init( + modalElement, + { + dismissible: false, + onCloseEnd: () => { + modal.destroy(); + modalElement.remove(); + } + } + ); + let confirmElement = modalElement.querySelector('.action-button[data-action="confirm"]'); + confirmElement.addEventListener('click', (event) => { + Requests.contributions.spacy_nlp_pipeline_models.entity.delete(itemId); + }); + modal.open(); break; } case 'view': { diff --git a/app/static/js/ResourceLists/TesseractOCRPipelineModelList.js b/app/static/js/ResourceLists/TesseractOCRPipelineModelList.js index 4ad3f5b1..765f44a6 100644 --- a/app/static/js/ResourceLists/TesseractOCRPipelineModelList.js +++ b/app/static/js/ResourceLists/TesseractOCRPipelineModelList.js @@ -38,14 +38,12 @@ class TesseractOCRPipelineModelList extends ResourceList {
                  ()
                  -
                  - + -
                  + delete @@ -89,6 +87,7 @@ class TesseractOCRPipelineModelList extends ResourceList { Title and Description Publisher + Availability @@ -120,6 +119,7 @@ class TesseractOCRPipelineModelList extends ResourceList { } onChange(event) { + if (event.target.tagName !== 'INPUT') {return;} let listItemElement = event.target.closest('.list-item[data-id]'); if (listItemElement === null) {return;} let itemId = listItemElement.dataset.id; @@ -127,8 +127,12 @@ class TesseractOCRPipelineModelList extends ResourceList { if (listActionElement === null) {return;} let listAction = listActionElement.dataset.listAction; switch (listAction) { - case 'share-request': { - Utils.tesseractOCRPipelineModelToggleIsPublicRequest(this.userId, itemId); + case 'toggle-is-public': { + let newIsPublicValue = listActionElement.checked; + Requests.contributions.tesseract_ocr_pipeline_models.entity.isPublic.update(itemId, newIsPublicValue) + .catch((response) => { + listActionElement.checked = !newIsPublicValue; + }); break; } default: { @@ -138,19 +142,45 @@ class TesseractOCRPipelineModelList extends ResourceList { } onClick(event) { + if (event.target.closest('.disable-on-click') !== null) {return;} let listItemElement = event.target.closest('.list-item[data-id]'); if (listItemElement === null) {return;} let itemId = listItemElement.dataset.id; let listActionElement = event.target.closest('.list-action-trigger[data-list-action]'); - // ignore switch clicks, handle them by the onChange method instead - if (listActionElement.classList.contains('switch')) { - event.preventDefault(); - this.onChange(event); - } let listAction = listActionElement === null ? 'view' : listActionElement.dataset.listAction; switch (listAction) { case 'delete-request': { - Utils.deleteTesseractOCRPipelineModelRequest(this.userId, itemId); + let values = this.listjs.get('id', itemId)[0].values(); + let modalElement = Utils.HTMLToElement( + ` +
                  +
                  +

                  Confirm Tesseract OCR Pipeline Model deletion

                  +

                  Do you really want to delete the Tesseract OCR Pipeline Model ${values.title}? All files will be permanently deleted!

                  +
                  +
                  + Cancel + Delete +
                  +
                  + ` + ); + document.querySelector('#modals').appendChild(modalElement); + let modal = M.Modal.init( + modalElement, + { + dismissible: false, + onCloseEnd: () => { + modal.destroy(); + modalElement.remove(); + } + } + ); + let confirmElement = modalElement.querySelector('.action-button[data-action="confirm"]'); + confirmElement.addEventListener('click', (event) => { + Requests.contributions.tesseract_ocr_pipeline_models.entity.delete(itemId); + }); + modal.open(); break; } case 'view': { diff --git a/app/static/js/ResourceLists/UserList.js b/app/static/js/ResourceLists/UserList.js index 03fabd73..2ba4dc19 100644 --- a/app/static/js/ResourceLists/UserList.js +++ b/app/static/js/ResourceLists/UserList.js @@ -13,14 +13,14 @@ class UserList extends ResourceList { get item() { return ` - user-image + user-image - send + `.trim(); @@ -72,12 +72,12 @@ class UserList extends ResourceList { return { 'id': user.id, 'member-since': user.member_since, - 'avatar': user.avatar ? `/users/${user.id}/avatar` : '/static/images/user_avatar.png', + 'avatar': user.avatar, 'username': user.username, 'full-name': user.full_name ? user.full_name : '', 'location': user.location ? user.location : '', 'organization': user.organization ? user.organization : '', - 'corpora-online': '-' + 'corpora-online': Object.values(user.corpora).filter((corpus) => corpus.is_public).length }; }; diff --git a/app/static/js/Utils.js b/app/static/js/Utils.js index aee382a0..79879c75 100644 --- a/app/static/js/Utils.js +++ b/app/static/js/Utils.js @@ -69,648 +69,4 @@ class Utils { return Utils.mergeObjectsDeep(mergedObject, ...objects.slice(2)); } - static enableCorpusIsPublicRequest(userId, corpusId) { - return new Promise((resolve, reject) => { - let corpus; - try { - corpus = app.data.users[userId].corpora[corpusId]; - } catch (error) { - corpus = {}; - } - - let modalElement = Utils.HTMLToElement( - ` -
                  -
                  -

                  Hier könnte eine Warnung stehen

                  -

                  -
                  -
                  - Cancel - Confirm -
                  -
                  - ` - ); - document.querySelector('#modals').appendChild(modalElement); - let modal = M.Modal.init( - modalElement, - { - dismissible: false, - onCloseEnd: () => { - modal.destroy(); - modalElement.remove(); - } - } - ); - - let confirmElement = modalElement.querySelector('.action-button[data-action="confirm"]'); - confirmElement.addEventListener('click', (event) => { - let corpusTitle = corpus?.title; - fetch(`/corpora/${corpusId}/enable_is_public`, {method: 'POST', headers: {Accept: 'application/json'}}) - .then( - (response) => { - if (response.status === 403) {app.flash('Forbidden', 'error'); reject(response);} - if (response.status === 404) {app.flash('Not Found', 'error'); reject(response);} - app.flash(`Corpus "${corpusTitle}" is public now`, 'corpus'); - resolve(response); - }, - (response) => { - app.flash('Something went wrong', 'error'); - reject(response); - } - ); - }); - modal.open(); - }); - } - - static disableCorpusIsPublicRequest(userId, corpusId) { - return new Promise((resolve, reject) => { - let corpus; - try { - corpus = app.data.users[userId].corpora[corpusId]; - } catch (error) { - corpus = {}; - } - - let corpusTitle = corpus?.title; - fetch(`/corpora/${corpusId}/disable_is_public`, {method: 'POST', headers: {Accept: 'application/json'}}) - .then( - (response) => { - if (response.status === 403) {app.flash('Forbidden', 'error'); reject(response);} - if (response.status === 404) {app.flash('Not Found', 'error'); reject(response);} - app.flash(`Corpus "${corpusTitle}" is private now`, 'corpus'); - resolve(response); - }, - (response) => { - app.flash('Something went wrong', 'error'); - reject(response); - } - ); - }); - } - - static buildCorpusRequest(userId, corpusId) { - return new Promise((resolve, reject) => { - let corpus; - try { - corpus = app.data.users[userId].corpora[corpusId]; - } catch (error) { - corpus = {}; - } - - fetch(`/corpora/${corpusId}/build`, {method: 'POST', headers: {Accept: 'application/json'}}) - .then( - (response) => { - if (response.status === 403) {app.flash('Forbidden', 'error'); reject(response);} - if (response.status === 404) {app.flash('Not Found', 'error'); reject(response);} - if (response.status === 409) {app.flash('Conflict', 'error'); reject(response);} - app.flash(`Corpus "${corpus?.title}" marked for building`, 'corpus'); - resolve(response); - }, - (response) => { - app.flash('Something went wrong', 'error'); - reject(response); - } - ); - }); - } - - static deleteCorpusRequest(userId, corpusId) { - return new Promise((resolve, reject) => { - let corpus; - try { - corpus = app.data.users[userId].corpora[corpusId]; - } catch (error) { - corpus = {}; - } - - let modalElement = Utils.HTMLToElement( - ` -
                  -
                  -

                  Confirm Corpus deletion

                  -

                  Do you really want to delete the Corpus ${corpus?.title}? All files will be permanently deleted!

                  -
                  -
                  - Cancel - Delete -
                  -
                  - ` - ); - document.querySelector('#modals').appendChild(modalElement); - let modal = M.Modal.init( - modalElement, - { - dismissible: false, - onCloseEnd: () => { - modal.destroy(); - modalElement.remove(); - } - } - ); - - let confirmElement = modalElement.querySelector('.action-button[data-action="confirm"]'); - confirmElement.addEventListener('click', (event) => { - let corpusTitle = corpus?.title; - fetch(`/corpora/${corpusId}`, {method: 'DELETE', headers: {Accept: 'application/json'}}) - .then( - (response) => { - if (response.status === 403) {app.flash('Forbidden', 'error'); reject(response);} - if (response.status === 404) {app.flash('Not Found', 'error'); reject(response);} - app.flash(`Corpus "${corpusTitle}" marked for deletion`, 'corpus'); - resolve(response); - }, - (response) => { - app.flash('Something went wrong', 'error'); - reject(response); - } - ); - }); - modal.open(); - }); - } - - static deleteCorpusFileRequest(userId, corpusId, corpusFileId) { - return new Promise((resolve, reject) => { - let corpusFile; - try { - corpusFile = app.data.users[userId].corpora[corpusId].files[corpusFileId]; - } catch (error) { - corpusFile = {}; - } - - let modalElement = Utils.HTMLToElement( - ` -
                  -
                  -

                  Confirm Corpus File deletion

                  -

                  Do you really want to delete the Corpus File ${corpusFile?.title}? All files will be permanently deleted!

                  -
                  -
                  - Cancel - Delete -
                  -
                  - ` - ); - document.querySelector('#modals').appendChild(modalElement); - let modal = M.Modal.init( - modalElement, - { - dismissible: false, - onCloseEnd: () => { - modal.destroy(); - modalElement.remove(); - } - } - ); - - let confirmElement = modalElement.querySelector('.action-button[data-action="confirm"]'); - confirmElement.addEventListener('click', (event) => { - let corpusFileTitle = corpusFile?.title; - fetch(`/corpora/${corpusId}/files/${corpusFileId}`, {method: 'DELETE', headers: {Accept: 'application/json'}}) - .then( - (response) => { - if (response.status === 403) {app.flash('Forbidden', 'error'); reject(response);} - if (response.status === 404) {app.flash('Not Found', 'error'); reject(response);} - app.flash(`Corpus File "${corpusFileTitle}" deleted`, 'corpus'); - resolve(response); - }, - (response) => { - app.flash('Something went wrong', 'error'); - reject(response); - } - ); - }); - modal.open(); - }); - } - - static deleteSpaCyNLPPipelineModelRequest(userId, spaCyNLPPipelineModelId) { - return new Promise((resolve, reject) => { - let spaCyNLPPipelineModel; - try { - spaCyNLPPipelineModel = app.data.users[userId].spacy_nlp_pipeline_models[spaCyNLPPipelineModelId]; - } catch (error) { - spaCyNLPPipelineModel = {}; - } - - let modalElement = Utils.HTMLToElement( - ` -
                  -
                  -

                  Confirm SpaCy NLP Pipeline Model deletion

                  -

                  Do you really want to delete the SpaCy NLP Pipeline Model ${spaCyNLPPipelineModel?.title}? All files will be permanently deleted!

                  -
                  -
                  - Cancel - Delete -
                  -
                  - ` - ); - document.querySelector('#modals').appendChild(modalElement); - let modal = M.Modal.init( - modalElement, - { - dismissible: false, - onCloseEnd: () => { - modal.destroy(); - modalElement.remove(); - } - } - ); - let confirmElement = modalElement.querySelector('.action-button[data-action="confirm"]'); - confirmElement.addEventListener('click', (event) => { - let spaCyNLPPipelineModelTitle = spaCyNLPPipelineModel?.title; - fetch(`/contributions/spacy-nlp-pipeline-models/${spaCyNLPPipelineModelId}`, {method: 'DELETE'}) - .then( - (response) => { - if (response.status === 403) {app.flash('Forbidden', 'error'); reject(response);} - if (response.status === 404) {app.flash('Not Found', 'error'); reject(response);} - app.flash(`SpaCy NLP Pipeline Model "${spaCyNLPPipelineModelTitle}" marked for deletion`); - resolve(response); - }, - (response) => { - app.flash('Something went wrong', 'error'); - reject(response); - } - ); - }); - modal.open(); - }); - } - - static deleteTesseractOCRPipelineModelRequest(userId, tesseractOCRPipelineModelId) { - return new Promise((resolve, reject) => { - let tesseractOCRPipelineModel; - try { - tesseractOCRPipelineModel = app.data.users[userId].tesseract_ocr_pipeline_models[tesseractOCRPipelineModelId]; - } catch (error) { - tesseractOCRPipelineModel = {}; - } - - let modalElement = Utils.HTMLToElement( - ` -
                  -
                  -

                  Confirm Tesseract OCR Pipeline Model deletion

                  -

                  Do you really want to delete the Tesseract OCR Pipeline Model ${tesseractOCRPipelineModel?.title}? All files will be permanently deleted!

                  -
                  -
                  - Cancel - Delete -
                  -
                  - ` - ); - document.querySelector('#modals').appendChild(modalElement); - let modal = M.Modal.init( - modalElement, - { - dismissible: false, - onCloseEnd: () => { - modal.destroy(); - modalElement.remove(); - } - } - ); - let confirmElement = modalElement.querySelector('.action-button[data-action="confirm"]'); - confirmElement.addEventListener('click', (event) => { - let tesseractOCRPipelineModelTitle = tesseractOCRPipelineModel?.title; - fetch(`/contributions/tesseract-ocr-pipeline-models/${tesseractOCRPipelineModelId}`, {method: 'DELETE'}) - .then( - (response) => { - if (response.status === 403) {app.flash('Forbidden', 'error'); reject(response);} - if (response.status === 404) {app.flash('Not Found', 'error'); reject(response);} - app.flash(`Tesseract OCR Pipeline Model "${tesseractOCRPipelineModelTitle}" marked for deletion`); - resolve(response); - }, - (response) => { - app.flash('Something went wrong', 'error'); - reject(response); - } - ); - }); - modal.open(); - }); - } - - static deleteProfileAvatarRequest(userId) { - return new Promise((resolve, reject) => { - let modalElement = Utils.HTMLToElement( - ` -
                  -
                  -

                  Confirm Avatar deletion

                  -

                  Do you really want to delete your Avatar?

                  -
                  -
                  - Cancel - Delete -
                  -
                  - ` - ); - document.querySelector('#modals').appendChild(modalElement); - let modal = M.Modal.init( - modalElement, - { - dismissible: false, - onCloseEnd: () => { - modal.destroy(); - modalElement.remove(); - } - } - ); - - let confirmElement = modalElement.querySelector('.action-button[data-action="confirm"]'); - confirmElement.addEventListener('click', (event) => { - fetch(`/users/${userId}/avatar`, {method: 'DELETE', headers: {Accept: 'application/json'}}) - .then( - (response) => { - if (response.status === 403) {app.flash('Forbidden', 'error'); reject(response);} - if (response.status === 404) {app.flash('Not Found', 'error'); reject(response);} - app.flash(`Avatar marked for deletion`); - resolve(response); - }, - (response) => { - app.flash('Something went wrong', 'error'); - reject(response); - } - ); - }); - modal.open(); - }); - } - - static deleteJobRequest(userId, jobId) { - return new Promise((resolve, reject) => { - let job; - try { - job = app.data.users[userId].jobs[jobId]; - } catch (error) { - job = {}; - } - - let modalElement = Utils.HTMLToElement( - ` -
                  -
                  -

                  Confirm Job deletion

                  -

                  Do you really want to delete the Job ${job?.title}? All files will be permanently deleted!

                  -
                  -
                  - Cancel - Delete -
                  -
                  - ` - ); - document.querySelector('#modals').appendChild(modalElement); - let modal = M.Modal.init( - modalElement, - { - dismissible: false, - onCloseEnd: () => { - modal.destroy(); - modalElement.remove(); - } - } - ); - - let confirmElement = modalElement.querySelector('.action-button[data-action="confirm"]'); - confirmElement.addEventListener('click', (event) => { - let jobTitle = job?.title; - fetch(`/jobs/${jobId}`, {method: 'DELETE', headers: {Accept: 'application/json'}}) - .then( - (response) => { - if (response.status === 403) {app.flash('Forbidden', 'error'); reject(response);} - if (response.status === 404) {app.flash('Not Found', 'error'); reject(response);} - app.flash(`Job "${jobTitle}" marked for deletion`, 'job'); - resolve(response); - }, - (response) => { - app.flash('Something went wrong', 'error'); - reject(response); - } - ); - }); - modal.open(); - }); - } - - static getJobLogRequest(userId, jobId) { - return new Promise((resolve, reject) => { - fetch(`/jobs/${jobId}/log`, {method: 'GET', headers: {Accept: 'application/json, text/plain'}}) - .then( - (response) => { - if (response.status === 403) {app.flash('Forbidden', 'error'); reject(response);} - if (response.status === 404) {app.flash('Not Found', 'error'); reject(response);} - return response.text(); - }, - (response) => { - app.flash('Something went wrong', 'error'); - reject(response); - } - ) - .then( - (text) => { - let modalElement = Utils.HTMLToElement( - ` -
                  -
                  -

                  Job logs

                  - 
                  ${text}
                  -
                  -
                  - Close -
                  -
                  - ` - ); - document.querySelector('#modals').appendChild(modalElement); - let modal = M.Modal.init( - modalElement, - { - onCloseEnd: () => { - modal.destroy(); - modalElement.remove(); - } - } - ); - modal.open(); - resolve(text); - } - ); - }); - } - - static restartJobRequest(userId, jobId) { - return new Promise((resolve, reject) => { - let job; - try { - job = app.data.users[userId].jobs[jobId]; - } catch (error) { - job = {}; - } - - let modalElement = Utils.HTMLToElement( - ` -
                  -
                  -

                  Confirm Job restart

                  -

                  Do you really want to restart the Job ${job?.title}? All Job Results will be permanently deleted.

                  -
                  -
                  - Cancel - Restart -
                  -
                  - ` - ); - document.querySelector('#modals').appendChild(modalElement); - let modal = M.Modal.init( - modalElement, - { - dismissible: false, - onCloseEnd: () => { - modal.destroy(); - modalElement.remove(); - } - } - ); - - let confirmElement = modalElement.querySelector('.action-button[data-action="confirm"]'); - confirmElement.addEventListener('click', (event) => { - let jobTitle = job?.title; - fetch(`/jobs/${jobId}/restart`, {method: 'POST', headers: {Accept: 'application/json'}}) - .then( - (response) => { - if (response.status === 403) {app.flash('Forbidden', 'error'); reject(response);} - if (response.status === 404) {app.flash('Not Found', 'error'); reject(response);} - if (response.status === 409) {app.flash('Conflict', 'error'); reject(response);} - app.flash(`Job "${jobTitle}" restarted.`, 'job'); - resolve(response); - }, - (response) => { - app.flash('Something went wrong', 'error'); - reject(response); - } - ); - }); - modal.open(); - }); - } - - static deleteUserRequest(userId) { - return new Promise((resolve, reject) => { - let user; - try { - user = app.data.users[userId]; - } catch (error) { - user = {}; - } - - let modalElement = Utils.HTMLToElement( - ` -
                  -
                  -

                  Confirm User deletion

                  -

                  Do you really want to delete the User ${user?.username}? All files will be permanently deleted!

                  -
                  -
                  - Cancel - Delete -
                  -
                  - ` - ); - document.querySelector('#modals').appendChild(modalElement); - let modal = M.Modal.init( - modalElement, - { - dismissible: false, - onCloseEnd: () => { - modal.destroy(); - modalElement.remove(); - } - } - ); - - let confirmElement = modalElement.querySelector('.action-button[data-action="confirm"]'); - confirmElement.addEventListener('click', (event) => { - let userName = user?.username; - fetch(`/users/${userId}`, {method: 'DELETE', headers: {Accept: 'application/json'}}) - .then( - (response) => { - if (response.status === 403) {app.flash('Forbidden', 'error'); reject(response);} - if (response.status === 404) {app.flash('Not Found', 'error'); reject(response);} - app.flash(`User "${userName}" marked for deletion`); - resolve(response); - }, - (response) => { - app.flash('Something went wrong', 'error'); - reject(response); - } - ); - }); - modal.open(); - }); - } - - static tesseractOCRPipelineModelToggleIsPublicRequest(userId, tesseractOCRPipelineModelId, is_public) { - return new Promise((resolve, reject) => { - let tesseractOCRPipelineModel; - try { - tesseractOCRPipelineModel = app.data.users[userId].tesseract_ocr_pipeline_models[tesseractOCRPipelineModelId]; - } catch (error) { - tesseractOCRPipelineModel = {}; - } - - fetch(`/contributions/tesseract-ocr-pipeline-models/${tesseractOCRPipelineModelId}/toggle-public-status`, {method: 'POST', headers: {Accept: 'application/json'}}) - .then( - (response) => { - if (response.status === 403) { - app.flash('Forbidden', 'error'); - reject(response); - } - resolve(response); - }, - (response) => { - app.flash('Something went wrong', 'error'); - reject(response); - } - ); - }); - } - - static spaCyNLPPipelineModelToggleIsPublicRequest(userId, spaCyNLPPipelineModelId) { - return new Promise((resolve, reject) => { - let spaCyNLPPipelineModel; - try { - spaCyNLPPipelineModel = app.data.users[userId].spacy_nlp_pipeline_models[spaCyNLPPipelineModelId]; - } catch (error) { - spaCyNLPPipelineModel = {}; - } - - fetch(`/contributions/spacy-nlp-pipeline-models/${spaCyNLPPipelineModelId}/toggle-public-status`, {method: 'POST', headers: {Accept: 'application/json'}}) - .then( - (response) => { - if (response.status === 403) { - app.flash('Forbidden', 'error'); - reject(response); - } - resolve(response); - }, - (response) => { - app.flash('Something went wrong', 'error'); - reject(response); - } - ); - }); - } } diff --git a/app/templates/_navbar.html.j2 b/app/templates/_navbar.html.j2 index d943c0e4..61adaee5 100644 --- a/app/templates/_navbar.html.j2 +++ b/app/templates/_navbar.html.j2 @@ -8,29 +8,32 @@ -
                    +
                      -
                    • home
                      • - {% if breadcrumbs is defined %} - {{ breadcrumbs }} + {%- for breadcrumb in breadcrumbs -%} +
                    • {{ breadcrumb.text }}
                      • + {% if not loop.last %} +
                    • navigate_next
                      • {% endif %} + {%- endfor -%}
                    - {% if current_user.is_authenticated %} + {# {% if current_user.is_authenticated %} explore - {% endif %} + {% endif %} #} + help
                      -
                    • helpManual
                      • + {#
                    • helpManual
                      • #} {% if current_user.is_authenticated %} -
                    • settingsGeneral settings
                      • -
                    • contact_pageProfile settings
                      • +
                    • settingsSettings
                    • Log out
                      • {% else %} diff --git a/app/templates/_roadmap.html.j2 b/app/templates/_roadmap.html.j2 index 50cc18cd..eaf428ac 100644 --- a/app/templates/_roadmap.html.j2 +++ b/app/templates/_roadmap.html.j2 @@ -21,7 +21,7 @@
                    • navigate_next
                      • {% if corpus %} {% if corpus.files.all() %} -
                    • Corpus analysis
                      • +
                    • Corpus analysis
                      • {% else %}
                    • Corpus analysis
                      • {% endif %} diff --git a/app/templates/_scripts.html.j2 b/app/templates/_scripts.html.j2 index 53a0469c..88167db7 100644 --- a/app/templates/_scripts.html.j2 +++ b/app/templates/_scripts.html.j2 @@ -6,21 +6,39 @@ output='gen/app.%(version)s.js', 'js/App.js', 'js/Utils.js', - 'js/Forms/Form.js', - 'js/Forms/CreateCorpusFileForm.js', - 'js/Forms/CreateJobForm.js', - 'js/Forms/CreateContributionForm.js', 'js/CorpusAnalysis/CQiClient.js', 'js/CorpusAnalysis/CorpusAnalysisApp.js', 'js/CorpusAnalysis/CorpusAnalysisConcordance.js', 'js/CorpusAnalysis/CorpusAnalysisReader.js', 'js/CorpusAnalysis/QueryBuilder.js', - 'js/RessourceDisplays/RessourceDisplay.js', - 'js/RessourceDisplays/CorpusDisplay.js', - 'js/RessourceDisplays/JobDisplay.js', + 'js/XMLtoObject.js' +%} + +{%- endassets %} +{%- assets + filters='rjsmin', + output='gen/Forms.%(version)s.js', + 'js/Forms/Form.js', + 'js/Forms/CreateCorpusFileForm.js', + 'js/Forms/CreateJobForm.js', + 'js/Forms/CreateContributionForm.js' +%} + +{%- endassets %} +{%- assets + filters='rjsmin', + output='gen/ResourceDisplays.%(version)s.js', + 'js/ResourceDisplays/ResourceDisplay.js', + 'js/ResourceDisplays/CorpusDisplay.js', + 'js/ResourceDisplays/JobDisplay.js' +%} + +{%- endassets %} +{%- assets + filters='rjsmin', + output='gen/ResourceLists.%(version)s.js', 'js/ResourceLists/ResourceList.js', 'js/ResourceLists/CorpusFileList.js', - 'js/ResourceLists/PublicCorpusFileList.js', 'js/ResourceLists/CorpusList.js', 'js/ResourceLists/PublicCorpusList.js', 'js/ResourceLists/JobList.js', @@ -30,7 +48,25 @@ 'js/ResourceLists/TesseractOCRPipelineModelList.js', 'js/ResourceLists/UserList.js', 'js/ResourceLists/AdminUserList.js', - 'js/XMLtoObject.js' + 'js/ResourceLists/CorpusFollowerList.js', + 'js/ResourceLists/DetailledPublicCorpusList.js' +%} + +{%- endassets %} +{%- assets + filters='rjsmin', + output='gen/Requests.%(version)s.js', + 'js/Requests/Requests.js', + 'js/Requests/admin/admin.js', + 'js/Requests/contributions/contributions.js', + 'js/Requests/contributions/spacy_nlp_pipeline_models.js', + 'js/Requests/contributions/tesseract_ocr_pipeline_models.js', + 'js/Requests/corpora/corpora.js', + 'js/Requests/corpora/files.js', + 'js/Requests/corpora/followers.js', + 'js/Requests/jobs/jobs.js', + 'js/Requests/users/users.js', + 'js/Requests/users/settings.js' %} {%- endassets %} @@ -50,7 +86,13 @@ for (let optionElement of document.querySelectorAll('option[value=""]')) { optionElement.disabled = true; } - + for (let optgroupElement of document.querySelectorAll('optgroup[label=""]')) { + for (let c of optgroupElement.children) { + optgroupElement.parentElement.insertAdjacentElement('afterbegin', c); + } + optgroupElement.remove(); + + } // Set the data-length attribute on textareas/inputs with the maxlength attribute for (let inputElement of document.querySelectorAll('textarea[maxlength], input[maxlength]')) { inputElement.dataset.length = inputElement.getAttribute('maxlength'); @@ -70,4 +112,35 @@ for (let [category, message] of {{ get_flashed_messages(with_categories=True)|tojson }}) { app.flash(message, message); } + + // Initialize manual modal + let manualModalTableOfContentsElement = document.querySelector('#manual-modal-table-of-contents'); + let manualModalTableOfContents = M.Tabs.init(manualModalTableOfContentsElement); + let manualModalElement = document.querySelector('#manual-modal'); + let manualModal = M.Modal.init( + manualModalElement, + { + onOpenStart: (manualModalElement, modalTriggerElement) => { + if ('manualModalChapter' in modalTriggerElement.dataset) { + manualModalTableOfContents.select(modalTriggerElement.dataset.manualModalChapter); + } + } + } + ); + + // Initialize terms of use modal + const termsOfUseModal = document.getElementById('terms-of-use-modal'); + M.Modal.init( + termsOfUseModal, + { + dismissible: false, + onCloseEnd: () => { + Requests.users.entity.acceptTermsOfUse(); + } + } + ); + {% if current_user.is_authenticated and not current_user.terms_of_use_accepted %} + termsOfUseModal.M_Modal.open(); + {% endif %} + diff --git a/app/templates/_sidenav.html.j2 b/app/templates/_sidenav.html.j2 index 676b7069..f9549d43 100644 --- a/app/templates/_sidenav.html.j2 +++ b/app/templates/_sidenav.html.j2 @@ -1,48 +1,92 @@ diff --git a/app/templates/_terms_of_use_modal.html.j2 b/app/templates/_terms_of_use_modal.html.j2 new file mode 100644 index 00000000..ddd8985b --- /dev/null +++ b/app/templates/_terms_of_use_modal.html.j2 @@ -0,0 +1,115 @@ + diff --git a/app/templates/admin/_breadcrumbs.html.j2 b/app/templates/admin/_breadcrumbs.html.j2 deleted file mode 100644 index c4a64046..00000000 --- a/app/templates/admin/_breadcrumbs.html.j2 +++ /dev/null @@ -1,18 +0,0 @@ -{% set breadcrumbs %} -
                    • navigate_next
                      • -
                    • Administration
                      • -
                    • navigate_next
                      • -{% if request.path == url_for('.users') %} -
                    • Users
                      • -{% elif request.path == url_for('.user', user_id=user.id) %} -
                    • Users
                      • -
                    • navigate_next
                      • -
                    • {{ user.username }}
                      • -{% elif request.path == url_for('.edit_user', user_id=user.id) %} -
                    • Users
                      • -
                    • navigate_next
                      • -
                    • {{ user.username }}
                      • -
                    • navigate_next
                      • -
                    • Edit
                      • -{% endif %} -{% endset %} diff --git a/app/templates/admin/admin.html.j2 b/app/templates/admin/admin.html.j2 new file mode 100644 index 00000000..f944bbe9 --- /dev/null +++ b/app/templates/admin/admin.html.j2 @@ -0,0 +1,43 @@ +{% extends "base.html.j2" %} + +{% block page_content %} +
                      +
                      +
                      +

                      {{ title }}

                      +
                      + +
                      +
                      + +
                      + groupUsers +

                      Edit the individual user accounts. You have the following options:

                      +
                        +
                      • - View, edit and delete user accounts
                        • +
                      • - View, edit and delete user corpora
                        • +
                      • - View, edit and delete user jobs
                        • +
                      • - View, edit and delete user added Tesseract models
                        • +
                      • - View, edit and delete user added SpaCy models
                        • +
                      +
                      +
                      +
                      + +
                      +
                      + +
                      + ICorpora +

                      Edit all Corpora. You have the following options:

                      +
                        +
                      • - View, edit and delete corpora
                        • +
                      • - View, edit and delete corpus jobs
                        • +
                      • - Edit corpus follower roles and the public status of the corpus
                        • +
                      +
                      +
                      +
                      +
                      +
                      +{% endblock page_content %} diff --git a/app/templates/admin/corpora.html.j2 b/app/templates/admin/corpora.html.j2 new file mode 100644 index 00000000..90a4b28e --- /dev/null +++ b/app/templates/admin/corpora.html.j2 @@ -0,0 +1,29 @@ +{% extends "base.html.j2" %} + +{% block page_content %} +
                      +

                      {{ title }}

                      + +
                      +
                      +
                      +
                      +
                      +
                      + +{% endblock page_content %} + +{% block scripts %} +{{ super() }} + +{% endblock scripts %} diff --git a/app/templates/admin/edit_user.html.j2 b/app/templates/admin/edit_user.html.j2 index c963b7f7..0ac4f27d 100644 --- a/app/templates/admin/edit_user.html.j2 +++ b/app/templates/admin/edit_user.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "admin/_breadcrumbs.html.j2" import breadcrumbs with context %} {% import "materialize/wtf.html.j2" as wtf %} {% block page_content %} diff --git a/app/templates/admin/user.html.j2 b/app/templates/admin/user.html.j2 index b4b0e303..4d99ea57 100644 --- a/app/templates/admin/user.html.j2 +++ b/app/templates/admin/user.html.j2 @@ -1,44 +1,59 @@ {% extends "base.html.j2" %} -{% from "admin/_breadcrumbs.html.j2" import breadcrumbs with context %} {% block page_content %}
                      -
                      +
                      +

                       

                      + {# user-image #} +
                      +

                      {{ title }}

                      +

                      + {{ user.role.name }} + {% if user.confirmed %} + confirmed + {% else %} + unconfirmed + {% endif %} +

                      + {% if user.about_me %} +

                      {{ user.about_me }}

                      + {% endif %}
                      -
                      -

                      {{ user.username }}

                      -

                      Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren,

                      - arrow_backBack to Users +
                       
                      + +
                      +
                      -
                      +
                      - User information
                      • Username: {{ user.username }}
                      • Email: {{ user.email }}
                      • Id: {{ user.id }}
                      • Hashid: {{ user.hashid }}
                        • -
                      • Member since: {{ user.member_since }}
                        • -
                      • Confirmed status: {{ user.confirmed }}
                        • -
                      • Last seen: {{ user.last_seen }}
                        • -
                      • Permissions as Int: {{ user.role.permissions }}
                        • -
                      • Role name: {{ user.role.name }}
                        • +
                      • Member since: {{ user.member_since.strftime('%Y-%m-%d') }}
                        • +
                      • Last seen: {% if user.last_seen %}{{ user.last_seen.strftime('%Y-%m-%d') }}
                        • {% endif %}
                      - editEdit - deleteDelete + editEdit + deleteDelete
                      -
                      -

                      Corpora

                      +
                      @@ -46,14 +61,29 @@
                      -
                      -

                      Jobs

                      +
                      + +
                      +
                      +
                      +
                      +
                      +
                      +
                      + +
                      +
                      +
                      +
                      +
                      +
                      +
                      {% endblock page_content %} @@ -67,8 +97,35 @@

                      Do you really want to delete the user {{ user.username }}? All associated data will be permanently deleted!

                      - Cancel - deleteDelete + Cancel + deleteDelete
                      {% endblock modals %} + + +{% block scripts %} +{{ super() }} + +{% endblock scripts %} diff --git a/app/templates/admin/user_settings.html.j2 b/app/templates/admin/user_settings.html.j2 new file mode 100644 index 00000000..fb022564 --- /dev/null +++ b/app/templates/admin/user_settings.html.j2 @@ -0,0 +1,66 @@ +{% extends "users/settings/settings.html.j2" %} + +{% block admin_settings %} +
                      + +
                      +

                      Administrator Settings

                      +

                      Here the Confirmation Status of the user can be set manually and a special role can be assigned.

                      +
                      +
                      +
                      +
                        +
                      • +
                        + Confirmation status + keyboard_arrow_right +
                        +
                        +
                        +

                        check

                        +

                        + Confirmed
                        + Change confirmation status manually. +

                        +
                        +
                        + +
                        +
                        +
                        +
                        • +
                      • +
                        + Role + keyboard_arrow_right +
                        +
                        +
                        + {{ update_user_form.hidden_tag() }} + {{ wtf.render_field(update_user_form.role, material_icon='manage_accounts') }} +
                        + {{ wtf.render_field(update_user_form.submit, material_icon='send') }} +
                        +
                        +
                        +
                        • +
                      +
                      +{% endblock admin_settings %} + +{% block scripts %} +{{ super() }} + +{% endblock scripts %} diff --git a/app/templates/admin/users.html.j2 b/app/templates/admin/users.html.j2 index c96024cf..2ccd8ee9 100644 --- a/app/templates/admin/users.html.j2 +++ b/app/templates/admin/users.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "admin/_breadcrumbs.html.j2" import breadcrumbs with context %} {% block page_content %}
                      @@ -24,6 +23,12 @@ {% endblock scripts %} diff --git a/app/templates/auth/_breadcrumbs.html.j2 b/app/templates/auth/_breadcrumbs.html.j2 deleted file mode 100644 index 2f46d9dc..00000000 --- a/app/templates/auth/_breadcrumbs.html.j2 +++ /dev/null @@ -1,14 +0,0 @@ -{% set breadcrumbs %} -
                    • navigate_next
                      • -{% if request.path == url_for('.login') %} -
                    • {{ title }}
                      • -{% elif request.path == url_for('.register') %} -
                    • {{ title }}
                      • -{% elif request.path == url_for('.reset_password', token=token) %} -
                    • {{ title }}
                      • -{% elif request.path == url_for('.reset_password_request') %} -
                    • {{ title }}
                      • -{% elif request.path == url_for('.unconfirmed') %} -
                    • {{ title }}
                      • -{% endif %} -{% endset %} diff --git a/app/templates/auth/login.html.j2 b/app/templates/auth/login.html.j2 index 213c0a5f..7aa402f6 100644 --- a/app/templates/auth/login.html.j2 +++ b/app/templates/auth/login.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "auth/_breadcrumbs.html.j2" import breadcrumbs with context %} {% import "materialize/wtf.html.j2" as wtf %} diff --git a/app/templates/auth/register.html.j2 b/app/templates/auth/register.html.j2 index 69a01912..adfbc0af 100644 --- a/app/templates/auth/register.html.j2 +++ b/app/templates/auth/register.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "auth/_breadcrumbs.html.j2" import breadcrumbs with context %} {% import "materialize/wtf.html.j2" as wtf %} @@ -24,6 +23,10 @@ {{ wtf.render_field(form.password, material_icon='vpn_key') }} {{ wtf.render_field(form.password_2, material_icon='vpn_key') }} {{ wtf.render_field(form.email, class_='validate', material_icon='email', type='email') }} +
                      + {{ wtf.render_field(form.terms_of_use_accepted, type='checkbox')}} +

                      +
                      {{ wtf.render_field(form.submit, class_='width-100', material_icon='send') }}
                      diff --git a/app/templates/auth/reset_password.html.j2 b/app/templates/auth/reset_password.html.j2 index 06f11059..7df460bb 100644 --- a/app/templates/auth/reset_password.html.j2 +++ b/app/templates/auth/reset_password.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "auth/_breadcrumbs.html.j2" import breadcrumbs with context %} {% import "materialize/wtf.html.j2" as wtf %} {% block page_content %} diff --git a/app/templates/auth/reset_password_request.html.j2 b/app/templates/auth/reset_password_request.html.j2 index a94d18da..5bf28111 100644 --- a/app/templates/auth/reset_password_request.html.j2 +++ b/app/templates/auth/reset_password_request.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "auth/_breadcrumbs.html.j2" import breadcrumbs with context %} {% import "materialize/wtf.html.j2" as wtf %} {% block page_content %} diff --git a/app/templates/auth/unconfirmed.html.j2 b/app/templates/auth/unconfirmed.html.j2 index 26384ecc..f927fcff 100644 --- a/app/templates/auth/unconfirmed.html.j2 +++ b/app/templates/auth/unconfirmed.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "auth/_breadcrumbs.html.j2" import breadcrumbs with context %} {% block page_content %}
                      diff --git a/app/templates/base.html.j2 b/app/templates/base.html.j2 index dbecd35e..9dd20f08 100644 --- a/app/templates/base.html.j2 +++ b/app/templates/base.html.j2 @@ -34,8 +34,12 @@ {% block page_content %}{% endblock page_content %}
                      {% block modals %} - {% if current_user.is_authenticated %} + {% include "main/_manual_modal.html.j2" %} + {# {% if current_user.is_authenticated %} {% include "_roadmap.html.j2" %} + {% endif %} #} + {% if current_user.is_authenticated and not current_user.terms_of_use_accepted %} + {% include "_terms_of_use_modal.html.j2" %} {% endif %} {% endblock modals %}
                      diff --git a/app/templates/contributions/_breadcrumbs.html.j2 b/app/templates/contributions/_breadcrumbs.html.j2 deleted file mode 100644 index ab64dec4..00000000 --- a/app/templates/contributions/_breadcrumbs.html.j2 +++ /dev/null @@ -1,46 +0,0 @@ -{% set breadcrumbs %} -
                    • navigate_next
                      • -{% if request.path == url_for('.contributions') %} -
                    • Contributions Overview
                      • -{% elif request.path == url_for('.tesseract_ocr_pipeline_models')%} -
                    • Contributions Overview
                      • -
                    • navigate_next
                      • -
                    • Tesseract OCR Pipeline Models
                      • -{% elif request.path == url_for('.spacy_nlp_pipeline_models')%} -
                    • Contributions Overview
                      • -
                    • navigate_next
                      • -
                    • SpaCy NLP Pipeline Models
                      • -{% elif request.path == url_for('.create_tesseract_ocr_pipeline_model') %} -
                    • Contributions Overview
                      • -
                    • navigate_next
                      • -
                    • Tesseract OCR Pipeline Models
                      • -
                    • navigate_next
                      • -
                    • {{ title }}
                      • -{% elif request.path == url_for('.create_spacy_nlp_pipeline_model') %} -
                    • Contributions Overview
                      • -
                    • navigate_next
                      • -
                    • SpaCy NLP Pipeline Models
                      • -
                    • navigate_next
                      • -
                    • {{ title }}
                      • -{% elif tesseract_ocr_pipeline_model and request.path == url_for('.tesseract_ocr_pipeline_model', tesseract_ocr_pipeline_model_id=tesseract_ocr_pipeline_model.id) %} -
                    • Contributions Overview
                      • -
                    • navigate_next
                      • -
                    • Tesseract OCR Pipeline Models
                      • -
                    • navigate_next
                      • -
                    • - - {{ tesseract_ocr_pipeline_model.title }} {{ tesseract_ocr_pipeline_model.version }} - -
                      • -{% elif spacy_nlp_pipeline_model and request.path == url_for('.spacy_nlp_pipeline_model', spacy_nlp_pipeline_model_id=spacy_nlp_pipeline_model.id) %} -
                    • Contributions Overview
                      • -
                    • navigate_next
                      • -
                    • SpaCy NLP Pipeline Models
                      • -
                    • navigate_next
                      • -
                    • - - {{ spacy_nlp_pipeline_model.title }} {{ spacy_nlp_pipeline_model.version }} - -
                      • -{% endif %} -{% endset %} diff --git a/app/templates/contributions/contributions.html.j2 b/app/templates/contributions/contributions.html.j2 deleted file mode 100644 index bdbcb10c..00000000 --- a/app/templates/contributions/contributions.html.j2 +++ /dev/null @@ -1,45 +0,0 @@ -{% extends "base.html.j2" %} -{% import "materialize/wtf.html.j2" as wtf %} -{% from "contributions/_breadcrumbs.html.j2" import breadcrumbs with context %} - -{% block page_content %} -
                      -
                      -
                      -

                      {{ title }}

                      -
                      - -
                      -
                      - -
                      - Tesseract OCR Pipeline Models -

                      Here you can see and edit the models that you have created. You can also create new models.

                      -
                      -
                      -
                      - -
                      -
                      - -
                      - SpaCy NLP Pipeline Models -

                      Here you can see and edit the models that you have created. You can also create new models.

                      -
                      -
                      -
                      - - -
                      -
                      -{% endblock page_content %} diff --git a/app/templates/contributions/create_spacy_nlp_pipeline_model.html.j2 b/app/templates/contributions/spacy_nlp_pipeline_models/create.html.j2 similarity index 97% rename from app/templates/contributions/create_spacy_nlp_pipeline_model.html.j2 rename to app/templates/contributions/spacy_nlp_pipeline_models/create.html.j2 index e17ac9e5..091c61ad 100644 --- a/app/templates/contributions/create_spacy_nlp_pipeline_model.html.j2 +++ b/app/templates/contributions/spacy_nlp_pipeline_models/create.html.j2 @@ -1,6 +1,5 @@ {% extends "base.html.j2" %} {% import "materialize/wtf.html.j2" as wtf %} -{% from "contributions/_breadcrumbs.html.j2" import breadcrumbs with context %} {% block main_attribs %} class="service-scheme" data-service="spacy-nlp-pipeline"{% endblock main_attribs %} diff --git a/app/templates/contributions/spacy_nlp_pipeline_model.html.j2 b/app/templates/contributions/spacy_nlp_pipeline_models/spacy_nlp_pipeline_model.html.j2 similarity index 96% rename from app/templates/contributions/spacy_nlp_pipeline_model.html.j2 rename to app/templates/contributions/spacy_nlp_pipeline_models/spacy_nlp_pipeline_model.html.j2 index 32f27303..467effc9 100644 --- a/app/templates/contributions/spacy_nlp_pipeline_model.html.j2 +++ b/app/templates/contributions/spacy_nlp_pipeline_models/spacy_nlp_pipeline_model.html.j2 @@ -1,6 +1,5 @@ {% extends "base.html.j2" %} {% import "materialize/wtf.html.j2" as wtf %} -{% from "contributions/_breadcrumbs.html.j2" import breadcrumbs with context %} {% block main_attribs %} class="service-scheme" data-service="spacy-nlp-pipeline"{% endblock main_attribs %} diff --git a/app/templates/contributions/spacy_nlp_pipeline_models.html.j2 b/app/templates/contributions/spacy_nlp_pipeline_models/spacy_nlp_pipeline_models.html.j2 similarity index 91% rename from app/templates/contributions/spacy_nlp_pipeline_models.html.j2 rename to app/templates/contributions/spacy_nlp_pipeline_models/spacy_nlp_pipeline_models.html.j2 index f3c7a40e..b57507be 100644 --- a/app/templates/contributions/spacy_nlp_pipeline_models.html.j2 +++ b/app/templates/contributions/spacy_nlp_pipeline_models/spacy_nlp_pipeline_models.html.j2 @@ -1,6 +1,5 @@ {% extends "base.html.j2" %} {% import "materialize/wtf.html.j2" as wtf %} -{% from "contributions/_breadcrumbs.html.j2" import breadcrumbs with context %} {% block page_content %}
                      diff --git a/app/templates/contributions/create_tesseract_ocr_pipeline_model.html.j2 b/app/templates/contributions/tesseract_ocr_pipeline_models/create.html.j2 similarity index 75% rename from app/templates/contributions/create_tesseract_ocr_pipeline_model.html.j2 rename to app/templates/contributions/tesseract_ocr_pipeline_models/create.html.j2 index ecede20a..84eda745 100644 --- a/app/templates/contributions/create_tesseract_ocr_pipeline_model.html.j2 +++ b/app/templates/contributions/tesseract_ocr_pipeline_models/create.html.j2 @@ -1,6 +1,5 @@ {% extends "base.html.j2" %} {% import "materialize/wtf.html.j2" as wtf %} -{% from "contributions/_breadcrumbs.html.j2" import breadcrumbs with context %} {% block main_attribs %} class="service-scheme" data-service="tesseract-ocr-pipeline"{% endblock main_attribs %} @@ -80,37 +79,3 @@
                      {% endblock page_content %} - -{% block modals %} -{{ super() }} - -{% endblock modals %} diff --git a/app/templates/contributions/tesseract_ocr_pipeline_model.html.j2 b/app/templates/contributions/tesseract_ocr_pipeline_models/tesseract_ocr_pipeline_model.html.j2 similarity index 95% rename from app/templates/contributions/tesseract_ocr_pipeline_model.html.j2 rename to app/templates/contributions/tesseract_ocr_pipeline_models/tesseract_ocr_pipeline_model.html.j2 index 02322d8a..c7cc2d5c 100644 --- a/app/templates/contributions/tesseract_ocr_pipeline_model.html.j2 +++ b/app/templates/contributions/tesseract_ocr_pipeline_models/tesseract_ocr_pipeline_model.html.j2 @@ -1,6 +1,5 @@ {% extends "base.html.j2" %} {% import "materialize/wtf.html.j2" as wtf %} -{% from "contributions/_breadcrumbs.html.j2" import breadcrumbs with context %} {% block main_attribs %} class="service-scheme" data-service="tesseract-ocr-pipeline"{% endblock main_attribs %} diff --git a/app/templates/contributions/tesseract_ocr_pipeline_models.html.j2 b/app/templates/contributions/tesseract_ocr_pipeline_models/tesseract_ocr_pipeline_models.html.j2 similarity index 91% rename from app/templates/contributions/tesseract_ocr_pipeline_models.html.j2 rename to app/templates/contributions/tesseract_ocr_pipeline_models/tesseract_ocr_pipeline_models.html.j2 index 3d43d727..a2f18c2a 100644 --- a/app/templates/contributions/tesseract_ocr_pipeline_models.html.j2 +++ b/app/templates/contributions/tesseract_ocr_pipeline_models/tesseract_ocr_pipeline_models.html.j2 @@ -1,6 +1,5 @@ {% extends "base.html.j2" %} {% import "materialize/wtf.html.j2" as wtf %} -{% from "contributions/_breadcrumbs.html.j2" import breadcrumbs with context %} {% block page_content %}
                      diff --git a/app/templates/corpora/analyse_corpus.concordance.html.j2 b/app/templates/corpora/_analysis/concordance.html.j2 similarity index 55% rename from app/templates/corpora/analyse_corpus.concordance.html.j2 rename to app/templates/corpora/_analysis/concordance.html.j2 index 56baf07d..5886a4b1 100644 --- a/app/templates/corpora/analyse_corpus.concordance.html.j2 +++ b/app/templates/corpora/_analysis/concordance.html.j2 @@ -1,22 +1,37 @@ -
                      +{% set name = 'Concordance' %} + +{% set description %} +Query your corpus with the CQP query language utilizing a KWIC view. +{% endset %} + +{% set id_prefix = name.lower().replace(' ', '-') + '-extension' %} + +{% set tab_content %} +list_alt{{ name }} +{% endset %} + +{% set container_content %} +
                      -
                      +
                      search - - - - help Corpus Query Language tutorial + + + + help Corpus Query Language tutorial | - info Tagsets + info Tagsets + | + info Examples
                      arrow_forward - - + +
                      @@ -68,7 +83,7 @@ build Query builder (beta) - @@ -80,16 +95,16 @@
                      -
                      +
                      -
                      +
                      -

                      -
                      +

                      +
                      @@ -102,10 +117,48 @@ - +
                      -
                        +
                          +{% endset %} + +{% set modals %} + +{% endset %} + +{% set scripts %} + +{% endset %} diff --git a/app/templates/corpora/analyse_corpus.reader.html.j2 b/app/templates/corpora/_analysis/reader.html.j2 similarity index 79% rename from app/templates/corpora/analyse_corpus.reader.html.j2 rename to app/templates/corpora/_analysis/reader.html.j2 index 99cdf56e..683435f9 100644 --- a/app/templates/corpora/analyse_corpus.reader.html.j2 +++ b/app/templates/corpora/_analysis/reader.html.j2 @@ -1,4 +1,17 @@ -
                          +{% set name = 'Reader' %} + +{% set description %} +Inspect your corpus in detail with a full text view, including annotations. +{% endset %} + +{% set id_prefix = name.lower().replace(' ', '-') + '-extension' %} + +{% set tab_content %} +chrome_reader_mode{{ name }} +{% endset %} + +{% set container_content %} +
                          @@ -6,7 +19,7 @@
                          -
                          +
                          format_list_numbered
                          -
                          +
                          format_shapes
                          -
                          +
                          format_quote @@ -497,7 +311,7 @@
                          -
                          Options to edit your token: help_outline
                          +
                          Options to edit your token: help_outline

                          @@ -567,48 +381,19 @@
                          - - - {% endblock modals %} {% block scripts %} {{ super() }} -corpusAnalysisApp.init(); +{% for extension in extensions %} +{{ extension.scripts }} +{% endfor %} + + {% endblock scripts %} diff --git a/app/templates/corpora/corpus.html.j2 b/app/templates/corpora/corpus.html.j2 index 34228347..5ced98e4 100644 --- a/app/templates/corpora/corpus.html.j2 +++ b/app/templates/corpora/corpus.html.j2 @@ -1,20 +1,18 @@ {% extends "base.html.j2" %} {% import "materialize/wtf.html.j2" as wtf %} -{% from "corpora/_breadcrumbs.html.j2" import breadcrumbs with context %} {% block main_attribs %} class="service-scheme" data-service="corpus-analysis"{% endblock main_attribs %} {% block page_content %}
                          -
                          -
                          -
                          -
                          -

                          -
                          -
                          -

                           

                          -

                           

                          +
                          +
                          +

                          {{ corpus.title }}

                          +
                          + +
                          +
                          +
                          -
                          -
                          - -
                          -
                          @@ -57,84 +50,336 @@
                          -
                          -
                          - searchAnalyze - KBuild - import_exportExport - deleteDelete +
                          +
                          + + {% if cfr.has_permission('VIEW') %} +
                          +
                          +
                          + Actions +
                          +
                          + KBuild +
                          +
                          + searchAnalyze +
                          + {#
                          + publishPublishing +
                          #} +
                          + deleteDelete +
                          + {# {% if cfr.has_permission('MANAGE_FOLLOWERS') %} + Social +
                          +
                          + person_addinvite user +
                          +
                          + linkShare link +
                          +
                          + {% endif %} #}
                          + {% endif %}
                          Corpus files -
                          +
                          + {% if cfr.has_permission('MANAGE_FILES') %}
                          addAdd corpus file
                          + {% endif %}
                          - {#
                          -
                          -
                          -
                          - - -
                          - - Generate Share Link - - Copy -
                          -
                          -
                          - + {# {% if cfr.has_permission('MANAGE_FOLLOWERS') %}
                          Corpus followers -
                          +
                          -
                          #} +
                          + {% endif %} #} +
                          {% endblock page_content %} +{% block modals %} +{{ super() }} + +{% if current_user == corpus.user or current_user.is_administrator() %} +{# #} + + +{% endif %} + +{# {% if cfr.has_permission('MANAGE_FOLLOWERS') %} + + + +{% endif %} #} + +{% endblock modals %} + {% block scripts %} {{ super() }} -{# #} {% endblock scripts %} diff --git a/app/templates/corpora/create_corpus.html.j2 b/app/templates/corpora/create.html.j2 similarity index 94% rename from app/templates/corpora/create_corpus.html.j2 rename to app/templates/corpora/create.html.j2 index ccb49877..5feb7225 100644 --- a/app/templates/corpora/create_corpus.html.j2 +++ b/app/templates/corpora/create.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "corpora/_breadcrumbs.html.j2" import breadcrumbs with context %} {% import "materialize/wtf.html.j2" as wtf %} {% block main_attribs %} class="service-scheme" data-service="corpus-analysis"{% endblock main_attribs %} diff --git a/app/templates/corpora/corpus_file.html.j2 b/app/templates/corpora/files/corpus_file.html.j2 similarity index 96% rename from app/templates/corpora/corpus_file.html.j2 rename to app/templates/corpora/files/corpus_file.html.j2 index 781ea059..28a762d4 100644 --- a/app/templates/corpora/corpus_file.html.j2 +++ b/app/templates/corpora/files/corpus_file.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "corpora/_breadcrumbs.html.j2" import breadcrumbs with context %} {% import "materialize/wtf.html.j2" as wtf %} {% block main_attribs %} class="service-scheme" data-service="corpus-analysis"{% endblock main_attribs %} diff --git a/app/templates/corpora/create_corpus_file.html.j2 b/app/templates/corpora/files/create.html.j2 similarity index 92% rename from app/templates/corpora/create_corpus_file.html.j2 rename to app/templates/corpora/files/create.html.j2 index 44e9ff82..ff634294 100644 --- a/app/templates/corpora/create_corpus_file.html.j2 +++ b/app/templates/corpora/files/create.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "corpora/_breadcrumbs.html.j2" import breadcrumbs with context %} {% import "materialize/wtf.html.j2" as wtf %} {% block main_attribs %} class="service-scheme" data-service="corpus-analysis"{% endblock main_attribs %} @@ -36,7 +35,7 @@
                          - closeCancel + closeCancel {{ wtf.render_field(form.submit, material_icon='send') }}
                          diff --git a/app/templates/corpora/import_corpus.html.j2 b/app/templates/corpora/import.html.j2 similarity index 96% rename from app/templates/corpora/import_corpus.html.j2 rename to app/templates/corpora/import.html.j2 index 957668e6..dd0806a7 100644 --- a/app/templates/corpora/import_corpus.html.j2 +++ b/app/templates/corpora/import.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "corpora/_breadcrumbs.html.j2" import breadcrumbs with context %} {% import "materialize/wtf.html.j2" as wtf %} {% block main_attribs %} class="service-scheme" data-service="corpus-analysis"{% endblock main_attribs %} diff --git a/app/templates/corpora/public_corpora.html.j2 b/app/templates/corpora/public_corpora.html.j2 deleted file mode 100644 index 9be377f3..00000000 --- a/app/templates/corpora/public_corpora.html.j2 +++ /dev/null @@ -1,72 +0,0 @@ -{% extends "base.html.j2" %} - -{% block main_attribs %} class="service-scheme" data-service="corpus-analysis"{% endblock main_attribs %} - -{% block page_content %} -
                          -
                          -
                          -
                          -
                          -
                          -

                          ICorpora

                          -
                          -
                          -
                          - search - - -
                          -
                          -
                          -
                          -
                          - - -
                          -
                          -
                          -
                          -
                          - - - - - - - - - - -
                          Title and DescriptionStatus
                          -
                            -
                            -
                            -
                            -
                            -
                            -
                            -{% endblock page_content %} - - -{% block scripts %} -{{ super() }} - -{% endblock scripts %} diff --git a/app/templates/corpora/public_corpus.html.j2 b/app/templates/corpora/public_corpus.html.j2 index 94b3524c..61efca3a 100644 --- a/app/templates/corpora/public_corpus.html.j2 +++ b/app/templates/corpora/public_corpus.html.j2 @@ -7,74 +7,402 @@
                            -

                            {{ corpus.title }}

                            -
                            -
                            - {% if current_user.is_following_corpus(corpus) %} - addUnfollow Corpus - {% endif %} - {% if corpus.status.name in ['BUILT', 'STARTING_ANALYSIS_SESSION', 'RUNNING_ANALYSIS_SESSION', 'CANCELING_ANALYSIS_SESSION'] and current_user.is_following_corpus(corpus) %} - Analyze - {% endif %} -
                            -
                            +

                            {{ corpus.title }}

                            +
                            +
                            + {% if corpus.status.name in ['SUBMITTED', 'QUEUED', 'BUILDING'] %} + refresh + {% endif %} +
                            +
                            -

                            Status:

                            -

                            -
                            +
                            + + +
                            -
                            -

                            Description: {{ corpus.description }}

                            -
                            -

                            + +
                            +
                            + + +
                            -
                            -

                            Creation date: {{ corpus.creation_date }}

                            -
                            -
                            -

                            Number of tokens used: {{ corpus.num_tokens }}

                            + +
                            +
                            + + +
                            +
                            + + {% if cfr.has_permission('VIEW') %} +
                            - Corpus files -
                            + Actions +
                            + {% if cfr.has_permission('MANAGE_FILES') %} +
                            + {% if corpus.status.name in ['UNPREPARED', 'FAILED'] %} + KBuild + {% else %} + KBuild + {% endif %} +
                            +
                            + {% if corpus.status.name in ['BUILT', 'STARTING_ANALYSIS_SESSION', 'RUNNING_ANALYSIS_SESSION', 'CANCELING_ANALYSIS_SESSION'] and current_user.is_following_corpus(corpus) %} + searchAnalyze + {% else %} + searchAnalyze + {% endif %} +
                            + {% endif %} + {% if current_user.is_following_corpus(corpus) %} +
                            + closeUnfollow Corpus +
                            + {% endif %} +
                            + {% if cfr.has_permission('MANAGE_FOLLOWERS') %} + Social +
                            +
                            + person_addinvite user +
                            +
                            + linkShare link +
                            +
                            + {% endif %}
                            + {% endif %} + +
                            +
                            +
                            + Corpus Owner +
                            +
                            + + + + + + +
                            + user-image + +
                              +
                            • {{ corpus.user.username }}
                              • + {% if corpus.user.full_name %} +
                            • {{ corpus.user.full_name }}
                              • + {% endif %} + {% if corpus.user.show_email %} +
                            • {{ corpus.user.email }} + {% endif %} +
                            +
                            +
                            +

                            + {% if not current_user.is_following_corpus(corpus) and corpus.user.has_profile_privacy_setting('SHOW_EMAIL') %} + Request Corpus + {% endif %} + View profile +
                            +
                            +
                            +
                            + +
                            +
                            +
                            + Corpus files +
                            +
                            + {% if cfr.has_permission('MANAGE_FILES') %} +
                            + addAdd corpus file +
                            + {% endif %} +
                            +
                            + + {% if cfr.has_permission('MANAGE_FOLLOWERS') %} +
                            +
                            +
                            + Corpus followers +
                            +
                            +
                            +
                            + {% endif %} +
                            {% endblock page_content %} +{% block modals %} +{{ super() }} + +{% if cfr.has_permission('MANAGE_FOLLOWERS') %} + + + +{% endif %} + +{% endblock modals %} + {% block scripts %} {{ super() }} {% endblock scripts %} diff --git a/app/templates/errors/error.html.j2 b/app/templates/errors/error.html.j2 index ef19de5f..8db723d2 100644 --- a/app/templates/errors/error.html.j2 +++ b/app/templates/errors/error.html.j2 @@ -4,7 +4,7 @@ {% block page_content %}
                            -

                            {{ error.name }}

                            +

                            {{ error.code }} {{ error.name }}

                            {{ error.description }}

                            {% endblock page_content %} diff --git a/app/templates/jobs/_breadcrumbs.html.j2 b/app/templates/jobs/_breadcrumbs.html.j2 deleted file mode 100644 index e3de43f3..00000000 --- a/app/templates/jobs/_breadcrumbs.html.j2 +++ /dev/null @@ -1,8 +0,0 @@ -{% set breadcrumbs %} -
                          • navigate_next
                            • -
                          • My jobs
                            • -{% if request.path == url_for('.job', job_id=job.id) %} -
                          • navigate_next
                            • -
                          • {{ job.title }}
                            • -{% endif %} -{% endset %} diff --git a/app/templates/jobs/job.html.j2 b/app/templates/jobs/job.html.j2 index c1222127..51f2fc6d 100644 --- a/app/templates/jobs/job.html.j2 +++ b/app/templates/jobs/job.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "jobs/_breadcrumbs.html.j2" import breadcrumbs with context %} {% block main_attribs %} class="service-scheme" data-service="{{ job.service }}"{% endblock main_attribs %} @@ -79,10 +78,10 @@
                            {% if current_user.is_administrator() %} - text_snippetLog + text_snippetLog {% endif %} - repeatRestart - deleteDelete + repeatRestart + deleteDelete
                            @@ -112,10 +111,65 @@
                            {% endblock page_content %} +{% block modals %} +{{ super() }} + + + + + +{% endblock modals %} + {% block scripts %} {{ super() }} {% endblock scripts %} diff --git a/app/templates/main/_breadcrumbs.html.j2 b/app/templates/main/_breadcrumbs.html.j2 deleted file mode 100644 index d65978d6..00000000 --- a/app/templates/main/_breadcrumbs.html.j2 +++ /dev/null @@ -1,14 +0,0 @@ -{% set breadcrumbs %} -{% if not (request.path == url_for('.index')) %} -
                          • navigate_next
                            • -{% endif %} -{% if request.path == url_for('.faq') %} -
                          • Frequently Asked Questions
                            • -{% elif request.path == url_for('.dashboard') %} -
                          • Dashboard
                            • -{% elif request.path == url_for('.news') %} -
                          • News
                            • -{% elif request.path == url_for('.terms_of_use') %} -
                          • Terms of use
                            • -{% endif %} -{% endset %} diff --git a/app/templates/main/_manual_modal.html.j2 b/app/templates/main/_manual_modal.html.j2 new file mode 100644 index 00000000..3eb5d4a1 --- /dev/null +++ b/app/templates/main/_manual_modal.html.j2 @@ -0,0 +1,50 @@ + diff --git a/app/templates/main/manual/_01_introduction.html.j2 b/app/templates/main/_manual_modal/_01_introduction.html.j2 similarity index 89% rename from app/templates/main/manual/_01_introduction.html.j2 rename to app/templates/main/_manual_modal/_01_introduction.html.j2 index 46064924..0b1d9ad7 100644 --- a/app/templates/main/manual/_01_introduction.html.j2 +++ b/app/templates/main/_manual_modal/_01_introduction.html.j2 @@ -1,4 +1,4 @@ -

                            Introduction

                            +

                            Introduction

                            nopaque is a web-based digital working environment. It implements a workflow based on the research process in the humanities and supports its diff --git a/app/templates/main/manual/_02_registration_and_log_in.html.j2 b/app/templates/main/_manual_modal/_02_registration_and_log_in.html.j2 similarity index 93% rename from app/templates/main/manual/_02_registration_and_log_in.html.j2 rename to app/templates/main/_manual_modal/_02_registration_and_log_in.html.j2 index 93d061f3..5f05c543 100644 --- a/app/templates/main/manual/_02_registration_and_log_in.html.j2 +++ b/app/templates/main/_manual_modal/_02_registration_and_log_in.html.j2 @@ -1,4 +1,4 @@ -

                            Registration and Log in

                            +

                            Registration and Log in

                            Registration and Log in diff --git a/app/templates/main/manual/_03_dashboard.html.j2 b/app/templates/main/_manual_modal/_03_dashboard.html.j2 similarity index 97% rename from app/templates/main/manual/_03_dashboard.html.j2 rename to app/templates/main/_manual_modal/_03_dashboard.html.j2 index abfd0ba4..e62fd434 100644 --- a/app/templates/main/manual/_03_dashboard.html.j2 +++ b/app/templates/main/_manual_modal/_03_dashboard.html.j2 @@ -1,4 +1,4 @@ -

                            Dashboard

                            +

                            Dashboard

                            Dashboard diff --git a/app/templates/main/manual/_06_services.html.j2 b/app/templates/main/_manual_modal/_06_services.html.j2 similarity index 89% rename from app/templates/main/manual/_06_services.html.j2 rename to app/templates/main/_manual_modal/_06_services.html.j2 index 701e6c80..fcb986e3 100644 --- a/app/templates/main/manual/_06_services.html.j2 +++ b/app/templates/main/_manual_modal/_06_services.html.j2 @@ -1,4 +1,4 @@ -

                            Services

                            +

                            Services

                            Services @@ -19,7 +19,7 @@
                            -

                            File Setup

                            +

                            File Setup

                            The File Setup Service bundles image data, such as scans and photos, together in a handy PDF file. To use this service, use the job form to @@ -34,16 +34,16 @@ sorted in ascending order by file name.

                            -

                            Optical Character Recognition (OCR)

                            +

                            Optical Character Recognition (OCR)

                            Comming soon...

                            -

                            Handwritten Text Recognition (HTR)

                            +

                            Handwritten Text Recognition (HTR)

                            Comming soon...

                            -

                            Natural Language Processing (NLP)

                            +

                            Natural Language Processing (NLP)

                            Comming soon...

                            -

                            Corpus Analysis

                            +

                            Corpus Analysis

                            With the corpus analysis service, it is possible to create a text corpus and then explore it in an analysis session. The analysis session is realized diff --git a/app/templates/main/manual/_07_a_closer_look_at_the_corpus_analysis.html.j2 b/app/templates/main/_manual_modal/_07_a_closer_look_at_the_corpus_analysis.html.j2 similarity index 95% rename from app/templates/main/manual/_07_a_closer_look_at_the_corpus_analysis.html.j2 rename to app/templates/main/_manual_modal/_07_a_closer_look_at_the_corpus_analysis.html.j2 index a2c2732c..b2a500c8 100644 --- a/app/templates/main/manual/_07_a_closer_look_at_the_corpus_analysis.html.j2 +++ b/app/templates/main/_manual_modal/_07_a_closer_look_at_the_corpus_analysis.html.j2 @@ -1,5 +1,5 @@ -

                            A closer look at the Corpus Analysis

                            -

                            Create a corpus

                            +

                            A closer look at the Corpus Analysis

                            +

                            Create a corpus

                            Create a Corpus @@ -32,7 +32,7 @@
                            -

                            Analyze a corpus

                            +

                            Analyze a corpus

                            After you have created and built a corpus, it can be analyzed. To do this, use the button labeled Analyze. The corpus analysis currently offers two diff --git a/app/templates/main/manual/_08_cqp_query_language.html.j2 b/app/templates/main/_manual_modal/_08_cqp_query_language.html.j2 similarity index 97% rename from app/templates/main/manual/_08_cqp_query_language.html.j2 rename to app/templates/main/_manual_modal/_08_cqp_query_language.html.j2 index 0af61dd6..9069d495 100644 --- a/app/templates/main/manual/_08_cqp_query_language.html.j2 +++ b/app/templates/main/_manual_modal/_08_cqp_query_language.html.j2 @@ -1,4 +1,4 @@ -

                            CQP Query Language

                            +

                            CQP Query Language

                            Within the Corpus Query Language, a distinction is made between two types of annotations: positional attributes and structural attributes. Positional attributes refer to a token, e.g. the word "book" is assigned the part-of-speech tag "NN", the lemma "book" and the simplified part-of-speech tag "NOUN" within the token structure. Structural attributes refer to text structure-giving elements such as sentence and entity markup. For example, the markup of a sentence is represented in the background as follows:

                               
@@ -13,7 +13,7 @@
                            -

                            Positional attributes

                            +

                            Positional attributes

                            Before you can start searching for positional attributes (also called tokens), it is necessary to know what properties they contain.

                            1. word: The string as it is also found in the original text
                              2. @@ -33,7 +33,7 @@
                            -

                            Searching for positional attributes

                            +
                            Searching for positional attributes

                            Token with no condition on any property (also called wildcard token)
                            @@ -118,7 +118,7 @@ 

                                     ^             ^ the braces indicate the start and end of an option group
                            -

                            Structural attributes

                            +

                            Structural attributes

                            nopaque provides several structural attributes for query. A distinction is made between attributes with and without value.

                            1. s: Annotates a sentence
                              2. @@ -153,7 +153,7 @@
                            -

                            Searching for structural attributes

                            +
                            Searching for structural attributes
                            <ent> [] </ent>;                       A one token long entity of any type
                            <ent_type="PERSON"> [] </ent_type>;     A one token long entity of type PERSON
                            <ent_type="PERSON"> []* </ent_type>;    Entity of any length of type PERSON
                            diff --git a/app/templates/main/manual/_09_query_builder.html.j2 b/app/templates/main/_manual_modal/_09_query_builder.html.j2 similarity index 91% rename from app/templates/main/manual/_09_query_builder.html.j2 rename to app/templates/main/_manual_modal/_09_query_builder.html.j2 index ff3544eb..ea1a07a7 100644 --- a/app/templates/main/manual/_09_query_builder.html.j2 +++ b/app/templates/main/_manual_modal/_09_query_builder.html.j2 @@ -1,4 +1,4 @@ -

                            Query Builder Tutorial

                            +

                            Query Builder Tutorial

                            The query builder helps you to make a query in the form of the Corpus Query Language (CQL) to your text. You can use the CQL to filter out various types of @@ -26,12 +26,12 @@ under the tab "Examples".


                            -

                            Add new token to your Query

                            +

                            Add new token to your Query

                            If you are only looking for a specific token, you can click on the left button and select the type of token you are looking for from the drop-down menu. By default "Word" is selected.

                            -

                            Word and Lemma

                            +
                            Word and Lemma

                            If you want to search for a specific word or lemma and the respective category is selected in the drop-down menu, you can type in the word or lemma of your choice in the input field. You can confirm your entry by clicking the @@ -41,13 +41,13 @@ under the tab "Examples".

                            word and lemma explanation
                            -

                            English pos, german pos or simple_pos

                            +
                            English pos, german pos or simple_pos

                            You can choose between the options "english pos", "german pos" and "simple_pos" to search for different parts-of-speech. You can find an overview of all tags under the "Tagsets" tab.

                            part-of-speech-tag explanation -

                            Empty Token

                            +
                            Empty Token

                            Here you can search for an empty token. This selection should never stand alone and should always be extended with an incidence modifier or stand in a larger query, because otherwise all possible tokens would be searched for and @@ -61,17 +61,17 @@ under the tab "Examples".


                            -

                            Options to edit your token

                            +

                            Options to edit your token

                            You have the possibility to extend or specify your searched token with certain factors. For this the query builder offers some fixed options. You can find more information about the options in the Corpus Query Language Tutorial.


                            -

                            Wildcard Character

                            +
                            Wildcard Character

                            A wildcard character replaces any character and is represented in the form of a dot.


                            -

                            Option Group

                            +
                            Option Group

                            With an option group you can search for different variants of a token. The variants are not limited, so you can manually enter more options in the same format. "Option1" and "option2" must be replaced accordingly.

                            @@ -79,7 +79,7 @@ under the tab "Examples".


                            -

                            Incidence Modifiers

                            +
                            Incidence Modifiers

                            With the Incidence Modifiers you can determine the occurrence of single tokens. For example you can use "?" to indicate that the token occurs either not at all or once:
                            @@ -88,12 +88,12 @@ under the tab "Examples".

                            [word="dogs?"] the search is for "dog "or "dogs".


                            -

                            Ignore Case

                            +
                            Ignore Case

                            With the check mark at Ignore Case the upper and lower case is ignored. This is marked with a "%c". By default (if not checked) it is case sensitive.


                            -

                            "or" & "and"

                            +
                            "or" & "and"

                            "Or" ( | ) and "and" ( & ) are conditions you can put on a token. With "or" one of the two conditions must be fulfilled, with "and" both conditions must be fulfilled. For example, the word must be called "will" AND be a verb, only then @@ -110,12 +110,12 @@ under the tab "Examples".


                            -

                            Add structural attributes to your query

                            +

                            Add structural attributes to your query

                            You can use structural attributes to search specifically for structures in the text or to further narrow down your previous search query.


                            -

                            Sentence

                            +
                            Sentence
                            With "Sentence" () you can search for sentences within your text. This search can of course be specified if you search for particular tokens or entities between the sentence tags (). For example, you can search for @@ -127,7 +127,7 @@ under the tab "Examples".

                            Sentence End
                            .

                            -

                            Entities

                            +
                            Entities

                            With entities, i.e. units of meaning, you search for text sections that follow a certain code. For example, persons, dates, certain events. You can select the codes using the drop-down menus. You can find an explanation of @@ -138,7 +138,7 @@ under the tab "Examples".


                            -

                            Meta Data

                            +
                            Meta Data

                            With the meta data you can annotate your text and add specific conditions. You can select a category on the left and enter your desired value on the right. The selected metadata will apply to your entire request and will be added at the end.

                            @@ -153,14 +153,14 @@ under the tab "Examples".


                            -

                            General Options of the query builder

                            +

                            General Options of the query builder

                            You have several options to edit your query after adding it to the preview.

                            -

                            Deleting the elements

                            +
                            Deleting the elements

                            You can delete the added elements from the query by clicking the X behind the respective content.

                            delete explanation -

                            Move the elements of your query

                            +
                            Move the elements of your query

                            You can drag and drop elements to customize your query.

                            Drag&Drop explanation diff --git a/app/templates/main/manual/_10_tagsets.html.j2 b/app/templates/main/_manual_modal/_10_tagsets.html.j2 similarity index 100% rename from app/templates/main/manual/_10_tagsets.html.j2 rename to app/templates/main/_manual_modal/_10_tagsets.html.j2 diff --git a/app/templates/main/dashboard.html.j2 b/app/templates/main/dashboard.html.j2 index ca5422df..54f91eaa 100644 --- a/app/templates/main/dashboard.html.j2 +++ b/app/templates/main/dashboard.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "main/_breadcrumbs.html.j2" import breadcrumbs with context %} {% block page_content %}
                            @@ -9,8 +8,11 @@
                            -

                            My Corpora

                            +

                            My Corpora

                            Create a corpus to interactively perform linguistic analysis.

                            +
                            + +
                            @@ -23,7 +25,7 @@
                            -

                            My Jobs

                            +

                            My Jobs

                            A job is the execution of a service provided by nopaque. You can create any number of jobs and let them be processed simultaneously. We @@ -33,6 +35,9 @@ next step.

                            Where is my Job data? Don't worry, please read this news entry

                            +
                            + +
                            @@ -42,23 +47,40 @@
                            - {#
                            -

                            Social

                            -
                            + +
                            +

                            My Contributions

                            +
                            + +
                            +
                            +
                            - Other users -

                            Find other users and follow them to see their corpora.

                            -
                            + Tesseract OCR Pipeline Models +

                            Here you can see and edit the models that you have created. You can also create new models.

                            -
                            +
                            + +
                            +
                            +
                            - Public corpora -

                            Find public corpora

                            -
                            + SpaCy NLP Pipeline Models +

                            Here you can see and edit the models that you have created. You can also create new models.

                            -
                            #} +
                            + +
                            +
                            + +
                            + Transkribus HTR Pipeline Models +

                            Here you can see and edit the models that you have created. You can also create new models.

                            +
                            +
                            +
                            {% endblock page_content %} @@ -113,14 +135,3 @@
                            {% endblock modals %} - -{% block scripts %} -{{ super() }} -{# #} -{% endblock scripts %} - diff --git a/app/templates/main/dashboard2.html.j2 b/app/templates/main/dashboard2.html.j2 deleted file mode 100644 index d45aaa04..00000000 --- a/app/templates/main/dashboard2.html.j2 +++ /dev/null @@ -1,274 +0,0 @@ -{% extends "base.html.j2" %} -{% from "main/_breadcrumbs.html.j2" import breadcrumbs with context %} - -{% block page_content %} -
                            -
                            -
                            -
                            -

                            Dashboard

                            -
                            -
                            -
                            -

                            Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

                            -
                            -
                            - IMy Corpora - JMy Jobs - groupsMy Groups -
                            -
                            -
                            - - -
                            -
                            -
                            -
                            -
                            -
                            -
                            - search - - -
                            -
                            -
                            -
                            -
                            - -
                            -
                            -
                            -
                            -

                            My Corpora

                            -

                            Create a corpus to interactively perform linguistic analysis.

                            -

                            Or browse our users public corpora.

                            -
                            -
                            -
                            -
                            -
                            - - - - - - - - - - -
                            Title and DescriptionStatus
                            -
                              -
                              -
                              -
                              - Import Corpusimport_export - Create corpusadd -
                              -
                              -
                              -
                              -
                              - -
                              -
                              -
                              -
                              - -
                              -
                              -
                              -
                              -
                              -
                              -
                              - search - - -
                              -
                              -
                              -
                              -
                              - -
                              -
                              -
                              -
                              -

                              My Jobs

                              -

                              - A job is the execution of a service provided by nopaque. You can - create any number of jobs and let them be processed simultaneously. We - strongly recommend that you create a folder on your computer where you - save the various files that nopaque provides you with after each - pre-processing step. You will need the result of each step for the - next step. -

                              -

                              Where is my Job data? Don't worry, please read this news entry

                              -
                              -
                              -
                              -
                              -
                              - - - - - - - - - - -
                              Title and DescriptionStatus
                              -
                                -
                                -
                                -
                                - addCreate job -
                                -
                                -
                                -
                                -
                                - -
                                -
                                -
                                -
                                - -
                                -
                                -
                                -
                                -
                                -
                                -
                                - search - - -
                                -
                                -
                                -
                                -
                                - -
                                -
                                -
                                -
                                -

                                My Groups

                                -

                                Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

                                -
                                -
                                -
                                -
                                -
                                - - - - - - - - - - -
                                Title and DescriptionStatus
                                -
                                  -
                                  -
                                  -
                                  - addCreate group -
                                  -
                                  -
                                  -
                                  -
                                  - -
                                  -
                                  -
                                  -
                                  -{% endblock page_content %} - -{% block modals %} -{{ super() }} - -{% endblock modals %} - - -{% block scripts %} -{{ super() }} - -{% endblock scripts %} diff --git a/app/templates/main/faq.html.j2 b/app/templates/main/faq.html.j2 index fb10e3b4..5c168007 100644 --- a/app/templates/main/faq.html.j2 +++ b/app/templates/main/faq.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "main/_breadcrumbs.html.j2" import breadcrumbs with context %} {% block page_content %}
                                  diff --git a/app/templates/main/index.html.j2 b/app/templates/main/index.html.j2 index 74bfa306..7b80a794 100644 --- a/app/templates/main/index.html.j2 +++ b/app/templates/main/index.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "main/_breadcrumbs.html.j2" import breadcrumbs with context %} {% import "materialize/wtf.html.j2" as wtf %} {% block page_content %} diff --git a/app/templates/main/news.html.j2 b/app/templates/main/news.html.j2 index b8961b02..d1111d8b 100644 --- a/app/templates/main/news.html.j2 +++ b/app/templates/main/news.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "main/_breadcrumbs.html.j2" import breadcrumbs with context %} {% block page_content %}
                                  diff --git a/app/templates/main/news_new.html.j2 b/app/templates/main/news_new.html.j2 index d3e2f9b6..d2b339e3 100644 --- a/app/templates/main/news_new.html.j2 +++ b/app/templates/main/news_new.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "main/_breadcrumbs.html.j2" import breadcrumbs with context %} {% block page_content %}
                                  diff --git a/app/templates/main/privacy_policy.html.j2 b/app/templates/main/privacy_policy.html.j2 index ff22b10a..c55ae722 100644 --- a/app/templates/main/privacy_policy.html.j2 +++ b/app/templates/main/privacy_policy.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "main/_breadcrumbs.html.j2" import breadcrumbs with context %} {% block page_content %}
                                  diff --git a/app/templates/main/social_area.html.j2 b/app/templates/main/social_area.html.j2 new file mode 100644 index 00000000..5ce67beb --- /dev/null +++ b/app/templates/main/social_area.html.j2 @@ -0,0 +1,82 @@ +{% extends "base.html.j2" %} +{% import "materialize/wtf.html.j2" as wtf %} + +{% block main_attribs %} class="social-area-color-lighten" {% endblock main_attribs %} + +{% block page_content %} +
                                  +
                                  +
                                  +

                                  {{ title }}

                                  +
                                  + +
                                  +
                                  +

                                   

                                  +

                                   

                                  + +
                                  +
                                  + +
                                  + +
                                  + +
                                  +

                                  Public Users

                                  +

                                  Find other users and see what corpora they have made public.

                                  +
                                  +
                                  +
                                  +
                                  +
                                  +
                                  + +
                                  +

                                  Public Corpora

                                  +

                                  Find public corpora.

                                  +
                                  +
                                  + Public Corpora +
                                  +
                                  +
                                  +
                                  +
                                  +
                                  +{% endblock page_content %} + +{% block scripts %} +{{ super() }} + +{% endblock scripts %} diff --git a/app/templates/main/terms_of_use.html.j2 b/app/templates/main/terms_of_use.html.j2 index baedd0a2..d61084d6 100644 --- a/app/templates/main/terms_of_use.html.j2 +++ b/app/templates/main/terms_of_use.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "main/_breadcrumbs.html.j2" import breadcrumbs with context %} {% block page_content %}
                                  diff --git a/app/templates/main/user_manual.html.j2 b/app/templates/main/user_manual.html.j2 index 0da85809..2ef1da01 100644 --- a/app/templates/main/user_manual.html.j2 +++ b/app/templates/main/user_manual.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "main/_breadcrumbs.html.j2" import breadcrumbs with context %} {% block page_content %}
                                  diff --git a/app/templates/services/_breadcrumbs.html.j2 b/app/templates/services/_breadcrumbs.html.j2 deleted file mode 100644 index a08beafa..00000000 --- a/app/templates/services/_breadcrumbs.html.j2 +++ /dev/null @@ -1,16 +0,0 @@ -{% set breadcrumbs %} -
                                • navigate_next
                                  • -
                                • Processes & Services
                                  • -
                                • navigate_next
                                  • -{% if request.path == url_for('.corpus_analysis') %} -
                                • {{ title }}
                                  • -{% elif request.path == url_for('.file_setup_pipeline') %} -
                                • {{ title }}
                                  • -{% elif request.path == url_for('.spacy_nlp_pipeline') %} -
                                • {{ title }}
                                  • -{% elif request.path == url_for('.tesseract_ocr_pipeline') %} -
                                • {{ title }}
                                  • -{% elif request.path == url_for('.transkribus_htr_pipeline') %} -
                                • {{ title }}
                                  • -{% endif %} -{% endset %} diff --git a/app/templates/services/corpus_analysis.html.j2 b/app/templates/services/corpus_analysis.html.j2 index a7e3da8e..47fc6a47 100644 --- a/app/templates/services/corpus_analysis.html.j2 +++ b/app/templates/services/corpus_analysis.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "services/_breadcrumbs.html.j2" import breadcrumbs with context %} {% block main_attribs %} class="service-scheme" data-service="corpus-analysis"{% endblock main_attribs %} @@ -29,38 +28,11 @@
                                  - Import Corpusimport_export + Import Corpusimport_export Create corpusadd
                                  - -
                                  -

                                  My query results

                                  -
                                  -
                                  -
                                  - search - - -
                                  - - - - - - - - - -
                                  Title and DescriptionCorpus and Query
                                  -
                                    -
                                    -
                                    - Add query resultfile_upload -
                                    -
                                    -
                                    {% endblock page_content %} diff --git a/app/templates/services/file_setup_pipeline.html.j2 b/app/templates/services/file_setup_pipeline.html.j2 index ebc4cfc4..0f046e98 100644 --- a/app/templates/services/file_setup_pipeline.html.j2 +++ b/app/templates/services/file_setup_pipeline.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "services/_breadcrumbs.html.j2" import breadcrumbs with context %} {% import "materialize/wtf.html.j2" as wtf %} {% block main_attribs %} class="service-scheme" data-service="file-setup-pipeline"{% endblock main_attribs %} diff --git a/app/templates/services/spacy_nlp_pipeline.html.j2 b/app/templates/services/spacy_nlp_pipeline.html.j2 index 030ea163..a7bf214c 100644 --- a/app/templates/services/spacy_nlp_pipeline.html.j2 +++ b/app/templates/services/spacy_nlp_pipeline.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "services/_breadcrumbs.html.j2" import breadcrumbs with context %} {% import "materialize/wtf.html.j2" as wtf %} {% block main_attribs %} class="service-scheme" data-service="spacy-nlp-pipeline"{% endblock main_attribs %} @@ -164,3 +163,14 @@
                                    {% endblock modals %} + +{% block scripts %} +{{ super() }} + +{% endblock scripts %} diff --git a/app/templates/services/tesseract_ocr_pipeline.html.j2 b/app/templates/services/tesseract_ocr_pipeline.html.j2 index ff4fd38b..69be6889 100644 --- a/app/templates/services/tesseract_ocr_pipeline.html.j2 +++ b/app/templates/services/tesseract_ocr_pipeline.html.j2 @@ -1,5 +1,4 @@ {% extends "base.html.j2" %} -{% from "services/_breadcrumbs.html.j2" import breadcrumbs with context %} {% import "materialize/wtf.html.j2" as wtf %} {% block main_attribs %} class="service-scheme" data-service="tesseract-ocr-pipeline"{% endblock main_attribs %} @@ -148,6 +147,13 @@ {% block scripts %} {{ super() }} -{% endblock scripts %} diff --git a/app/templates/users/edit_profile.html.j2 b/app/templates/users/edit_profile.html.j2 deleted file mode 100644 index 11b4b4d2..00000000 --- a/app/templates/users/edit_profile.html.j2 +++ /dev/null @@ -1,154 +0,0 @@ -{% extends "base.html.j2" %} -{% import "materialize/wtf.html.j2" as wtf %} - -{% block page_content %} -
                                    -
                                    -
                                    -

                                    {{ title }}

                                    -
                                    - -
                                    - -
                                    - -
                                    -
                                    -
                                    - {{ edit_profile_settings_form.hidden_tag() }} - {{ wtf.render_field(edit_profile_settings_form.username, material_icon='person') }} - {{ wtf.render_field(edit_profile_settings_form.email, material_icon='email') }} -
                                    -
                                    -
                                    -
                                    -
                                    - {{ wtf.render_field(edit_profile_settings_form.submit, material_icon='send') }} -
                                    -
                                    - -
                                    - -
                                    - {{ edit_privacy_settings_form.hidden_tag() }} -
                                    -
                                    - Privacy settings -
                                    - {{ wtf.render_field(edit_privacy_settings_form.is_public, id='public-profile') }} -
                                    -
                                    -
                                    - {{ wtf.render_field(edit_privacy_settings_form.show_email, data_action='disable', disabled=true) }} -
                                    - {{ wtf.render_field(edit_privacy_settings_form.show_last_seen, data_action='disable', disabled=true) }} -
                                    - {{ wtf.render_field(edit_privacy_settings_form.show_member_since, data_action='disable', disabled=true) }} -
                                    -
                                    -
                                    -
                                    - {{ wtf.render_field(edit_privacy_settings_form.submit, material_icon='send') }} -
                                    -
                                    -
                                    -
                                    - -
                                    -
                                    -
                                    - {{ edit_public_profile_information_form.hidden_tag() }} -
                                    -
                                    - Public Profile -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    - {% if user.avatar %} - user-image - {% else %} - user-image - {% endif %} -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    - delete -
                                    -
                                    -
                                    - {{ wtf.render_field(edit_public_profile_information_form.avatar, accept='image/jpeg, image/png, image/gif', placeholder='Choose an image file', id='avatar-upload') }} -
                                    -
                                    -
                                    -
                                    -

                                    -
                                    - {{ wtf.render_field(edit_public_profile_information_form.full_name, material_icon='badge') }} - {{ wtf.render_field(edit_public_profile_information_form.about_me, material_icon='description') }} - {{ wtf.render_field(edit_public_profile_information_form.website, material_icon='laptop') }} - {{ wtf.render_field(edit_public_profile_information_form.organization, material_icon='business') }} - {{ wtf.render_field(edit_public_profile_information_form.location, material_icon='location_on') }} -
                                    -
                                    -
                                    -
                                    -
                                    - {{ wtf.render_field(edit_public_profile_information_form.submit, material_icon='send') }} -
                                    -
                                    -
                                    -
                                    - -
                                    -
                                    -
                                    -{% endblock page_content %} - -{% block scripts %} -{{ super() }} - -{% endblock scripts %} diff --git a/app/templates/users/profile.html.j2 b/app/templates/users/profile.html.j2 deleted file mode 100644 index a6ad5b30..00000000 --- a/app/templates/users/profile.html.j2 +++ /dev/null @@ -1,132 +0,0 @@ -{% extends "base.html.j2" %} -{% import "materialize/wtf.html.j2" as wtf %} - -{% block page_content %} -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    - {% if user.avatar %} - user-image - {% else %} - user-image - {% endif %} -
                                    -
                                    -
                                    -
                                    -
                                    -

                                    {{ user.username }}

                                    -
                                    -
                                    - {% if user.show_last_seen %} -
                                    Last seen: {{ user.last_seen }}
                                    - {% endif %} - {% if user.location %} -

                                    location_on{{ user.location }}

                                    - {% endif %} -

                                    -
                                    - {% if user.about_me %} -
                                    -
                                    About me
                                    -

                                    {{ user.about_me }}

                                    -
                                    - {% endif %} -
                                    -
                                    -
                                    -
                                    -

                                    -
                                    -
                                    -
                                    -
                                    - - {% if user.full_name %} - - - - - {% endif %} - {% if user.show_email %} - - - - - {% endif %} - {% if user.website %} - - - - - {% endif %} - {% if user.organization %} - - - - - {% endif %} -
                                    person{{ user.full_name }}
                                    email{{ user.email }}
                                    laptop{{ user.website }}
                                    business{{ user.organization }}
                                    -
                                    - {% if user.show_member_since %} -

                                    Member since: {{ user.member_since }}

                                    - {% endif %} -

                                    -
                                    - {% if current_user.is_authenticated and current_user.hashid == user.id %} - Edit profile - {% endif %} -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    -

                                    Groups

                                    -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    -

                                    Public corpora

                                    -
                                    -
                                    -
                                    -
                                    -
                                    - -
                                    -{% endblock page_content %} - -{% block scripts %} -{{ super() }} - -{% endblock scripts %} - diff --git a/app/templates/users/settings/settings.html.j2 b/app/templates/users/settings/settings.html.j2 new file mode 100644 index 00000000..9b7d6b05 --- /dev/null +++ b/app/templates/users/settings/settings.html.j2 @@ -0,0 +1,282 @@ +{% extends "base.html.j2" %} +{% import "materialize/wtf.html.j2" as wtf %} + +{% block page_content %} +
                                    +
                                    +
                                    +

                                    {{ title }}

                                    +
                                    + + {#
                                    +

                                    Profile Settings

                                    +

                                    You can edit your public profile here and share it with other nopaque users. + Tell others about your (scientific) background so they can relate and network with you. + You can also set what should not be visible.

                                    +
                                    +
                                    +
                                    +
                                      +
                                    • +
                                      + Privacy + keyboard_arrow_right +
                                      +
                                      +
                                      +

                                      public

                                      +

                                      + Public status
                                      + Choose whether your profile is visible to other users. +

                                      +
                                      +
                                      + +
                                      +
                                      +
                                      +

                                      badge

                                      +

                                      + Public data
                                      + Choose which data is visible on your profile. +

                                      +
                                      +
                                      +
                                      + +
                                      +
                                      + +
                                      +
                                      + +
                                      +
                                      +
                                      +
                                      • +
                                    • +
                                      + Information + keyboard_arrow_right +
                                      +
                                      +
                                      + {{ update_profile_information_form.hidden_tag() }} + {{ wtf.render_field(update_profile_information_form.full_name, material_icon='badge') }} + {{ wtf.render_field(update_profile_information_form.about_me, material_icon='description', id='about-me-textfield') }} + {{ wtf.render_field(update_profile_information_form.website, material_icon='laptop') }} + {{ wtf.render_field(update_profile_information_form.organization, material_icon='business') }} + {{ wtf.render_field(update_profile_information_form.location, material_icon='location_on') }} +
                                      + {{ wtf.render_field(update_profile_information_form.submit, material_icon='send') }} +
                                      +
                                      +
                                      +
                                      • +
                                    • +
                                      + Avatar + keyboard_arrow_right +
                                      +
                                      +
                                      + {{ update_avatar_form.hidden_tag() }} +
                                      +
                                      + Avatar +
                                      +
                                      +
                                      + {{ wtf.render_field(update_avatar_form.avatar, accept='image/jpeg, image/png, image/gif', placeholder='Choose a JPEG or PNG file') }} +
                                      +
                                      +
                                      + deleteDelete + {{ wtf.render_field(update_avatar_form.submit, material_icon='send') }} +
                                      +
                                      +
                                      +
                                      • +
                                    +
                                    + +
                                    #} + +
                                    +

                                    General Settings

                                    +

                                    Make general changes to your profile here. You can change your password, + username or email address, delete your profile and customize your notifications.

                                    +
                                    +
                                    +
                                    +
                                      +
                                    • +
                                      + Account + keyboard_arrow_right +
                                      +
                                      +
                                      + {{ update_account_information_form.hidden_tag() }} + {{ wtf.render_field(update_account_information_form.username, material_icon='person') }} + {{ wtf.render_field(update_account_information_form.email, material_icon='email') }} +
                                      + deleteDelete + {{ wtf.render_field(update_account_information_form.submit, material_icon='send') }} +
                                      +
                                      +
                                      +
                                      • +
                                    • +
                                      + Change Password + keyboard_arrow_right +
                                      +
                                      +
                                      + {{ update_password_form.hidden_tag() }} + {{ wtf.render_field(update_password_form.password, material_icon='vpn_key') }} + {{ wtf.render_field(update_password_form.new_password, material_icon='vpn_key') }} + {{ wtf.render_field(update_password_form.new_password_2, material_icon='vpn_key') }} +
                                      + {{ wtf.render_field(update_password_form.submit, material_icon='send') }} +
                                      +
                                      +
                                      +
                                      • +
                                    • +
                                      + Notifications + keyboard_arrow_right +
                                      +
                                      +
                                      + {{ update_notifications_form.hidden_tag() }} + {{ wtf.render_field(update_notifications_form.job_status_mail_notification_level, material_icon='notifications') }} +
                                      + {{ wtf.render_field(update_notifications_form.submit, material_icon='send') }} +
                                      +
                                      +
                                      +
                                      • +
                                    +
                                    + + {% block admin_settings %}{% endblock admin_settings %} +
                                    +
                                    +{% endblock page_content %} + +{% block modals %} +{{ super() }} +{# #} + + +{% endblock modals %} + +{% block scripts %} +{{ super() }} + +{% endblock scripts %} diff --git a/app/templates/users/user.html.j2 b/app/templates/users/user.html.j2 new file mode 100644 index 00000000..d75ffc7e --- /dev/null +++ b/app/templates/users/user.html.j2 @@ -0,0 +1,146 @@ +{% extends "base.html.j2" %} +{% import "materialize/wtf.html.j2" as wtf %} + + +{% block page_content %} +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    +

                                     

                                    +
                                    + user-image +
                                    +
                                    +
                                    +
                                    +
                                    +

                                    {{ user.username }}

                                    + {% if user.role.name != 'User' %} + {{ user.role.name }} + {% endif %} + {% if user.is_public %} + Public Profile + {% else %} + Private Profile + {% endif %} + {% if user.has_profile_privacy_setting('SHOW_MEMBER_SINCE') %} + Member since: {{ user.member_since.strftime('%Y-%m-%d') }} + {% endif %} + {% if user.has_profile_privacy_setting('SHOW_LAST_SEEN') %} + Last seen: {{ user.last_seen.strftime('%Y-%m-%d') }} + {% endif %} +
                                    +
                                    + {% if user.location %} +

                                     

                                    +

                                    location_on{{ user.location }}

                                    + {% endif %} +
                                    +
                                    +
                                    +
                                    +

                                    +
                                    +
                                    +
                                    +
                                    + {% if user.about_me %} +
                                    +
                                    About me
                                    +

                                    {{ user.about_me }}

                                    +
                                    + {% endif %} +

                                    +
                                    + + {% if user.full_name %} + + + + + {% endif %} + {% if user.has_profile_privacy_setting('SHOW_EMAIL') %} + + + + + {% endif %} + {% if user.website %} + + + + + {% endif %} + {% if user.organization %} + + + + + {% endif %} +
                                    person{{ user.full_name }}
                                    email{{ user.email }}
                                    laptop{{ user.website }}
                                    business{{ user.organization }}
                                    +

                                     

                                    +
                                    +
                                    +
                                    + {% if current_user == user %} +
                                    +

                                    + Edit profile +

                                    +
                                    + {% endif %} +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    +

                                    Followed corpora

                                    +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    +

                                    Public corpora

                                    +
                                    +
                                    +
                                    +
                                    +
                                    + +
                                    +{% endblock page_content %} + +{% block scripts %} +{{ super() }} + +{% endblock scripts %} diff --git a/app/tests/__init__.py b/app/tests/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/app/tests/cli.py b/app/tests/cli.py new file mode 100644 index 00000000..a620bf0b --- /dev/null +++ b/app/tests/cli.py @@ -0,0 +1,9 @@ +from unittest import TestLoader, TextTestRunner +from unittest.suite import TestSuite +from . import bp + +@bp.cli.command('run') +def run_test(): + ''' Run unit tests. ''' + tests: TestSuite = TestLoader().discover('tests') + TextTestRunner(verbosity=2).run(tests) diff --git a/app/users/__init__.py b/app/users/__init__.py index 885cdbe2..b3492a37 100644 --- a/app/users/__init__.py +++ b/app/users/__init__.py @@ -1,5 +1,18 @@ from flask import Blueprint +from flask_login import login_required bp = Blueprint('users', __name__) -from . import events, routes + + +@bp.before_request +@login_required +def before_request(): + ''' + Ensures that the routes in this package can only be visited by users that + are logged in. + ''' + pass + + +from . import events, json_routes, routes, settings diff --git a/app/users/events.py b/app/users/events.py index 532bf42d..af490a01 100644 --- a/app/users/events.py +++ b/app/users/events.py @@ -12,7 +12,7 @@ def get_user(user_hashid, backrefs=False, relationships=False): user = User.query.get(user_id) if user is None: return {'status': 404, 'statusText': 'Not found'} - if not (user == current_user or current_user.is_administrator): + if not (user == current_user or current_user.is_administrator()): return {'status': 403, 'statusText': 'Forbidden'} return { 'body': user.to_json_serializeable( @@ -24,25 +24,6 @@ def get_user(user_hashid, backrefs=False, relationships=False): } -# @socketio.on('GET /users/') -# @socketio_login_required -# def get_user(user_hashid): -# user_id = hashids.decode(user_hashid) -# user = User.query.get(user_id) -# if user is None: -# return {'options': {'status': 404, 'statusText': 'Not found'}} -# if not (user == current_user or current_user.is_administrator): -# return {'options': {'status': 403, 'statusText': 'Forbidden'}} -# return { -# 'body': user.to_json_serializable2(), -# 'options': { -# 'status': 200, -# 'statusText': 'OK', -# 'headers': {'Content-Type: application/json'} -# } -# } - - @socketio.on('SUBSCRIBE /users/') @socketio_login_required def subscribe_user(user_hashid): @@ -50,7 +31,7 @@ def subscribe_user(user_hashid): user = User.query.get(user_id) if user is None: return {'status': 404, 'statusText': 'Not found'} - if not (user == current_user or current_user.is_administrator): + if not (user == current_user or current_user.is_administrator()): return {'status': 403, 'statusText': 'Forbidden'} join_room(f'/users/{user.hashid}') return {'status': 200, 'statusText': 'OK'} @@ -63,7 +44,7 @@ def unsubscribe_user(user_hashid): user = User.query.get(user_id) if user is None: return {'status': 404, 'statusText': 'Not found'} - if not (user == current_user or current_user.is_administrator): + if not (user == current_user or current_user.is_administrator()): return {'status': 403, 'statusText': 'Forbidden'} leave_room(f'/users/{user.hashid}') return {'status': 200, 'statusText': 'OK'} diff --git a/app/users/forms.py b/app/users/forms.py deleted file mode 100644 index 5fd5d81e..00000000 --- a/app/users/forms.py +++ /dev/null @@ -1,100 +0,0 @@ -from flask_wtf import FlaskForm -from wtforms import ( - BooleanField, - FileField, - StringField, - SubmitField, - TextAreaField, - ValidationError -) -from wtforms.validators import ( - DataRequired, - Email, - Length, - Regexp -) -from app.models import User -from app.auth import USERNAME_REGEX -from app.wtf_validators import FileSizeLimit - -class EditProfileSettingsForm(FlaskForm): - email = StringField( - 'E-Mail', - validators=[DataRequired(), Length(max=254), Email()] - ) - username = StringField( - 'Username', - validators=[ - DataRequired(), - Length(max=64), - Regexp( - USERNAME_REGEX, - message=( - 'Usernames must have only letters, numbers, dots or ' - 'underscores' - ) - ) - ] - ) - submit = SubmitField() - - def __init__(self, user, *args, **kwargs): - super().__init__(*args, **kwargs) - self.user = user - - def validate_email(self, field): - if (field.data != self.user.email - and User.query.filter_by(email=field.data).first()): - raise ValidationError('Email already registered') - - def validate_username(self, field): - if (field.data != self.user.username - and User.query.filter_by(username=field.data).first()): - raise ValidationError('Username already in use') - -class EditPublicProfileInformationForm(FlaskForm): - avatar = FileField( - 'Image File', - [FileSizeLimit(max_size_in_mb=2)] - ) - full_name = StringField( - 'Full name', - validators=[Length(max=128)] - ) - about_me = TextAreaField( - 'About me', - validators=[ - Length(max=254) - ] - ) - website = StringField( - 'Website', - validators=[ - Length(max=254) - ] - ) - organization = StringField( - 'Organization', - validators=[ - Length(max=128) - ] - ) - location = StringField( - 'Location', - validators=[ - Length(max=128) - ] - ) - - submit = SubmitField() - - def validate_image_file(self, field): - if not field.data.filename.lower().endswith('.jpg' or '.png' or '.jpeg'): - raise ValidationError('only .jpg, .png and .jpeg!') - -class EditPrivacySettingsForm(FlaskForm): - is_public = BooleanField('Public profile') - show_email = BooleanField('Show email') - show_last_seen = BooleanField('Show last seen') - show_member_since = BooleanField('Show member since') - submit = SubmitField() diff --git a/app/users/json_routes.py b/app/users/json_routes.py new file mode 100644 index 00000000..da8ea335 --- /dev/null +++ b/app/users/json_routes.py @@ -0,0 +1,69 @@ +from flask import abort, current_app +from flask_login import current_user, logout_user +from threading import Thread +from app import db +from app.decorators import content_negotiation +from app.models import Avatar, User +from . import bp + + +# @bp.route('/', methods=['DELETE']) +# @content_negotiation(produces='application/json') +# def delete_user(user_id): +# def _delete_user(app, user_id): +# with app.app_context(): +# user = User.query.get(user_id) +# user.delete() +# db.session.commit() + +# user = User.query.get_or_404(user_id) +# if not (user == current_user or current_user.is_administrator()): +# abort(403) +# thread = Thread( +# target=_delete_user, +# args=(current_app._get_current_object(), user.id) +# ) +# if user == current_user: +# logout_user() +# thread.start() +# response_data = { +# 'message': f'User "{user.username}" marked for deletion' +# } +# return response_data, 202 + + +# @bp.route('//avatar', methods=['DELETE']) +# @content_negotiation(produces='application/json') +# def delete_user_avatar(user_id): +# def _delete_avatar(app, avatar_id): +# with app.app_context(): +# avatar = Avatar.query.get(avatar_id) +# avatar.delete() +# db.session.commit() + +# user = User.query.get_or_404(user_id) +# if user.avatar is None: +# abort(404) +# if not (user == current_user or current_user.is_administrator()): +# abort(403) +# thread = Thread( +# target=_delete_avatar, +# args=(current_app._get_current_object(), user.avatar.id) +# ) +# thread.start() +# response_data = { +# 'message': f'Avatar marked for deletion' +# } +# return response_data, 202 + +@bp.route('/accept-terms-of-use', methods=['POST']) +@content_negotiation(produces='application/json') +def accept_terms_of_use(): + if not (current_user.is_authenticated or current_user.confirmed): + abort(403) + current_user.terms_of_use_accepted = True + db.session.commit() + response_data = { + 'message': 'You accepted the terms of use', + } + return response_data, 202 diff --git a/app/users/nevents.py b/app/users/nevents.py new file mode 100644 index 00000000..8205df03 --- /dev/null +++ b/app/users/nevents.py @@ -0,0 +1,114 @@ +from flask_login import current_user +from flask_socketio import join_room, leave_room +from app import hashids, socketio +from app.decorators import socketio_admin_required, socketio_login_required +from app.models import User + + +@socketio.on('GET /users') +@socketio_admin_required +def get_users(): + users = User.query.filter_by().all() + return { + 'body': [user.to_json_serializable() for user in users], + 'options': { + 'status': 200, + 'statusText': 'OK', + 'headers': {'Content-Type: application/json'} + } + } + + +@socketio.on('SUBSCRIBE /users') +@socketio_admin_required +def subscribe_users(): + join_room('/users') + return {'options': {'status': 200, 'statusText': 'OK'}} + + +@socketio.on('GET /users/') +@socketio_login_required +def get_user(user_hashid): + user_id = hashids.decode(user_hashid) + user = User.query.get(user_id) + if user is None: + return {'options': {'status': 404, 'statusText': 'Not found'}} + if not (user == current_user or current_user.is_administrator()): + return {'options': {'status': 403, 'statusText': 'Forbidden'}} + return { + 'body': user.to_json_serializable(), + 'options': { + 'status': 200, + 'statusText': 'OK', + 'headers': {'Content-Type: application/json'} + } + } + + +@socketio.on('SUBSCRIBE /users/') +@socketio_login_required +def subscribe_user(user_hashid): + user_id = hashids.decode(user_hashid) + user = User.query.get(user_id) + if user is None: + return {'options': {'status': 404, 'statusText': 'Not found'}} + if not (user == current_user or current_user.is_administrator()): + return {'options': {'status': 403, 'statusText': 'Forbidden'}} + join_room(f'/users/{user.hashid}') + return {'options': {'status': 200, 'statusText': 'OK'}} + + +@socketio.on('GET /public_users') +@socketio_login_required +def get_public_users(): + users = User.query.filter_by(is_public=True).all() + return { + 'body': [ + user.to_json_serializable(filter_by_privacy_settings=True) + for user in users + ], + 'options': { + 'status': 200, + 'statusText': 'OK', + 'headers': {'Content-Type: application/json'} + } + } + + +@socketio.on('SUBSCRIBE /users') +@socketio_admin_required +def subscribe_users(): + join_room('/public_users') + return {'options': {'status': 200, 'statusText': 'OK'}} + + +@socketio.on('GET /public_users/') +@socketio_login_required +def get_user(user_hashid): + user_id = hashids.decode(user_hashid) + user = User.query.filter_by(id=user_id, is_public=True).first() + if user is None: + return {'options': {'status': 404, 'statusText': 'Not found'}} + if not (user == current_user or current_user.is_administrator()): + return {'options': {'status': 403, 'statusText': 'Forbidden'}} + return { + 'body': user.to_json_serializable(filter_by_privacy_settings=True), + 'options': { + 'status': 200, + 'statusText': 'OK', + 'headers': {'Content-Type: application/json'} + } + } + + +@socketio.on('SUBSCRIBE /public_users/') +@socketio_login_required +def subscribe_user(user_hashid): + user_id = hashids.decode(user_hashid) + user = User.query.filter_by(id=user_id, is_public=True).first() + if user is None: + return {'options': {'status': 404, 'statusText': 'Not found'}} + if not (user == current_user or current_user.is_administrator()): + return {'options': {'status': 403, 'statusText': 'Forbidden'}} + join_room(f'/public_users/{user.hashid}') + return {'options': {'status': 200, 'statusText': 'OK'}} diff --git a/app/users/routes.py b/app/users/routes.py index 48a8d7b5..8c817617 100644 --- a/app/users/routes.py +++ b/app/users/routes.py @@ -1,168 +1,48 @@ from flask import ( abort, - current_app, - flash, - Markup, redirect, render_template, send_from_directory, url_for ) -from flask_login import current_user, login_required -from threading import Thread +from flask_breadcrumbs import register_breadcrumb +from flask_login import current_user import os -from app import db -from app.models import Avatar, ProfilePrivacySettings, User +from app.models import User from . import bp -from .forms import ( - EditPrivacySettingsForm, - EditProfileSettingsForm, - EditPublicProfileInformationForm -) - -@bp.before_request -@login_required -def before_request(): - pass - -@bp.route('/') -@login_required -def user(user_id): - user = User.query.get_or_404(user_id) - if not user.is_public and user != current_user: - abort(403) - return render_template( - 'users/profile.html.j2', - user=user.to_json_serializeable(), - user_id=user_id - ) - -@bp.route('/', methods=['DELETE']) -@login_required -def delete_user(user_id): - def _delete_user(app, user_id): - with app.app_context(): - user = User.query.get(user_id) - user.delete() - db.session.commit() - - user = User.query.get_or_404(user_id) - if not (user == current_user or current_user.is_administrator()): - abort(403) - thread = Thread( - target=_delete_user, - args=(current_app._get_current_object(), user_id) - ) - thread.start() - return {}, 202 - -@bp.route('/') -def profile(user_id): - user = User.query.get_or_404(user_id) - if not user.is_public and user != current_user: - abort(403) - return render_template( - 'users/profile.html.j2', - user=user.to_json_serializeable(), - user_id=user_id - ) +from .utils import user_dynamic_list_constructor as user_dlc -@bp.route('//avatar') -def profile_avatar(user_id): - user = User.query.get_or_404(user_id) - if user.avatar is None: - abort(404) - if not user.is_public and not (user == current_user or current_user.is_administrator()): - abort(403) - return send_from_directory( - os.path.dirname(user.avatar.path), - os.path.basename(user.avatar.path), - as_attachment=True, - attachment_filename=user.avatar.filename, - mimetype=user.avatar.mimetype - ) +# @bp.route('') +# @register_breadcrumb(bp, '.', 'groupUsers') +# def users(): +# return redirect(url_for('main.social_area', _anchor='users')) -@bp.route('//avatar', methods=['DELETE']) -def delete_profile_avatar(user_id): - def _delete_avatar(app, avatar_id): - with app.app_context(): - avatar = Avatar.query.get(avatar_id) - avatar.delete() - db.session.commit() - - user = User.query.get_or_404(user_id) - if user.avatar is None: - abort(404) - thread = Thread( - target=_delete_avatar, - args=(current_app._get_current_object(), user.avatar.id) - ) - thread.start() - return {}, 202 +# @bp.route('/') +# @register_breadcrumb(bp, '.entity', '', dynamic_list_constructor=user_dlc) +# def user(user_id): +# user = User.query.get_or_404(user_id) +# if not (user.is_public or user == current_user or current_user.is_administrator()): +# abort(403) +# return render_template( +# 'users/user.html.j2', +# title=user.username, +# user=user +# ) -@bp.route('//edit', methods=['GET', 'POST']) -def edit_profile(user_id): - user = User.query.get_or_404(user_id) - if not (user == current_user or current_user.is_administrator()): - abort(403) - edit_profile_settings_form = EditProfileSettingsForm( - current_user, - data=current_user.to_json_serializeable(), - prefix='edit-profile-settings-form' - ) - edit_privacy_settings_form = EditPrivacySettingsForm( - data=current_user.to_json_serializeable(), - prefix='edit-privacy-settings-form' - ) - edit_public_profile_information_form = EditPublicProfileInformationForm( - data=current_user.to_json_serializeable(), - prefix='edit-public-profile-information-form' - ) - if edit_profile_settings_form.validate_on_submit(): - current_user.email = edit_profile_settings_form.email.data - current_user.username = edit_profile_settings_form.username.data - db.session.commit() - flash('Profile settings updated') - return redirect(url_for('.user', user_id=user.id)) - if edit_privacy_settings_form.submit.data and edit_privacy_settings_form.validate(): - current_user.is_public = edit_privacy_settings_form.is_public.data - if edit_privacy_settings_form.show_email.data: - current_user.add_profile_privacy_setting(ProfilePrivacySettings.SHOW_EMAIL) - else: - current_user.remove_profile_privacy_setting(ProfilePrivacySettings.SHOW_EMAIL) - if edit_privacy_settings_form.show_last_seen.data: - current_user.add_profile_privacy_setting(ProfilePrivacySettings.SHOW_LAST_SEEN) - else: - current_user.remove_profile_privacy_setting(ProfilePrivacySettings.SHOW_LAST_SEEN) - if edit_privacy_settings_form.show_member_since.data: - current_user.add_profile_privacy_setting(ProfilePrivacySettings.SHOW_MEMBER_SINCE) - else: - current_user.remove_profile_privacy_setting(ProfilePrivacySettings.SHOW_MEMBER_SINCE) - db.session.commit() - flash('Your changes have been saved') - return redirect(url_for('.user', user_id=user.id)) - if edit_public_profile_information_form.validate_on_submit(): - if edit_public_profile_information_form.avatar.data: - try: - Avatar.create(edit_public_profile_information_form.avatar.data, user=current_user) - except (AttributeError, OSError): - abort(500) - current_user.about_me = edit_public_profile_information_form.about_me.data - current_user.location = edit_public_profile_information_form.location.data - current_user.organization = edit_public_profile_information_form.organization.data - current_user.website = edit_public_profile_information_form.website.data - current_user.full_name = edit_public_profile_information_form.full_name.data - db.session.commit() - flash('Profile settings updated') - return redirect(url_for('.user', user_id=user.id)) - return render_template( - 'users/edit_profile.html.j2', - edit_profile_settings_form=edit_profile_settings_form, - edit_privacy_settings_form=edit_privacy_settings_form, - edit_public_profile_information_form=edit_public_profile_information_form, - user=user, - title='Edit Profile' - ) +# @bp.route('//avatar') +# def user_avatar(user_id): +# user = User.query.get_or_404(user_id) +# if not (user.is_public or user == current_user or current_user.is_administrator()): +# abort(403) +# if user.avatar is None: +# return redirect(url_for('static', filename='images/user_avatar.png')) +# return send_from_directory( +# os.path.dirname(user.avatar.path), +# os.path.basename(user.avatar.path), +# as_attachment=True, +# attachment_filename=user.avatar.filename, +# mimetype=user.avatar.mimetype +# ) diff --git a/app/users/settings/__init__.py b/app/users/settings/__init__.py new file mode 100644 index 00000000..e06bada9 --- /dev/null +++ b/app/users/settings/__init__.py @@ -0,0 +1,2 @@ +from .. import bp +from . import json_routes, routes diff --git a/app/users/settings/forms.py b/app/users/settings/forms.py new file mode 100644 index 00000000..71c29456 --- /dev/null +++ b/app/users/settings/forms.py @@ -0,0 +1,162 @@ +from flask_login import current_user +from flask_wtf import FlaskForm +from flask_wtf.file import FileField, FileRequired +from wtforms import ( + PasswordField, + SelectField, + StringField, + SubmitField, + TextAreaField, + ValidationError +) +from wtforms.validators import ( + DataRequired, + Email, + EqualTo, + Length, + Regexp +) +from app.models import User, UserSettingJobStatusMailNotificationLevel +from app.wtforms.validators import FileSize + + +class UpdateAccountInformationForm(FlaskForm): + email = StringField( + 'E-Mail', + validators=[DataRequired(), Length(max=254), Email()] + ) + username = StringField( + 'Username', + validators=[ + DataRequired(), + Length(max=64), + Regexp( + User.username_pattern, + message=( + 'Usernames must have only letters, numbers, dots or ' + 'underscores' + ) + ) + ] + ) + submit = SubmitField() + + def __init__(self, user, *args, **kwargs): + if 'data' not in kwargs: + kwargs['data'] = user.to_json_serializeable() + if 'prefix' not in kwargs: + kwargs['prefix'] = 'update-account-information-form' + super().__init__(*args, **kwargs) + self.user = user + + def validate_email(self, field): + if (field.data != self.user.email + and User.query.filter_by(email=field.data).first()): + raise ValidationError('Email already registered') + + def validate_username(self, field): + if (field.data != self.user.username + and User.query.filter_by(username=field.data).first()): + raise ValidationError('Username already in use') + + +class UpdateProfileInformationForm(FlaskForm): + full_name = StringField( + 'Full name', + validators=[Length(max=128)] + ) + about_me = TextAreaField( + 'About me', + validators=[ + Length(max=254) + ] + ) + website = StringField( + 'Website', + validators=[ + Length(max=254) + ] + ) + organization = StringField( + 'Organization', + validators=[ + Length(max=128) + ] + ) + location = StringField( + 'Location', + validators=[ + Length(max=128) + ] + ) + submit = SubmitField() + + def __init__(self, user, *args, **kwargs): + if 'data' not in kwargs: + kwargs['data'] = user.to_json_serializeable() + if 'prefix' not in kwargs: + kwargs['prefix'] = 'update-profile-information-form' + super().__init__(*args, **kwargs) + + +class UpdateAvatarForm(FlaskForm): + avatar = FileField('File', validators=[FileRequired(), FileSize(2)]) + submit = SubmitField() + + def validate_avatar(self, field): + valid_mimetypes = ['image/jpeg', 'image/png'] + if field.data.mimetype not in valid_mimetypes: + raise ValidationError('JPEG and PNG files only!') + + def __init__(self, *args, **kwargs): + if 'prefix' not in kwargs: + kwargs['prefix'] = 'update-avatar-form' + super().__init__(*args, **kwargs) + + +class UpdatePasswordForm(FlaskForm): + password = PasswordField('Old password', validators=[DataRequired()]) + new_password = PasswordField( + 'New password', + validators=[ + DataRequired(), + EqualTo('new_password_2', message='Passwords must match') + ] + ) + new_password_2 = PasswordField( + 'New password confirmation', + validators=[ + DataRequired(), + EqualTo('new_password', message='Passwords must match') + ] + ) + submit = SubmitField() + + def __init__(self, user, *args, **kwargs): + if 'prefix' not in kwargs: + kwargs['prefix'] = 'update-password-form' + super().__init__(*args, **kwargs) + self.user = user + + def validate_current_password(self, field): + if not self.user.verify_password(field.data): + raise ValidationError('Invalid password') + + +class UpdateNotificationsForm(FlaskForm): + job_status_mail_notification_level = SelectField( + 'Job status mail notification level', + choices=[ + (x.name, x.name.capitalize()) + for x in UserSettingJobStatusMailNotificationLevel + ], + validators=[DataRequired()] + ) + submit = SubmitField() + + def __init__(self, user, *args, **kwargs): + if 'data' not in kwargs: + kwargs['data'] = user.to_json_serializeable() + if 'prefix' not in kwargs: + kwargs['prefix'] = 'update-notifications-form' + super().__init__(*args, **kwargs) diff --git a/app/users/settings/json_routes.py b/app/users/settings/json_routes.py new file mode 100644 index 00000000..03f34a22 --- /dev/null +++ b/app/users/settings/json_routes.py @@ -0,0 +1,49 @@ +from flask import abort, request +from flask_login import current_user +from app import db +from app.decorators import content_negotiation +from app.models import User, ProfilePrivacySettings +from . import bp + + +@bp.route('//settings/profile-privacy/is-public', methods=['PUT']) +@content_negotiation(consumes='application/json', produces='application/json') +def update_user_profile_privacy_setting_is_public(user_id): + user = User.query.get_or_404(user_id) + if not (user == current_user or current_user.is_administrator()): + abort(403) + enabled = request.json + if not isinstance(enabled, bool): + abort(400) + user.is_public = enabled + db.session.commit() + response_data = { + 'message': 'Profile privacy settings updated', + 'category': 'settings' + } + return response_data, 200 + + +@bp.route('//settings/profile-privacy/', methods=['PUT']) +@content_negotiation(consumes='application/json', produces='application/json') +def update_user_profile_privacy_settings(user_id, profile_privacy_setting_name): + user = User.query.get_or_404(user_id) + try: + profile_privacy_setting = ProfilePrivacySettings[profile_privacy_setting_name] + except KeyError: + abort(404) + if not (user == current_user or current_user.is_administrator()): + abort(403) + enabled = request.json + if not isinstance(enabled, bool): + abort(400) + if enabled: + user.add_profile_privacy_setting(profile_privacy_setting) + else: + user.remove_profile_privacy_setting(profile_privacy_setting) + db.session.commit() + response_data = { + 'message': 'Profile privacy settings updated', + 'category': 'settings' + } + return response_data, 200 diff --git a/app/users/settings/routes.py b/app/users/settings/routes.py new file mode 100644 index 00000000..68f0a303 --- /dev/null +++ b/app/users/settings/routes.py @@ -0,0 +1,96 @@ +from flask import abort, flash, g, redirect, render_template, url_for +from flask_breadcrumbs import register_breadcrumb +from flask_login import current_user +from app import db +from app.models import Avatar, User +from ..utils import user_endpoint_arguments_constructor as user_eac +from . import bp +from .forms import ( + UpdateAvatarForm, + UpdatePasswordForm, + UpdateNotificationsForm, + UpdateAccountInformationForm, + UpdateProfileInformationForm +) + + +@bp.route('//settings', methods=['GET', 'POST']) +@register_breadcrumb(bp, '.entity.settings', 'settingsSettings', endpoint_arguments_constructor=user_eac) +def settings(user_id): + user = User.query.get_or_404(user_id) + if not (user == current_user or current_user.is_administrator()): + abort(403) + + redirect_location_on_post = g.pop( + '_nopaque_redirect_location_on_post', + url_for('.settings', user_id=user_id) + ) + + update_account_information_form = UpdateAccountInformationForm(user) + update_profile_information_form = UpdateProfileInformationForm(user) + update_avatar_form = UpdateAvatarForm() + update_password_form = UpdatePasswordForm(user) + update_notifications_form = UpdateNotificationsForm(user) + + # region handle update profile information form + if update_profile_information_form.submit.data and update_profile_information_form.validate(): + user.about_me = update_profile_information_form.about_me.data + user.location = update_profile_information_form.location.data + user.organization = update_profile_information_form.organization.data + user.website = update_profile_information_form.website.data + user.full_name = update_profile_information_form.full_name.data + db.session.commit() + flash('Your changes have been saved') + return redirect(redirect_location_on_post) + # endregion handle update profile information form + + # region handle update avatar form + if update_avatar_form.submit.data and update_avatar_form.validate(): + try: + Avatar.create( + update_avatar_form.avatar.data, + user=user + ) + except (AttributeError, OSError): + abort(500) + db.session.commit() + flash('Your changes have been saved') + return redirect(redirect_location_on_post) + # endregion handle update avatar form + + # region handle update account information form + if update_account_information_form.submit.data and update_account_information_form.validate(): + user.email = update_account_information_form.email.data + user.username = update_account_information_form.username.data + db.session.commit() + flash('Profile settings updated') + return redirect(redirect_location_on_post) + # endregion handle update account information form + + # region handle update password form + if update_password_form.submit.data and update_password_form.validate(): + user.password = update_password_form.new_password.data + db.session.commit() + flash('Your changes have been saved') + return redirect(redirect_location_on_post) + # endregion handle update password form + + # region handle update notifications form + if update_notifications_form.submit.data and update_notifications_form.validate(): + user.setting_job_status_mail_notification_level = \ + update_notifications_form.job_status_mail_notification_level.data + db.session.commit() + flash('Your changes have been saved') + return redirect(redirect_location_on_post) + # endregion handle update notifications form + + return render_template( + 'users/settings/settings.html.j2', + title='Settings', + update_account_information_form=update_account_information_form, + update_avatar_form=update_avatar_form, + update_notifications_form=update_notifications_form, + update_password_form=update_password_form, + update_profile_information_form=update_profile_information_form, + user=user + ) diff --git a/app/users/utils.py b/app/users/utils.py new file mode 100644 index 00000000..5c1ca83e --- /dev/null +++ b/app/users/utils.py @@ -0,0 +1,17 @@ +from flask import request, url_for +from app.models import User + + +def user_endpoint_arguments_constructor(): + return {'user_id': request.view_args['user_id']} + + +def user_dynamic_list_constructor(): + user_id = request.view_args['user_id'] + user = User.query.get_or_404(user_id) + return [ + { + 'text': f'person{user.username}', + 'url': url_for('.user', user_id=user_id) + } + ] diff --git a/app/wtf_validators.py b/app/wtf_validators.py deleted file mode 100644 index 326ef7e7..00000000 --- a/app/wtf_validators.py +++ /dev/null @@ -1,9 +0,0 @@ -from wtforms.validators import ValidationError - -def FileSizeLimit(max_size_in_mb): - max_bytes = max_size_in_mb*1024*1024 - def file_length_check(form, field): - if len(field.data.read()) > max_bytes: - raise ValidationError(f"File size must be less than {max_size_in_mb}MB") - field.data.seek(0) - return file_length_check diff --git a/app/wtforms/__init__.py b/app/wtforms/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/app/wtforms/validators.py b/app/wtforms/validators.py new file mode 100644 index 00000000..bef95681 --- /dev/null +++ b/app/wtforms/validators.py @@ -0,0 +1,14 @@ +from wtforms.validators import ValidationError + + +def FileSize(max_size_mb): + max_size_b = max_size_mb * 1024 * 1024 + + def file_length_check(form, field): + if len(field.data.read()) >= max_size_b: + raise ValidationError( + f'File size must be less or equal than {max_size_mb} MB' + ) + field.data.seek(0) + + return file_length_check diff --git a/migrations/versions/03c7211f089d_.py b/migrations/versions/03c7211f089d_.py new file mode 100644 index 00000000..2f73e3aa --- /dev/null +++ b/migrations/versions/03c7211f089d_.py @@ -0,0 +1,42 @@ +"""empty message + +Revision ID: 03c7211f089d +Revises: 5fe6a6c7870c +Create Date: 2023-02-21 09:57:22.005883 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '03c7211f089d' +down_revision = '5fe6a6c7870c' +branch_labels = None +depends_on = None + + +def upgrade(): + op.alter_column( + 'corpus_follower_associations', + 'followed_corpus_id', + new_column_name='corpus_id' + ) + op.alter_column( + 'corpus_follower_associations', + 'following_user_id', + new_column_name='follower_id' + ) + + +def downgrade(): + op.alter_column( + 'corpus_follower_associations', + 'corpus_id', + new_column_name='followed_corpus_id' + ) + op.alter_column( + 'corpus_follower_associations', + 'follower_id', + new_column_name='following_user_id' + ) diff --git a/migrations/versions/1f77ce4346c6_.py b/migrations/versions/1f77ce4346c6_.py new file mode 100644 index 00000000..1d7e2160 --- /dev/null +++ b/migrations/versions/1f77ce4346c6_.py @@ -0,0 +1,72 @@ +"""empty message + +Revision ID: 1f77ce4346c6 +Revises: 03c7211f089d +Create Date: 2023-02-22 12:56:30.176665 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '1f77ce4346c6' +down_revision = '03c7211f089d' +branch_labels = None +depends_on = None + + +def upgrade(): + op.create_table( + 'corpus_follower_roles', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('name', sa.String(length=64), nullable=True), + sa.Column('default', sa.Boolean(), nullable=True), + sa.Column('permissions', sa.Integer(), nullable=True), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('name') + ) + op.create_index( + op.f('ix_corpus_follower_roles_default'), + 'corpus_follower_roles', + ['default'], + unique=False + ) + + op.add_column( + 'corpus_follower_associations', + sa.Column('role_id', sa.Integer(), nullable=True) + ) + op.create_foreign_key( + 'fk_corpus_follower_associations_role_id_corpus_follower_roles', + 'corpus_follower_associations', + 'corpus_follower_roles', + ['role_id'], + ['id'] + ) + op.drop_column('corpus_follower_associations', 'permissions') + + +def downgrade(): + op.add_column( + 'corpus_follower_associations', + sa.Column('permissions', sa.Integer(), nullable=True) + ) + op.execute('UPDATE corpus_follower_associations SET permissions = 0;') + op.alter_column( + 'corpus_follower_associations', + 'permissions', + nullable=False + ) + op.drop_constraint( + 'fk_corpus_follower_associations_role_id_corpus_follower_roles', + 'corpus_follower_associations', + type_='foreignkey' + ) + op.drop_column('corpus_follower_associations', 'role_id') + + op.drop_index( + op.f('ix_corpus_follower_roles_default'), + table_name='corpus_follower_roles' + ) + op.drop_table('corpus_follower_roles') diff --git a/migrations/versions/31dd42e5ea6f_.py b/migrations/versions/31dd42e5ea6f_.py index b4824c49..e597b36e 100644 --- a/migrations/versions/31dd42e5ea6f_.py +++ b/migrations/versions/31dd42e5ea6f_.py @@ -25,7 +25,7 @@ def upgrade(): if os.path.exists(spacy_nlp_pipeline_models_dir): if not os.path.isdir(spacy_nlp_pipeline_models_dir): raise OSError(f'Not a directory: {spacy_nlp_pipeline_models_dir}') - if not os.listdir(spacy_nlp_pipeline_models_dir): + if len(os.listdir(spacy_nlp_pipeline_models_dir)) > 0: raise OSError(f'Directory not empty: {spacy_nlp_pipeline_models_dir}') else: os.mkdir(spacy_nlp_pipeline_models_dir) diff --git a/migrations/versions/9e8d7d15d950_.py b/migrations/versions/9e8d7d15d950_.py index bb6e9fe9..290c722b 100644 --- a/migrations/versions/9e8d7d15d950_.py +++ b/migrations/versions/9e8d7d15d950_.py @@ -24,7 +24,7 @@ def upgrade(): if os.path.exists(users_dir): if not os.path.isdir(users_dir): raise OSError(f'Not a directory: {users_dir}') - if not os.listdir(users_dir): + if len(os.listdir(users_dir)) > 0: raise OSError(f'Directory not empty: {users_dir}') else: os.mkdir(users_dir) diff --git a/migrations/versions/b15b639288d4_.py b/migrations/versions/b15b639288d4_.py new file mode 100644 index 00000000..21c2a4d2 --- /dev/null +++ b/migrations/versions/b15b639288d4_.py @@ -0,0 +1,29 @@ +"""Add terms_of_use_accepted column to users table + +Revision ID: b15b639288d4 +Revises: 1f77ce4346c6 +Create Date: 2023-04-13 10:19:38.662996 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'b15b639288d4' +down_revision = '1f77ce4346c6' +branch_labels = None +depends_on = None + + +def upgrade(): + with op.batch_alter_table('users', schema=None) as batch_op: + batch_op.add_column(sa.Column('terms_of_use_accepted', sa.Boolean(), nullable=True)) + op.execute('UPDATE users SET terms_of_use_accepted = false;') + + # ### end Alembic commands ### + + +def downgrade(): + with op.batch_alter_table('users', schema=None) as batch_op: + batch_op.drop_column('terms_of_use_accepted') diff --git a/nopaque.py b/nopaque.py index 602954cc..bd9a9165 100644 --- a/nopaque.py +++ b/nopaque.py @@ -3,16 +3,16 @@ import eventlet eventlet.monkey_patch() -from app import cli, create_app, db, scheduler, socketio # noqa +from app import create_app, db, scheduler, socketio # noqa from app.models import ( Avatar, Corpus, CorpusFile, CorpusFollowerAssociation, + CorpusFollowerRole, Job, JobInput, JobResult, - Permission, Role, TesseractOCRPipelineModel, SpaCyNLPPipelineModel, @@ -23,28 +23,21 @@ from typing import Any, Dict # noqa app: Flask = create_app() -cli.register(app) - - -@app.context_processor -def make_context() -> Dict[str, Any]: - ''' Adds variables to the template context. ''' - return {'Permission': Permission} @app.shell_context_processor def make_shell_context() -> Dict[str, Any]: ''' Adds variables to the shell context. ''' return { + 'db': db, 'Avatar': Avatar, 'Corpus': Corpus, 'CorpusFile': CorpusFile, 'CorpusFollowerAssociation': CorpusFollowerAssociation, - 'db': db, + 'CorpusFollowerRole': CorpusFollowerRole, 'Job': Job, 'JobInput': JobInput, 'JobResult': JobResult, - 'Permission': Permission, 'Role': Role, 'TesseractOCRPipelineModel': TesseractOCRPipelineModel, 'SpaCyNLPPipelineModel': SpaCyNLPPipelineModel, diff --git a/requirements.txt b/requirements.txt index 838cee8f..404b9e87 100644 --- a/requirements.txt +++ b/requirements.txt @@ -6,10 +6,12 @@ eventlet Flask==2.1.3 Flask-APScheduler Flask-Assets +Flask-Breadcrumbs Flask-Hashids==1.0.1 Flask-HTTPAuth Flask-Login Flask-Mail +flask-marshmallow==0.14.0 Flask-Migrate Flask-Paranoid Flask-SocketIO @@ -17,7 +19,7 @@ Flask-SQLAlchemy==2.5.1 Flask-WTF hiredis MarkupSafe==2.0.1 -marshmallow-sqlalchemy +marshmallow-sqlalchemy==0.29.0 psycopg2 PyJWT pyScss