[enh] Check domain expiration date

data/hooks/diagnosis/12-dnsrecords.py

@@ -1,6 +1,10 @@
 #!/usr/bin/env python
 
 import os
+import re
+
+from datetime import datetime, timedelta
+from subprocess import Popen, PIPE
 
 from moulinette.utils.filesystem import read_file
 
@@ -8,6 +12,7 @@ from yunohost.utils.network import dig
 from yunohost.diagnosis import Diagnoser
 from yunohost.domain import domain_list, _build_dns_conf, _get_maindomain
 
+SMALL_SUFFIX_LIST = ['noho.st', 'nohost.me', 'ynh.fr', 'netlib.re']
 
 class DNSRecordsDiagnoser(Diagnoser):
 
@@ -32,9 +37,11 @@ class DNSRecordsDiagnoser(Diagnoser):
             for report in self.check_domain(domain, domain == main_domain, is_subdomain=is_subdomain):
                 yield report
         
-        # FIXME : somewhere, should implement a check for reverse DNS ...
-
-        # FIXME / TODO : somewhere, could also implement a check for domain expiring soon
+        # Check if a domain buy by the user will expire soon
+        domains_from_registrar = ['.'.join(domain.split('.')[-2:]) for domain in all_domains]
+        domains_from_registrar = set(domains_from_registrar) - set(SMALL_SUFFIX_LIST)
+        for report in self.check_expiration_date(domains_from_registrar):
+            yield report
 
     def check_domain(self, domain, is_main_domain, is_subdomain):
 
@@ -137,5 +144,69 @@ class DNSRecordsDiagnoser(Diagnoser):
             return r["current"] == r["value"]
 
 
+    def check_expiration_date(self, domains):
+        """
+        Alert if expiration date of a domain is soon
+        """
+
+        # FIXME find a way to ignore a specific domain without 
+        # create a report by domain each time. We need something small
+        details = {
+            "not_found": [],
+            "error": [],
+            "warning": [],
+            "info": []
+        }
+
+        for domain in domains:
+            expire_date = self.get_domain_expiration(domain)
+
+            if not expire_date:
+                details["not_found"].append((
+                    "diagnosis_domain_expiration_date_not_found",
+                    {"domain": domain}))
+                continue
+
+            expire_in = expire_date - datetime.now()
+
+            alert_type = "info"
+            if expire_in <= timedelta(7):
+                alert_type = "error"
+            elif expire_in <= timedelta(30):
+                alert_type = "warning"
+
+            args = {
+                "domain": domain,
+                "days": expire_in.days - 1,
+                "expire_date": str(expire_date)
+            }
+            details[alert_type].append(("diagnosis_domain_expires_in", args))
+
+        for alert_type in ["error", "warning", "not_found", "info"]:
+            if details[alert_type]:
+                yield dict(meta={"category": "expiration"},
+                           data={},
+                           status=alert_type.upper() if alert_type != "not_found" else "INFO",
+                           summary="diagnosis_domain_expiration_" + alert_type,
+                           details=details[alert_type])
+
+    def get_domain_expiration(self, domain):
+        """
+        Return the expiration datetime of a domain or None
+        """
+
+        p1 = Popen(['whois', domain], stdout=PIPE)
+        p2 = Popen(['grep', 'Expir'], stdin=p1.stdout, stdout=PIPE)
+        out, err = p2.communicate()
+        out = out.decode("utf-8").split('\n')
+        p1.terminate()
+        #p2.terminate()
+
+        for line in out:
+            match = re.search(r'\d{4}-\d{2}-\d{2}', line)
+            if match is not None:
+                return datetime.strptime(match.group(), '%Y-%m-%d')
+        return None
+
 def main(args, env, loggers):
     return DNSRecordsDiagnoser(args, env, loggers).diagnose()

debian/control

@@ -29,7 +29,7 @@ Depends: ${python:Depends}, ${misc:Depends}
  , redis-server
  , metronome
  , git, curl, wget, cron, unzip, jq
- , lsb-release, haveged, fake-hwclock, equivs, lsof
+ , lsb-release, haveged, fake-hwclock, equivs, lsof, whois
 Recommends: yunohost-admin
  , ntp, inetutils-ping | iputils-ping
  , bash-completion, rsyslog

locales/en.json

@@ -172,6 +172,11 @@
     "diagnosis_dns_missing_record": "According to the recommended DNS configuration, you should add a DNS record with the following info.<br>Type: <code>{type}</code><br>Name: <code>{name}</code><br>Value: <code>{value}</code>",
     "diagnosis_dns_discrepancy": "The following DNS record does not seem to follow the recommended configuration:<br>Type: <code>{type}</code><br>Name: <code>{name}</code><br>Current value: <code>{current}</code><br>Excepted value: <code>{value}</code>",
     "diagnosis_dns_point_to_doc": "Please check the documentation at <a href='https://yunohost.org/dns_config'>https://yunohost.org/dns_config</a> if you need help about configuring DNS records.",
+    "diagnosis_domain_expiration_not_found": "Unable to check the expiration date of some domains",
+    "diagnosis_domain_expiration_info": "Domains expiration dates",
+    "diagnosis_domain_expiration_warning": "Some domains expire in less than a month",
+    "diagnosis_domain_expiration_error": "Some domains expire in less than a week",
+    "diagnosis_domain_expires_in": "{domain} expires in {days} days.",
     "diagnosis_services_running": "Service {service} is running!",
     "diagnosis_services_conf_broken": "Configuration is broken for service {service}!",
     "diagnosis_services_bad_status": "Service {service} is {status} :(",