# #
###############################################################################
+import datetime
import logging
+import os
import subprocess
import urllib2
import xml.dom.minidom
DEFAULT_SETTINGS = {}
+ # holdoff time - Number of days no update is performed unless
+ # 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
+
# Automatically register all providers.
class __metaclass__(type):
def __init__(provider, name, bases, dict):
_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
def __cmp__(self, other):
return cmp(self.hostname, other.hostname)
+ @property
+ def db(self):
+ return self.core.db
+
def get(self, key, default=None):
"""
Get a setting from the settings dictionary.
if force:
logger.debug(_("Updating %s forced") % self.hostname)
- # Check if we actually need to update this host.
- elif self.is_uptodate(self.protocols):
- logger.debug(_("The dynamic host %(hostname)s (%(provider)s) is already up to date") % \
- { "hostname" : self.hostname, "provider" : self.name })
+ # 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.
- self.update()
+ try:
+ self.update()
+
+ # In case of any errors, log the failed request and
+ # raise the exception.
+ except DDNSError as e:
+ self.core.db.log_failure(self.hostname, e)
+ raise
logger.info(_("Dynamic DNS update for %(hostname)s (%(provider)s) successful") % \
{ "hostname" : self.hostname, "provider" : self.name })
+ self.core.db.log_success(self.hostname)
def update(self):
for protocol in self.protocols:
if self.have_address(protocol):
self.update_protocol(protocol)
- else:
+ elif self.can_remove_records:
self.remove_protocol(protocol)
def update_protocol(self, proto):
raise NotImplementedError
def remove_protocol(self, proto):
- logger.warning(_("%(hostname)s current resolves to an IP address"
- " of the %(proto)s protocol which could not be removed by ddns") % \
- { "hostname" : self.hostname, "proto" : proto })
+ if not self.can_remove_records:
+ raise RuntimeError, "can_remove_records is enabled, but remove_protocol() not implemented"
+
+ raise NotImplementedError
+
+ @property
+ def requires_update(self):
+ # If the IP addresses have changed, an update is required
+ if self.ip_address_changed(self.protocols):
+ logger.debug(_("An update for %(hostname)s (%(provider)s)"
+ " is performed because of an IP address change") % \
+ { "hostname" : self.hostname, "provider" : self.name })
+
+ return True
+
+ # If the holdoff time has expired, an update is required, too
+ if self.holdoff_time_expired():
+ logger.debug(_("An update for %(hostname)s (%(provider)s)"
+ " is performed because the holdoff time has expired") % \
+ { "hostname" : self.hostname, "provider" : self.name })
+
+ return True
+
+ # Otherwise, we don't need to perform an update
+ logger.debug(_("No update required for %(hostname)s (%(provider)s)") % \
+ { "hostname" : self.hostname, "provider" : self.name })
+
+ 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
- # Maybe this will raise NotImplementedError at some time
- #raise NotImplementedError
+ # 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)
- def is_uptodate(self, protos):
+ 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
and does not need to change the IP address on the
"""
for proto in protos:
addresses = self.core.system.resolve(self.hostname, proto)
-
current_address = self.get_address(proto)
- # If no addresses for the given protocol exist, we
- # are fine...
- if current_address is None and not addresses:
+ # Handle if the system has not got any IP address from a protocol
+ # (i.e. had full dual-stack connectivity which it has not any more)
+ if current_address is None:
+ # If addresses still exists in the DNS system and if this provider
+ # is able to remove records, we will do that.
+ if addresses and self.can_remove_records:
+ return True
+
+ # Otherwise, we cannot go on...
continue
if not current_address in addresses:
- return False
+ return True
- return True
+ return False
+
+ def holdoff_time_expired(self):
+ """
+ Returns true if the holdoff time has expired
+ and the host requires an update
+ """
+ # If no holdoff days is defined, we cannot go on
+ if not self.holdoff_days:
+ return False
+
+ # Get the timestamp of the last successfull update
+ 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.
+ if not last_update:
+ return True
+
+ # Determine when the holdoff time ends
+ holdoff_end = last_update + datetime.timedelta(days=self.holdoff_days)
+
+ now = datetime.datetime.utcnow()
+
+ if now >= holdoff_end:
+ logger.debug("The holdoff time has expired for %s" % self.hostname)
+ return True
+ else:
+ logger.debug("Updates for %s are held off until %s" % \
+ (self.hostname, holdoff_end))
+ return False
def send_request(self, *args, **kwargs):
"""
# http://dyn.com/support/developers/api/perform-update/
# http://dyn.com/support/developers/api/return-codes/
+ # The DynDNS protocol version 2 does not allow to remove records
+ can_remove_records = False
+
def prepare_request_data(self, proto):
data = {
"hostname" : self.hostname,
# http://all-inkl.goetze.it/v01/ddns-mit-einfachen-mitteln/
url = "http://dyndns.kasserver.com"
+ can_remove_records = False
def update(self):
# There is no additional data required so we directly can
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()
# grabed from source code of ez-ipudate.
url = "http://members.dhs.org/nic/hosts"
+ can_remove_records = False
def update_protocol(self, proto):
data = {
# https://dnspark.zendesk.com/entries/31229348-Dynamic-DNS-API-Documentation
url = "https://control.dnspark.com/api/dynamic/update.php"
+ can_remove_records = False
def update_protocol(self, proto):
data = {
# http://www.dtdns.com/dtsite/updatespec
url = "https://www.dtdns.com/api/autodns.cfm"
+ can_remove_records = False
def update_protocol(self, proto):
data = {
if myipv6:
data["myipv6"] = myipv6
- self._send_request(data)
+ self.send_request(data)
class DDNSProviderEasyDNS(DDNSProtocolDynDNS2, DDNSProvider):
name = "DyNS"
website = "http://www.dyns.net/"
protocols = ("ipv4",)
+ can_remove_records = False
# There is very detailed informatio about how to send the update request and
# the possible response codes. (Currently we are using the v1.1 proto)
# http://www.enom.com/APICommandCatalog/
url = "https://dynamic.name-services.com/interface.asp"
+ can_remove_records = False
def update_protocol(self, proto):
data = {
# Some very tiny details about their so called "Simple API" can be found
# here: https://entrydns.net/help
url = "https://entrydns.net/records/modify"
+ can_remove_records = False
def update_protocol(self, proto):
data = {
# 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"
+ can_remove_records = False
def update_protocol(self, proto):
data = {
# https://community.namecheap.com/forums/viewtopic.php?f=6&t=6772
url = "https://dynamicdns.park-your-domain.com/update"
+ can_remove_records = False
def update_protocol(self, proto):
# Namecheap requires the hostname splitted into a host and domain part.
# 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),
# https://www.regfish.de/domains/dyndns/dokumentation
url = "https://dyndns.regfish.de/"
+ can_remove_records = False
def update(self):
data = {
# https://bugzilla.ipfire.org/show_bug.cgi?id=10584#c2
url = "https://zzzz.io/api/v1/update"
+ can_remove_records = False
def update_protocol(self, proto):
data = {
projects / ddns.git / blobdiff