Merge pull request #3683 from modoboa/domain_dnsbl_results_display

Display domain DNSBL issues when necessary

frontend/src/components/admin/domains/DNSBLSummary.vue

@@ -0,0 +1,41 @@
+<template>
+  <v-card>
+    <v-card-title class="text-h5">
+      <span>
+        {{ $gettext('DNSBL summary for ') }} {{ props.mxrecord.name }}
+      </span>
+    </v-card-title>
+    <v-card-text>
+      {{
+        $gettext(
+          'IP address %{ address } is currently listed by the following DNSBL providers:',
+          { address: mxrecord.address }
+        )
+      }}
+      <v-list>
+        <v-list-item
+          v-for="result in props.mxrecord.dnsbl_results"
+          :key="result.provider"
+        >
+          {{ result.provider }} ({{ result.status }})
+        </v-list-item>
+      </v-list>
+    </v-card-text>
+    <v-card-actions>
+      <v-spacer></v-spacer>
+      <v-btn @click="emit('close')">
+        {{ $gettext('Close') }}
+      </v-btn>
+    </v-card-actions>
+  </v-card>
+</template>
+
+<script setup>
+const props = defineProps({
+  mxrecord: {
+    type: Object,
+    default: null,
+  },
+})
+const emit = defineEmits(['close'])
+</script>

frontend/src/components/admin/domains/DNSDetail.vue

@@ -30,9 +30,20 @@
           <template #[`item.updated`]="{ item }">
             {{ $date(item.updated) }}
           </template>
+          <template #[`item.issues`]="{ item }">
+            <template v-if="item.dnsbl_results.length">
+              <v-btn
+                icon="mdi-bell"
+                color="error"
+                variant="flat"
+                size="x-small"
+                @click="openDNSBLSummary(item)"
+              />
+            </template>
+          </template>
         </v-data-table-virtual>
       </template>
-      <div class="overline">{{ $gettext('Auto configuration') }}</div>
+      <div class="mt-4 overline">{{ $gettext('Auto configuration') }}</div>
       <template v-if="domain.dns_global_status == 'pending'">
         <v-row>
           <v-col>
@@ -69,7 +80,7 @@
             </v-chip>
           </v-col>
         </v-row>
-        <div class="overline">{{ $gettext('Authentication') }}</div>
+        <div class="mt-4 overline">{{ $gettext('Authentication') }}</div>
         <v-row>
           <v-col>
             <v-chip v-if="detail.spf_record" color="success">
@@ -142,16 +153,23 @@
     <v-dialog v-model="showDKIMKey" max-width="800px" persistent>
       <DomainDKIMKey :domain="domain" @close="showDKIMKey = false" />
     </v-dialog>
+    <v-dialog v-model="showDNSBLSummary" max-width="800px" persistent>
+      <DNSBLSummary
+        :mxrecord="selectedMXRecord"
+        @close="showDNSBLSummary = false"
+      />
+    </v-dialog>
     <ConfirmDialog ref="dialog" />
   </v-card>
 </template>
 
-<script setup lang="js">
+<script setup>
 import { useGettext } from 'vue3-gettext'
 import { useBusStore } from '@/stores'
 import domainsApi from '@/api/domains'
 import DomainDKIMKey from './DomainDKIMKey.vue'
 import DomainDNSConfig from './DomainDNSConfig.vue'
+import DNSBLSummary from './DNSBLSummary.vue'
 import ConfirmDialog from '@/components/tools/ConfirmDialog.vue'
 import { ref, computed, watch } from 'vue'
 
@@ -170,11 +188,14 @@ const mxRecordHeaders = ref([
   { title: $gettext('Name'), value: 'name' },
   { title: $gettext('Address'), value: 'address' },
   { title: $gettext('Updated'), value: 'updated' },
+  { title: '', value: 'issues' },
 ])
 const keyLoading = ref(false)
+const selectedMXRecord = ref(null)
 
 const showConfigHelp = ref(false)
 const showDKIMKey = ref(false)
+const showDNSBLSummary = ref(false)
 
 function copyPubKey() {
   navigator.clipboard.writeText(domain.value.dkim_public_key)
@@ -246,6 +267,11 @@ function generateNewKey() {
   )
 }
 
+function openDNSBLSummary(mxrecord) {
+  selectedMXRecord.value = mxrecord
+  showDNSBLSummary.value = true
+}
+
 watch(
   domain,
   (newDomain) => {

modoboa/admin/models/mxrecord.py

@@ -71,6 +71,10 @@ class MXRecord(models.Model):
     def __str__(self):
         return f"{self.name} ({self.address}) for {self.domain} "
 
+    @property
+    def active_dnsbl_results(self):
+        return self.dnsblresult_set.exclude(status="")
+
 
 class DNSBLQuerySet(models.QuerySet):
     """Custom manager for DNSBLResultManager."""

modoboa/dnstools/api/v2/serializers.py

@@ -7,22 +7,22 @@ from modoboa.admin import models as admin_models
 from ... import models
 
 
-class MXRecordSerializer(serializers.ModelSerializer):
-    """Serializer for MXRecord."""
-
-    class Meta:
-        model = admin_models.MXRecord
-        fields = ("name", "address", "updated")
-
-
 class DNSBLResultSerializer(serializers.ModelSerializer):
     """Serializer for DNSBLResult."""
 
-    mx = MXRecordSerializer()
-
     class Meta:
         model = admin_models.DNSBLResult
-        fields = ("provider", "mx", "status")
+        fields = ("provider", "status")
+
+
+class MXRecordSerializer(serializers.ModelSerializer):
+    """Serializer for MXRecord."""
+
+    dnsbl_results = DNSBLResultSerializer(many=True, source="active_dnsbl_results")
+
+    class Meta:
+        model = admin_models.MXRecord
+        fields = ("name", "address", "dnsbl_results", "updated")
 
 
 class DNSRecordSerializer(serializers.ModelSerializer):
@@ -41,13 +41,11 @@ class DNSDetailSerializer(serializers.ModelSerializer):
     spf_record = DNSRecordSerializer()
     dkim_record = DNSRecordSerializer()
     dmarc_record = DNSRecordSerializer()
-    dnsbl_results = DNSBLResultSerializer(many=True, source="dnsblresult_set")
 
     class Meta:
         model = admin_models.Domain
         fields = (
             "mx_records",
-            "dnsbl_results",
             "autoconfig_record",
             "autodiscover_record",
             "spf_record",