###############################################################################
import logging
+import subprocess
import urllib2
import xml.dom.minidom
logger = logging.getLogger("ddns.providers")
logger.propagate = 1
+_providers = {}
+
+def get():
+ """
+ Returns a dict with all automatically registered providers.
+ """
+ return _providers.copy()
+
class DDNSProvider(object):
# A short string that uniquely identifies
# this provider.
DEFAULT_SETTINGS = {}
+ # Automatically register all providers.
+ class __metaclass__(type):
+ def __init__(provider, name, bases, dict):
+ type.__init__(provider, name, bases, dict)
+
+ # The main class from which is inherited is not registered
+ # as a provider.
+ if name == "DDNSProvider":
+ return
+
+ if not all((provider.handle, provider.name, provider.website)):
+ raise DDNSError(_("Provider is not properly configured"))
+
+ assert not _providers.has_key(provider.handle), \
+ "Provider '%s' has already been registered" % provider.handle
+
+ _providers[provider.handle] = provider
+
def __init__(self, core, **settings):
self.core = core
"""
# Information about the format of the request is to be found
- # http://http://dyn.com/support/developers/api/perform-update/
+ # http://dyn.com/support/developers/api/perform-update/
# http://dyn.com/support/developers/api/return-codes/
def _prepare_request_data(self):
raise DDNSUpdateError(_("Server response: %s") % output)
+class DDNSResponseParserXML(object):
+ """
+ This class provides a parser for XML responses which
+ will be sent by various providers. This class uses the python
+ shipped XML minidom module to walk through the XML tree and return
+ a requested element.
+ """
+
+ def get_xml_tag_value(self, document, content):
+ # Send input to the parser.
+ xmldoc = xml.dom.minidom.parseString(document)
+
+ # Get XML elements by the given content.
+ element = xmldoc.getElementsByTagName(content)
+
+ # If no element has been found, we directly can return None.
+ if not element:
+ return None
+
+ # Only get the first child from an element, even there are more than one.
+ firstchild = element[0].firstChild
+
+ # Get the value of the child.
+ value = firstchild.nodeValue
+
+ # Return the value.
+ return value
+
+
class DDNSProviderAllInkl(DDNSProvider):
handle = "all-inkl.com"
name = "All-inkl.com"
raise DDNSUpdateError
+class DDNSProviderBindNsupdate(DDNSProvider):
+ handle = "nsupdate"
+ name = "BIND nsupdate utility"
+ website = "http://en.wikipedia.org/wiki/Nsupdate"
+
+ DEFAULT_TTL = 60
+
+ def update(self):
+ scriptlet = self.__make_scriptlet()
+
+ # -v enables TCP hence we transfer keys and other data that may
+ # exceed the size of one packet.
+ # -t sets the timeout
+ command = ["nsupdate", "-v", "-t", "60"]
+
+ p = subprocess.Popen(command, shell=True,
+ stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE,
+ )
+ stdout, stderr = p.communicate(scriptlet)
+
+ if p.returncode == 0:
+ return
+
+ raise DDNSError("nsupdate terminated with error code: %s\n %s" % (p.returncode, stderr))
+
+ def __make_scriptlet(self):
+ scriptlet = []
+
+ # Set a different server the update is sent to.
+ server = self.get("server", None)
+ if server:
+ scriptlet.append("server %s" % server)
+
+ key = self.get("key", None)
+ if key:
+ secret = self.get("secret")
+
+ scriptlet.append("key %s %s" % (key, secret))
+
+ ttl = self.get("ttl", self.DEFAULT_TTL)
+
+ # Perform an update for each supported protocol.
+ for rrtype, proto in (("AAAA", "ipv6"), ("A", "ipv4")):
+ address = self.get_address(proto)
+ if not address:
+ continue
+
+ scriptlet.append("update delete %s. %s" % (self.hostname, rrtype))
+ scriptlet.append("update add %s. %s %s %s" % \
+ (self.hostname, ttl, rrtype, address))
+
+ # Send the actions to the server.
+ scriptlet.append("send")
+ scriptlet.append("quit")
+
+ logger.debug(_("Scriptlet:"))
+ for line in scriptlet:
+ # Masquerade the line with the secret key.
+ if line.startswith("key"):
+ line = "key **** ****"
+
+ logger.debug(" %s" % line)
+
+ return "\n".join(scriptlet)
+
+
class DDNSProviderDHS(DDNSProvider):
handle = "dhs.org"
name = "DHS International"
url = "http://api.cp.easydns.com/dyn/tomato.php"
+class DDNSProviderEnomCom(DDNSResponseParserXML, DDNSProvider):
+ handle = "enom.com"
+ name = "eNom Inc."
+ website = "http://www.enom.com/"
+
+ # There are very detailed information about how to send an update request and
+ # the respone codes.
+ # http://www.enom.com/APICommandCatalog/
+
+ url = "https://dynamic.name-services.com/interface.asp"
+
+ def update(self):
+ data = {
+ "command" : "setdnshost",
+ "responsetype" : "xml",
+ "address" : self.get_address("ipv4"),
+ "domainpassword" : self.password,
+ "zone" : self.hostname
+ }
+
+ # Send update to the server.
+ response = self.send_request(self.url, data=data)
+
+ # Get the full response message.
+ output = response.read()
+
+ # Handle success messages.
+ if self.get_xml_tag_value(output, "ErrCount") == "0":
+ return
+
+ # Handle error codes.
+ errorcode = self.get_xml_tag_value(output, "ResponseNumber")
+
+ if errorcode == "304155":
+ raise DDNSAuthenticationError
+ elif errorcode == "304153":
+ raise DDNSRequestError(_("Domain not found."))
+
+ # If we got here, some other update error happened.
+ raise DDNSUpdateError
+
+
class DDNSProviderFreeDNSAfraidOrg(DDNSProvider):
handle = "freedns.afraid.org"
name = "freedns.afraid.org"
raise DDNSUpdateError
-class DDNSProviderNamecheap(DDNSProvider):
+class DDNSProviderNamecheap(DDNSResponseParserXML, DDNSProvider):
handle = "namecheap.com"
name = "Namecheap"
website = "http://namecheap.com"
url = "https://dynamicdns.park-your-domain.com/update"
- def parse_xml(self, document, content):
- # Send input to the parser.
- xmldoc = xml.dom.minidom.parseString(document)
-
- # Get XML elements by the given content.
- element = xmldoc.getElementsByTagName(content)
-
- # If no element has been found, we directly can return None.
- if not element:
- return None
-
- # Only get the first child from an element, even there are more than one.
- firstchild = element[0].firstChild
-
- # Get the value of the child.
- value = firstchild.nodeValue
-
- # Return the value.
- return value
-
def update(self):
# Namecheap requires the hostname splitted into a host and domain part.
host, domain = self.hostname.split(".", 1)
output = response.read()
# Handle success messages.
- if self.parse_xml(output, "IP") == self.get_address("ipv4"):
+ if self.get_xml_tag_value(output, "IP") == self.get_address("ipv4"):
return
# Handle error codes.
- errorcode = self.parse_xml(output, "ResponseNumber")
+ errorcode = self.get_xml_tag_value(output, "ResponseNumber")
if errorcode == "304156":
raise DDNSAuthenticationError
projects / oddments / ddns.git / blobdiff