From 1fcf0e677b691f7c07189a7757ae79668dc0ec41 Mon Sep 17 00:00:00 2001 From: Cédric Bonhomme Date: Sun, 10 Apr 2016 13:49:05 +0200 Subject: Moved notifications module. --- src/notifications/emails.py | 102 +++++++++++++++++++++++++++++++++++++ src/notifications/notifications.py | 67 ++++++++++++++++++++++++ src/web/emails.py | 102 ------------------------------------- src/web/notifications.py | 67 ------------------------ src/web/views/session_mgmt.py | 2 +- src/web/views/user.py | 3 +- 6 files changed, 172 insertions(+), 171 deletions(-) create mode 100644 src/notifications/emails.py create mode 100644 src/notifications/notifications.py delete mode 100644 src/web/emails.py delete mode 100644 src/web/notifications.py diff --git a/src/notifications/emails.py b/src/notifications/emails.py new file mode 100644 index 00000000..5fb5ce01 --- /dev/null +++ b/src/notifications/emails.py @@ -0,0 +1,102 @@ +#! /usr/bin/env python +# -*- coding: utf-8 -*- + +# JARR - A Web based news aggregator. +# Copyright (C) 2010-2016 Cédric Bonhomme - https://www.cedricbonhomme.org +# +# For more information : https://github.com/JARR-aggregator/JARR/ +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + +import logging +import smtplib +from email.mime.multipart import MIMEMultipart +from email.mime.text import MIMEText + +from postmark import PMMail + +import conf +from web.decorators import async + +logger = logging.getLogger(__name__) + + +@async +def send_async_email(mfrom, mto, msg): + try: + s = smtplib.SMTP(conf.NOTIFICATION_HOST) + s.login(conf.NOTIFICATION_USERNAME, conf.NOTIFICATION_PASSWORD) + except Exception: + logger.exception('send_async_email raised:') + else: + s.sendmail(mfrom, mto, msg.as_string()) + s.quit() + +def send(*args, **kwargs): + """ + This functions enables to send email through Postmark + or a SMTP server. + """ + if conf.ON_HEROKU: + send_postmark(**kwargs) + else: + send_smtp(**kwargs) + +def send_smtp(to="", bcc="", subject="", plaintext="", html=""): + """ + Send an email. + """ + # Create message container - the correct MIME type is multipart/alternative. + msg = MIMEMultipart('alternative') + msg['Subject'] = subject + msg['From'] = conf.NOTIFICATION_EMAIL + msg['To'] = to + msg['BCC'] = bcc + + # Record the MIME types of both parts - text/plain and text/html. + part1 = MIMEText(plaintext, 'plain', 'utf-8') + part2 = MIMEText(html, 'html', 'utf-8') + + # Attach parts into message container. + # According to RFC 2046, the last part of a multipart message, in this case + # the HTML message, is best and preferred. + msg.attach(part1) + msg.attach(part2) + + try: + s = smtplib.SMTP(conf.NOTIFICATION_HOST) + s.login(conf.NOTIFICATION_USERNAME, conf.NOTIFICATION_PASSWORD) + except Exception: + logger.exception("send_smtp raised:") + else: + s.sendmail(conf.NOTIFICATION_EMAIL, msg['To'] + ", " + msg['BCC'], msg.as_string()) + s.quit() + +def send_postmark(to="", bcc="", subject="", plaintext=""): + """ + Send an email via Postmark. Used when the application is deployed on + Heroku. + """ + try: + message = PMMail(api_key = conf.POSTMARK_API_KEY, + subject = subject, + sender = conf.NOTIFICATION_EMAIL, + text_body = plaintext) + message.to = to + if bcc != "": + message.bcc = bcc + message.send() + except Exception as e: + logger.exception("send_postmark raised:") + raise e diff --git a/src/notifications/notifications.py b/src/notifications/notifications.py new file mode 100644 index 00000000..86486074 --- /dev/null +++ b/src/notifications/notifications.py @@ -0,0 +1,67 @@ +#! /usr/bin/env python +# -*- coding: utf-8 -*- + +# JARR - A Web based news aggregator. +# Copyright (C) 2010-2016 Cédric Bonhomme - https://www.cedricbonhomme.org +# +# For more information : https://github.com/JARR-aggregator/JARR/ +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + +import datetime +from flask import render_template +import conf +from notifications import emails +from web.lib.user_utils import generate_confirmation_token + + +def information_message(subject, plaintext): + """ + Send an information message to the users of the platform. + """ + from web.models import User + users = User.query.all() + # Only send email for activated accounts. + user_emails = [user.email for user in users if user.enabled] + # Postmark has a limit of twenty recipients per message in total. + for i in xrange(0, len(user_emails), 19): + emails.send(to=conf.NOTIFICATION_EMAIL, + bcc=", ".join(user_emails[i:i+19]), + subject=subject, plaintext=plaintext) + +def new_account_notification(user): + """ + Account creation notification. + """ + token = generate_confirmation_token(user.email) + expire_time = datetime.datetime.now() + \ + datetime.timedelta(seconds=conf.TOKEN_VALIDITY_PERIOD) + + plaintext = render_template('emails/account_activation.txt', + user=user, platform_url=conf.PLATFORM_URL, + token=token, + expire_time=expire_time) + + emails.send(to=user.email, bcc=conf.NOTIFICATION_EMAIL, + subject="[JARR] Account creation", plaintext=plaintext) + +def new_password_notification(user, password): + """ + New password notification. + """ + plaintext = render_template('emails/new_password.txt', + user=user, password=password) + emails.send(to=user.email, + bcc=conf.NOTIFICATION_EMAIL, + subject="[JARR] New password", plaintext=plaintext) diff --git a/src/web/emails.py b/src/web/emails.py deleted file mode 100644 index 5fb5ce01..00000000 --- a/src/web/emails.py +++ /dev/null @@ -1,102 +0,0 @@ -#! /usr/bin/env python -# -*- coding: utf-8 -*- - -# JARR - A Web based news aggregator. -# Copyright (C) 2010-2016 Cédric Bonhomme - https://www.cedricbonhomme.org -# -# For more information : https://github.com/JARR-aggregator/JARR/ -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Affero General Public License as -# published by the Free Software Foundation, either version 3 of the -# License, or (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU Affero General Public License for more details. -# -# You should have received a copy of the GNU Affero General Public License -# along with this program. If not, see . - -import logging -import smtplib -from email.mime.multipart import MIMEMultipart -from email.mime.text import MIMEText - -from postmark import PMMail - -import conf -from web.decorators import async - -logger = logging.getLogger(__name__) - - -@async -def send_async_email(mfrom, mto, msg): - try: - s = smtplib.SMTP(conf.NOTIFICATION_HOST) - s.login(conf.NOTIFICATION_USERNAME, conf.NOTIFICATION_PASSWORD) - except Exception: - logger.exception('send_async_email raised:') - else: - s.sendmail(mfrom, mto, msg.as_string()) - s.quit() - -def send(*args, **kwargs): - """ - This functions enables to send email through Postmark - or a SMTP server. - """ - if conf.ON_HEROKU: - send_postmark(**kwargs) - else: - send_smtp(**kwargs) - -def send_smtp(to="", bcc="", subject="", plaintext="", html=""): - """ - Send an email. - """ - # Create message container - the correct MIME type is multipart/alternative. - msg = MIMEMultipart('alternative') - msg['Subject'] = subject - msg['From'] = conf.NOTIFICATION_EMAIL - msg['To'] = to - msg['BCC'] = bcc - - # Record the MIME types of both parts - text/plain and text/html. - part1 = MIMEText(plaintext, 'plain', 'utf-8') - part2 = MIMEText(html, 'html', 'utf-8') - - # Attach parts into message container. - # According to RFC 2046, the last part of a multipart message, in this case - # the HTML message, is best and preferred. - msg.attach(part1) - msg.attach(part2) - - try: - s = smtplib.SMTP(conf.NOTIFICATION_HOST) - s.login(conf.NOTIFICATION_USERNAME, conf.NOTIFICATION_PASSWORD) - except Exception: - logger.exception("send_smtp raised:") - else: - s.sendmail(conf.NOTIFICATION_EMAIL, msg['To'] + ", " + msg['BCC'], msg.as_string()) - s.quit() - -def send_postmark(to="", bcc="", subject="", plaintext=""): - """ - Send an email via Postmark. Used when the application is deployed on - Heroku. - """ - try: - message = PMMail(api_key = conf.POSTMARK_API_KEY, - subject = subject, - sender = conf.NOTIFICATION_EMAIL, - text_body = plaintext) - message.to = to - if bcc != "": - message.bcc = bcc - message.send() - except Exception as e: - logger.exception("send_postmark raised:") - raise e diff --git a/src/web/notifications.py b/src/web/notifications.py deleted file mode 100644 index f10cff73..00000000 --- a/src/web/notifications.py +++ /dev/null @@ -1,67 +0,0 @@ -#! /usr/bin/env python -# -*- coding: utf-8 -*- - -# JARR - A Web based news aggregator. -# Copyright (C) 2010-2016 Cédric Bonhomme - https://www.cedricbonhomme.org -# -# For more information : https://github.com/JARR-aggregator/JARR/ -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Affero General Public License as -# published by the Free Software Foundation, either version 3 of the -# License, or (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU Affero General Public License for more details. -# -# You should have received a copy of the GNU Affero General Public License -# along with this program. If not, see . - -import datetime -from flask import render_template -import conf -from web import emails -from web.lib.user_utils import generate_confirmation_token - - -def information_message(subject, plaintext): - """ - Send an information message to the users of the platform. - """ - from web.models import User - users = User.query.all() - # Only send email for activated accounts. - user_emails = [user.email for user in users if user.enabled] - # Postmark has a limit of twenty recipients per message in total. - for i in xrange(0, len(user_emails), 19): - emails.send(to=conf.NOTIFICATION_EMAIL, - bcc=", ".join(user_emails[i:i+19]), - subject=subject, plaintext=plaintext) - -def new_account_notification(user): - """ - Account creation notification. - """ - token = generate_confirmation_token(user.email) - expire_time = datetime.datetime.now() + \ - datetime.timedelta(seconds=conf.TOKEN_VALIDITY_PERIOD) - - plaintext = render_template('emails/account_activation.txt', - user=user, platform_url=conf.PLATFORM_URL, - token=token, - expire_time=expire_time) - - emails.send(to=user.email, bcc=conf.NOTIFICATION_EMAIL, - subject="[JARR] Account creation", plaintext=plaintext) - -def new_password_notification(user, password): - """ - New password notification. - """ - plaintext = render_template('emails/new_password.txt', - user=user, password=password) - emails.send(to=user.email, - bcc=conf.NOTIFICATION_EMAIL, - subject="[JARR] New password", plaintext=plaintext) diff --git a/src/web/views/session_mgmt.py b/src/web/views/session_mgmt.py index dc80516a..a3ef8e3c 100644 --- a/src/web/views/session_mgmt.py +++ b/src/web/views/session_mgmt.py @@ -16,7 +16,7 @@ import conf from web.views.common import admin_role, api_role, login_user_bundle from web.controllers import UserController from web.forms import SignupForm, SigninForm -from web import notifications +from notifications import notifications Principal(current_app) # Create a permission with a single Need, in this case a RoleNeed. diff --git a/src/web/views/user.py b/src/web/views/user.py index 1ce16ade..8568439f 100644 --- a/src/web/views/user.py +++ b/src/web/views/user.py @@ -6,7 +6,8 @@ from flask.ext.babel import gettext from flask.ext.login import login_required, current_user import conf -from web import utils, notifications +from notifications import notifications +from web import utils from web.lib.user_utils import confirm_token from web.controllers import (UserController, FeedController, ArticleController, CategoryController) -- cgit