Add email notication on package/release removal

Until now, where there are multiple contributors on a single
the project, if one of them deletes a release or the whole
project the other contributors don't get any notification,
which is problematic.

Connected with issue #5714.

Signed-off-by: Martin Vrachev <[email protected]>

Author: di

warehouse/email/__init__.py

@@ -201,6 +201,40 @@ def send_added_as_collaborator_email(request, user, *, submitter, project_name,
     return {"project": project_name, "submitter": submitter.username, "role": role}
 
 
+@_email("removed-package")
+def send_removed_package_email(
+    request, user, *, project_name, submitter_name, submitter_role, recipient_role
+):
+    recipient_role_descr = "an owner"
+    if recipient_role == "Maintainer":
+        recipient_role_descr = "a maintainer"
+
+    return {
+        "project": project_name,
+        "submitter": submitter_name,
+        "submitter_role": submitter_role,
+        "recipient_role_descr": recipient_role_descr,
+    }
+
+
+@_email("removed-package-release")
+def send_removed_package_release_email(
+    request, user, *, project_name, release, release_date, submitter_name, submitter_role, recipient_role
+):
+    recipient_role_descr = "an owner"
+    if recipient_role == "Maintainer":
+        recipient_role_descr = "a maintainer"
+
+    return {
+        "project": project_name,
+        "release": release,
+        "release_date": release_date,
+        "submitter": submitter_name,
+        "submitter_role": submitter_role,
+        "recipient_role_descr": recipient_role_descr,
+    }
+
+
 def includeme(config):
     email_sending_class = config.maybe_dotted(config.registry.settings["mail.backend"])
     config.register_service_factory(email_sending_class.create_service, IEmailSender)

warehouse/manage/views.py

@@ -38,6 +38,8 @@
     send_email_verification_email,
     send_password_change_email,
     send_primary_email_change_email,
+    send_removed_package_email,
+    send_removed_package_release_email,
 )
 from warehouse.i18n import localize as _
 from warehouse.macaroons.interfaces import IMacaroonService
@@ -799,6 +801,40 @@ def manage_project_settings(project, request):
     return {"project": project}
 
 
+def get_project_contributors(project, request):
+    query_res = (
+        request.db.query(Project)
+        .join(User, Project.users)
+        .filter(Project.name == project.name)
+        .one()
+    )
+    return query_res.users
+
+
+def get_user_role_in_project(project, request):
+    query_res = (
+        request.db.query(Project)
+        .join(User, Project.users)
+        .filter(User.username == request.user.username, Project.name == project.name)
+        .with_entities(Role.role_name)
+        .distinct(Role.role_name)
+        .all()
+    )
+
+    user_role = ""
+    # This check is needed because of
+    # issue https://github.com/pypa/warehouse/issues/2745
+    # which is not yet resolved and a user could be an owner
+    # and a maintainer at the same time
+    if len(query_res) == 2 and (
+        query_res[0].role_name == "Owner" or query_res[1].role_name == "Owner"
+    ):
+        user_role = "Owner"
+    else:
+        user_role = "Maintainer"
+    return user_role
+
+
 @view_config(
     route_name="manage.project.delete_project",
     context=Project,
@@ -823,6 +859,21 @@ def delete_project(project, request):
     confirm_project(project, request, fail_route="manage.project.settings")
     remove_project(project, request)
 
+    submitter_role = get_user_role_in_project(project, request)
+    contributors = get_project_contributors(project, request)
+
+    for contributor in contributors:
+        contributor_role = get_user_role_in_project(project, request)
+
+        send_removed_package_email(
+            request,
+            contributor,
+            project_name=project.name,
+            submitter_name=request.user.username,
+            submitter_role=submitter_role,
+            recipient_role=contributor_role,
+        )
+
     return HTTPSeeOther(request.route_path("manage.projects"))
 
 
@@ -978,6 +1029,23 @@ def delete_project_release(self):
             f"Deleted release {self.release.version!r}", queue="success"
         )
 
+        submitter_role = get_user_role_in_project(self.release.project, self.request)
+        contributors = get_project_contributors(self.release.project, self.request)
+
+        for contributor in contributors:
+            contributor_role = get_user_role_in_project(self.release.project, self.request)
+
+            send_removed_package_release_email(
+                self.request,
+                contributor,
+                project_name=self.release.project.name,
+                release=self.release.version,
+                release_date=self.release.created.strftime("%b %d %Y"),
+                submitter_name=self.request.user.username,
+                submitter_role=submitter_role,
+                recipient_role=contributor_role,
+            )
+
         return HTTPSeeOther(
             self.request.route_path(
                 "manage.project.releases", project_name=self.release.project.name

warehouse/templates/email/removed-package-release/body.html

@@ -0,0 +1,42 @@
+{#
+ # Licensed under the Apache License, Version 2.0 (the "License");
+ # you may not use this file except in compliance with the License.
+ # You may obtain a copy of the License at
+ #
+ # http://www.apache.org/licenses/LICENSE-2.0
+ #
+ # Unless required by applicable law or agreed to in writing, software
+ # distributed under the License is distributed on an "AS IS" BASIS,
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ # limitations under the License.
+-#}
+{% extends "email/_base/body.html" %}
+
+{% block extra_style %}
+ul.collaborator-details {
+list-style-type: none;
+}
+{% endblock %}
+
+{% block content %}
+<p>
+  <ul class="removed-package-release">
+    <li>{% trans project=project, release=release, date=release_date %}The {{ project }} release {{ release }} released on {{ date }} has been deleted.{% endtrans  %}</li>
+    <li>{% trans submitter=submitter, role=submitter_role %}<strong>Deleted by:</strong> {{ submitter }} with a role:
+      {{ role }}.{% endtrans %}
+    </li>
+  </ul>
+</p>
+
+<p>{% trans href='mailto:[email protected]', email_address='[email protected]' %}If this was a mistake, you can email <a
+    href="{{ href }}">{{ email_address }}</a> to communicate with the PyPI administrators.{% endtrans %}</p>
+{% endblock %}
+
+{% block reason %}
+
+{% trans %}
+You are receiving this because you are {{ recipient_role_descr }} of this package.
+{% endtrans %}
+
+{% endblock %}

warehouse/templates/email/removed-package-release/body.txt

@@ -0,0 +1,30 @@
+{#
+ # Licensed under the Apache License, Version 2.0 (the "License");
+ # you may not use this file except in compliance with the License.
+ # You may obtain a copy of the License at
+ #
+ # http://www.apache.org/licenses/LICENSE-2.0
+ #
+ # Unless required by applicable law or agreed to in writing, software
+ # distributed under the License is distributed on an "AS IS" BASIS,
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ # limitations under the License.
+-#}
+
+{% extends "email/_base/body.txt" %}
+
+{% block content %}
+  {% trans project=project, release=release, date=release_date %}The {{ project }} release {{ release }} released on {{ date }} has been deleted.{% endtrans  %}
+
+  {% trans submitter=submitter, role=submitter_role %}Deleted by: {{ submitter }} with a role: {{ role }}.{% endtrans %}
+
+  {% trans email_address='[email protected]' %}If this was a mistake, you can email {{ email_address }} to communicate with the PyPI administrators.{% endtrans %}
+{% endblock %}
+
+{% block reason %}
+  {% trans %}
+    You are receiving this because you are {{ recipient_role_descr }} of this package.
+  {% endtrans %}
+{% endblock %}
+

warehouse/templates/email/removed-package-release/subject.txt

@@ -0,0 +1,18 @@
+{#
+ # Licensed under the Apache License, Version 2.0 (the "License");
+ # you may not use this file except in compliance with the License.
+ # You may obtain a copy of the License at
+ #
+ # http://www.apache.org/licenses/LICENSE-2.0
+ #
+ # Unless required by applicable law or agreed to in writing, software
+ # distributed under the License is distributed on an "AS IS" BASIS,
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ # limitations under the License.
+-#}
+
+{% extends "email/_base/subject.txt" %}
+
+{% block content %}
+{% trans project=project, release=release %}The {{ project }} release {{ release }} has been deleted.{% endtrans  %}{% endblock %}

warehouse/templates/email/removed-package/body.html

@@ -0,0 +1,42 @@
+{#
+ # Licensed under the Apache License, Version 2.0 (the "License");
+ # you may not use this file except in compliance with the License.
+ # You may obtain a copy of the License at
+ #
+ # http://www.apache.org/licenses/LICENSE-2.0
+ #
+ # Unless required by applicable law or agreed to in writing, software
+ # distributed under the License is distributed on an "AS IS" BASIS,
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ # limitations under the License.
+-#}
+{% extends "email/_base/body.html" %}
+
+{% block extra_style %}
+ul.collaborator-details {
+list-style-type: none;
+}
+{% endblock %}
+
+{% block content %}
+<p>
+  <ul class="removed-package-details">
+    <li>{% trans project=project %}The package {{ project }} has been deleted.{% endtrans %}</li>
+    <li>{% trans submitter=submitter, role=submitter_role %}<strong>Deleted by:</strong> {{ submitter }} with a role:
+      {{ role }}.{% endtrans %}
+    </li>
+  </ul>
+</p>
+
+<p>{% trans href='mailto:[email protected]', email_address='[email protected]' %}If this was a mistake, you can email <a
+    href="{{ href }}">{{ email_address }}</a> to communicate with the PyPI administrators.{% endtrans %}</p>
+{% endblock %}
+
+{% block reason %}
+
+{% trans %}
+You are receiving this because you are {{ recipient_role_descr }} of this package.
+{% endtrans %}
+
+{% endblock %}

warehouse/templates/email/removed-package/body.txt

@@ -0,0 +1,30 @@
+{#
+ # Licensed under the Apache License, Version 2.0 (the "License");
+ # you may not use this file except in compliance with the License.
+ # You may obtain a copy of the License at
+ #
+ # http://www.apache.org/licenses/LICENSE-2.0
+ #
+ # Unless required by applicable law or agreed to in writing, software
+ # distributed under the License is distributed on an "AS IS" BASIS,
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ # limitations under the License.
+-#}
+
+{% extends "email/_base/body.txt" %}
+
+{% block content %}
+  {% trans project=project %}The package {{ project }} has been deleted.{% endtrans  %}
+
+  {% trans submitter=submitter, role=submitter_role %}Deleted by: {{ submitter }} with a role: {{ role }}.{% endtrans %}
+
+  {% trans email_address='[email protected]' %}If this was a mistake, you can email {{ email_address }} to communicate with the PyPI administrators.{% endtrans %}
+{% endblock %}
+
+{% block reason %}
+  {% trans %}
+    You are receiving this because you are {{ recipient_role_descr }} of this package.
+  {% endtrans %}
+{% endblock %}
+

warehouse/templates/email/removed-package/subject.txt

@@ -0,0 +1,19 @@
+{#
+ # Licensed under the Apache License, Version 2.0 (the "License");
+ # you may not use this file except in compliance with the License.
+ # You may obtain a copy of the License at
+ #
+ # http://www.apache.org/licenses/LICENSE-2.0
+ #
+ # Unless required by applicable law or agreed to in writing, software
+ # distributed under the License is distributed on an "AS IS" BASIS,
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ # limitations under the License.
+-#}
+
+{% extends "email/_base/subject.txt" %}
+
+{% block content %}
+  {% trans project=project %}The package {{ project }} has been deleted.{% endtrans %}
+{% endblock %}