Add support for sending mass emails (#7528)

* Add support for sending mass emails

* Accept a User.id instead of email address

Author: di

tests/unit/admin/test_routes.py

@@ -116,6 +116,7 @@ def test_includeme():
             "admin.blacklist.remove", "/admin/blacklist/remove/", domain=warehouse
         ),
         pretend.call("admin.emails.list", "/admin/emails/", domain=warehouse),
+        pretend.call("admin.emails.mass", "/admin/emails/mass/", domain=warehouse),
         pretend.call(
             "admin.emails.detail", "/admin/emails/{email_id}/", domain=warehouse
         ),

tests/unit/admin/views/test_emails.py

@@ -10,15 +10,18 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import csv
+import io
 import uuid
 
 import pretend
 import pytest
 
-from pyramid.httpexceptions import HTTPBadRequest, HTTPNotFound
+from pyramid.httpexceptions import HTTPBadRequest, HTTPNotFound, HTTPSeeOther
 
 from warehouse.admin.views import emails as views
 
+from ....common.db.accounts import EmailFactory, UserFactory
 from ....common.db.ses import EmailMessageFactory
 
 
@@ -73,6 +76,128 @@ def test_wildcard_query(self, db_request):
         assert result == {"emails": [emails[0]], "query": emails[0].to[:-1] + "%"}
 
 
+class TestEmailMass:
+    def test_sends_emails(self, db_request):
+        user1 = UserFactory.create()
+        email1 = EmailFactory.create(user=user1, primary=True)
+        user2 = UserFactory.create()
+        email2 = EmailFactory.create(user=user2, primary=True)
+
+        input_file = io.BytesIO()
+        wrapper = io.TextIOWrapper(input_file, encoding="utf-8")
+        fieldnames = ["user_id", "subject", "body_text"]
+        writer = csv.DictWriter(wrapper, fieldnames=fieldnames)
+        writer.writeheader()
+        writer.writerow(
+            {
+                "user_id": user1.id,
+                "subject": "Test Subject 1",
+                "body_text": "Test Body 1",
+            }
+        )
+        writer.writerow(
+            {
+                "user_id": user2.id,
+                "subject": "Test Subject 2",
+                "body_text": "Test Body 2",
+            }
+        )
+        wrapper.seek(0)
+
+        delay = pretend.call_recorder(lambda *a, **kw: None)
+        db_request.params = {"csvfile": pretend.stub(file=input_file)}
+        db_request.task = lambda a: pretend.stub(delay=delay)
+        db_request.route_path = pretend.call_recorder(lambda *a, **kw: "/the-redirect")
+        db_request.session = pretend.stub(
+            flash=pretend.call_recorder(lambda *a, **kw: None)
+        )
+
+        result = views.email_mass(db_request)
+
+        assert isinstance(result, HTTPSeeOther)
+        assert db_request.route_path.calls == [pretend.call("admin.emails.list")]
+        assert result.headers["Location"] == "/the-redirect"
+        assert db_request.session.flash.calls == [
+            pretend.call("Mass emails sent", queue="success")
+        ]
+        assert delay.calls == [
+            pretend.call(
+                email1.email,
+                {
+                    "subject": "Test Subject 1",
+                    "body_text": "Test Body 1",
+                    "body_html": None,
+                },
+            ),
+            pretend.call(
+                email2.email,
+                {
+                    "subject": "Test Subject 2",
+                    "body_text": "Test Body 2",
+                    "body_html": None,
+                },
+            ),
+        ]
+
+    def test_user_without_email_sends_no_emails(self, db_request):
+        user = UserFactory.create()
+
+        input_file = io.BytesIO()
+        wrapper = io.TextIOWrapper(input_file, encoding="utf-8")
+        fieldnames = ["user_id", "subject", "body_text"]
+        writer = csv.DictWriter(wrapper, fieldnames=fieldnames)
+        writer.writeheader()
+        writer.writerow(
+            {
+                "user_id": user.id,
+                "subject": "Test Subject 1",
+                "body_text": "Test Body 1",
+            }
+        )
+        wrapper.seek(0)
+
+        delay = pretend.call_recorder(lambda *a, **kw: None)
+        db_request.params = {"csvfile": pretend.stub(file=input_file)}
+        db_request.task = lambda a: pretend.stub(delay=delay)
+        db_request.route_path = pretend.call_recorder(lambda *a, **kw: "/the-redirect")
+        db_request.session = pretend.stub(
+            flash=pretend.call_recorder(lambda *a, **kw: None)
+        )
+
+        result = views.email_mass(db_request)
+
+        assert isinstance(result, HTTPSeeOther)
+        assert db_request.route_path.calls == [pretend.call("admin.emails.list")]
+        assert result.headers["Location"] == "/the-redirect"
+        assert delay.calls == []
+
+    def test_no_rows_sends_no_emails(self):
+        input_file = io.BytesIO()
+        wrapper = io.TextIOWrapper(input_file, encoding="utf-8")
+        fieldnames = ["user_id", "subject", "body_text"]
+        writer = csv.DictWriter(wrapper, fieldnames=fieldnames)
+        writer.writeheader()
+        wrapper.seek(0)
+
+        delay = pretend.call_recorder(lambda *a, **kw: None)
+        request = pretend.stub(
+            params={"csvfile": pretend.stub(file=input_file)},
+            task=lambda a: pretend.stub(delay=delay),
+            route_path=pretend.call_recorder(lambda *a, **kw: "/the-redirect"),
+            session=pretend.stub(flash=pretend.call_recorder(lambda *a, **kw: None)),
+        )
+
+        result = views.email_mass(request)
+
+        assert isinstance(result, HTTPSeeOther)
+        assert request.route_path.calls == [pretend.call("admin.emails.list")]
+        assert result.headers["Location"] == "/the-redirect"
+        assert request.session.flash.calls == [
+            pretend.call("No emails to send", queue="error")
+        ]
+        assert delay.calls == []
+
+
 class TestEmailDetail:
     def test_existing_email(self, db_session):
         em = EmailMessageFactory.create()

warehouse/admin/routes.py

@@ -117,6 +117,7 @@ def includeme(config):
 
     # Email related Admin pages
     config.add_route("admin.emails.list", "/admin/emails/", domain=warehouse)
+    config.add_route("admin.emails.mass", "/admin/emails/mass/", domain=warehouse)
     config.add_route(
         "admin.emails.detail", "/admin/emails/{email_id}/", domain=warehouse
     )

warehouse/admin/templates/admin/emails/list.html

@@ -36,8 +36,34 @@
 {% endblock %}
 
 {% block content %}
-<div class="box">
-  <div class="box-body">
+<div class="box box-primary">
+  <form method="POST" action={{ request.route_path('admin.emails.mass') }} enctype="multipart/form-data">
+    <input name="csrf_token" type="hidden" value="{{ request.session.get_csrf_token() }}">
+    <div class="box-header with-border">
+      <h3 class="box-title">Send mass emails</h3>
+    </div>
+    <div class="box-body with-border">
+      <p>
+      Uploaded files should have the following header: <code>user_id,subject,body_text</code>, where <code>user_id</code> is a user's UUID, <code>subject</code> is the subject, and <code>body_text</code> is the plaintext message body.
+      </p>
+      <p>
+      Including <code>body_html</code> is also supported, but optional.
+      </p>
+      <input name="csvfile" type="file">
+    </div>
+    <div class="box-footer">
+      <div class="pull-right">
+        <button type="submit" class="btn btn-primary">Send</button>
+      </div>
+    </div>
+  </form>
+</div>
+
+<div class="box box-primary">
+  <div class="box-header with-border">
+    <h3 class="box-title">Search</h3>
+  </div>
+  <div class="box-body with-border">
     <form>
       <div class="input-group input-group-lg">
         <input name="q" type="text" class="form-control input-lg" placeholder="Search"{% if query %} value="{{ query }}"{% endif %}>
@@ -46,11 +72,6 @@
         </div>
       </div>
     </form>
-  </div>
-</div>
-
-<div class="box">
-  <div class="box-body table-responsive no-padding">
     <table class="table table-hover">
       <tr>
         <th></th>

warehouse/admin/views/emails.py

@@ -10,14 +10,18 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import csv
+import io
 import shlex
 
 from paginate_sqlalchemy import SqlalchemyOrmPage as SQLAlchemyORMPage
-from pyramid.httpexceptions import HTTPBadRequest, HTTPNotFound
+from pyramid.httpexceptions import HTTPBadRequest, HTTPNotFound, HTTPSeeOther
 from pyramid.view import view_config
 from sqlalchemy import or_
 from sqlalchemy.orm.exc import NoResultFound
 
+from warehouse.accounts.models import User
+from warehouse.email import send_email
 from warehouse.email.ses.models import EmailMessage
 from warehouse.utils.paginate import paginate_url_factory
 
@@ -60,6 +64,37 @@ def email_list(request):
     return {"emails": emails, "query": q}
 
 
+@view_config(
+    route_name="admin.emails.mass",
+    permission="admin",
+    request_method="POST",
+    uses_session=True,
+    require_methods=False,
+)
+def email_mass(request):
+    input_file = request.params["csvfile"].file
+    wrapper = io.TextIOWrapper(input_file, encoding="utf-8")
+    rows = list(csv.DictReader(wrapper))
+    if rows:
+        for row in rows:
+            user = request.db.query(User).get(row["user_id"])
+            email = user.primary_email
+
+            if email:
+                request.task(send_email).delay(
+                    email.email,
+                    {
+                        "subject": row["subject"],
+                        "body_text": row["body_text"],
+                        "body_html": row.get("body_html"),
+                    },
+                )
+        request.session.flash("Mass emails sent", queue="success")
+    else:
+        request.session.flash("No emails to send", queue="error")
+    return HTTPSeeOther(request.route_path("admin.emails.list"))
+
+
 @view_config(
     route_name="admin.emails.detail",
     renderer="admin/emails/detail.html",