From 4c05c6cc18b4973bb158f978517eccb179fa7f75 Mon Sep 17 00:00:00 2001
From: Inga Kirschnick <inga.kirschnick@uni-bielefeld.de>
Date: Mon, 13 Mar 2023 15:04:44 +0100
Subject: [PATCH] merge settings into users route
---
app/__init__.py | 3 -
app/admin/routes.py | 2 +-
app/settings/__init__.py | 5 --
app/settings/forms.py | 43 -----------
app/settings/routes.py | 39 ----------
app/templates/_navbar.html.j2 | 3 +-
app/templates/_sidenav.html.j2 | 3 +-
app/templates/settings/_breadcrumbs.html.j2 | 6 --
app/templates/settings/settings.html.j2 | 84 ---------------------
app/templates/users/edit_profile.html.j2 | 77 +++++++++++++++++--
app/templates/users/edit_profile.js.j2 | 5 ++
app/users/forms.py | 43 ++++++++++-
app/users/routes.py | 36 ++++++++-
13 files changed, 157 insertions(+), 192 deletions(-)
delete mode 100644 app/settings/__init__.py
delete mode 100644 app/settings/forms.py
delete mode 100644 app/settings/routes.py
delete mode 100644 app/templates/settings/_breadcrumbs.html.j2
delete mode 100644 app/templates/settings/settings.html.j2
diff --git a/app/__init__.py b/app/__init__.py
index dcb58e47..09e479a8 100644
--- a/app/__init__.py
+++ b/app/__init__.py
@@ -81,9 +81,6 @@ def create_app(config: Config = Config) -> Flask:
from .services import bp as services_blueprint
app.register_blueprint(services_blueprint, url_prefix='/services')
- from .settings import bp as settings_blueprint
- app.register_blueprint(settings_blueprint, url_prefix='/settings')
-
from .users import bp as users_blueprint
app.register_blueprint(users_blueprint, url_prefix='/users')
diff --git a/app/admin/routes.py b/app/admin/routes.py
index 08f219ab..95ce7730 100644
--- a/app/admin/routes.py
+++ b/app/admin/routes.py
@@ -4,7 +4,7 @@ from threading import Thread
from app import db, hashids
from app.decorators import admin_required
from app.models import Role, User, UserSettingJobStatusMailNotificationLevel
-from app.settings.forms import (
+from app.users.forms import (
EditNotificationSettingsForm
)
from app.users.forms import EditProfileSettingsForm
diff --git a/app/settings/__init__.py b/app/settings/__init__.py
deleted file mode 100644
index 1dab5142..00000000
--- a/app/settings/__init__.py
+++ /dev/null
@@ -1,5 +0,0 @@
-from flask import Blueprint
-
-
-bp = Blueprint('settings', __name__)
-from . import routes # noqa
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
deleted file mode 100644
index a07869b8..00000000
--- a/app/settings/routes.py
+++ /dev/null
@@ -1,39 +0,0 @@
-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 . import bp
-from .forms import ChangePasswordForm, EditNotificationSettingsForm
-
-
-@bp.route('', methods=['GET', 'POST'])
-@login_required
-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'
- )
diff --git a/app/templates/_navbar.html.j2 b/app/templates/_navbar.html.j2
index d943c0e4..c4c4d3b7 100644
--- a/app/templates/_navbar.html.j2
+++ b/app/templates/_navbar.html.j2
@@ -29,8 +29,7 @@
<ul class="dropdown-content" id="nav-more-dropdown">
<li><a href="{{ url_for('main.user_manual') }}"><i class="material-icons left">help</i>Manual</a></li>
{% if current_user.is_authenticated %}
- <li><a href="{{ url_for('settings.settings') }}"><i class="material-icons left">settings</i>General settings</a></li>
- <li><a href="{{ url_for('users.edit_profile', user_id=current_user.id) }}"><i class="material-icons left">contact_page</i>Profile settings</a></li>
+ <li><a href="{{ url_for('users.edit_profile', user_id=current_user.id) }}"><i class="material-icons left">settings</i>User settings</a></li>
<li class="divider" tabindex="-1"></li>
<li><a href="{{ url_for('auth.logout') }}">Log out</a></li>
{% else %}
diff --git a/app/templates/_sidenav.html.j2 b/app/templates/_sidenav.html.j2
index 2d55999a..0d955fe5 100644
--- a/app/templates/_sidenav.html.j2
+++ b/app/templates/_sidenav.html.j2
@@ -38,8 +38,7 @@
<li class="service-color service-color-border border-darken" data-service="corpus-analysis" style="border-left: 10px solid; margin-top: 5px;"><a href="{{ url_for('services.corpus_analysis') }}"><i class="nopaque-icons service-icons" data-service="corpus-analysis"></i>Corpus analysis</a></li>
<li><div class="divider"></div></li>
<li><a class="subheader">Account</a></li>
- <li><a href="{{ url_for('settings.settings') }}"><i class="material-icons">settings</i>General Settings</a></li>
- <li><a href="{{ url_for('users.edit_profile', user_id=current_user.id) }}"><i class="material-icons left">contact_page</i>Profile Settings</a></li>
+ <li><a href="{{ url_for('users.edit_profile', user_id=current_user.id) }}"><i class="material-icons left">settings</i>User Settings</a></li>
<li><a href="{{ url_for('auth.logout') }}">Log out</a></li>
{% if current_user.can('ADMINISTRATE') or current_user.can('USE_API') %}
<li><div class="divider"></div></li>
diff --git a/app/templates/settings/_breadcrumbs.html.j2 b/app/templates/settings/_breadcrumbs.html.j2
deleted file mode 100644
index 3b5077bf..00000000
--- a/app/templates/settings/_breadcrumbs.html.j2
+++ /dev/null
@@ -1,6 +0,0 @@
-{% set breadcrumbs %}
-<li class="tab disabled"><i class="material-icons">navigate_next</i></li>
-{% if request.path == url_for('settings.settings') %}
-<li class="tab"><a{%if request.path == url_for('settings.settings') %} class="active"{% endif %} href="{{ url_for('settings.settings') }}" target="_self">Settings</a></li>
-{% endif %}
-{% endset %}
diff --git a/app/templates/settings/settings.html.j2 b/app/templates/settings/settings.html.j2
deleted file mode 100644
index 9210d36f..00000000
--- a/app/templates/settings/settings.html.j2
+++ /dev/null
@@ -1,84 +0,0 @@
-{% extends "base.html.j2" %}
-{% from "settings/_breadcrumbs.html.j2" import breadcrumbs with context %}
-{% import "materialize/wtf.html.j2" as wtf %}
-
-{% block page_content %}
-<div class="container">
- <div class="row">
- <div class="col s12">
- <h1 id="title">{{ title }}</h1>
- </div>
- <div class="col s12">
- <form method="POST">
- {{ edit_notification_settings_form.hidden_tag() }}
- <div class="card">
- <div class="card-content">
- <span class="card-title">Notification settings</span>
- {{ wtf.render_field(edit_notification_settings_form.job_status_mail_notification_level, material_icon='notifications') }}
- </div>
- <div class="card-action">
- <div class="right-align">
- {{ wtf.render_field(edit_notification_settings_form.submit, material_icon='send') }}
- </div>
- </div>
- </div>
- </form>
-
- <form method="POST">
- {{ change_password_form.hidden_tag() }}
- <div class="card">
- <div class="card-content">
- <span class="card-title">Change Password</span>
- {{ wtf.render_field(change_password_form.password, material_icon='vpn_key') }}
- {{ wtf.render_field(change_password_form.new_password, material_icon='vpn_key') }}
- {{ wtf.render_field(change_password_form.new_password_2, material_icon='vpn_key') }}
- </div>
- <div class="card-action">
- <div class="right-align">
- {{ wtf.render_field(change_password_form.submit, material_icon='send') }}
- </div>
- </div>
- </div>
- </form>
-
- <div class="card">
- <div class="card-content">
- <span class="card-title">Delete account</span>
- <p>Deleting an account has the following effects:</p>
- <ul>
- <li>All data associated with your corpora and jobs will be permanently deleted.</li>
- <li>All settings will be permanently deleted.</li>
- </ul>
- </div>
- <div class="card-action right-align">
- <a class="btn red waves-effect waves-light modal-trigger" href="#delete-user"><i class="material-icons left">delete</i>Delete</a>
- </div>
- </div>
- </div>
- </div>
-</div>
-{% endblock page_content %}
-
-{% block modals%}
-<div class="modal" id="delete-user">
- <div class="modal-content">
- <h4>Confirm User deletion</h4>
- <p>Do you really want to delete the User <b>{{ current_user.username }}</b>? All files will be permanently deleted!</p>
- </div>
- <div class="modal-footer">
- <a class="btn modal-close waves-effect waves-light">Cancel</a>
- <a class="btn modal-close red waves-effect waves-light" id="delete-user-button">Delete</a>
- </div>
-</div>
-{% endblock modals %}
-
-{% block scripts %}
-{{ super() }}
-<script>
-document.querySelector('#delete-user-button').addEventListener('click', (event) => {
- Requests.users.entity.delete(currentUserId)
- .then((response) => {window.location.href = '/';});
-});
-
-</script>
-{% endblock scripts %}
diff --git a/app/templates/users/edit_profile.html.j2 b/app/templates/users/edit_profile.html.j2
index 1b2ef3f9..5861a969 100644
--- a/app/templates/users/edit_profile.html.j2
+++ b/app/templates/users/edit_profile.html.j2
@@ -7,10 +7,11 @@
<div class="col s12">
<h1 id="title">{{ title }}</h1>
</div>
-
- <div class="col s12">
+ </div>
+ <div class="row">
+ <div class="col s12 m9 l10">
- <div class="card">
+ <div id="user-settings" class="card section scrollspy">
<form method="POST" enctype="multipart/form-data">
<div class="card-content">
<div class="row">
@@ -31,7 +32,7 @@
<form method="POST">
{{ edit_privacy_settings_form.hidden_tag() }}
- <div class="card">
+ <div id="privacy-settings" class="card section scrollspy">
<div class="card-content">
<span class="card-title">Privacy settings</span>
<br>
@@ -54,7 +55,7 @@
</div>
</form>
- <div class="card">
+ <div id="public-profile-settings" class="card section scrollspy">
<form method="POST" enctype="multipart/form-data">
<div class="card-content">
{{ edit_public_profile_information_form.hidden_tag() }}
@@ -106,6 +107,62 @@
</form>
</div>
+ <form method="POST">
+ {{ edit_notification_settings_form.hidden_tag() }}
+ <div id="notification-settings" class="card section scrollspy">
+ <div class="card-content">
+ <span class="card-title">Notification settings</span>
+ {{ wtf.render_field(edit_notification_settings_form.job_status_mail_notification_level, material_icon='notifications') }}
+ </div>
+ <div class="card-action">
+ <div class="right-align">
+ {{ wtf.render_field(edit_notification_settings_form.submit, material_icon='send') }}
+ </div>
+ </div>
+ </div>
+ </form>
+
+ <form method="POST">
+ {{ change_password_form.hidden_tag() }}
+ <div id="change-password" class="card section scrollspy">
+ <div class="card-content">
+ <span class="card-title">Change Password</span>
+ {{ wtf.render_field(change_password_form.password, material_icon='vpn_key') }}
+ {{ wtf.render_field(change_password_form.new_password, material_icon='vpn_key') }}
+ {{ wtf.render_field(change_password_form.new_password_2, material_icon='vpn_key') }}
+ </div>
+ <div class="card-action">
+ <div class="right-align">
+ {{ wtf.render_field(change_password_form.submit, material_icon='send') }}
+ </div>
+ </div>
+ </div>
+ </form>
+
+ <div id="delete-account" class="card section scrollspy">
+ <div class="card-content">
+ <span class="card-title">Delete account</span>
+ <p>Deleting an account has the following effects:</p>
+ <ul>
+ <li>All data associated with your corpora and jobs will be permanently deleted.</li>
+ <li>All settings will be permanently deleted.</li>
+ </ul>
+ </div>
+ <div class="card-action right-align">
+ <a class="btn red waves-effect waves-light modal-trigger" href="#delete-user"><i class="material-icons left">delete</i>Delete</a>
+ </div>
+ </div>
+
+ </div>
+ <div class="col hide-on-small-only m3 l2">
+ <ul class="section table-of-contents" style="position: fixed !important;">
+ <li><a href="#user-settings">User Settings</a></li>
+ <li><a href="#privacy-settings">Privacy Settings</a></li>
+ <li><a href="#public-profile-settings">Public Profile Settings</a></li>
+ <li><a href="#notification-settings">Notification Settings</a></li>
+ <li><a href="#change-password">Change Password</a></li>
+ <li><a href="#delete-account">Delete Account</a></li>
+ </ul>
</div>
</div>
</div>
@@ -122,4 +179,14 @@
<a class="btn modal-close red waves-effect waves-light" id="delete-avatar">Delete</a>
</div>
</div>
+<div class="modal" id="delete-user">
+ <div class="modal-content">
+ <h4>Confirm User deletion</h4>
+ <p>Do you really want to delete the User <b>{{ current_user.username }}</b>? All files will be permanently deleted!</p>
+ </div>
+ <div class="modal-footer">
+ <a class="btn modal-close waves-effect waves-light">Cancel</a>
+ <a class="btn modal-close red waves-effect waves-light" id="delete-user-button">Delete</a>
+ </div>
+</div>
{% endblock modals %}
diff --git a/app/templates/users/edit_profile.js.j2 b/app/templates/users/edit_profile.js.j2
index a5058d85..a56effae 100644
--- a/app/templates/users/edit_profile.js.j2
+++ b/app/templates/users/edit_profile.js.j2
@@ -34,3 +34,8 @@ deleteButton.addEventListener('click', () => {
}
);
});
+
+document.querySelector('#delete-user-button').addEventListener('click', (event) => {
+ Requests.users.entity.delete(currentUserId)
+ .then((response) => {window.location.href = '/';});
+});
diff --git a/app/users/forms.py b/app/users/forms.py
index 5fd5d81e..af0e1984 100644
--- a/app/users/forms.py
+++ b/app/users/forms.py
@@ -2,6 +2,8 @@ from flask_wtf import FlaskForm
from wtforms import (
BooleanField,
FileField,
+ PasswordField,
+ SelectField,
StringField,
SubmitField,
TextAreaField,
@@ -10,10 +12,11 @@ from wtforms import (
from wtforms.validators import (
DataRequired,
Email,
+ EqualTo,
Length,
Regexp
)
-from app.models import User
+from app.models import User, UserSettingJobStatusMailNotificationLevel
from app.auth import USERNAME_REGEX
from app.wtf_validators import FileSizeLimit
@@ -98,3 +101,41 @@ class EditPrivacySettingsForm(FlaskForm):
show_last_seen = BooleanField('Show last seen')
show_member_since = BooleanField('Show member since')
submit = SubmitField()
+
+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/users/routes.py b/app/users/routes.py
index 5d8ff266..82d37247 100644
--- a/app/users/routes.py
+++ b/app/users/routes.py
@@ -16,6 +16,8 @@ from app import db
from app.models import Avatar, Corpus, ProfilePrivacySettings, User
from . import bp
from .forms import (
+ ChangePasswordForm,
+ EditNotificationSettingsForm,
EditPrivacySettingsForm,
EditProfileSettingsForm,
EditPublicProfileInformationForm
@@ -74,6 +76,7 @@ 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)
+ # region forms
edit_profile_settings_form = EditProfileSettingsForm(
current_user,
data=current_user.to_json_serializeable(),
@@ -87,12 +90,24 @@ def edit_profile(user_id):
data=current_user.to_json_serializeable(),
prefix='edit-public-profile-information-form'
)
+ 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'
+ )
+ # endregion forms
+ # region handle edit profile settings 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))
+ # endregion handle edit profile settings form
+ # region handle edit privacy settings form
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:
@@ -110,7 +125,9 @@ def edit_profile(user_id):
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():
+ # endregion handle edit privacy settings form
+ # region handle edit public profile information form
+ if edit_public_profile_information_form.submit.data and edit_public_profile_information_form.validate():
if edit_public_profile_information_form.avatar.data:
try:
Avatar.create(edit_public_profile_information_form.avatar.data, user=current_user)
@@ -124,11 +141,28 @@ def edit_profile(user_id):
db.session.commit()
flash('Profile settings updated')
return redirect(url_for('.user', user_id=user.id))
+ # endregion handle edit public profile information 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('.edit_profile', user_id=user.id))
+ # 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('.edit_profile', user_id=user.id))
+ # endregion handle edit_notification_settings_form POST
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,
+ change_password_form=change_password_form,
+ edit_notification_settings_form=edit_notification_settings_form,
user=user,
title='Edit Profile'
)
--
GitLab