udata 10.0.3.dev32541__py2.py3-none-any.whl → 10.0.3.dev32594__py2.py3-none-any.whl

udata/core/dataset/models.py

@@ -21,6 +21,7 @@ from udata.core import storages
 from udata.core.owned import Owned, OwnedQuerySet
 from udata.frontend.markdown import mdstrip
 from udata.i18n import lazy_gettext as _
+from udata.mail import get_mail_campaign_dict
 from udata.models import Badge, BadgeMixin, BadgesList, SpatialCoverage, WithMetrics, db
 from udata.mongo.errors import FieldValidationError
 from udata.uris import ValidationError, endpoint_for
@@ -689,6 +690,11 @@ class Dataset(WithMetrics, DatasetBadgeMixin, Owned, db.Document):
     def external_url(self):
         return self.url_for(_external=True)
 
+    @property
+    def external_url_with_campaign(self):
+        extras = get_mail_campaign_dict()
+        return self.url_for(_external=True, **extras)
+
     @property
     def image_url(self):
         if self.organization:

udata/core/discussions/models.py

@@ -4,6 +4,7 @@ from datetime import datetime
 from flask_login import current_user
 
 from udata.core.spam.models import SpamMixin, spam_protected
+from udata.mail import get_mail_campaign_dict
 from udata.mongo import db
 
 from .signals import on_discussion_closed, on_new_discussion, on_new_discussion_comment
@@ -94,6 +95,13 @@ class Discussion(SpamMixin, db.Document):
     def external_url(self):
         return self.subject.url_for(_anchor="discussion-{id}".format(id=self.id), _external=True)
 
+    @property
+    def external_url_with_campaign(self):
+        extras = get_mail_campaign_dict()
+        return self.subject.url_for(
+            _anchor="discussion-{id}".format(id=self.id), _external=True, **extras
+        )
+
     def spam_report_message(self, breadcrumb):
         message = f"Spam potentiel sur la discussion « [{self.title}]({self.external_url}) »"
         if self.user:

udata/core/organization/models.py

@@ -11,6 +11,7 @@ from udata.core.metrics.models import WithMetrics
 from udata.core.storages import avatars, default_image_basename
 from udata.frontend.markdown import mdstrip
 from udata.i18n import lazy_gettext as _
+from udata.mail import get_mail_campaign_dict
 from udata.mongo import db
 from udata.uris import endpoint_for
 
@@ -188,6 +189,11 @@ class Organization(WithMetrics, OrganizationBadgeMixin, db.Datetimed, db.Documen
     def external_url(self):
         return self.url_for(_external=True)
 
+    @property
+    def external_url_with_campaign(self):
+        extras = get_mail_campaign_dict()
+        return self.url_for(_external=True, **extras)
+
     @property
     def pending_requests(self):
         return [r for r in self.requests if r.status == "pending"]

udata/core/post/models.py

@@ -2,6 +2,7 @@ from flask import url_for
 
 from udata.core.storages import default_image_basename, images
 from udata.i18n import lazy_gettext as _
+from udata.mail import get_mail_campaign_dict
 from udata.mongo import db
 
 from .constants import BODY_TYPES, IMAGE_SIZES
@@ -61,6 +62,11 @@ class Post(db.Datetimed, db.Document):
     def external_url(self):
         return self.url_for(_external=True)
 
+    @property
+    def external_url_with_campaign(self):
+        extras = get_mail_campaign_dict()
+        return self.url_for(_external=True, **extras)
+
     def count_discussions(self):
         # There are no metrics on Post to store discussions count
         pass

udata/core/reuse/models.py

@@ -9,6 +9,7 @@ from udata.core.reuse.api_fields import BIGGEST_IMAGE_SIZE
 from udata.core.storages import default_image_basename, images
 from udata.frontend.markdown import mdstrip
 from udata.i18n import lazy_gettext as _
+from udata.mail import get_mail_campaign_dict
 from udata.models import Badge, BadgeMixin, BadgesList, WithMetrics, db
 from udata.mongo.errors import FieldValidationError
 from udata.uris import endpoint_for
@@ -218,6 +219,11 @@ class Reuse(db.Datetimed, WithMetrics, ReuseBadgeMixin, Owned, db.Document):
     def external_url(self):
         return self.url_for(_external=True)
 
+    @property
+    def external_url_with_campaign(self):
+        extras = get_mail_campaign_dict()
+        return self.url_for(_external=True, **extras)
+
     @property
     def type_label(self):
         return REUSE_TYPES[self.type]

udata/core/spatial/models.py

@@ -5,6 +5,7 @@ from werkzeug.utils import cached_property
 from udata.app import cache
 from udata.core.metrics.models import WithMetrics
 from udata.i18n import _, get_locale, language
+from udata.mail import get_mail_campaign_dict
 from udata.mongo import db
 from udata.uris import endpoint_for
 
@@ -97,6 +98,11 @@ class GeoZone(WithMetrics, db.Document):
     def external_url(self):
         return endpoint_for("territories.territory", territory=self, _external=True)
 
+    @property
+    def external_url_with_campaign(self):
+        extras = get_mail_campaign_dict()
+        return endpoint_for("territories.territory", territory=self, _external=True, **extras)
+
     def count_datasets(self):
         from udata.models import Dataset
 

udata/core/user/models.py

@@ -17,6 +17,7 @@ from udata.core.discussions.models import Discussion
 from udata.core.storages import avatars, default_image_basename
 from udata.frontend.markdown import mdstrip
 from udata.i18n import lazy_gettext as _
+from udata.mail import get_mail_campaign_dict
 from udata.models import Follow, WithMetrics, db
 from udata.uris import endpoint_for
 
@@ -128,6 +129,11 @@ class User(WithMetrics, UserMixin, db.Document):
     def external_url(self):
         return self.url_for(_external=True)
 
+    @property
+    def external_url_with_campaign(self):
+        extras = get_mail_campaign_dict()
+        return self.url_for(_external=True, **extras)
+
     @property
     def visible(self):
         count = self.metrics.get("datasets", 0) + self.metrics.get("reuses", 0)

udata/features/territories/models.py

@@ -1,5 +1,6 @@
 from flask import url_for
 
+from udata.mail import get_mail_campaign_dict
 from udata.models import License, Organization
 
 __all__ = ("TerritoryDataset", "ResourceBasedTerritoryDataset", "TERRITORY_DATASETS")
@@ -59,3 +60,8 @@ class ResourceBasedTerritoryDataset(TerritoryDataset):
     @property
     def external_url(self):
         return self.url_for(external=True)
+
+    @property
+    def external_url_with_campaign(self):
+        extras = get_mail_campaign_dict()
+        return self.url_for(_external=True, **extras)

udata/mail.py

@@ -50,6 +50,7 @@ def send(subject, recipients, template_base, **kwargs):
     debug = current_app.config.get("DEBUG", False)
     send_mail = current_app.config.get("SEND_MAIL", not debug)
     connection = send_mail and mail.connect or dummyconnection
+    extras = get_mail_campaign_dict()
 
     with connection() as conn:
         for recipient in recipients:
@@ -58,16 +59,31 @@ def send(subject, recipients, template_base, **kwargs):
                 log.debug('Sending mail "%s" to recipient "%s"', subject, recipient)
                 msg = Message(subject, sender=sender, recipients=[recipient.email])
                 msg.body = render_template(
-                    f"{tpl_path}.txt", subject=subject, sender=sender, recipient=recipient, **kwargs
+                    f"{tpl_path}.txt",
+                    subject=subject,
+                    sender=sender,
+                    recipient=recipient,
+                    extras=extras,
+                    **kwargs,
                 )
                 msg.html = render_template(
                     f"{tpl_path}.html",
                     subject=subject,
                     sender=sender,
                     recipient=recipient,
+                    extras=extras,
                     **kwargs,
                 )
                 try:
                     conn.send(msg)
                 except SMTPException as e:
                     log.error(f"Error sending mail {e}")
+
+
+def get_mail_campaign_dict() -> dict:
+    """Return a dict with the `mtm_campaign` key set if there is a `MAIL_CAMPAIGN` configured in udata.cfg."""
+    extras = {}
+    mail_campaign = current_app.config.get("MAIL_CAMPAIGN")
+    if mail_campaign:
+        extras["mtm_campaign"] = mail_campaign
+    return extras