From: Kim Barthel Date: Wed, 15 Jan 2020 15:41:06 +0000 (+0100) Subject: ddns: Port to python3 X-Git-Tag: 013~9 X-Git-Url: http://git.ipfire.org/?p=ddns.git;a=commitdiff_plain;h=91aead365f0b0da834a0340551deebb714a6b074 ddns: Port to python3 Signed-off-by: Stefan Schantl --- diff --git a/configure.ac b/configure.ac index 14bccc0..4c93285 100644 --- a/configure.ac +++ b/configure.ac @@ -54,7 +54,7 @@ AC_PROG_SED AC_PATH_PROG([XSLTPROC], [xsltproc]) # Python -AM_PATH_PYTHON([2.7]) +AM_PATH_PYTHON([3.6]) save_LIBS="$LIBS" diff --git a/ddns.in b/ddns.in index 1ca5f83..0e377e7 100644 --- a/ddns.in +++ b/ddns.in @@ -1,4 +1,4 @@ -#!/usr/bin/python +#!/usr/bin/python3 ############################################################################### # # # ddns - A dynamic DNS client for IPFire # @@ -74,16 +74,16 @@ def main(): # IPv6 ipv6_address = d.system.guess_external_ip_address("ipv6") if ipv6_address: - print _("IPv6 Address: %s") % ipv6_address + print("IPv6 Address: %s" % ipv6_address) # IPv4 ipv4_address = d.system.guess_external_ip_address("ipv4") if ipv4_address: - print _("IPv4 Address: %s") % ipv4_address + print("IPv4 Address: %s" % ipv4_address) elif args.subparsers_name == "list-providers": provider_names = d.get_provider_names() - print "\n".join(provider_names) + print("\n".join(provider_names)) elif args.subparsers_name == "update": d.updateone(hostname=args.hostname, force=args.force) diff --git a/src/ddns/__init__.py b/src/ddns/__init__.py index 7f2729c..3e43fa7 100644 --- a/src/ddns/__init__.py +++ b/src/ddns/__init__.py @@ -1,4 +1,4 @@ -#!/usr/bin/python +#!/usr/bin/python3 ############################################################################### # # # ddns - A dynamic DNS client for IPFire # @@ -21,15 +21,15 @@ import logging import logging.handlers -import ConfigParser +import configparser -from i18n import _ +from .i18n import _ logger = logging.getLogger("ddns.core") logger.propagate = 1 -import database -import providers +from . import database +from . import providers from .errors import * from .system import DDNSSystem @@ -89,7 +89,7 @@ class DDNSCore(object): def load_configuration(self, filename): logger.debug(_("Loading configuration file %s") % filename) - configs = ConfigParser.RawConfigParser() + configs = configparser.RawConfigParser() configs.read([filename,]) # First apply all global configuration settings. @@ -98,7 +98,7 @@ class DDNSCore(object): self.settings[k] = v # Allow missing config section - except ConfigParser.NoSectionError: + except configparser.NoSectionError: pass for entry in configs.sections(): @@ -127,7 +127,7 @@ class DDNSCore(object): # Check if the provider is actually supported and if there are # some dependencies missing on this system. if not provider.supported(): - logger.warning("Provider '%s' is known, but not supported on this machine" % (provider.name)) + logger.warning("Provider '%s' is known, but not supported on this machine" % provider.name) continue # Create an instance of the provider object with settings from the @@ -163,13 +163,13 @@ class DDNSCore(object): try: entry(force=force) - except DDNSError, e: - logger.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) failed:") % \ - { "hostname" : entry.hostname, "provider" : entry.name }) + except DDNSError as e: + logger.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) failed:") % + {"hostname": entry.hostname, "provider": entry.name}) logger.error(" %s: %s" % (e.__class__.__name__, e.reason)) if e.message: logger.error(" %s" % e.message) - except Exception, e: - logger.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) throwed an unhandled exception:") % \ - { "hostname" : entry.hostname, "provider" : entry.name }, exc_info=True) + except Exception: + logger.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) threw an unhandled exception:") % + {"hostname": entry.hostname, "provider": entry.name}, exc_info=True) diff --git a/src/ddns/database.py b/src/ddns/database.py index 70a7363..e0a035a 100644 --- a/src/ddns/database.py +++ b/src/ddns/database.py @@ -1,4 +1,4 @@ -#!/usr/bin/python +#!/usr/bin/python3 ############################################################################### # # # ddns - A dynamic DNS client for IPFire # @@ -82,6 +82,7 @@ class DDNSDatabase(object): def _close_database(self): if self._db: + # TODO: Check Unresolved attribute reference '_db_close' for class 'DDNSDatabase' self._db_close() self._db = None diff --git a/src/ddns/errors.py b/src/ddns/errors.py index a8a2017..0bc1fa5 100644 --- a/src/ddns/errors.py +++ b/src/ddns/errors.py @@ -1,4 +1,4 @@ -#!/usr/bin/python +#!/usr/bin/python3 ############################################################################### # # # ddns - A dynamic DNS client for IPFire # diff --git a/src/ddns/i18n.py b/src/ddns/i18n.py index 170414d..1b8a970 100644 --- a/src/ddns/i18n.py +++ b/src/ddns/i18n.py @@ -1,4 +1,4 @@ -#!/usr/bin/python +#!/usr/bin/python3 ############################################################################### # # # ddns - A dynamic DNS client for IPFire # @@ -25,15 +25,14 @@ TEXTDOMAIN = "ddns" N_ = lambda x: x + def _(singular, plural=None, n=None): """ A function that returnes the translation of a string if available. - The language is taken from the system environment. - """ - if not plural is None: + """ + if plural is not None: assert n is not None return gettext.dngettext(TEXTDOMAIN, singular, plural, n) return gettext.dgettext(TEXTDOMAIN, singular) - diff --git a/src/ddns/providers.py b/src/ddns/providers.py index 661fbcc..eb66054 100644 --- a/src/ddns/providers.py +++ b/src/ddns/providers.py @@ -1,4 +1,4 @@ -#!/usr/bin/python +#!/usr/bin/python3 ############################################################################### # # # ddns - A dynamic DNS client for IPFire # @@ -23,10 +23,12 @@ import datetime import logging import os import subprocess -import urllib2 +import urllib.request +import urllib.error +import urllib.parse import xml.dom.minidom -from i18n import _ +from .i18n import _ # Import all possible exception types. from .errors import * @@ -84,7 +86,7 @@ class DDNSProvider(object): if not all((provider.handle, provider.name, provider.website)): raise DDNSError(_("Provider is not properly configured")) - assert not _providers.has_key(provider.handle), \ + assert provider.handle not in _providers, \ "Provider '%s' has already been registered" % provider.handle _providers[provider.handle] = provider @@ -109,7 +111,7 @@ class DDNSProvider(object): return "" % (self.name, self.handle) def __cmp__(self, other): - return cmp(self.hostname, other.hostname) + return (lambda a, b: (a > b)-(a < b))(self.hostname, other.hostname) @property def db(self): @@ -176,8 +178,8 @@ class DDNSProvider(object): 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 }) + 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): @@ -192,7 +194,7 @@ class DDNSProvider(object): def remove_protocol(self, proto): if not self.can_remove_records: - raise RuntimeError, "can_remove_records is enabled, but remove_protocol() not implemented" + raise RuntimeError("can_remove_records is enabled, but remove_protocol() not implemented") raise NotImplementedError @@ -200,23 +202,21 @@ class DDNSProvider(object): 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 }) + 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 }) + 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 }) + logger.debug(_("No update required for %(hostname)s (%(provider)s)") % + {"hostname": self.hostname, "provider": self.name}) return False @@ -234,8 +234,7 @@ class DDNSProvider(object): # 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(_("An update has not been performed because earlier updates failed for %s") % self.hostname) logger.warning(_("There will be no retries")) return True @@ -248,8 +247,7 @@ class DDNSProvider(object): 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) + logger.warning(_("An update has not been performed because earlier updates failed for %s") % self.hostname) if failure_message: logger.warning(_("Last failure message:")) @@ -315,8 +313,8 @@ class DDNSProvider(object): 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)) + logger.debug("Updates for %s are held off until %s" % + (self.hostname, holdoff_end)) return False def send_request(self, *args, **kwargs): @@ -375,8 +373,7 @@ class DDNSProtocolDynDNS2(object): def send_request(self, data): # Send update to the server. - response = DDNSProvider.send_request(self, self.url, data=data, - username=self.username, password=self.password) + response = DDNSProvider.send_request(self, self.url, data=data, username=self.username, password=self.password) # Get the full response message. output = response.read() @@ -413,7 +410,7 @@ class DDNSResponseParserXML(object): 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. @@ -494,9 +491,7 @@ class DDNSProviderBindNsupdate(DDNSProvider): # -t sets the timeout command = ["nsupdate", "-v", "-t", "60"] - p = subprocess.Popen(command, shell=True, - stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, - ) + p = subprocess.Popen(command, shell=True, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE) stdout, stderr = p.communicate(scriptlet) if p.returncode == 0: @@ -570,11 +565,10 @@ class DDNSProviderChangeIP(DDNSProvider): # Send update to the server. try: - response = self.send_request(self.url, username=self.username, password=self.password, - data=data) + response = self.send_request(self.url, username=self.username, password=self.password, data=data) # Handle error codes. - except urllib2.HTTPError, e: + except urllib.error.HTTPError as e: if e.code == 422: raise DDNSRequestError(_("Domain not found.")) @@ -703,8 +697,7 @@ class DDNSProviderDHS(DDNSProvider): } # Send update to the server. - response = self.send_request(self.url, username=self.username, password=self.password, - data=data) + response = self.send_request(self.url, username=self.username, password=self.password, data=data) # Handle success messages. if response.code == 200: @@ -733,8 +726,7 @@ class DDNSProviderDNSpark(DDNSProvider): } # Send update to the server. - response = self.send_request(self.url, username=self.username, password=self.password, - data=data) + response = self.send_request(self.url, username=self.username, password=self.password, data=data) # Get the full response message. output = response.read() @@ -903,14 +895,13 @@ class DDNSProviderDynUp(DDNSProvider): output = output.strip() # Handle success messages. - if output.startswith("I:OK") : + if output.startswith("I:OK"): return # If we got here, some other update error happened. raise DDNSUpdateError - class DDNSProviderDynU(DDNSProtocolDynDNS2, DDNSProvider): handle = "dynu.com" name = "Dynu" @@ -957,8 +948,7 @@ class DDNSProviderEasyDNS(DDNSProvider): } # Send update to the server. - response = self.send_request(self.url, data=data, - username=self.username, password=self.password) + response = self.send_request(self.url, data=data, username=self.username, password=self.password) # Get the full response message. output = response.read() @@ -1111,7 +1101,7 @@ class DDNSProviderEntryDNS(DDNSProvider): response = self.send_request(url, data=data) # Handle error codes - except urllib2.HTTPError, e: + except urllib.error.HTTPError as e: if e.code == 404: raise DDNSAuthenticationError @@ -1488,7 +1478,7 @@ class DDNSProviderRegfish(DDNSProvider): data["ipv4"] = address4 # Raise an error if none address is given. - if not data.has_key("ipv6") and not data.has_key("ipv4"): + if "ipv6" not in data and "ipv4" not in data: raise DDNSConfigurationError # Check if a token has been set. @@ -1506,8 +1496,7 @@ class DDNSProviderRegfish(DDNSProvider): response = self.send_request(self.url, data=data) else: # Send update to the server. - response = self.send_request(self.url, username=self.username, password=self.password, - data=data) + response = self.send_request(self.url, username=self.username, password=self.password, data=data) # Get the full response message. output = response.read() @@ -1726,8 +1715,7 @@ class DDNSProviderZoneedit(DDNSProvider): } # Send update to the server. - response = self.send_request(self.url, username=self.username, password=self.password, - data=data) + response = self.send_request(self.url, username=self.username, password=self.password, data=data) # Get the full response message. output = response.read() diff --git a/src/ddns/system.py b/src/ddns/system.py index b7a51f6..299ed07 100644 --- a/src/ddns/system.py +++ b/src/ddns/system.py @@ -1,4 +1,4 @@ -#!/usr/bin/python +#!/usr/bin/python3 ############################################################################### # # # ddns - A dynamic DNS client for IPFire # @@ -23,12 +23,13 @@ import base64 import re import ssl import socket -import urllib -import urllib2 +import urllib.request +import urllib.parse +import urllib.error -from __version__ import CLIENT_VERSION +from .__version__ import CLIENT_VERSION from .errors import * -from i18n import _ +from .i18n import _ # Initialize the logger. import logging @@ -79,7 +80,7 @@ class DDNSSystem(object): with open("/var/ipfire/red/local-ipaddress") as f: return f.readline() - except IOError, e: + except IOError as e: # File not found if e.errno == 2: return @@ -137,7 +138,7 @@ class DDNSSystem(object): if data: logger.debug(" data: %s" % data) - req = urllib2.Request(url, data=data) + req = urllib.request.Request(url, data=data) if username and password: basic_auth_header = self._make_basic_auth_header(username, password) @@ -163,7 +164,7 @@ class DDNSSystem(object): logger.debug(" %s: %s" % (k, v)) try: - resp = urllib2.urlopen(req, timeout=timeout) + resp = urllib.request.urlopen(req, timeout=timeout) # Log response header. logger.debug(_("Response header (Status Code %s):") % resp.code) @@ -173,7 +174,7 @@ class DDNSSystem(object): # Return the entire response object. return resp - except urllib2.HTTPError, e: + except urllib.error.HTTPError as e: # Log response header. logger.debug(_("Response header (Status Code %s):") % e.code) for k, v in e.hdrs.items(): @@ -209,7 +210,7 @@ class DDNSSystem(object): # Raise all other unhandled exceptions. raise - except urllib2.URLError, e: + except urllib.error.URLError as e: if e.reason: # Handle SSL errors if isinstance(e.reason, ssl.SSLError): @@ -240,7 +241,7 @@ class DDNSSystem(object): # Raise all other unhandled exceptions. raise - except socket.timeout, e: + except socket.timeout as e: logger.debug(_("Connection timeout")) raise DDNSConnectionTimeoutError @@ -249,7 +250,7 @@ class DDNSSystem(object): args = [] for k, v in data.items(): - arg = "%s=%s" % (k, urllib.quote(v)) + arg = "%s=%s" % (k, urllib.parse.quote(v)) args.append(arg) return "&".join(args) @@ -258,7 +259,7 @@ class DDNSSystem(object): authstring = "%s:%s" % (username, password) # Encode authorization data in base64. - authstring = base64.encodestring(authstring) + authstring = base64.encodebytes(authstring) # Remove any newline characters. authstring = authstring.replace("\n", "") @@ -354,7 +355,7 @@ class DDNSSystem(object): # Resolve the host address. try: response = socket.getaddrinfo(hostname, None, family) - except socket.gaierror, e: + except socket.gaierror as e: # Name or service not known if e.errno == -2: return [] @@ -388,7 +389,7 @@ class DDNSSystem(object): continue # Add to repsonse list if not already in there. - if not address in addresses: + if address not in addresses: addresses.append(address) return addresses @@ -418,7 +419,7 @@ class DDNSSystem(object): """ try: f = open("/etc/os-release", "r") - except IOError, e: + except IOError as e: # File not found if e.errno == 2: return @@ -447,7 +448,7 @@ class DDNSSystem(object): """ try: f = open("/etc/system-release", "r") - except IOError, e: + except IOError as e: # File not found if e.errno == 2: return