almet/ihatemoney
1
0
Fork 0
mirror of https://github.com/spiral-project/ihatemoney.git synced 2025-04-28 09:22:38 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Display admin email in error message for password reminder (#965)

Browse source 
Co-authored-by: Glandos <bugs-github@antipoul.fr>
This commit is contained in:
Peter Maksymowsky 2022-01-30 09:33:54 -05:00 committed by GitHub
parent 7c3ced06f8
commit a5452ccee5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 56 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
Dockerfile
View file

@ -14,7 +14,7 @@ ENV DEBUG="False" \
ALLOW_PUBLIC_PROJECT_CREATION="True" \
BABEL_DEFAULT_TIMEZONE="UTC" \
GREENLET_TEST_CPP="no" \
MAIL_DEFAULT_SENDER="('Budget manager', 'budget@notmyidea.org')" \
MAIL_DEFAULT_SENDER="('Budget manager', 'admin@example.com')" \
MAIL_PASSWORD="" \
MAIL_PORT="25" \
MAIL_SERVER="localhost" \
@ -23,6 +23,7 @@ ENV DEBUG="False" \
MAIL_USERNAME="" \
SECRET_KEY="tralala" \
SESSION_COOKIE_SECURE="True" \
SHOW_ADMIN_EMAIL="True" \
SQLALCHEMY_DATABASE_URI="sqlite:////database/ihatemoney.db" \
SQLALCHEMY_TRACK_MODIFICATIONS="False" \
ENABLE_CAPTCHA="False" \

1
conf/entrypoint.sh
View file

@ -19,6 +19,7 @@ MAIL_USE_TLS = $MAIL_USE_TLS
MAIL_USERNAME = "$MAIL_USERNAME"
SECRET_KEY = "$SECRET_KEY"
SESSION_COOKIE_SECURE = $SESSION_COOKIE_SECURE
SHOW_ADMIN_EMAIL = $SHOW_ADMIN_EMAIL
SQLACHEMY_DEBUG = DEBUG
SQLALCHEMY_DATABASE_URI = "$SQLALCHEMY_DATABASE_URI"
SQLALCHEMY_TRACK_MODIFICATIONS = $SQLALCHEMY_TRACK_MODIFICATIONS

3
docker-compose.yml
View file

@ -13,7 +13,7 @@ services:
- ALLOW_PUBLIC_PROJECT_CREATION=True
- BABEL_DEFAULT_TIMEZONE=UTC
- GREENLET_TEST_CPP=no
- MAIL_DEFAULT_SENDER=('Budget manager', 'budget@notmyidea.org')
- MAIL_DEFAULT_SENDER=('Budget manager', 'admin@example.com')
- MAIL_PASSWORD=
- MAIL_PORT=25
- MAIL_SERVER=localhost
@ -22,6 +22,7 @@ services:
- MAIL_USERNAME=
- SECRET_KEY=tralala
- SESSION_COOKIE_SECURE=True
- SHOW_ADMIN_EMAIL=True
- SQLALCHEMY_DATABASE_URI=sqlite:////database/ihatemoney.db
- SQLALCHEMY_TRACK_MODIFICATIONS=False
- ENABLE_CAPTCHA=False

12
docs/configuration.md
View file

@ -79,9 +79,19 @@ for details.
A python tuple describing the name and email address to use when sending
emails.
- **Default value:** `("Budget manager", "budget@notmyidea.org")`
- **Default value:** `("Budget manager", "admin@example.com")`
- **Production value:** Any tuple you want.
## SHOW_ADMIN_EMAIL
A boolean that determines whether the admin email (`MAIL_DEFAULT_SENDER`) is
shown in error messages. This also needs `MAIL_DEFAULT_SENDER` to be set to a
non default value to show it in the error messages.
- **Default value:** `True`
- **Production value:** Usually `True` unless you don't want the admin
email to be shown for privacy reasons.
## ACTIVATE_DEMO_PROJECT
If set to `True`, a demo project will be available on the frontpage.

6
ihatemoney/conf-templates/ihatemoney.cfg.j2
View file

@ -19,7 +19,11 @@ SQLALCHEMY_TRACK_MODIFICATIONS = False
SECRET_KEY = "{{ secret_key }}"
# A python tuple describing the name and email adress of the sender of the mails.
MAIL_DEFAULT_SENDER = ("Budget manager", "budget@notmyidea.org") # CUSTOMIZE
MAIL_DEFAULT_SENDER = ("Budget manager", "admin@example.com") # CUSTOMIZE
# A boolean that determines whether the admin email (MAIL_DEFAULT_SENDER) is
# shown in error messages.
SHOW_ADMIN_EMAIL = True
# If set to True, a demonstration project will be activated.
ACTIVATE_DEMO_PROJECT = True

3
ihatemoney/default_settings.py
View file

@ -3,7 +3,8 @@ DEBUG = SQLACHEMY_ECHO = False
SQLALCHEMY_DATABASE_URI = "sqlite:////tmp/ihatemoney.db"
SQLALCHEMY_TRACK_MODIFICATIONS = False
SECRET_KEY = "tralala"
MAIL_DEFAULT_SENDER = ("Budget manager", "budget@notmyidea.org")
MAIL_DEFAULT_SENDER = ("Budget manager", "admin@example.com")
SHOW_ADMIN_EMAIL = True
ACTIVATE_DEMO_PROJECT = True
ADMIN_PASSWORD = ""
ALLOW_PUBLIC_PROJECT_CREATION = True

2
ihatemoney/tests/ihatemoney.cfg
View file

@ -6,4 +6,4 @@ SQLACHEMY_ECHO = DEBUG
SECRET_KEY = "supersecret"
MAIL_DEFAULT_SENDER = ("Budget manager", "budget@notmyidea.org")
MAIL_DEFAULT_SENDER = ("Budget manager", "admin@example.com")

2
ihatemoney/tests/ihatemoney_envvar.cfg
View file

@ -6,4 +6,4 @@ SQLACHEMY_ECHO = DEBUG
SECRET_KEY = "lalatra"
MAIL_DEFAULT_SENDER = ("Budget manager", "budget@notmyidea.org")
MAIL_DEFAULT_SENDER = ("Budget manager", "admin@example.com")

2
ihatemoney/tests/main_test.py
View file

@ -26,7 +26,7 @@ class ConfigurationTestCase(BaseTestCase):
self.assertFalse(self.app.config["SQLALCHEMY_TRACK_MODIFICATIONS"])
self.assertEqual(
self.app.config["MAIL_DEFAULT_SENDER"],
("Budget manager", "budget@notmyidea.org"),
("Budget manager", "admin@example.com"),
)
self.assertTrue(self.app.config["ACTIVATE_DEMO_PROJECT"])
self.assertTrue(self.app.config["ALLOW_PUBLIC_PROJECT_CREATION"])

22
ihatemoney/utils.py
View file

@ -12,7 +12,7 @@ import socket
from babel import Locale
from babel.numbers import get_currency_name, get_currency_symbol
from flask import current_app, redirect, render_template
from flask import current_app, flash, redirect, render_template
from flask_babel import get_locale, lazy_gettext as _
import jinja2
from markupsafe import Markup, escape
@ -48,6 +48,26 @@ def send_email(mail_message):
return True
def flash_email_error(error_message, category="danger"):
"""Helper to flash a message for email errors. It will also show the
admin email as a contact if MAIL_DEFAULT_SENDER is set to not the
default value and SHOW_ADMIN_EMAIL is True.
"""
(admin_name, admin_email) = current_app.config.get("MAIL_DEFAULT_SENDER")
error_extension = "."
if admin_email != "admin@example.com" and current_app.config.get(
"SHOW_ADMIN_EMAIL"
):
error_extension = f" or contact the administrator at {admin_email}."
flash(
_(
f"{error_message} Please check the email configuration of the server{error_extension}"
),
category=category,
)
class Redirect303(HTTPException, RoutingException):
"""Raise if the map requests a redirect. This is for example the case if

29
ihatemoney/web.py
View file

@ -55,6 +55,7 @@ from ihatemoney.utils import (
LoginThrottler,
Redirect303,
csv2list_of_dicts,
flash_email_error,
format_form_errors,
list_of_dicts2csv,
list_of_dicts2json,
@ -329,11 +330,9 @@ def create_project():
else:
# Display the error as a simple "info" alert, because it's
# not critical and doesn't prevent using the project.
flash(
_(
"We tried to send you an reminder email, but there was an error. "
"You can still use the project normally."
),
flash_email_error(
"We tried to send you an reminder email, but there was an error. "
"You can still use the project normally.",
category="info",
)
return redirect(url_for(".list_bills", project_id=project.id))
@ -358,14 +357,9 @@ def remind_password():
if success:
return redirect(url_for(".password_reminder_sent"))
else:
flash(
_(
"Sorry, there was an error while sending you an email "
"with password reset instructions. "
"Please check the email configuration of the server "
"or contact the administrator."
),
category="danger",
flash_email_error(
"Sorry, there was an error while sending you an email with "
"password reset instructions."
)
# Fall-through: we stay on the same page and display the form again
return render_template("password_reminder.html", form=form)
@ -588,13 +582,8 @@ def invite():
flash(_("Your invitations have been sent"), category="success")
return redirect(url_for(".list_bills"))
else:
flash(
_(
"Sorry, there was an error while trying to send the invitation emails. "
"Please check the email configuration of the server "
"or contact the administrator."
),
category="danger",
flash_email_error(
"Sorry, there was an error while trying to send the invitation emails."
)
# Fall-through: we stay on the same page and display the form again
return render_template("send_invites.html", form=form)