]> git.ipfire.org Git - ddns.git/blobdiff - src/ddns/providers.py
Move call to get token to main class.
[ddns.git] / src / ddns / providers.py
index 124cf2f8280e7618759725d733b0d3573492025a..cbbeeea2c74f9f8ce1783a14f0b989f4e62ab900 100644 (file)
 #                                                                             #
 ###############################################################################
 
+import logging
+
+from i18n import _
+
 # Import all possible exception types.
 from .errors import *
 
+logger = logging.getLogger("ddns.providers")
+logger.propagate = 1
+
 class DDNSProvider(object):
        INFO = {
                # A short string that uniquely identifies
@@ -104,9 +111,48 @@ class DDNSProvider(object):
                """
                return self.get("password")
 
-       def __call__(self):
+       @property
+       def protocols(self):
+               return self.INFO.get("protocols")
+
+       @property
+       def token(self):
+               """
+                       Fast access to the token.
+               """
+               return self.get("token")
+
+       def __call__(self, force=False):
+               if force:
+                       logger.info(_("Updating %s forced") % self.hostname)
+
+               # Check if we actually need to update this host.
+               elif self.is_uptodate(self.protocols):
+                       logger.info(_("%s is already up to date") % self.hostname)
+                       return
+
+               # Execute the update.
+               self.update()
+
+       def update(self):
                raise NotImplementedError
 
+       def is_uptodate(self, protos):
+               """
+                       Returns True if this host is already up to date
+                       and does not need to change the IP address on the
+                       name server.
+               """
+               for proto in protos:
+                       addresses = self.core.system.resolve(self.hostname, proto)
+
+                       current_address = self.get_address(proto)
+
+                       if not current_address in addresses:
+                               return False
+
+               return True
+
        def send_request(self, *args, **kwargs):
                """
                        Proxy connection to the send request
@@ -121,6 +167,267 @@ class DDNSProvider(object):
                return self.core.system.get_address(proto)
 
 
+class DDNSProviderDHS(DDNSProvider):
+       INFO = {
+               "handle"    : "dhs.org",
+               "name"      : "DHS International",
+               "website"   : "http://dhs.org/",
+               "protocols" : ["ipv4",]
+       }
+
+       # No information about the used update api provided on webpage,
+       # grabed from source code of ez-ipudate.
+       url = "http://members.dhs.org/nic/hosts"
+
+       def update(self):
+               url = self.url % {
+                       "username" : self.username,
+                       "password" : self.password,
+               }
+
+               data = {
+                       "domain"       : self.hostname,
+                       "ip"           : self.get_address("ipv4"),
+                       "hostcmd"      : "edit",
+                       "hostcmdstage" : "2",
+                       "type"         : "4",
+               }
+
+               # Send update to the server.
+               response = self.send_request(url, username=self.username, password=self.password,
+                       data=data)
+
+               # Handle success messages.
+               if response.code == 200:
+                       return
+
+               # Handle error codes.
+               elif response.code == 401:
+                       raise DDNSAuthenticationError
+
+               # If we got here, some other update error happened.
+               raise DDNSUpdateError
+
+
+class DDNSProviderDNSpark(DDNSProvider):
+       INFO = {
+               "handle"    : "dnspark.com",
+               "name"      : "DNS Park",
+               "website"   : "http://dnspark.com/",
+               "protocols" : ["ipv4",]
+       }
+
+       # Informations to the used api can be found here:
+       # https://dnspark.zendesk.com/entries/31229348-Dynamic-DNS-API-Documentation
+       url = "https://control.dnspark.com/api/dynamic/update.php"
+
+       def update(self):
+               url = self.url % {
+                       "username" : self.username,
+                       "password" : self.password,
+               }
+
+               data = {
+                       "domain" : self.hostname,
+                       "ip"     : self.get_address("ipv4"),
+               }
+
+               # Send update to the server.
+               response = self.send_request(url, username=self.username, password=self.password,
+                       data=data)
+
+               # Get the full response message.
+               output = response.read()
+
+               # Handle success messages.
+               if output.startswith("ok") or output.startswith("nochange"):
+                       return
+
+               # Handle error codes.
+               if output == "unauth":
+                       raise DDNSAuthenticationError
+               elif output == "abuse":
+                       raise DDNSAbuseError
+               elif output == "blocked":
+                       raise DDNSBlockedError
+               elif output == "nofqdn":
+                       raise DDNSRequestError(_("No valid FQDN was given."))
+               elif output == "nohost":
+                       raise DDNSRequestError(_("Invalid hostname specified."))
+               elif output == "notdyn":
+                       raise DDNSRequestError(_("Hostname not marked as a dynamic host."))
+               elif output == "invalid":
+                       raise DDNSRequestError(_("Invalid IP address has been sent."))
+
+               # If we got here, some other update error happened.
+               raise DDNSUpdateError
+
+
+class DDNSProviderDtDNS(DDNSProvider):
+       INFO = {
+               "handle"    : "dtdns.com",
+               "name"      : "DtDNS",
+               "website"   : "http://dtdns.com/",
+               "protocols" : ["ipv4",]
+               }
+
+       # Information about the format of the HTTPS request is to be found
+       # http://www.dtdns.com/dtsite/updatespec
+       url = "https://www.dtdns.com/api/autodns.cfm"
+
+
+       def update(self):
+               data = {
+                       "ip" : self.get_address("ipv4"),
+                       "id" : self.hostname,
+                       "pw" : self.password
+               }
+
+               # Send update to the server.
+               response = self.send_request(self.url, data=data)
+
+               # Get the full response message.
+               output = response.read()
+
+               # Remove all leading and trailing whitespace.
+               output = output.strip()
+
+               # Handle success messages.
+               if "now points to" in output:
+                       return
+
+               # Handle error codes.
+               if output == "No hostname to update was supplied.":
+                       raise DDNSRequestError(_("No hostname specified."))
+
+               elif output == "The hostname you supplied is not valid.":
+                       raise DDNSRequestError(_("Invalid hostname specified."))
+
+               elif output == "The password you supplied is not valid.":
+                       raise DDNSAuthenticationError
+
+               elif output == "Administration has disabled this account.":
+                       raise DDNSRequestError(_("Account has been disabled."))
+
+               elif output == "Illegal character in IP.":
+                       raise DDNSRequestError(_("Invalid IP address has been sent."))
+
+               elif output == "Too many failed requests.":
+                       raise DDNSRequestError(_("Too many failed requests."))
+
+               # If we got here, some other update error happened.
+               raise DDNSUpdateError
+
+
+class DDNSProviderFreeDNSAfraidOrg(DDNSProvider):
+       INFO = {
+               "handle"    : "freedns.afraid.org",
+               "name"      : "freedns.afraid.org",
+               "website"   : "http://freedns.afraid.org/",
+               "protocols" : ["ipv6", "ipv4",]
+               }
+
+       # No information about the request or response could be found on the vendor
+       # page. All used values have been collected by testing.
+       url = "https://freedns.afraid.org/dynamic/update.php"
+
+       @property
+       def proto(self):
+               return self.get("proto")
+
+       def update(self):
+               address = self.get_address(self.proto)
+
+               data = {
+                       "address" : address,
+               }
+
+               # Add auth token to the update url.
+               url = "%s?%s" % (self.url, self.token)
+
+               # Send update to the server.
+               response = self.send_request(url, data=data)
+
+               # Get the full response message.
+               output = response.read()
+
+               # Handle success messages.
+               if output.startswith("Updated") or "has not changed" in output:
+                       return
+
+               # Handle error codes.
+               if output == "ERROR: Unable to locate this record":
+                       raise DDNSAuthenticationError
+               elif "is an invalid IP address" in output:
+                       raise DDNSRequestError(_("Invalid IP address has been sent."))
+
+               # If we got here, some other update error happened.
+               raise DDNSUpdateError
+
+
+class DDNSProviderLightningWireLabs(DDNSProvider):
+       INFO = {
+               "handle"    : "dns.lightningwirelabs.com",
+               "name"      : "Lightning Wire Labs",
+               "website"   : "http://dns.lightningwirelabs.com/",
+               "protocols" : ["ipv6", "ipv4",]
+       }
+
+       # Information about the format of the HTTPS request is to be found
+       # https://dns.lightningwirelabs.com/knowledge-base/api/ddns
+       url = "https://dns.lightningwirelabs.com/update"
+
+       def update(self):
+               data =  {
+                       "hostname" : self.hostname,
+               }
+
+               # Check if we update an IPv6 address.
+               address6 = self.get_address("ipv6")
+               if address6:
+                       data["address6"] = address6
+
+               # Check if we update an IPv4 address.
+               address4 = self.get_address("ipv4")
+               if address4:
+                       data["address4"] = address4
+
+               # Raise an error if none address is given.
+               if not data.has_key("address6") and not data.has_key("address4"):
+                       raise DDNSConfigurationError
+
+               # Check if a token has been set.
+               if self.token:
+                       data["token"] = self.token
+
+               # Check for username and password.
+               elif self.username and self.password:
+                       data.update({
+                               "username" : self.username,
+                               "password" : self.password,
+                       })
+
+               # Raise an error if no auth details are given.
+               else:
+                       raise DDNSConfigurationError
+
+               # Send update to the server.
+               response = self.send_request(self.url, data=data)
+
+               # Handle success messages.
+               if response.code == 200:
+                       return
+
+               # Handle error codes.
+               if response.code == 403:
+                       raise DDNSAuthenticationError
+               elif response.code == 400:
+                       raise DDNSRequestError
+
+               # If we got here, some other update error happened.
+               raise DDNSUpdateError
+
+
 class DDNSProviderNOIP(DDNSProvider):
        INFO = {
                "handle"    : "no-ip.com",
@@ -135,7 +442,7 @@ class DDNSProviderNOIP(DDNSProvider):
 
        url = "http://%(username)s:%(password)s@dynupdate.no-ip.com/nic/update"
 
-       def __call__(self):
+       def update(self):
                url = self.url % {
                        "username" : self.username,
                        "password" : self.password,
@@ -178,7 +485,7 @@ class DDNSProviderSelfhost(DDNSProvider):
 
        url = "https://carol.selfhost.de/update"
 
-       def __call__(self):
+       def update(self):
                data = {
                        "username" : self.username,
                        "password" : self.password,