Merge branch 'develop' into web/feature/profile-message-form

Author: nabramow

app/backend/src/couchers/email/dev.py

@@ -2,20 +2,12 @@
 
 from couchers.crypto import random_hex
 from couchers.models import Email
+from couchers.proto.internal import jobs_pb2
 
 logger = logging.getLogger(__name__)
 
 
-def print_dev_email(
-    sender_name: str,
-    sender_email: str,
-    recipient: str,
-    subject: str,
-    plain: str,
-    html: str,
-    list_unsubscribe_header: str | None,
-    source_data: str | None,
-) -> Email:
+def print_dev_email(payload: jobs_pb2.SendEmailPayload) -> Email:
     """
     Generates a dummy Email object and prints the plain email contents to the logger
 
@@ -26,16 +18,16 @@ def print_dev_email(
     message_id = random_hex()
 
     logger.info("Dev email:")
-    logger.info(plain)
+    logger.info(payload.plain)
 
     return Email(
         id=message_id,
-        sender_name=sender_name,
-        sender_email=sender_email,
-        recipient=recipient,
-        subject=subject,
-        plain=plain,
-        html=html,
-        list_unsubscribe_header=list_unsubscribe_header,
-        source_data=source_data,
+        sender_name=payload.sender_name,
+        sender_email=payload.sender_email,
+        recipient=payload.recipient,
+        subject=payload.subject,
+        plain=payload.plain,
+        html=payload.html,
+        list_unsubscribe_header=payload.list_unsubscribe_header,
+        source_data=payload.source_data,
     )

app/backend/src/couchers/email/queuing.py

@@ -13,34 +13,14 @@
 from couchers.utils import now
 
 
-def _queue_email(
-    session: Session,
-    sender_name: str,
-    sender_email: str,
-    recipient: str,
-    subject: str,
-    plain: str,
-    html: str | None,
-    list_unsubscribe_header: str | None,
-    source_data: str | None,
-) -> None:
+def _queue_email(session: Session, payload: jobs_pb2.SendEmailPayload) -> None:
     """
     This indirection is so that this can be easily mocked. Not sure how to do it better :(
     """
 
     # Import here to avoid circular dependency
     from couchers.jobs.handlers import send_email  # noqa: PLC0415
 
-    payload = jobs_pb2.SendEmailPayload(
-        sender_name=sender_name,
-        sender_email=sender_email,
-        recipient=recipient,
-        subject=subject,
-        plain=plain,
-        html=html,
-        list_unsubscribe_header=list_unsubscribe_header,
-        source_data=source_data,
-    )
     queue_job(
         session,
         job=send_email,
@@ -51,28 +31,8 @@ def _queue_email(
     emails_counter.inc()
 
 
-def queue_email(
-    session: Session,
-    sender_name: str,
-    sender_email: str,
-    recipient: str,
-    subject: str,
-    plain: str,
-    html: str | None,
-    list_unsubscribe_header: str | None = None,
-    source_data: str | None = None,
-) -> None:
-    _queue_email(
-        session=session,
-        sender_name=sender_name,
-        sender_email=sender_email,
-        recipient=recipient,
-        subject=subject,
-        plain=plain,
-        html=html,
-        list_unsubscribe_header=list_unsubscribe_header,
-        source_data=source_data,
-    )
+def queue_email(session: Session, payload: jobs_pb2.SendEmailPayload) -> None:
+    _queue_email(session, payload)
 
 
 def queue_userless_email(
@@ -109,13 +69,15 @@ def queue_userless_email(
 
     queue_email(
         session,
-        sender_name=config["NOTIFICATION_EMAIL_SENDER"],
-        sender_email=config["NOTIFICATION_EMAIL_ADDRESS"],
-        recipient=recipient,
-        subject=config["NOTIFICATION_PREFIX"] + subject,
-        plain=plain,
-        html=html,
-        source_data=config["VERSION"] + f"/{template_name}",
+        jobs_pb2.SendEmailPayload(
+            sender_name=config["NOTIFICATION_EMAIL_SENDER"],
+            sender_email=config["NOTIFICATION_EMAIL_ADDRESS"],
+            recipient=recipient,
+            subject=config["NOTIFICATION_PREFIX"] + subject,
+            plain=plain,
+            html=html,
+            source_data=config["VERSION"] + f"/{template_name}",
+        ),
     )
 
 
@@ -134,11 +96,12 @@ def queue_system_email(session: Session, recipient: str, template_name: str, tem
 
     queue_email(
         session,
-        sender_name=config["NOTIFICATION_EMAIL_SENDER"],
-        sender_email=config["NOTIFICATION_EMAIL_ADDRESS"],
-        recipient=recipient,
-        subject=config["NOTIFICATION_PREFIX"] + frontmatter["subject"],
-        plain=plain,
-        html=None,
-        source_data=template_name,
+        jobs_pb2.SendEmailPayload(
+            sender_name=config["NOTIFICATION_EMAIL_SENDER"],
+            sender_email=config["NOTIFICATION_EMAIL_ADDRESS"],
+            recipient=recipient,
+            subject=config["NOTIFICATION_PREFIX"] + frontmatter["subject"],
+            plain=plain,
+            source_data=template_name,
+        ),
     )

app/backend/src/couchers/email/smtp.py

@@ -8,6 +8,7 @@
 from couchers.config import config
 from couchers.crypto import EMAIL_SOURCE_DATA_KEY_NAME, random_hex, simple_hash_signature
 from couchers.models import Email
+from couchers.proto.internal import jobs_pb2
 
 template_base = Path(Path(__file__).parent / ".." / ".." / ".." / "templates" / "v2")
 
@@ -18,51 +19,43 @@ def make_cid(sender_email: str) -> tuple[str, str]:
     return cid, without_tag
 
 
-def send_smtp_email(
-    sender_name: str,
-    sender_email: str,
-    recipient: str,
-    subject: str,
-    plain: str,
-    html: str,
-    list_unsubscribe_header: str | None,
-    source_data: str | None,
-) -> Email:
+def send_smtp_email(payload: jobs_pb2.SendEmailPayload) -> Email:
     """
     Sends out the email through SMTP, settings from config.
 
     Returns a models.Email object that can be straight away added to the database.
     """
     message_id = random_hex()
     msg = EmailMessage()
-    msg["Subject"] = subject
-    msg["From"] = Address(sender_name, addr_spec=sender_email)
-    msg["To"] = Address(addr_spec=recipient)
+    msg["Subject"] = payload.subject
+    msg["From"] = Address(payload.sender_name, addr_spec=payload.sender_email)
+    msg["To"] = Address(addr_spec=payload.recipient)
     msg["X-Couchers-ID"] = message_id
 
-    if list_unsubscribe_header:
-        msg["List-Unsubscribe"] = list_unsubscribe_header
+    if payload.list_unsubscribe_header:
+        msg["List-Unsubscribe"] = payload.list_unsubscribe_header
 
-    if source_data:
-        msg["X-Couchers-Source-Data"] = source_data
-        msg["X-Couchers-Source-Sig"] = simple_hash_signature(source_data, EMAIL_SOURCE_DATA_KEY_NAME)
+    if payload.source_data:
+        msg["X-Couchers-Source-Data"] = payload.source_data
+        msg["X-Couchers-Source-Sig"] = simple_hash_signature(payload.source_data, EMAIL_SOURCE_DATA_KEY_NAME)
 
-    msg.set_content(plain)
+    msg.set_content(payload.plain)
 
-    if html:
+    updated_html = payload.html
+    if updated_html:
         # for any png files in attachment_imgs/, goes through and replaces instances of the filename with attachment
         used_attachments = []
         for attachment in (template_base / "attachment_imgs").glob("*.png"):
             attachment_html_path = str(attachment.relative_to(template_base))
-            if attachment_html_path not in html:
+            if attachment_html_path not in updated_html:
                 continue
             # it's used in this template, so attach and replace it
             data = attachment.read_bytes()
-            cid, wcid = make_cid(sender_email)
-            html = html.replace(attachment_html_path, f"cid:{wcid}")
+            cid, wcid = make_cid(payload.sender_email)
+            updated_html = updated_html.replace(attachment_html_path, f"cid:{wcid}")
             used_attachments.append((cid, "image", "png", data))
 
-        msg.add_alternative(html, subtype="html")
+        msg.add_alternative(updated_html, subtype="html")
 
         for cid, mime_type, mime_subtype, data in used_attachments:
             payloads = cast(list[MIMEPart], msg.get_payload())
@@ -75,16 +68,16 @@ def send_smtp_email(
             # stmplib docs recommend calling ehlo() before and after starttls()
             server.ehlo()
             server.login(config["SMTP_USERNAME"], config["SMTP_PASSWORD"])
-        server.sendmail(sender_email, recipient, msg.as_string())
+        server.sendmail(payload.sender_email, payload.recipient, msg.as_string())
 
     return Email(
         id=message_id,
-        sender_name=sender_name,
-        sender_email=sender_email,
-        recipient=recipient,
-        subject=subject,
-        plain=plain,
-        html=html,
-        list_unsubscribe_header=list_unsubscribe_header,
-        source_data=source_data,
+        sender_name=payload.sender_name,
+        sender_email=payload.sender_email,
+        recipient=payload.recipient,
+        subject=payload.subject,
+        plain=payload.plain,
+        html=updated_html,
+        list_unsubscribe_header=payload.list_unsubscribe_header,
+        source_data=payload.source_data,
     )

app/backend/src/couchers/jobs/handlers.py

@@ -139,16 +139,7 @@ def send_email(payload: jobs_pb2.SendEmailPayload) -> None:
     # selects a "sender", which either prints the email to the logger or sends it out with SMTP
     sender = send_smtp_email if config["ENABLE_EMAIL"] else print_dev_email
     # the sender must return a models.Email object that can be added to the database
-    email = sender(
-        sender_name=payload.sender_name,
-        sender_email=payload.sender_email,
-        recipient=payload.recipient,
-        subject=payload.subject,
-        plain=payload.plain,
-        html=payload.html,
-        list_unsubscribe_header=payload.list_unsubscribe_header,
-        source_data=payload.source_data,
-    )
+    email = sender(payload)
     with session_scope() as session:
         session.add(email)
 

app/backend/src/couchers/notifications/background.py

@@ -49,14 +49,16 @@ def _send_email_notification(session: Session, user: User, notification: Notific
 
     queue_email(
         session,
-        sender_name=config["NOTIFICATION_EMAIL_SENDER"],
-        sender_email=config["NOTIFICATION_EMAIL_ADDRESS"],
-        recipient=user.email,
-        subject=config["NOTIFICATION_PREFIX"] + rendered.subject,
-        plain=rendered.body_plaintext,
-        html=rendered.body_html,
-        source_data=rendered.source_data,
-        list_unsubscribe_header=rendered.list_unsubscribe_header,
+        jobs_pb2.SendEmailPayload(
+            sender_name=config["NOTIFICATION_EMAIL_SENDER"],
+            sender_email=config["NOTIFICATION_EMAIL_ADDRESS"],
+            recipient=user.email,
+            subject=config["NOTIFICATION_PREFIX"] + rendered.subject,
+            plain=rendered.body_plaintext,
+            html=rendered.body_html,
+            source_data=rendered.source_data,
+            list_unsubscribe_header=rendered.list_unsubscribe_header,
+        ),
     )
 
 

app/backend/src/couchers/servicers/admin.py

@@ -4,7 +4,7 @@
 import grpc
 from google.protobuf import empty_pb2
 from sqlalchemy import select
-from sqlalchemy.orm import Session, selectinload
+from sqlalchemy.orm import Session, aliased, selectinload
 from sqlalchemy.sql import and_, func, or_
 from user_agents import parse as user_agents_parse
 
@@ -114,6 +114,8 @@ def _user_to_details(session: Session, user: User) -> admin_pb2.UserDetails:
                 level=adminactionlevel2api[action.level],
                 note=action.note or "",
                 tag=action.tag or "",
+                target_user_id=action.target_user_id,
+                target_username=user.username,
             )
         )
 
@@ -1085,3 +1087,49 @@ def SetModScore(
         user.mod_score = request.mod_score
         log_admin_action(session, context, user, "set_mod_score", note=f"mod_score={request.mod_score}")
         return _user_to_details(session, user)
+
+    def ListAdminActions(
+        self, request: admin_pb2.ListAdminActionsReq, context: CouchersContext, session: Session
+    ) -> admin_pb2.ListAdminActionsRes:
+        page_size = min(MAX_PAGINATION_LENGTH, request.page_size or MAX_PAGINATION_LENGTH)
+
+        admin_user = aliased(User)
+        target_user = aliased(User)
+
+        statement = (
+            select(AdminAction, admin_user.username, target_user.username)
+            .join(admin_user, AdminAction.admin_user_id == admin_user.id)
+            .join(target_user, AdminAction.target_user_id == target_user.id)
+        )
+
+        if request.admin_user_id:
+            statement = statement.where(AdminAction.admin_user_id == request.admin_user_id)
+        if request.target_user_id:
+            statement = statement.where(AdminAction.target_user_id == request.target_user_id)
+        if request.page_token:
+            statement = statement.where(AdminAction.id < int(request.page_token))
+
+        statement = statement.order_by(AdminAction.id.desc()).limit(page_size + 1)
+
+        rows = session.execute(statement).all()
+
+        action_pbs = [
+            admin_pb2.AdminActionLog(
+                admin_action_id=action.id,
+                created=Timestamp_from_datetime(action.created),
+                admin_user_id=action.admin_user_id,
+                admin_username=admin_username,
+                action_type=action.action_type,
+                level=adminactionlevel2api[action.level],
+                note=action.note or "",
+                tag=action.tag or "",
+                target_user_id=action.target_user_id,
+                target_username=target_username,
+            )
+            for action, admin_username, target_username in rows[:page_size]
+        ]
+
+        return admin_pb2.ListAdminActionsRes(
+            admin_actions=action_pbs,
+            next_page_token=str(rows[page_size - 1][0].id) if len(rows) > page_size else None,
+        )