update docs after renames

[toast/tdyndns.git] / bin / nsupdate_dyndns

diff --git a/bin/nsupdate_dyndns b/bin/nsupdate_dyndns
index 49ed3e3b01ce1af8d0fd88e95c3cc0f291d22219..4452fe088d4881fae85e826ee35caf2a773531e3 100755 (executable)
--- a/bin/nsupdate_dyndns
+++ b/bin/nsupdate_dyndns
@@ -1,10 +1,16 @@
 #!/usr/bin/python
 #!/usr/bin/python

+import sys

 import re
 import argparse
 from subprocess import Popen, PIPE
 import ipaddr
 
 
 import re
 import argparse
 from subprocess import Popen, PIPE
 import ipaddr
 
 

+class NsupdateError(Exception):
+       def __init__(self, returncode):
+               self.returncode = returncode
+
+

 def ipfamily_by_ip(ip):
        if isinstance(ip, ipaddr.IPv4Address):
                return 'A'
 def ipfamily_by_ip(ip):
        if isinstance(ip, ipaddr.IPv4Address):
                return 'A'


@@ -13,43 +19,54 @@ def ipfamily_by_ip(ip):
        assert False
 
 
        assert False
 
 

-def nsupdate_add(hostname, domain, ttl, ip):
-       """ip_family: A or AAAA"""
-       command = "update add {hostname}.{domain} {ttl} IN {ip_family} {ip}\n\n".format(hostname=hostname, domain=domain, ttl=ttl, ip_family=ipfamily_by_ip(ip), ip=ip)
+def nsupdate_add(fqdn, ttl, ip):
+       """
+       :param fqdn: Fully qualified domain name
+       :param ip_family: A or AAAA
+       :raises an NsupdateError in case of errors."""
+       command = "update add {fqdn} {ttl} IN {ip_family} {ip}\n\n".format(fqdn=fqdn, ttl=ttl, ip_family=ipfamily_by_ip(ip), ip=ip)

        p = Popen(['nsupdate', '-l'], stdin=PIPE)
        p.communicate(command)
        p = Popen(['nsupdate', '-l'], stdin=PIPE)
        p.communicate(command)

+       if p.returncode != 0:
+               raise NsupdateError(p.returncode)

 
 
 
 

-def nsupdate_delete(hostname, domain, ip_family):
-       """ip_family: A or AAAA"""
-       command = "update delete {hostname}.{domain} {ip_family}\n\n".format(hostname=hostname, domain=domain, ip_family=ip_family)
+def nsupdate_delete(fqdn, ip_family):
+       """
+       :param fqdn: Fully qualified domain name
+       :param ip_family: A or AAAA
+       :raises an NsupdateError in case of errors."""
+       command = "update delete {fqdn} {ip_family}\n\n".format(fqdn=fqdn, ip_family=ip_family)

        p = Popen(['nsupdate', '-l'], stdin=PIPE)
        p.communicate(command)
        p = Popen(['nsupdate', '-l'], stdin=PIPE)
        p.communicate(command)

+       if p.returncode != 0:
+               raise NsupdateError(p.returncode)

 
 
 def main(args):
 
 
 def main(args):

-       if args.delete:
-               if args.ip is None:
-                       nsupdate_delete(args.hostname, args.domain, 'A')
-                       nsupdate_delete(args.hostname, args.domain, 'AAAA')
+       try:
+               if args.delete:
+                       if args.ip is None:
+                               nsupdate_delete(args.fqdn, 'A')
+                               nsupdate_delete(args.fqdn, 'AAAA')
+                       else:
+                               nsupdate_delete(args.fqdn, ipfamily_by_ip(args.ip))

                else:
                else:

-                       nsupdate_delete(args.hostname, args.domain, ipfamily_by_ip(args.ip))
-       else:
-               nsupdate_delete(args.hostname, args.domain, ipfamily_by_ip(args.ip))
-               nsupdate_add(args.hostname, args.domain, args.ttl, args.ip)
+                       nsupdate_delete(args.fqdn, ipfamily_by_ip(args.ip))
+                       nsupdate_add(args.fqdn, args.ttl, args.ip)
+       except NsupdateError as e:
+               sys.exit(e.returncode)
+

 
 
 if __name__ == '__main__':
 
 
 if __name__ == '__main__':

-       parser = argparse.ArgumentParser(description='Add or delete a hostname from dyndns (simplifies call to nsupdate).')
+       parser = argparse.ArgumentParser(description='Add or delete a domain name from dyndns (simplifies call to nsupdate).')

        parser.add_argument('-d', '--delete', action='store_true', help='delete instead of add')
        parser.add_argument('-i', '--ip', help='IP address (either IPv4 or IPv6)')
        parser.add_argument('-d', '--delete', action='store_true', help='delete instead of add')
        parser.add_argument('-i', '--ip', help='IP address (either IPv4 or IPv6)')

-       # parser.add_argument('-t', '--ttl', type=int, default=600, help='TTL (default: 600)')
-       parser.add_argument('hostname', help='hostname to add or delete, e.g. myserver')
+       parser.add_argument('-t', '--ttl', type=int, default=600, help='TTL (default: 600)')
+       parser.add_argument('fqdn', help='fully qualified domain name to add or delete, e.g. myserver.dyn.example.com')

        args = parser.parse_args()
 
        args = parser.parse_args()
 

-       args.domain = 'dyn.colgarra.priv.at' # <---- TODO
-       args.ttl = 600 # <---- TODO
-

        # check ip
        if not args.delete and not args.ip:
                parser.error('The IP address is mandatory')
        # check ip
        if not args.delete and not args.ip:
                parser.error('The IP address is mandatory')


@@ -59,8 +76,8 @@ if __name__ == '__main__':
                except ValueError:
                        parser.error('The IP address is not valid')
 
                except ValueError:
                        parser.error('The IP address is not valid')
 

-       # check hostname
-       if re.match(r'[-0-9a-z]+(\.[-0-9a-z]+)*$', args.hostname) is None:
-               parser.error('The hostname has an invalid format.')
+       # check fqdn
+       if re.match(r'[-0-9a-z]+(\.[-0-9a-z]+)*$', args.fqdn) is None:
+               parser.error('The fqdn has an invalid format.')

 
        main(args)
 
        main(args)