Feature/mailcow email lists #289

EricTRL · 2022-11-09T18:31:46Z

THIS BUILDS ON TOP OF THE CHANGES IN #282

Sending emails to all Squire members is complicated. While it is possible to export the membership file, copy all the email addresses, and paste them in the BCC, doing so is time-consuming and error-prone. Furthermore, all email aliases for committees need to be kept track of manually.

This feature aims for a few things:

Automatically sync Squire's member list to an email alias in Mailcow.
Ensure that this member-wide email alias can only be mailed to from our own domains.
Automatically create an email alias for committees and orders in Squire
Ensure that these commitee-wide email aliases can be mailed to from external domains as well.
Allow for the option to only create email aliases for some committees/orders, as some of them have their own mailbox instead.

Connecting to the mailcow API is possible and data can be properly read from it. Not all API endpoints are properly documented, but a somewhat good overview can be found here: https://mailcow.docs.apiary.io/# For Rspamd settings specifically, their API endpoint was extracted manually by making requests in the Mailcow admin panel. Note: Mailcow also uses an IP whitelist for its API in addition to an API key. Only ipv4 address can be added to this whitelist.

Changed file organisation. Added an API route for changing rspamd setting maps (requires read/write API access).

Squire can read, update, or create an rspamd setting that marks an alias as 'internal'. Inernal aliases can only be emailed from within the domain.

When a new member is added, or when the email address of an existing member changes, changes a "members"-alias in Mailcow. Does not handle deletions yet, nor is it made "internal".

codecov · 2022-11-10T14:52:35Z

Codecov Report

Patch coverage: 95.98% and project coverage change: +0.01% 🎉

Comparison is base (ed362f0) 95.84% compared to head (95505d3) 95.86%.

❗ Current head 95505d3 differs from pull request most recent head e050cc6. Consider uploading reports for the commit e050cc6 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #289      +/-   ##
==========================================
+ Coverage   95.84%   95.86%   +0.01%     
==========================================
  Files         145      161      +16     
  Lines        6113     7106     +993     
  Branches      968     1164     +196     
==========================================
+ Hits         5859     6812     +953     
- Misses        174      193      +19     
- Partials       80      101      +21

Flag	Coverage Δ
unittests	`95.86% <95.98%> (+0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed	Coverage Δ
user_interaction/views.py	`83.01% <ø> (ø)`
utils/viewcollectives.py	`89.42% <85.00%> (-2.25%)`	⬇️
mailcow_integration/signals.py	`87.02% <87.02%> (ø)`
core/status_collective.py	`90.90% <90.90%> (ø)`
mailcow_integration/account_pages/config.py	`93.75% <93.75%> (ø)`
mailcow_integration/admin_status/views.py	`95.21% <95.21%> (ø)`
mailcow_integration/api/client.py	`97.22% <97.22%> (ø)`
committees/committeecollective.py	`97.67% <100.00%> (ø)`
committees/models.py	`100.00% <100.00%> (ø)`
core/backends.py	`100.00% <100.00%> (ø)`
... and 16 more

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Added a status page listing all member aliases, and whether they are up-to-date.

Moved the mailcow config to a separate json file, and added this to the gitignore. Included a sample config to show the formatting. Added a page that allows users to set their preferences for each of the member aliases. Aliases that do not allow opt-outs are still shown, though their settings are disabled.

Label-formatting is now already done at the preference itself, rather than its form.

Users' preferences now sync with Mailcow.

Added a button that updates all member preferences. Member aliases are now finished, with the exception of proper error handling and additional verification (e.g. users setting a member-alias as their own email)

Also removed unused imports.

Allow updating and viewing the status of committee aliases. If an alias is not managed by Squire, it now instead lists the emails present in Mailcow. Pre-existing mailboxes break the system, as Squire still attempts to create an alias for those. Split off a separate alias-list template from the status template.

Added an interface for Mailcow Mailboxes (and friends). Added a management command that allows retrieving responses from the Mailcow API.

Results for fetching mailboxes and aliases are cached. If a member adds one of the member-aliases as their email address, then this email address is ignored.

If a committee alias address is identical to one of the member aliases, it is not updated. This is also reflected in the UI.

Aliases for which a mailbox with the same name exists are ignored. This is also indicated in the UI.

Internal aliases can still be emailed from outside the domain if another (non-internal) alias has the internal alias in its goto addresses. A warning is now issued if this is the case, along with the "routes" that allow emailing internal aliases from outside.

Added archive addresses to the config. All aliases contain such an archive addresses. The status page now also lists orphan data. That is, aliases that indicate they are managed by Squire, even though Squire doesn't actually use them.

Allows emailing all committees and workgroups through a single send-address.

Added tests for barebone requests and validation in the MailcowClient

Subscribed members are now retrieved properly, regardless of the default opt-in/opt-out status, even if they do not have explicit preferences set up.

Resolved code duplication by unifying data read by the template.

Uses the same interface/template as those for committees and global member-addresses.

Created a viewCollective for admin pages. Nextcloud status (not in this branch yet) can be added here later too. Modified mentioned payment amount on membership extension page. This should be changed to a global preference later on.

Added various signals for detecting changes for Mailcow aliases. Minor problem: Cascade deletes can cause multiple signals to run. For example, deleting a committee activates the deletion signal for the committee itself and for all attached members. This causes multiple (duplicate) requests to the API that aren't needed.

CASCADE deletion greatly complicates signal logic (see previous commit). Deletion behaviour was set to PROTECT or SET_NULL where possible.

Added a global preference that disables all of the signals. Global committee aliases no longer throw an exception in the status view. Global committee aliases no longer blocklist themselves. Alias deletion API updated. It does not match up with how it's done in the Mailcow admin panel though.

Untestable code does not count towards coverage. Added new greeting lines.

committees/models.py

DutcherNL · 2023-05-07T10:35:36Z

committees/committeecollective.py

-    def check_access_validity(self, request, association_group=None):
-        if not super(CommitteeBaseConfig, self).check_access_validity(request):
+    def is_accessible(self, request, association_group=None):
+        if not super(CommitteeBaseConfig, self).is_accessible(request):


I get why you did this namechange, but I think it conflicts with general property_naming. is_x is generally more used for get-properties. Similar to how you changed is_considered_member() to is_active on the Member model. That is why is purposely started with check_x. If you don't like the original name, maybe change it to validate_access() or something like that (i.e. a more active-sounding name)

I guess I'm a bit confused about the intent of the method in itself. Take this snippet in committees.committeecollective.CommitteeBaseConfig.is_accessible:

def is_accessible(self, request, association_group=None): if not super(CommitteeBaseConfig, self).is_accessible(request): return False if not user_in_association_group(request.user, association_group): raise PermissionDenied() # Check group permission if self.group_requires_permission is not None: app_label, codename = self.group_requires_permission.split('.', maxsplit=1) if not Permission.objects.filter( content_type__app_label=app_label, codename=codename, group__associationgroup=association_group ): return False return True

In one case it raises an exception (user is not in the committee), while in other cases it returns a boolean (committee/group does not have a specific permission). Why the difference?
In some of the calling code the boolean value is checked, and a Permission-denied exception is raised if it's false. Right now there seems to be a bit of a mismatch somewhere.

but I think it conflicts with general property_naming. is_x is generally more used for get-properties

I disagree on this. Imo, method names should roughly indicate what they do and what is returned. My assumption that the return value of this method would always be a boolean wasn't correct though.

Yeah, I may have to straighten that issue out. I agree that it should not work with both returning booleans and throw erros, that is just confusing. I'll do that in another PR though one day.

core/status_collective.py

mailcow_integration/account_pages/views.py

DutcherNL · 2023-05-07T10:48:56Z

mailcow_integration/account_pages/views.py

+            #   Mailcow client must be set up if this view can be accessed
+            config = apps.get_app_config("mailcow_integration")
+            mailcow_client: SquireMailcowManager = config.mailcow_client
+            mailcow_client.update_member_aliases()


Is it not better to add this to the form?

Agreed; views in general shouldn't make changes to the database themselves. Same goes for the statusview, which currently doesn't use a form class at all.

DutcherNL · 2023-05-07T11:34:53Z

membership_file/models.py

@@ -229,7 +252,8 @@ def __str__(self):

 class Membership(models.Model):
    """ Defines membership details of a member in a certain memberyear"""
-    member = models.ForeignKey(Member, on_delete=models.CASCADE)
+    # NULL-value allows keeping track of membership numbers over the years, even when members are deleted
+    member = models.ForeignKey(Member, on_delete=models.SET_NULL, null=True)


👍 Sounds good, but check if it does not cause conflicts with the unique_together property as it could cause multiple null- instances to exist

Good call. It seems like NULL-values aren't considered for unique_together. Judging from various StackOverflow threads that seems to be a common thing people don't realise.

Can you write a testcase to validate that (and catch any non-intended Django changes in the future?)

user_interaction/views.py

utils/viewcollectives.py

mailcow_integration/squire_mailcow.py

Tests various init_<foo>_alias_list methods. Added tests for get_context_data. Added tests for the status view's POST request handling.

Added a link to the server status page in the hamburger menu. Addressed review comments.

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

blackfmt

github-actions · 2023-05-07T14:52:35Z

committees/models.py

@@ -84,9 +84,12 @@ class AssociationGroupMembership(models.Model):
    For another we want additional information stored that is difficult when attempting to override the link between
    user and group.
    """
-    member = models.ForeignKey(Member, on_delete=models.CASCADE, blank=True, null=True)
+    # PROTECT prevents accidental deletion of a member while it is still in a committee.


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

# PROTECT prevents accidental deletion of a member while it is still in a committee.

# PROTECT prevents accidental deletion of a member while it is still in a committee.

github-actions · 2023-05-07T14:52:35Z

committees/models.py

+    # PROTECT prevents accidental deletion of a member while it is still in a committee.
+    #   It also serves as a way to prevent deletion-signals to fire at the same
+    #   time when a committee is deleted (once for member, and then the committee)
+    member = models.ForeignKey(Member, on_delete=models.PROTECT, blank=True, null=True)
    external_person = models.CharField(max_length=64, help_text="Name of a person who is not a registered member", blank=True)


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

external_person = models.CharField(max_length=64, help_text="Name of a person who is not a registered member", blank=True)

external_person = models.CharField(

max_length=64, help_text="Name of a person who is not a registered member", blank=True

)

github-actions · 2023-05-07T14:52:35Z

committees/tests/test_committee_collective.py

@@ -30,26 +30,26 @@ def test_check_access_super(self):
        # New request with no info WILL fail at the parent
        request = RequestFactory().get(path='')


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

request = RequestFactory().get(path='')

request = RequestFactory().get(path="")

github-actions · 2023-05-07T14:52:36Z

committees/tests/test_committee_collective.py


    def test_check_access_without_permission_requirement(self):
-        self.assertEqual(self.config.check_access_validity(self.request, self.association_group), True)
+        self.assertEqual(self.config.is_accessible(self.request, self.association_group), True)

    def test_check_access_permission_requirement_fails(self):
        self.config.group_requires_permission = 'auth.change_user'


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

self.config.group_requires_permission = 'auth.change_user'

self.config.group_requires_permission = "auth.change_user"

github-actions · 2023-05-07T14:52:36Z

committees/tests/test_committee_collective.py


    def test_check_access_permission_requirement_fails(self):
        self.config.group_requires_permission = 'auth.change_user'
-        self.assertEqual(self.config.check_access_validity(self.request, self.association_group), False)
+        self.assertEqual(self.config.is_accessible(self.request, self.association_group), False)

    def test_check_access_permission_requirement_success(self):
        self.config.group_requires_permission = 'auth.change_user'


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

self.config.group_requires_permission = 'auth.change_user'

self.config.group_requires_permission = "auth.change_user"

github-actions · 2023-05-07T14:52:39Z

mailcow_integration/admin_status/config.py

+
+    def get_urls(self):
+        return [
+            path('', MailcowTabbedStatusView.as_view(config=self), name='mailcow_status'),


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

path('', MailcowTabbedStatusView.as_view(config=self), name='mailcow_status'),

path("", MailcowTabbedStatusView.as_view(config=self), name="mailcow_status"),

github-actions · 2023-05-07T14:52:39Z

mailcow_integration/admin_status/views.py

+from committees.models import AssociationGroup
+from core.status_collective import AdminStatusViewMixin
+
+from mailcow_integration.api.exceptions import MailcowAPIAccessDenied, MailcowAPIReadWriteAccessDenied, MailcowAuthException, MailcowException


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

from mailcow_integration.api.exceptions import MailcowAPIAccessDenied, MailcowAPIReadWriteAccessDenied, MailcowAuthException, MailcowException

from mailcow_integration.api.exceptions import (

MailcowAPIAccessDenied,

MailcowAPIReadWriteAccessDenied,

MailcowAuthException,

MailcowException,

)

github-actions · 2023-05-07T14:52:39Z

mailcow_integration/admin_status/views.py

+
+logger = logging.getLogger(__name__)
+
+class AliasStatus(Enum):


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

class AliasStatus(Enum):

class AliasStatus(Enum):

github-actions · 2023-05-07T14:52:39Z

mailcow_integration/admin_status/views.py

+    """ Aliases that should exist according to Squire may not be in sync with those in Mailcow.
+        This Enum indicates the disparity between the two.


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

""" Aliases that should exist according to Squire may not be in sync with those in Mailcow.

This Enum indicates the disparity between the two.

"""Aliases that should exist according to Squire may not be in sync with those in Mailcow.

This Enum indicates the disparity between the two.

github-actions · 2023-05-07T14:52:39Z

mailcow_integration/admin_status/views.py

+    VALID = 0 # Squire and mailcow are in sync
+    MISSING = 1 # Alias is not in Mailcow, but should exist
+    NOT_MANAGED_BY_SQUIRE = 2 # Alias is in Mailcow, but does not have a public comment indicating it is managed by Squire
+    OUTDATED = 3 # Alias goto-addresses do not match up with Squire
+    RESERVED = 4 # Alias already reserved for a member-alias, but a committee has it as their contact info
+    MAILBOX = 5 # Mailbox with the same name already exists; not managed by Squire
+    ORPHAN = 6 # Alias is not needed by Squire, but existed in Mailcow


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

VALID = 0 # Squire and mailcow are in sync

MISSING = 1 # Alias is not in Mailcow, but should exist

NOT_MANAGED_BY_SQUIRE = 2 # Alias is in Mailcow, but does not have a public comment indicating it is managed by Squire

OUTDATED = 3 # Alias goto-addresses do not match up with Squire

RESERVED = 4 # Alias already reserved for a member-alias, but a committee has it as their contact info

MAILBOX = 5 # Mailbox with the same name already exists; not managed by Squire

ORPHAN = 6 # Alias is not needed by Squire, but existed in Mailcow

VALID = 0 # Squire and mailcow are in sync

MISSING = 1 # Alias is not in Mailcow, but should exist

NOT_MANAGED_BY_SQUIRE = (

2 # Alias is in Mailcow, but does not have a public comment indicating it is managed by Squire

)

OUTDATED = 3 # Alias goto-addresses do not match up with Squire

RESERVED = 4 # Alias already reserved for a member-alias, but a committee has it as their contact info

MAILBOX = 5 # Mailbox with the same name already exists; not managed by Squire

ORPHAN = 6 # Alias is not needed by Squire, but existed in Mailcow

Moved member aliases update call to a form when a member updates their email preferences. Added tests for this form and the corresponding view. Honorary members are considered active members. Renamed is_accessble to is_accessible_for

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

blackfmt

github-actions · 2023-05-21T11:53:00Z

mailcow_integration/account_pages/config.py

+
+    def get_urls(self):
+        return [
+            path('', TabbedEmailPreferencesChangeView.as_view(config=self), name='email_preferences'),


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

path('', TabbedEmailPreferencesChangeView.as_view(config=self), name='email_preferences'),

path("", TabbedEmailPreferencesChangeView.as_view(config=self), name="email_preferences"),

github-actions · 2023-05-21T11:53:00Z

mailcow_integration/account_pages/forms.py

+
+from mailcow_integration.squire_mailcow import SquireMailcowManager, get_mailcow_manager
+
+class MemberMailPreferencesForm(UserPreferenceForm):


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

class MemberMailPreferencesForm(UserPreferenceForm):

class MemberMailPreferencesForm(UserPreferenceForm):

github-actions · 2023-05-21T11:53:01Z

mailcow_integration/account_pages/forms.py

+    """ Form that allows changing member mail preferences """
+    def __init__(self, *args, mailcow_manager:SquireMailcowManager=None, **kwargs):


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

""" Form that allows changing member mail preferences """

def __init__(self, *args, mailcow_manager:SquireMailcowManager=None, **kwargs):

"""Form that allows changing member mail preferences"""

def __init__(self, *args, mailcow_manager: SquireMailcowManager = None, **kwargs):

github-actions · 2023-05-21T11:53:01Z

mailcow_integration/account_pages/forms.py

+        super().__init__(*args, **kwargs)
+
+    def update_preferences(self, **kwargs):
+        """ Update mail preferences and invokes the SquireMailcowManager """


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

""" Update mail preferences and invokes the SquireMailcowManager """

"""Update mail preferences and invokes the SquireMailcowManager"""

github-actions · 2023-05-21T11:53:01Z

mailcow_integration/account_pages/views.py

+
+from user_interaction.accountcollective import AccountViewMixin
+
+class EmailPreferencesChangeView(FormView):


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

class EmailPreferencesChangeView(FormView):

class EmailPreferencesChangeView(FormView):

github-actions · 2023-05-21T11:53:04Z

mailcow_integration/admin_status/views.py

+            status, alias, mailbox = self._get_alias_status(address, subscribers, AliasCategory.MEMBER,
+                aliases, mailboxes, self.mailcow_manager.ALIAS_MEMBERS_PUBLIC_COMMENT)


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

status, alias, mailbox = self._get_alias_status(address, subscribers, AliasCategory.MEMBER,

aliases, mailboxes, self.mailcow_manager.ALIAS_MEMBERS_PUBLIC_COMMENT)

github-actions · 2023-05-21T11:53:04Z

mailcow_integration/admin_status/views.py

+                aliases, mailboxes, self.mailcow_manager.ALIAS_MEMBERS_PUBLIC_COMMENT)
+
+            exposure_routes = []
+            if config['internal']:


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

if config['internal']:

if config["internal"]:

github-actions · 2023-05-21T11:53:05Z

mailcow_integration/admin_status/views.py

+            info = AliasInfos(status.name, subscribers, address, "m_" + alias_address_to_id(address), config['title'], config['description'],
+                alias or mailbox, config['internal'], exposure_routes, config['allow_opt_out'], archive_addresses=config['archive_addresses']


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

info = AliasInfos(status.name, subscribers, address, "m_" + alias_address_to_id(address), config['title'], config['description'],

alias or mailbox, config['internal'], exposure_routes, config['allow_opt_out'], archive_addresses=config['archive_addresses']

info = AliasInfos(

status.name,

subscribers,

address,

"m_" + alias_address_to_id(address),

config["title"],

config["description"],

alias or mailbox,

config["internal"],

exposure_routes,

config["allow_opt_out"],

archive_addresses=config["archive_addresses"],

github-actions · 2023-05-21T11:53:05Z

mailcow_integration/admin_status/views.py

+    def _init_global_committee_alias_list(self, aliases: List[MailcowAlias], mailboxes: List[MailcowMailbox]) -> List[AliasInfos]:
+        """ Initialize global committee aliases. e.g. commissies@example.com """


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

def _init_global_committee_alias_list(self, aliases: List[MailcowAlias], mailboxes: List[MailcowMailbox]) -> List[AliasInfos]:

""" Initialize global committee aliases. e.g. commissies@example.com """

def _init_global_committee_alias_list(

self, aliases: List[MailcowAlias], mailboxes: List[MailcowMailbox]

) -> List[AliasInfos]:

"""Initialize global committee aliases. e.g. commissies@example.com"""

github-actions · 2023-05-21T11:53:05Z

mailcow_integration/admin_status/views.py

+            status, alias, mailbox = self._get_alias_status(address, subscribers, AliasCategory.GLOBAL_COMMITTEE,
+                aliases, mailboxes, self.mailcow_manager.ALIAS_GLOBAL_COMMITTEE_PUBLIC_COMMENT)


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

status, alias, mailbox = self._get_alias_status(address, subscribers, AliasCategory.GLOBAL_COMMITTEE,

aliases, mailboxes, self.mailcow_manager.ALIAS_GLOBAL_COMMITTEE_PUBLIC_COMMENT)

status, alias, mailbox = self._get_alias_status(

address,

subscribers,

AliasCategory.GLOBAL_COMMITTEE,

aliases,

mailboxes,

self.mailcow_manager.ALIAS_GLOBAL_COMMITTEE_PUBLIC_COMMENT,

)

Added tests for alias signals, fixing a small collection of related bugs in the process.

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

blackfmt

github-actions · 2023-05-21T17:15:33Z

mailcow_integration/admin_status/views.py

+            subscribers = self._get_subscriberinfos_by_status(status, subscribers, alias, alias_type=AliasCategory.GLOBAL_COMMITTEE)
+            info = AliasInfos(status.name, subscribers, address, "gc_" + alias_address_to_id(address), address,


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

subscribers = self._get_subscriberinfos_by_status(status, subscribers, alias, alias_type=AliasCategory.GLOBAL_COMMITTEE)

info = AliasInfos(status.name, subscribers, address, "gc_" + alias_address_to_id(address), address,

subscribers = self._get_subscriberinfos_by_status(

status, subscribers, alias, alias_type=AliasCategory.GLOBAL_COMMITTEE

)

info = AliasInfos(

status.name,

subscribers,

address,

"gc_" + alias_address_to_id(address),

address,

github-actions · 2023-05-21T17:15:33Z

mailcow_integration/admin_status/views.py

+            subscribers = self._get_subscriberinfos_by_status(status, subscribers, alias, alias_type=AliasCategory.GLOBAL_COMMITTEE)
+            info = AliasInfos(status.name, subscribers, address, "gc_" + alias_address_to_id(address), address,
+                "Allows mailing all committees at the same time.",
+                alias or mailbox, internal=False, allow_opt_out=False, archive_addresses=settings.COMMITTEE_CONFIGS['global_archive_addresses']


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

alias or mailbox, internal=False, allow_opt_out=False, archive_addresses=settings.COMMITTEE_CONFIGS['global_archive_addresses']

alias or mailbox,

internal=False,

allow_opt_out=False,

archive_addresses=settings.COMMITTEE_CONFIGS["global_archive_addresses"],

github-actions · 2023-05-21T17:15:33Z

mailcow_integration/admin_status/views.py

+    def _init_committee_alias_list(self, aliases: List[MailcowAlias], mailboxes: List[MailcowMailbox]) -> List[AliasInfos]:
+        """ Initialize committee aliases. e.g. bg@example.com """


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

def _init_committee_alias_list(self, aliases: List[MailcowAlias], mailboxes: List[MailcowMailbox]) -> List[AliasInfos]:

""" Initialize committee aliases. e.g. bg@example.com """

def _init_committee_alias_list(

self, aliases: List[MailcowAlias], mailboxes: List[MailcowMailbox]

) -> List[AliasInfos]:

"""Initialize committee aliases. e.g. bg@example.com"""

github-actions · 2023-05-21T17:15:33Z

mailcow_integration/admin_status/views.py

+
+        for assoc_group in self.mailcow_manager.get_active_committees():
+            address = assoc_group.contact_email
+            subscribers = assoc_group.members.filter_active().order_by('email')


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

subscribers = assoc_group.members.filter_active().order_by('email')

subscribers = assoc_group.members.filter_active().order_by("email")

github-actions · 2023-05-21T17:15:33Z

mailcow_integration/admin_status/views.py

+            status, alias, mailbox = self._get_alias_status(address, subscribers, AliasCategory.COMMITTEE,
+                aliases, mailboxes, self.mailcow_manager.ALIAS_COMMITTEE_PUBLIC_COMMENT)


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

status, alias, mailbox = self._get_alias_status(address, subscribers, AliasCategory.COMMITTEE,

aliases, mailboxes, self.mailcow_manager.ALIAS_COMMITTEE_PUBLIC_COMMENT)

status, alias, mailbox = self._get_alias_status(

address,

subscribers,

AliasCategory.COMMITTEE,

aliases,

mailboxes,

self.mailcow_manager.ALIAS_COMMITTEE_PUBLIC_COMMENT,

)

github-actions · 2023-05-21T17:15:37Z

mailcow_integration/api/client.py

+        In order to connect to a `host`'s API, an `api_key` needs to be generated in the
+        Mailcow admin. Additionally, the API needs to be activated, and the ipv4 and/or ipv6
+        addresses of the client needs to be added to an IP whitelist (alternatively, the
+        IP whitelist can be disabled entirely).


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

In order to connect to a `host`'s API, an `api_key` needs to be generated in the

Mailcow admin. Additionally, the API needs to be activated, and the ipv4 and/or ipv6

addresses of the client needs to be added to an IP whitelist (alternatively, the

IP whitelist can be disabled entirely).

In order to connect to a `host`'s API, an `api_key` needs to be generated in the

Mailcow admin. Additionally, the API needs to be activated, and the ipv4 and/or ipv6

addresses of the client needs to be added to an IP whitelist (alternatively, the

IP whitelist can be disabled entirely).

github-actions · 2023-05-21T17:15:37Z

mailcow_integration/api/client.py

+        addresses of the client needs to be added to an IP whitelist (alternatively, the
+        IP whitelist can be disabled entirely).
+    """
+    API_FORMAT = "%(host)s/api/v1/"


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

API_FORMAT = "%(host)s/api/v1/"

API_FORMAT = "%(host)s/api/v1/"

github-actions · 2023-05-21T17:15:37Z

mailcow_integration/api/client.py

+        self.api_key = api_key
+
+    def _get_headers(self) -> dict:
+        """ Retrieves the headers required to fetch info from the Mailcow API. """


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

""" Retrieves the headers required to fetch info from the Mailcow API. """

"""Retrieves the headers required to fetch info from the Mailcow API."""

github-actions · 2023-05-21T17:15:37Z

mailcow_integration/api/client.py

+        """ Checks some response data, and generates an appropriate exception based on it """
+        if content.get('type', None) == "error":


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

""" Checks some response data, and generates an appropriate exception based on it """

if content.get('type', None) == "error":

"""Checks some response data, and generates an appropriate exception based on it"""

if content.get("type", None) == "error":

github-actions · 2023-05-21T17:15:38Z

mailcow_integration/api/client.py

+        """ Checks some response data, and generates an appropriate exception based on it """
+        if content.get('type', None) == "error":
+            # API returned an error
+            if content.get('msg', None) == "authentication failed":


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

if content.get('msg', None) == "authentication failed":

if content.get("msg", None) == "authentication failed":

Rspamd setting that makes aliases internal can be viewed on the status page. "Internal" aliases now indicate they're exposed when this rspamd setting is missing or inactive. Aliases now indicate if they're inactive. Added a few more missing tests.

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

blackfmt

github-actions · 2023-05-21T19:26:48Z

mailcow_integration/admin_status/views.py

+            subscribers = self._get_subscriberinfos_by_status(status, subscribers, alias, alias_type=AliasCategory.GLOBAL_COMMITTEE)
+            info = AliasInfos(status.name, subscribers, address, "gc_" + alias_address_to_id(address), address,
+                "Allows mailing all committees at the same time.",
+                alias or mailbox, internal=True, exposure_routes=exp_routes, allow_opt_out=None, archive_addresses=settings.COMMITTEE_CONFIGS['global_archive_addresses']


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

alias or mailbox, internal=True, exposure_routes=exp_routes, allow_opt_out=None, archive_addresses=settings.COMMITTEE_CONFIGS['global_archive_addresses']

alias or mailbox,

internal=True,

exposure_routes=exp_routes,

allow_opt_out=None,

archive_addresses=settings.COMMITTEE_CONFIGS["global_archive_addresses"],

github-actions · 2023-05-21T19:26:48Z

mailcow_integration/admin_status/views.py

+            context['internal_alias_rspamd_setting'] = self.mailcow_manager.internal_alias_rspamd_setting
+            context['mailcow_host'] = self.mailcow_manager.mailcow_host


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

context['internal_alias_rspamd_setting'] = self.mailcow_manager.internal_alias_rspamd_setting

context['mailcow_host'] = self.mailcow_manager.mailcow_host

context["internal_alias_rspamd_setting"] = self.mailcow_manager.internal_alias_rspamd_setting

context["mailcow_host"] = self.mailcow_manager.mailcow_host

github-actions · 2023-05-21T19:26:48Z

mailcow_integration/api/client.py

+                raise MailcowAuthException(f"{request_url}: {content['msg']}")
+            elif content.get("msg", "").startswith("API read/write access denied"):
+                raise MailcowAPIReadWriteAccessDenied(f"{request_url}: {content['msg']}")
+            elif content.get('msg', "").startswith("api access denied"):


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

elif content.get('msg', "").startswith("api access denied"):

elif content.get("msg", "").startswith("api access denied"):

github-actions · 2023-05-21T19:26:48Z

mailcow_integration/api/client.py

+            elif content.get('msg', "").startswith("api access denied"):
+                # IP is not whitelisted
+                raise MailcowAPIAccessDenied(f"{request_url}: {content['msg']}")
+            elif content.get('msg', None) == "route not found":


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

elif content.get('msg', None) == "route not found":

elif content.get("msg", None) == "route not found":

github-actions · 2023-05-21T19:26:48Z

mailcow_integration/api/client.py

+                # Some other error (should not happen)
+                logger.error(content)
+                raise MailcowException(f"{request_url}: {content['msg']}")
+        elif content.get('type', None) == 'danger':


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

elif content.get('type', None) == 'danger':

elif content.get("type", None) == "danger":

github-actions · 2023-05-21T19:26:52Z

mailcow_integration/api/client.py

+        return RspamdSettings.from_json(content)
+
+    def update_rspamd_setting(self, setting: RspamdSettings) -> dict:
+        """ Updates the RspamdSetting associated to the given ID with the given data """


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

""" Updates the RspamdSetting associated to the given ID with the given data """

"""Updates the RspamdSetting associated to the given ID with the given data"""

github-actions · 2023-05-21T19:26:52Z

mailcow_integration/api/client.py

+        data = json.dumps({
+            'items': [setting.id],
+            'attr': {
+                'active': int(setting.active),
+                'desc': setting.desc,
+                'content': setting.content,


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

data = json.dumps({

'items': [setting.id],

'attr': {

'active': int(setting.active),

'desc': setting.desc,

'content': setting.content,

data = json.dumps(

{

"items": [setting.id],

"attr": {

"active": int(setting.active),

"desc": setting.desc,

"content": setting.content,

},

github-actions · 2023-05-21T19:26:52Z

mailcow_integration/api/client.py

+                'desc': setting.desc,
+                'content': setting.content,
+            }
+        })


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

})

)

github-actions · 2023-05-21T19:26:52Z

mailcow_integration/api/client.py

+        return self._make_request(f"edit/rsetting", request_type=RequestType.POST, data=data)
+
+    def create_rspamd_setting(self, setting: RspamdSettings) -> dict:
+        """ Creates a new Rspamd setting """


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

""" Creates a new Rspamd setting """

"""Creates a new Rspamd setting"""

github-actions · 2023-05-21T19:26:52Z

mailcow_integration/api/client.py

+        data = json.dumps({
+            'desc': setting.desc,
+            'content': setting.content,
+            'active': int(setting.active),
+        })


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

data = json.dumps({

'desc': setting.desc,

'content': setting.content,

'active': int(setting.active),

})

data = json.dumps(

{

"desc": setting.desc,

"content": setting.content,

"active": int(setting.active),

}

)

Turned MailcowManager.internal_alias_rspamd_setting back into a method due to the extra cache-control parameter.

SquireMailcowManager.is_internal_alias Member.is_active

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

blackfmt

github-actions · 2023-06-23T09:11:34Z

mailcow_integration/admin_status/views.py

+            context['internal_alias_rspamd_setting'] = self.mailcow_manager.get_internal_alias_rspamd_setting(use_cache=False)
+            context['mailcow_host'] = self.mailcow_manager.mailcow_host


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

context['internal_alias_rspamd_setting'] = self.mailcow_manager.get_internal_alias_rspamd_setting(use_cache=False)

context['mailcow_host'] = self.mailcow_manager.mailcow_host

context["internal_alias_rspamd_setting"] = self.mailcow_manager.get_internal_alias_rspamd_setting(

use_cache=False

)

context["mailcow_host"] = self.mailcow_manager.mailcow_host

github-actions · 2023-06-23T09:11:34Z

mailcow_integration/api/exceptions.py

@@ -0,0 +1,18 @@
+


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

github-actions · 2023-06-23T09:11:34Z

mailcow_integration/api/exceptions.py

@@ -0,0 +1,18 @@
+
+class MailcowException(Exception):
+    """ General exception class for errors raised by the Mailcow API """


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

""" General exception class for errors raised by the Mailcow API """

"""General exception class for errors raised by the Mailcow API"""

github-actions · 2023-06-23T09:11:34Z

mailcow_integration/api/exceptions.py

+    """ General exception class for errors raised by the Mailcow API """
+
+class MailcowAuthException(MailcowException):
+    """ Raised if authentication with the Mailcow server fails (invalid API key) """


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

""" Raised if authentication with the Mailcow server fails (invalid API key) """

"""Raised if authentication with the Mailcow server fails (invalid API key)"""

github-actions · 2023-06-23T09:11:35Z

mailcow_integration/api/exceptions.py

+    """ Raised if authentication with the Mailcow server fails (invalid API key) """
+
+class MailcowAPIAccessDenied(MailcowException):
+    """ Raised if API access is denied for some IP """


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

""" Raised if API access is denied for some IP """

"""Raised if API access is denied for some IP"""

github-actions · 2023-06-23T09:11:39Z

mailcow_integration/api/interface/mailbox.py

+    """ Mailcow Mailbox """
+    username: str # Username is the id
+    name: str # Name appearing when sending an email
+    local_part: str = None # everything before the @example.com


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

""" Mailcow Mailbox """

username: str # Username is the id

name: str # Name appearing when sending an email

local_part: str = None # everything before the @example.com

"""Mailcow Mailbox"""

username: str # Username is the id

name: str # Name appearing when sending an email

local_part: str = None # everything before the @example.com

github-actions · 2023-06-23T09:11:39Z

mailcow_integration/api/interface/mailbox.py

+    domain: str = None
+
+    active: MailboxStatus = MailboxStatus.ACTIVE
+    active_int: int = None # ??? Always identical to active


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

active_int: int = None # ??? Always identical to active

active_int: int = None # ??? Always identical to active

github-actions · 2023-06-23T09:11:39Z

mailcow_integration/api/interface/mailbox.py

+    messages: int = 0 # Number of messages in the mailbox
+    quota: int = 0 # in bytes; 0 for infinite
+    quota_used: int = 0 # in bytes
+    percent_in_use: Optional[int] = None # from 0-100, or None if N/A
+    max_new_quota: int = 0 # in bytes; maximum possible quota


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

messages: int = 0 # Number of messages in the mailbox

quota: int = 0 # in bytes; 0 for infinite

quota_used: int = 0 # in bytes

percent_in_use: Optional[int] = None # from 0-100, or None if N/A

max_new_quota: int = 0 # in bytes; maximum possible quota

messages: int = 0 # Number of messages in the mailbox

quota: int = 0 # in bytes; 0 for infinite

quota_used: int = 0 # in bytes

percent_in_use: Optional[int] = None # from 0-100, or None if N/A

max_new_quota: int = 0 # in bytes; maximum possible quota

github-actions · 2023-06-23T09:11:39Z

mailcow_integration/api/interface/mailbox.py

+    rl: bool = False # ???
+    rl_scope: str = "domain" # ??? E.g. 'domain'
+    is_relayed: bool = False # ???


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

rl: bool = False # ???

rl_scope: str = "domain" # ??? E.g. 'domain'

is_relayed: bool = False # ???

rl: bool = False # ???

rl_scope: str = "domain" # ??? E.g. 'domain'

is_relayed: bool = False # ???

github-actions · 2023-06-23T09:11:39Z

mailcow_integration/api/interface/mailbox.py

+    last_pop3_login: Optional[datetime] = None
+
+    domain_xmpp: int = 0
+    domain_xmpp_prefix: str = "" # ???


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

domain_xmpp_prefix: str = "" # ???

domain_xmpp_prefix: str = "" # ???

Catch MailcowExceptions when working with the API.

utils/viewcollectives.py

DutcherNL · 2023-08-18T20:49:15Z

mailcow_integration/admin_status/views.py

+
+logger = logging.getLogger(__name__)
+
+class AliasStatus(Enum):


There is a lot going on in this file that I don't believe should be in this file. Or at least not in this class. To me it feels like there should be a MailcowAlias class that contains all information such as status, info (currently AliasInfo) and even get_alias_status() and get_alias_exposure_route() logic. Otherwise I fear that the code may become hard to decipher/ update once we are gone.

That said, it's more about code clarity/readability than functionality, so I'm fine with approving this PR if you can refactor that in the coming months and update it in a later PR.

Delaying to a future PR would be appreciated. There's a few other refactors I'd like to make as well.

Take a stab at "merging" some of the tabs on the account page. There's little reason for email preferences to be a tab separate from the main account settings/preferences (like site theming).

Play around with task queue systems like Celery. This should not only reduce HTTP traffic, but also ensure that signals from cascade deletes will never cause a headache again.

(possibly) have an overview somewhere of aliases you're a part of (committee, global committee, and subbed member)

The require_membership parameter for ViewCollectives now requires an active membership, rather than any membership whatsoever. Adjusted testcases to ensure those members are active.

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

blackfmt

github-actions · 2023-08-19T09:13:22Z

activity_calendar/tests/test_models.py

+    fixtures = ["test_users.json", "test_activity_slots", "test_members.json",
+                "activity_calendar/test_activity_organisers",


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

fixtures = ["test_users.json", "test_activity_slots", "test_members.json",

"activity_calendar/test_activity_organisers",

fixtures = [

"test_users.json",

"test_activity_slots",

"test_members.json",

"activity_calendar/test_activity_organisers",

github-actions · 2023-08-19T09:13:22Z

mailcow_integration/admin_status/views.py

+            if error is None:
+                messages.success(self.request, f"Orphan data deleted: {', '.join(unused_addresses)}.")
+            else:
+                messages.error(self.request, f"Error deleting data: {', '.join(unused_addresses)}.\nException: {error}")


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

messages.error(self.request, f"Error deleting data: {', '.join(unused_addresses)}.\nException: {error}")

messages.error(

self.request, f"Error deleting data: {', '.join(unused_addresses)}.\nException: {error}"

)

github-actions · 2023-08-19T09:13:22Z

mailcow_integration/admin_status/views.py

+        else:
+            return HttpResponseBadRequest("Invalid alias_type passed")
+
+        for (addr, e) in errors:


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

for (addr, e) in errors:

for addr, e in errors:

github-actions · 2023-08-19T09:13:22Z

mailcow_integration/api/interface/mailbox.py

+    spam_aliases: int = 0 # ???
+    pushover_active: bool = False # Push notification settings
+    percent_class: str = "success" # ??? E.g. 'success'


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

spam_aliases: int = 0 # ???

pushover_active: bool = False # Push notification settings

percent_class: str = "success" # ??? E.g. 'success'

spam_aliases: int = 0 # ???

pushover_active: bool = False # Push notification settings

percent_class: str = "success" # ??? E.g. 'success'

github-actions · 2023-08-19T09:13:22Z

mailcow_integration/api/interface/mailbox.py

+    def __post_init__(self):
+        index = self.username.find("@")
+        if self.local_part is None:
+            self.local_part = self.username[index + 1:]


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

self.local_part = self.username[index + 1:]

self.local_part = self.username[index + 1 :]

github-actions · 2023-08-19T09:13:25Z

mailcow_integration/dynamic_preferences_registry.py

+                if not alias_data['internal']:
+                    label_elements.append('<span class="badge badge-primary badge-pill"><i class="fas fas fa-globe"></i> Public</span>')


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

if not alias_data['internal']:

label_elements.append(' Public')

if not alias_data["internal"]:

label_elements.append(

' Public'

)

github-actions · 2023-08-19T09:13:25Z

mailcow_integration/dynamic_preferences_registry.py

+                    ' '.join(label_elements),
+                    alias_data['description'],


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

' '.join(label_elements),

alias_data['description'],

" ".join(label_elements),

alias_data["description"],

github-actions · 2023-08-19T09:13:25Z

mailcow_integration/dynamic_preferences_registry.py

+
+            section = mail
+            name = alias_address_to_id(alias_address)
+            default = alias_data['default_opt']


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

default = alias_data['default_opt']

default = alias_data["default_opt"]

github-actions · 2023-08-19T09:13:25Z

mailcow_integration/dynamic_preferences_registry.py

+            # help_text = ''
+
+            field_kwargs = {
+                'disabled': not alias_data['allow_opt_out'],


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

'disabled': not alias_data['allow_opt_out'],

"disabled": not alias_data["allow_opt_out"],

github-actions · 2023-08-19T09:13:26Z

mailcow_integration/dynamic_preferences_registry.py

+                'disabled': not alias_data['allow_opt_out'],
+            }
+
+register_preferences(settings.MEMBER_ALIASES)


[blackfmt] _{reported by reviewdog 🐶}

Suggested change

register_preferences(settings.MEMBER_ALIASES)

register_preferences(settings.MEMBER_ALIASES)

EricTRL added 3 commits November 9, 2022 13:51

Rspamd change API + move

cc0f0b1

Changed file organisation. Added an API route for changing rspamd setting maps (requires read/write API access).

Rspamd setting for 'internal' alias

5642c25

Squire can read, update, or create an rspamd setting that marks an alias as 'internal'. Inernal aliases can only be emailed from within the domain.

EricTRL added membership file Related to the membership file feature feature admin The Admin Panel for Back-end stuff downloads Newsletter and other downloadable content labels Nov 9, 2022

Update members-alias based on active members

54466b2

When a new member is added, or when the email address of an existing member changes, changes a "members"-alias in Mailcow. Does not handle deletions yet, nor is it made "internal".

EricTRL added 21 commits November 17, 2022 14:07

Status page

88e219a

Added a status page listing all member aliases, and whether they are up-to-date.

Moved preference label-formatting to preference

1b53bcf

Label-formatting is now already done at the preference itself, rather than its form.

Connect preference change to API

b60a7d7

Users' preferences now sync with Mailcow.

Update member preferences on status page

65023a5

Added a button that updates all member preferences. Member aliases are now finished, with the exception of proper error handling and additional verification (e.g. users setting a member-alias as their own email)

Updated docstrings and comments

7d9f185

Also removed unused imports.

Management command + Mailbox interface

675f0ad

Added an interface for Mailcow Mailboxes (and friends). Added a management command that allows retrieving responses from the Mailcow API.

Ignore member alias + cache

253d167

Results for fetching mailboxes and aliases are cached. If a member adds one of the member-aliases as their email address, then this email address is ignored.

Filter invalid committee aliases

0f1c427

If a committee alias address is identical to one of the member aliases, it is not updated. This is also reflected in the UI.

Mailbox handling

ee0af60

Aliases for which a mailbox with the same name exists are ignored. This is also indicated in the UI.

Internal alias exposure

c0e4413

Internal aliases can still be emailed from outside the domain if another (non-internal) alias has the internal alias in its goto addresses. A warning is now issued if this is the case, along with the "routes" that allow emailing internal aliases from outside.

Archive addresses + Orphan data

887bf30

Added archive addresses to the config. All aliases contain such an archive addresses. The status page now also lists orphan data. That is, aliases that indicate they are managed by Squire, even though Squire doesn't actually use them.

Global committee alias

7a6e301

Allows emailing all committees and workgroups through a single send-address.

Util methods + separate settings file

04878de

Client request tests

4f5c424

Added tests for barebone requests and validation in the MailcowClient

Test interfaces

a9a5f21

Bugfix: Subscribed Members

fea5480

Subscribed members are now retrieved properly, regardless of the default opt-in/opt-out status, even if they do not have explicit preferences set up.

Subscription tests

c50aaac

Refactor Status View

9dcd1d8

Resolved code duplication by unifying data read by the template.

Add orphan display

0fd581d

Uses the same interface/template as those for committees and global member-addresses.

EricTRL added 6 commits April 14, 2023 10:53

Admin Status ViewCollective

b7db1c6

Created a viewCollective for admin pages. Nextcloud status (not in this branch yet) can be added here later too. Modified mentioned payment amount on membership extension page. This should be changed to a global preference later on.

PROTECT instead of CASCADE

f669112

CASCADE deletion greatly complicates signal logic (see previous commit). Deletion behaviour was set to PROTECT or SET_NULL where possible.

Fixed broken test + misc

36e7e78

Untestable code does not count towards coverage. Added new greeting lines.

Tests: Delete + global committee alias update

e93f73e

DutcherNL requested changes May 7, 2023

View reviewed changes

EricTRL added 4 commits May 7, 2023 15:07

AliasInfos View Tests

14c1753

Tests various init_<foo>_alias_list methods. Added tests for get_context_data. Added tests for the status view's POST request handling.

Address review comments + link

872b2b3

Added a link to the server status page in the hamburger menu. Addressed review comments.

Merge branch 'master' into feature/mailcow-email-lists

c72ec7b

Fix broken tests as result of merge

2664cc4

github-actions bot reviewed May 7, 2023

View reviewed changes

Addressed review: member alias change form

972a804

Moved member aliases update call to a form when a member updates their email preferences. Added tests for this form and the corresponding view. Honorary members are considered active members. Renamed is_accessble to is_accessible_for

github-actions bot reviewed May 21, 2023

View reviewed changes

Signal tests + bugfixes

7ca381a

Added tests for alias signals, fixing a small collection of related bugs in the process.

github-actions bot reviewed May 21, 2023

View reviewed changes

Tests + internal alias status

82f1e99

Rspamd setting that makes aliases internal can be viewed on the status page. "Internal" aliases now indicate they're exposed when this rspamd setting is missing or inactive. Aliases now indicate if they're inactive. Added a few more missing tests.

github-actions bot reviewed May 21, 2023

View reviewed changes

EricTRL added 2 commits June 23, 2023 10:40

Fixed broken testcases

13396e0

Turned MailcowManager.internal_alias_rspamd_setting back into a method due to the extra cache-control parameter.

Added missing tests

5daea4e

SquireMailcowManager.is_internal_alias Member.is_active

github-actions bot reviewed Jun 23, 2023

View reviewed changes

API Exception handling

95505d3

Catch MailcowExceptions when working with the API.

EricTRL requested a review from DutcherNL June 23, 2023 10:51

DutcherNL reviewed Aug 18, 2023

View reviewed changes

requires_membership requires active membership

e050cc6

The require_membership parameter for ViewCollectives now requires an active membership, rather than any membership whatsoever. Adjusted testcases to ensure those members are active.

github-actions bot reviewed Aug 19, 2023

View reviewed changes

DutcherNL approved these changes Aug 19, 2023

View reviewed changes

EricTRL mentioned this pull request Aug 19, 2023

Martor CI invalid url name #325

Open

EricTRL merged commit 5411925 into master Aug 19, 2023
0 of 4 checks passed

EricTRL deleted the feature/mailcow-email-lists branch August 19, 2023 10:56

	# PROTECT prevents accidental deletion of a member while it is still in a committee.

	# PROTECT prevents accidental deletion of a member while it is still in a committee.

		@@ -30,26 +30,26 @@ def test_check_access_super(self):
		# New request with no info WILL fail at the parent
		request = RequestFactory().get(path='')

	request = RequestFactory().get(path='')
	request = RequestFactory().get(path="")

	self.config.group_requires_permission = 'auth.change_user'
	self.config.group_requires_permission = "auth.change_user"

	path('', MailcowTabbedStatusView.as_view(config=self), name='mailcow_status'),
	path("", MailcowTabbedStatusView.as_view(config=self), name="mailcow_status"),


		logger = logging.getLogger(__name__)

		class AliasStatus(Enum):

		""" Aliases that should exist according to Squire may not be in sync with those in Mailcow.
		This Enum indicates the disparity between the two.

	path('', TabbedEmailPreferencesChangeView.as_view(config=self), name='email_preferences'),
	path("", TabbedEmailPreferencesChangeView.as_view(config=self), name="email_preferences"),


		from mailcow_integration.squire_mailcow import SquireMailcowManager, get_mailcow_manager

		class MemberMailPreferencesForm(UserPreferenceForm):

		""" Form that allows changing member mail preferences """
		def __init__(self, args, mailcow_manager:SquireMailcowManager=None, *kwargs):

	""" Update mail preferences and invokes the SquireMailcowManager """
	"""Update mail preferences and invokes the SquireMailcowManager"""


		from user_interaction.accountcollective import AccountViewMixin

		class EmailPreferencesChangeView(FormView):

		status, alias, mailbox = self._get_alias_status(address, subscribers, AliasCategory.MEMBER,
		aliases, mailboxes, self.mailcow_manager.ALIAS_MEMBERS_PUBLIC_COMMENT)

		info = AliasInfos(status.name, subscribers, address, "m_" + alias_address_to_id(address), config['title'], config['description'],
		alias or mailbox, config['internal'], exposure_routes, config['allow_opt_out'], archive_addresses=config['archive_addresses']

		def _init_global_committee_alias_list(self, aliases: List[MailcowAlias], mailboxes: List[MailcowMailbox]) -> List[AliasInfos]:
		""" Initialize global committee aliases. e.g. commissies@example.com """

		subscribers = self._get_subscriberinfos_by_status(status, subscribers, alias, alias_type=AliasCategory.GLOBAL_COMMITTEE)
		info = AliasInfos(status.name, subscribers, address, "gc_" + alias_address_to_id(address), address,

		def _init_committee_alias_list(self, aliases: List[MailcowAlias], mailboxes: List[MailcowMailbox]) -> List[AliasInfos]:
		""" Initialize committee aliases. e.g. bg@example.com """

	subscribers = assoc_group.members.filter_active().order_by('email')
	subscribers = assoc_group.members.filter_active().order_by("email")

	API_FORMAT = "%(host)s/api/v1/"

	API_FORMAT = "%(host)s/api/v1/"

	""" Retrieves the headers required to fetch info from the Mailcow API. """
	"""Retrieves the headers required to fetch info from the Mailcow API."""

Feature/mailcow email lists #289

Feature/mailcow email lists #289

Conversation

EricTRL commented Nov 9, 2022 • edited Loading

codecov bot commented Nov 10, 2022 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot May 7, 2023

Choose a reason for hiding this comment

github-actions bot May 7, 2023

Choose a reason for hiding this comment

github-actions bot May 7, 2023

Choose a reason for hiding this comment

github-actions bot May 7, 2023

Choose a reason for hiding this comment

github-actions bot May 7, 2023

Choose a reason for hiding this comment

github-actions bot May 7, 2023

Choose a reason for hiding this comment

github-actions bot May 7, 2023

Choose a reason for hiding this comment

github-actions bot May 7, 2023

Choose a reason for hiding this comment

github-actions bot May 7, 2023

Choose a reason for hiding this comment

github-actions bot May 7, 2023

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

github-actions bot May 21, 2023

Choose a reason for hiding this comment

EricTRL commented Nov 9, 2022 •

edited

Loading

codecov bot commented Nov 10, 2022 •

edited

Loading

		""" Checks some response data, and generates an appropriate exception based on it """
		if content.get('type', None) == "error":

	if content.get('msg', None) == "authentication failed":
	if content.get("msg", None) == "authentication failed":

		context['internal_alias_rspamd_setting'] = self.mailcow_manager.internal_alias_rspamd_setting
		context['mailcow_host'] = self.mailcow_manager.mailcow_host

	elif content.get('msg', "").startswith("api access denied"):
	elif content.get("msg", "").startswith("api access denied"):

	elif content.get('msg', None) == "route not found":
	elif content.get("msg", None) == "route not found":

	elif content.get('type', None) == 'danger':
	elif content.get("type", None) == "danger":

	""" Updates the RspamdSetting associated to the given ID with the given data """
	"""Updates the RspamdSetting associated to the given ID with the given data"""

	""" Creates a new Rspamd setting """
	"""Creates a new Rspamd setting"""

		@@ -0,0 +1,18 @@

		class MailcowException(Exception):
		""" General exception class for errors raised by the Mailcow API """

	""" General exception class for errors raised by the Mailcow API """
	"""General exception class for errors raised by the Mailcow API"""