import datetime
import logging
+import os
import subprocess
import urllib2
import xml.dom.minidom
# the IP address has changed.
holdoff_days = 30
+ # holdoff time for update failures - Number of days no update
+ # is tried after the last one has failed.
+ holdoff_failure_days = 0.5
+
# True if the provider is able to remove records, too.
# Required to remove AAAA records if IPv6 is absent again.
can_remove_records = True
_providers[provider.handle] = provider
+ @staticmethod
+ def supported():
+ """
+ Should be overwritten to check if the system the code is running
+ on has all the required tools to support this provider.
+ """
+ return True
+
def __init__(self, core, **settings):
self.core = core
if force:
logger.debug(_("Updating %s forced") % self.hostname)
- # Do nothing if no update is required
- elif not self.requires_update:
+ # Do nothing if the last update has failed or no update is required
+ elif self.has_failure or not self.requires_update:
return
# Execute the update.
return False
+ @property
+ def has_failure(self):
+ """
+ Returns True when the last update has failed and no retry
+ should be performed, yet.
+ """
+ last_status = self.db.last_update_status(self.hostname)
+
+ # Return False if the last update has not failed.
+ if not last_status == "failure":
+ return False
+
+ # If there is no holdoff time, we won't update ever again.
+ if self.holdoff_failure_days is None:
+ logger.warning(_("An update has not been performed because earlier updates failed for %s") \
+ % self.hostname)
+ logger.warning(_("There will be no retries"))
+
+ return True
+
+ # Determine when the holdoff time ends
+ last_update = self.db.last_update(self.hostname, status=last_status)
+ holdoff_end = last_update + datetime.timedelta(days=self.holdoff_failure_days)
+
+ now = datetime.datetime.utcnow()
+ if now < holdoff_end:
+ failure_message = self.db.last_update_failure_message(self.hostname)
+
+ logger.warning(_("An update has not been performed because earlier updates failed for %s") \
+ % self.hostname)
+
+ if failure_message:
+ logger.warning(_("Last failure message:"))
+
+ for line in failure_message.splitlines():
+ logger.warning(" %s" % line)
+
+ logger.warning(_("Further updates will be withheld until %s") % holdoff_end)
+
+ return True
+
+ return False
+
def ip_address_changed(self, protos):
"""
Returns True if this host is already up to date
return False
# Get the timestamp of the last successfull update
- last_update = self.db.last_update(self.hostname)
+ last_update = self.db.last_update(self.hostname, status="success")
# If no timestamp has been recorded, no update has been
# performed. An update should be performed now.
DEFAULT_TTL = 60
+ @staticmethod
+ def supported():
+ # Search if the nsupdate utility is available
+ paths = os.environ.get("PATH")
+
+ for path in paths.split(":"):
+ executable = os.path.join(path, "nsupdate")
+
+ if os.path.exists(executable):
+ return True
+
+ return False
+
def update(self):
scriptlet = self.__make_scriptlet()
return "\n".join(scriptlet)
+class DDNSProviderChangeIP(DDNSProvider):
+ handle = "changeip.com"
+ name = "ChangeIP.com"
+ website = "https://changeip.com"
+ protocols = ("ipv4",)
+
+ # Detailed information about the update api can be found here.
+ # http://www.changeip.com/accounts/knowledgebase.php?action=displayarticle&id=34
+
+ url = "https://nic.changeip.com/nic/update"
+ can_remove_records = False
+
+ def update_protocol(self, proto):
+ data = {
+ "hostname" : self.hostname,
+ "myip" : self.get_address(proto),
+ }
+
+ # Send update to the server.
+ try:
+ response = self.send_request(self.url, username=self.username, password=self.password,
+ data=data)
+
+ # Handle error codes.
+ except urllib2.HTTPError, e:
+ if e.code == 422:
+ raise DDNSRequestError(_("Domain not found."))
+
+ raise
+
+ # Handle success message.
+ if response.code == 200:
+ return
+
+ # If we got here, some other update error happened.
+ raise DDNSUpdateError(_("Server response: %s") % output)
+
+
+class DDNSProviderDDNSS(DDNSProvider):
+ handle = "ddnss.de"
+ name = "DDNSS"
+ website = "http://www.ddnss.de"
+ protocols = ("ipv4",)
+
+ # Detailed information about how to send the update request and possible response
+ # codes can be obtained from here.
+ # http://www.ddnss.de/info.php
+ # http://www.megacomputing.de/2014/08/dyndns-service-response-time/#more-919
+
+ url = "http://www.ddnss.de/upd.php"
+ can_remove_records = False
+
+ def update_protocol(self, proto):
+ data = {
+ "ip" : self.get_address(proto),
+ "host" : self.hostname,
+ }
+
+ # Check if a token has been set.
+ if self.token:
+ data["key"] = self.token
+
+ # Check if username and hostname are given.
+ elif self.username and self.password:
+ data.update({
+ "user" : self.username,
+ "pwd" : 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)
+
+ # This provider sends the response code as part of the header.
+ header = response.info()
+
+ # Get status information from the header.
+ output = header.getheader('ddnss-response')
+
+ # Handle success messages.
+ if output == "good" or output == "nochg":
+ return
+
+ # Handle error codes.
+ if output == "badauth":
+ raise DDNSAuthenticationError
+ elif output == "notfqdn":
+ raise DDNSRequestError(_("No valid FQDN was given."))
+ elif output == "nohost":
+ raise DDNSRequestError(_("Specified host does not exist."))
+ elif output == "911":
+ raise DDNSInternalServerError
+ elif output == "dnserr":
+ raise DDNSInternalServerError(_("DNS error encountered."))
+ elif output == "disabled":
+ raise DDNSRequestError(_("Account disabled or locked."))
+
+ # If we got here, some other update error happened.
+ raise DDNSUpdateError
+
+
class DDNSProviderDHS(DDNSProvider):
handle = "dhs.org"
name = "DHS International"
if myipv6:
data["myipv6"] = myipv6
- self._send_request(data)
+ self.send_request(data)
-class DDNSProviderEasyDNS(DDNSProtocolDynDNS2, DDNSProvider):
+class DDNSProviderEasyDNS(DDNSProvider):
handle = "easydns.com"
name = "EasyDNS"
website = "http://www.easydns.com/"
protocols = ("ipv4",)
- # There is only some basic documentation provided by the vendor,
- # also searching the web gain very poor results.
- # http://mediawiki.easydns.com/index.php/Dynamic_DNS
+ # Detailed information about the request and response codes
+ # (API 1.3) are available on the providers webpage.
+ # https://fusion.easydns.com/index.php?/Knowledgebase/Article/View/102/7/dynamic-dns
url = "http://api.cp.easydns.com/dyn/tomato.php"
+ def update_protocol(self, proto):
+ data = {
+ "myip" : self.get_address(proto, "-"),
+ "hostname" : self.hostname,
+ }
+
+ # Send update to the server.
+ response = self.send_request(self.url, data=data,
+ username=self.username, password=self.password)
+
+ # Get the full response message.
+ output = response.read()
+
+ # Remove all leading and trailing whitespace.
+ output = output.strip()
+
+ # Handle success messages.
+ if output.startswith("NOERROR"):
+ return
+
+ # Handle error codes.
+ if output.startswith("NOACCESS"):
+ raise DDNSAuthenticationError
+
+ elif output.startswith("NOSERVICE"):
+ raise DDNSRequestError(_("Dynamic DNS is not turned on for this domain."))
+
+ elif output.startswith("ILLEGAL INPUT"):
+ raise DDNSRequestError(_("Invalid data has been sent."))
+
+ elif output.startswith("TOOSOON"):
+ raise DDNSRequestError(_("Too frequent update requests have been sent."))
+
+ # If we got here, some other update error happened.
+ raise DDNSUpdateError
+
class DDNSProviderDomopoli(DDNSProtocolDynDNS2, DDNSProvider):
handle = "domopoli.de"
# after login on the provider user interface and here:
# http://nsupdateinfo.readthedocs.org/en/latest/user.html
+ url = "https://nsupdate.info/nic/update"
+
# TODO nsupdate.info can actually do this, but the functionality
# has not been implemented here, yet.
can_remove_records = False
+ # After a failed update, there will be no retries
+ # https://bugzilla.ipfire.org/show_bug.cgi?id=10603
+ holdoff_failure_days = None
+
# Nsupdate.info uses the hostname as user part for the HTTP basic auth,
# and for the password a so called secret.
@property
def password(self):
return self.token or self.get("secret")
- @property
- def url(self):
- # The update URL is different by the used protocol.
- if self.proto == "ipv4":
- return "https://ipv4.nsupdate.info/nic/update"
- elif self.proto == "ipv6":
- return "https://ipv6.nsupdate.info/nic/update"
- else:
- raise DDNSUpdateError(_("Invalid protocol has been given"))
-
def prepare_request_data(self, proto):
data = {
"myip" : self.get_address(proto),
@property
def password(self):
- return self.get("username") or self.token
+ return self.get("password") or self.token
class DDNSProviderStrato(DDNSProtocolDynDNS2, DDNSProvider):
return data
-class DDNSProviderZoneedit(DDNSProtocolDynDNS2, DDNSProvider):
+class DDNSProviderXLhost(DDNSProtocolDynDNS2, DDNSProvider):
+ handle = "xlhost.de"
+ name = "XLhost"
+ website = "http://xlhost.de/"
+ protocols = ("ipv4",)
+
+ # Information about the format of the HTTP request is to be found
+ # here: https://xlhost.de/faq/index_html?topicId=CQA2ELIPO4SQ
+
+ url = "https://nsupdate.xlhost.de/"
+
+
+class DDNSProviderZoneedit(DDNSProvider):
handle = "zoneedit.com"
name = "Zoneedit"
website = "http://www.zoneedit.com"
projects / oddments / ddns.git / blobdiff