src/ddns/__init__.py

   1 #!/usr/bin/python
   2 ###############################################################################
   3 #                                                                             #
   4 # ddns - A dynamic DNS client for IPFire                                      #
   5 # Copyright (C) 2012 IPFire development team                                  #
   6 #                                                                             #
   7 # This program is free software: you can redistribute it and/or modify        #
   8 # it under the terms of the GNU General Public License as published by        #
   9 # the Free Software Foundation, either version 3 of the License, or           #
  10 # (at your option) any later version.                                         #
  11 #                                                                             #
  12 # This program is distributed in the hope that it will be useful,             #
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of              #
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               #
  15 # GNU General Public License for more details.                                #
  16 #                                                                             #
  17 # You should have received a copy of the GNU General Public License           #
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.       #
  19 #                                                                             #
  20 ###############################################################################
  21
  22 import logging
  23 import logging.handlers
  24 import ConfigParser
  25
  26 from i18n import _
  27
  28 logger = logging.getLogger("ddns.core")
  29 logger.propagate = 1
  30
  31 from .providers import *
  32 from .system import DDNSSystem
  33
  34 # Setup the logger.
  35 def setup_logging():
  36         rootlogger = logging.getLogger("ddns")
  37         rootlogger.setLevel(logging.DEBUG)
  38
  39         # Setup a logger that logs to syslog.
  40         #handler = logging.handlers.SysLogHandler(address="/dev/log")
  41
  42         handler = logging.StreamHandler()
  43         rootlogger.addHandler(handler)
  44
  45 setup_logging()
  46
  47 class DDNSCore(object):
  48         def __init__(self, debug=False):
  49                 # In debug mode, enable debug logging.
  50                 if debug:
  51                         logger.setLevel(logging.DEBUG)
  52
  53                 # Initialize the settings array.
  54                 self.settings = {}
  55
  56                 # Dict with all providers, that are supported.
  57                 self.providers = {}
  58                 self.register_all_providers()
  59
  60                 # List of configuration entries.
  61                 self.entries = []
  62
  63                 # Add the system class.
  64                 self.system = DDNSSystem(self)
  65
  66         def register_provider(self, provider):
  67                 """
  68                         Registers a new provider.
  69                 """
  70                 assert issubclass(provider, DDNSProvider)
  71
  72                 provider_handle = provider.INFO.get("handle")
  73                 assert provider_handle
  74
  75                 assert not self.providers.has_key(provider_handle), \
  76                         "Provider '%s' has already been registered" % provider_handle
  77
  78                 provider_name = provider.INFO.get("name")
  79                 assert provider_name
  80
  81                 logger.debug("Registered new provider: %s (%s)" % (provider_name, provider_handle))
  82                 self.providers[provider_handle] = provider
  83
  84         def register_all_providers(self):
  85                 """
  86                         Simply registers all providers.
  87                 """
  88                 for provider in (
  89                         DDNSProviderDHS,
  90                         DDNSProviderDNSpark,
  91                         DDNSProviderNOIP,
  92                         DDNSProviderLightningWireLabs,
  93                         DDNSProviderSelfhost,
  94                 ):
  95                         self.register_provider(provider)
  96
  97         def get_provider_names(self):
  98                 """
  99                         Returns a list of names of all registered providers.
 100                 """
 101                 return sorted(self.providers.keys())
 102
 103         def load_configuration(self, filename):
 104                 configs = ConfigParser.SafeConfigParser()
 105                 configs.read([filename,])
 106
 107                 # First apply all global configuration settings.
 108                 for k, v in configs.items("config"):
 109                         self.settings[k] = v
 110
 111                 for entry in configs.sections():
 112                         # Skip the special config section.
 113                         if entry == "config":
 114                                 continue
 115
 116                         settings = {}
 117                         for k, v in configs.items(entry):
 118                                 settings[k] = v
 119                         settings["hostname"] = entry
 120
 121                         # Get the name of the provider.
 122                         provider = settings.get("provider", None)
 123                         if not provider:
 124                                 logger.warning("Entry '%s' lacks a provider setting. Skipping." % entry)
 125                                 continue
 126
 127                         # Try to find the provider with the wanted name.
 128                         try:
 129                                 provider = self.providers[provider]
 130                         except KeyError:
 131                                 logger.warning("Could not find provider '%s' for entry '%s'." % (provider, entry))
 132                                 continue
 133
 134                         # Create an instance of the provider object with settings from the
 135                         # configuration file.
 136                         entry = provider(self, **settings)
 137
 138                         # Add new entry to list (if not already exists).
 139                         if not entry in self.entries:
 140                                 self.entries.append(entry)
 141
 142         def updateone(self, hostname, **kwargs):
 143                 for entry in self.entries:
 144                         if not entry.hostname == hostname:
 145                                 continue
 146
 147                         return self._update(entry, **kwargs)
 148
 149                 raise DDNSHostNotFoundError(hostname)
 150
 151         def updateall(self, **kwargs):
 152                 """
 153                         Update all configured entries.
 154                 """
 155                 # If there are no entries, there is nothing to do.
 156                 if not self.entries:
 157                         logger.debug(_("Found no entries in the configuration file. Exiting."))
 158                         return
 159
 160                 for entry in self.entries:
 161                         self._update(entry, **kwargs)
 162
 163         def _update(self, entry, force=False):
 164                 try:
 165                         entry(force=force)
 166
 167                 except DDNSUpdateError, e:
 168                         logger.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) failed:") % \
 169                                 { "hostname" : entry.hostname, "provider" : entry.name })
 170                         logger.error("  %s" % e)
 171
 172                 except Exception, e:
 173                         logger.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) throwed an unhandled exception:") % \
 174                                 { "hostname" : entry.hostname, "provider" : entry.name })
 175                         logger.error("  %s" % e)
 176
 177                 logger.info(_("Dynamic DNS update for %(hostname)s (%(provider)s) successful") % \
 178                         { "hostname" : entry.hostname, "provider" : entry.name })