from __future__ import annotations
from onegov.core.utils import normalize_for_url, is_uuid
from onegov.newsletter import Newsletter, Recipient
from onegov.newsletter.errors import AlreadyExistsError
from typing import Any, TYPE_CHECKING
if TYPE_CHECKING:
from datetime import datetime
from markupsafe import Markup
from sqlalchemy.orm import Query, Session
from uuid import UUID
[docs]
class NewsletterCollection:
def __init__(self, session: Session):
[docs]
def query(self) -> Query[Newsletter]:
return self.session.query(Newsletter)
[docs]
def by_name(self, name: str) -> Newsletter | None:
return self.query().filter(Newsletter.name == name).first()
[docs]
def add(
self,
title: str,
html: Markup,
lead: str | None = None,
meta: dict[str, Any] | None = None,
content: dict[str, Any] | None = None,
scheduled: datetime | None = None
) -> Newsletter:
name = normalize_for_url(title)
if self.by_name(name):
raise AlreadyExistsError(name)
newsletter = Newsletter(
name=normalize_for_url(title),
title=title,
html=html,
lead=lead,
meta=meta or {},
content=content or {},
scheduled=scheduled
)
self.session.add(newsletter)
self.session.flush()
return newsletter
[docs]
def delete(self, newsletter: Newsletter) -> None:
self.session.delete(newsletter)
self.session.flush()
[docs]
class RecipientCollection:
def __init__(self, session: Session):
[docs]
def query(self) -> Query[Recipient]:
return self.session.query(Recipient)
[docs]
def by_id(self, id: str | UUID) -> Recipient | None:
if is_uuid(id):
return self.query().filter(Recipient.id == id).first()
return None
[docs]
def by_inactive(self) -> Query[Recipient]:
return self.query().filter(
Recipient.meta['inactive'].as_boolean() == True)
[docs]
def by_address(
self,
address: str,
group: str | None = None
) -> Recipient | None:
query = self.query()
query = query.filter(Recipient.address == address)
query = query.filter(Recipient.group == group)
return query.first()
[docs]
def ordered_by_status_address(self) -> Query[Recipient]:
""" Orders the recipients by status and address. """
return self.query().order_by(Recipient.confirmed, Recipient.address)
[docs]
def add(
self,
address: str,
group: str | None = None,
confirmed: bool = False,
subscribed_categories: list[str] | None = None,
) -> Recipient:
recipient = Recipient(
address=address,
group=group,
confirmed=confirmed,
subscribed_categories=subscribed_categories, # type: ignore[misc]
)
self.session.add(recipient)
self.session.flush()
return recipient
[docs]
def delete(self, recipient: Recipient) -> None:
self.session.delete(recipient)
self.session.flush()
[docs]
def count(self) -> int:
""" Returns the number of recipients. """
return self.session.query(Recipient).count()