Brevo Mailing list integration

indico_jacow/blueprint.py

@@ -9,7 +9,8 @@
 
 from indico_jacow.controllers import (RHAbstractsExportCSV, RHAbstractsExportExcel, RHAbstractsStats,
                                       RHContributionsExportCSV, RHContributionsExportExcel, RHCountries,
-                                      RHCreateAffiliation, RHDisplayAbstractsStatistics, RHPeerReviewCSVImport)
+                                      RHCreateAffiliation, RHDisplayAbstractsStatistics, RHMailingLists,
+                                      RHMailingListSubscribe, RHMailingListUnsubscribe, RHPeerReviewCSVImport)
 
 
 blueprint = IndicoPluginBlueprint('jacow', __name__, url_prefix='/event/<int:event_id>')
@@ -35,3 +36,11 @@
 
 blueprint.add_url_rule('!/api/jacow/countries', 'countries', RHCountries)
 blueprint.add_url_rule('!/api/jacow/affiliation', 'create_affiliation', RHCreateAffiliation, methods=('POST',))
+
+
+# Mailing preferences
+blueprint.add_url_rule('!/users/emails/mailing-lists', 'mailing_lists', RHMailingLists)
+blueprint.add_url_rule('!/users/emails/mailing-lists/subscribe', 'mailing_lists_subscribe',
+                       RHMailingListSubscribe, methods=('POST',))
+blueprint.add_url_rule('!/users/emails/mailing-lists/unsubscribe', 'mailing_lists_unsubscribe',
+                       RHMailingListUnsubscribe, methods=('POST',))

indico_jacow/client/MailingList.jsx

@@ -0,0 +1,117 @@
+// This file is part of the JACoW plugin.
+// Copyright (C) 2021 - 2025 CERN
+//
+// The CERN Indico plugins are free software; you can redistribute
+// them and/or modify them under the terms of the MIT License; see
+// the LICENSE file for more details.
+
+// import getMailingListsURL from 'indico-url:plugin_jacow.mailing_lists';
+import mailingListSubscribeURL from 'indico-url:plugin_jacow.mailing_lists_subscribe';
+import mailingListUnsubscribeURL from 'indico-url:plugin_jacow.mailing_lists_unsubscribe';
+
+import PropTypes from 'prop-types';
+import {useState} from 'react';
+import ReactDOM from 'react-dom';
+import {ListItem, ListContent, List, Checkbox} from 'semantic-ui-react';
+
+import {Translate} from 'indico/react/i18n';
+import {indicoAxios, handleAxiosError} from 'indico/utils/axios';
+
+import './MailingList.module.scss';
+
+export function MailingList({mailingLists}) {
+  const [lists, setLists] = useState(mailingLists.lists);
+  const [listsLoadingRequests, setListsLoadingRequests] = useState(new Set());
+
+  const subscribeList = async list => {
+    await indicoAxios.post(mailingListSubscribeURL(), list);
+  };
+
+  const unsubscribeList = async list => {
+    await indicoAxios.post(mailingListUnsubscribeURL(), list);
+  };
+
+  const handleToggle = async (ev, {value}) => {
+    if (listsLoadingRequests.has(value)) return;
+
+    setListsLoadingRequests(prev => new Set(prev).add(value));
+
+    const targetList = lists.find(list => list.id === value);
+    const newSubscriptionStatus = !targetList.subscribed;
+
+    setLists(prevLists =>
+      prevLists.map(list =>
+        list.id === value ? { ...list, subscribed: newSubscriptionStatus } : list
+      )
+    );
+
+    try {
+      if (newSubscriptionStatus) {
+        await subscribeList({list_id: value});
+      } else {
+        await unsubscribeList({list_id: value});
+      }
+    } catch (e) {
+      handleAxiosError(e);
+      setLists(prevLists =>
+        prevLists.map(list =>
+          list.id === value ? { ...list, subscribed: !newSubscriptionStatus } : list
+        )
+      );
+    } finally {
+      setListsLoadingRequests(prev => {
+        const newSet = new Set(prev);
+        newSet.delete(value);
+        return newSet;
+      });
+    }
+  };
+
+  return (
+    <div style={{marginTop: '15px'}}>
+      {/* Subscribed Lists Section */}
+      <div className="i-box">
+        <div className="i-box-header">
+          <div className="i-box-title">
+            <Translate>Mailing Lists</Translate>
+          </div>
+        </div>
+        <div className="i-box-content">
+          <List divided relaxed size="big">
+            {lists.map(list => (
+              <ListItem styleName="mailing" key={list.id}>
+                <ListContent>{list.name}</ListContent>
+                <ListContent>
+                  <Checkbox
+                    toggle
+                    value={list.id}
+                    onChange={handleToggle}
+                    disabled={listsLoadingRequests.has(list.id)}
+                    checked={list.subscribed}
+                  />
+                </ListContent>
+              </ListItem>
+            ))}
+          </List>
+        </div>
+      </div>
+    </div>
+  );
+}
+
+MailingList.propTypes = {
+  mailingLists: PropTypes.shape({
+    lists: PropTypes.arrayOf(
+      PropTypes.shape({
+        id: PropTypes.number.isRequired,
+        name: PropTypes.string.isRequired,
+        subscribed: PropTypes.bool.isRequired,
+      })
+    ).isRequired,
+  }).isRequired,
+};
+
+window.setupMailingList = (elem, subMailingLists) => {
+  subMailingLists = JSON.parse(subMailingLists);
+  ReactDOM.render(<MailingList mailingLists={subMailingLists} />, elem);
+};

indico_jacow/client/MailingList.module.scss

@@ -0,0 +1,17 @@
+// This file is part of the JACoW plugin.
+// Copyright (C) 2021 - 2025 CERN
+//
+// The CERN Indico plugins are free software; you can redistribute
+// them and/or modify them under the terms of the MIT License; see
+// the LICENSE file for more details.
+
+:global(.ui.list .item).mailing {
+    display: flex;
+    justify-content: space-between;
+    align-items: center;
+    width: 100%;
+
+    &::after {
+        content: none;
+    }
+}

indico_jacow/client/index.js

@@ -7,6 +7,7 @@
 
 import {registerPluginComponent, registerPluginObject} from 'indico/utils/plugins';
 
+import {MailingList} from './MailingList';
 import MultipleAffiliationsSelector, {
   MultipleAffiliationsButton,
   customFields,

indico_jacow/controllers.py

@@ -7,17 +7,21 @@
 
 import csv
 import io
+import json
 from collections import defaultdict
 from statistics import mean, pstdev
 
-from flask import jsonify, session
+import brevo_python
+from brevo_python.rest import ApiException
+from flask import jsonify, request, session
 from flask_pluginengine import current_plugin
 from marshmallow import fields
 from sqlalchemy.orm import load_only
 from werkzeug.exceptions import Forbidden
+from werkzeug.utils import cached_property
 
 from indico.core.db import db
-from indico.core.errors import UserValueError
+from indico.core.errors import IndicoError, UserValueError
 from indico.modules.events.abstracts.controllers.abstract_list import RHManageAbstractsExportActionsBase
 from indico.modules.events.abstracts.controllers.base import RHAbstractsBase
 from indico.modules.events.abstracts.models.review_ratings import AbstractReviewRating
@@ -28,7 +32,9 @@
 from indico.modules.events.management.controllers import RHManageEventBase
 from indico.modules.events.papers.controllers.base import RHManagePapersBase
 from indico.modules.events.tracks.models.tracks import Track
+from indico.modules.logs.models.entries import LogKind, UserLogRealm
 from indico.modules.users import User
+from indico.modules.users.controllers import RHUserBase
 from indico.modules.users.models.affiliations import Affiliation
 from indico.modules.users.schemas import AffiliationSchema
 from indico.modules.users.util import search_affiliations
@@ -42,7 +48,7 @@
 from indico.web.flask.util import url_for
 from indico.web.rh import RH, RHProtected
 
-from indico_jacow.views import WPAbstractsStats, WPDisplayAbstractsStatistics
+from indico_jacow.views import WPAbstractsStats, WPDisplayAbstractsStatistics, WPUserMailingLists
 
 
 def _get_boolean_questions(event):
@@ -309,3 +315,109 @@ def _process(self, data):
         current_plugin.logger.info('Affiliation %r created by %r', aff, session.user)
         search_affiliations.bump_version()
         return AffiliationSchema().jsonify(aff)
+
+
+class BrevoAPIMixin:
+    @cached_property
+    def api_instance(self):
+        if not hasattr(self, '_api_instance'):
+            from indico_jacow.plugin import JACOWPlugin
+            configuration_brevo = brevo_python.Configuration()
+            configuration_brevo.api_key['api-key'] = JACOWPlugin.settings.get('brevo_api_key')
+            self._api_instance = brevo_python.ContactsApi(brevo_python.ApiClient(configuration_brevo))
+        return self._api_instance
+
+    def get_contact_info(self, email):
+        try:
+            return self.api_instance.get_contact_info(email).to_dict()
+        except ApiException as e:
+            if e.status == 404:
+                return None
+            raise
+
+    def create_contact(self, email, first_name, last_name, list_ids):
+        contact = brevo_python.CreateContact(
+            email=email,
+            attributes={'FIRSTNAME': first_name, 'LASTNAME': last_name},
+            list_ids=list_ids
+        )
+        return self.api_instance.create_contact(contact).to_dict()
+
+    def get_list(self, list_id):
+        try:
+            return self.api_instance.get_list(list_id).to_dict()
+        except ApiException as e:
+            raise IndicoError(f'Exception when retrieving Mailing List from Brevo: {e.reason}')
+
+
+class RHMailingLists(BrevoAPIMixin, RHUserBase):
+    def _process(self):
+        valid_contact_ids = set()
+        emails = self.user.all_emails
+        lists = self.get_all_lists()
+
+        for email in emails:
+            if (contact_info := self.get_contact_info(email)):
+                if 'list_ids' in contact_info:
+                    valid_contact_ids.update(contact_info['list_ids'])
+
+        for lst in lists.get('lists', []):
+            lst['subscribed'] = lst['id'] in valid_contact_ids
+
+        mailing_lists = json.dumps(lists)
+        return WPUserMailingLists.render_template('mailing_lists.html', 'mailing_lists', user=self.user,
+                                                  mailing_lists=mailing_lists)
+
+    def get_all_lists(self):
+        try:
+            return self.api_instance.get_lists().to_dict()
+        except ApiException as e:
+            raise IndicoError(f'Exception when retrieving Mailing Lists from Brevo: {e.reason}')
+
+
+class RHMailingListSubscribe(BrevoAPIMixin, RHUserBase):
+    @use_kwargs({
+        'list_id': fields.Int(required=True, validate=not_empty),
+    })
+    def _process(self, list_id):
+        email = self.user.email
+        try:
+            if self.get_contact_info(email):
+                response = self.add_contact_to_lists(list_id, email)
+            else:
+                response = self.create_contact(
+                    email=email,
+                    first_name=self.user.first_name,
+                    last_name=self.user.last_name,
+                    list_ids=[list_id],
+                    )
+            self.user.log(UserLogRealm.user, LogKind.positive, 'Mailing Lists',
+                            f'Subscribed to list: {self.get_list(list_id)['name']}',
+                            session.user, data={'IP': request.remote_addr},
+                            meta={'list_id': list_id})
+            return response
+        except ApiException as e:
+            raise IndicoError(f'Failed to subscribe to the list and/or create contact: {e.reason}')
+
+    def add_contact_to_lists(self, list_id, contact_email):
+        contact_email = brevo_python.AddContactToList(emails=[contact_email])
+        response = self.api_instance.add_contact_to_list(list_id, contact_email)
+        return response.to_dict()
+
+
+class RHMailingListUnsubscribe(BrevoAPIMixin, RHUserBase):
+    @use_kwargs({
+        'list_id': fields.Int(required=True, validate=not_empty),
+    })
+    def _process(self, list_id):
+        contact_emails = brevo_python.RemoveContactFromList(emails=list(self.user.all_emails))
+
+        try:
+            response = self.api_instance.remove_contact_from_list(list_id, contact_emails)
+            self.user.log(UserLogRealm.user, LogKind.positive, 'Mailing Lists',
+                            f'Unsubscribed from list: {self.get_list(list_id)['name']}',
+                            session.user, data={'IP': request.remote_addr},
+                            meta={'list_id': list_id})
+            return response.to_dict()
+        except Exception as e:
+            raise IndicoError(f'Could not unsubscribe from the list: {e.reason}')

indico_jacow/plugin.py

@@ -26,8 +26,10 @@
 from indico.modules.events.persons.forms import ManagePersonListsForm
 from indico.modules.events.persons.schemas import PersonLinkSchema
 from indico.modules.events.registration.schemas import CheckinRegistrationSchema
+from indico.modules.users.views import WPUser
 from indico.util.i18n import _
 from indico.web.forms.base import IndicoForm
+from indico.web.forms.fields import IndicoPasswordField
 from indico.web.forms.widgets import SwitchWidget
 from indico.web.menu import SideMenuItem
 
@@ -38,6 +40,7 @@
 class SettingsForm(IndicoForm):
     sync_enabled = BooleanField(_('Sync profiles'), widget=SwitchWidget(),
                                 description=_('Periodically sync user details with the central database'))
+    brevo_api_key = IndicoPasswordField(_('Brevo API key'), toggle=True)
 
 
 class JACOWPlugin(IndicoPlugin):
@@ -50,6 +53,7 @@ class JACOWPlugin(IndicoPlugin):
     settings_form = SettingsForm
     default_settings = {
         'sync_enabled': False,
+        'brevo_api_key': '',
     }
     default_event_settings = {
         'multiple_affiliations': False,
@@ -73,10 +77,11 @@ def init(self):
         self.connect(signals.menu.items, self._add_sidemenu_item, sender='event-management-sidemenu')
         self.connect(signals.plugin.schema_pre_load, self._person_link_schema_pre_load, sender=PersonLinkSchema)
         self.connect(signals.plugin.schema_post_dump, self._person_link_schema_post_dump, sender=PersonLinkSchema)
+        self.connect(signals.menu.items, self._extend_user_profile_menu, sender='user-profile-sidemenu')
         self.connect(signals.plugin.schema_post_dump, self._checkin_registration_schema_post_dump,
                      sender=CheckinRegistrationSchema)
         wps = (WPContributions, WPDisplayAbstracts, WPManageAbstracts, WPManageContributions,
-               WPMyContributions, WPManagePapers)
+               WPMyContributions, WPManagePapers, WPUser)
         self.inject_bundle('main.js', wps)
         self.inject_bundle('main.css', wps)
 
@@ -221,6 +226,10 @@ def _add_sidemenu_item(self, sender, event, **kwargs):
         return SideMenuItem('abstracts_stats', _('CfA Statistics'),
                             url_for_plugin('jacow.abstracts_stats', event), section='reports')
 
+    def _extend_user_profile_menu(self, sender, user, **kwargs):
+        return SideMenuItem('mailing_lists', _('Mailing Lists'),
+                            url_for_plugin('jacow.mailing_lists', user), 65, disabled=user.is_system)
+
     def _person_link_schema_pre_load(self, sender, data, **kwargs):
         jacow_affiliations_ids = g.setdefault('jacow_affiliations_ids', {})
         jacow_affiliations_ids[data['email'].lower()] = data.get('jacow_affiliations_ids', [])

indico_jacow/templates/mailing_lists.html

@@ -0,0 +1,8 @@
+{% extends 'users/base.html' %}
+
+{% block user_content %}
+    <div id="mailing-lists"></div>
+    <script>
+        setupMailingList(document.querySelector('#mailing-lists'), {{ mailing_lists | tojson }});
+    </script>
+{% endblock %}

indico_jacow/views.py

@@ -8,6 +8,7 @@
 from indico.core.plugins import WPJinjaMixinPlugin
 from indico.modules.events.abstracts.views import WPDisplayAbstracts
 from indico.modules.events.management.views import WPEventManagement
+from indico.modules.users.views import WPUser
 
 
 class WPDisplayAbstractsStatistics(WPJinjaMixinPlugin, WPDisplayAbstracts):
@@ -17,3 +18,7 @@ class WPDisplayAbstractsStatistics(WPJinjaMixinPlugin, WPDisplayAbstracts):
 
 class WPAbstractsStats(WPJinjaMixinPlugin, WPEventManagement):
     sidemenu_option = 'abstracts_stats'
+
+
+class WPUserMailingLists(WPJinjaMixinPlugin, WPUser):
+    sidemenu_option = 'mailing_lists'