51728325d86b5fadd3a3b6c3e450e3a16534db15
[oddments/ddns.git] / 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.INFO)
38
39         # Setup a logger that logs to syslog.
40         handler = logging.handlers.SysLogHandler(address="/dev/log",
41                 facility=logging.handlers.SysLogHandler.LOG_DAEMON
42         )
43         handler.setLevel(logging.INFO)
44         rootlogger.addHandler(handler)
45
46         handler = logging.StreamHandler()
47         rootlogger.addHandler(handler)
48
49 setup_logging()
50
51 class DDNSCore(object):
52         def __init__(self, debug=False):
53                 # In debug mode, enable debug logging.
54                 if debug:
55                         logger.setLevel(logging.DEBUG)
56                         logger.debug(_("Debugging mode enabled"))
57
58                 # Initialize the settings array.
59                 self.settings = {}
60
61                 # Dict with all providers, that are supported.
62                 self.providers = {}
63                 self.register_all_providers()
64
65                 # List of configuration entries.
66                 self.entries = []
67
68                 # Add the system class.
69                 self.system = DDNSSystem(self)
70
71         def register_provider(self, provider):
72                 """
73                         Registers a new provider.
74                 """
75                 assert issubclass(provider, DDNSProvider)
76
77                 provider_handle = provider.INFO.get("handle")
78                 assert provider_handle
79
80                 assert not self.providers.has_key(provider_handle), \
81                         "Provider '%s' has already been registered" % provider_handle
82
83                 provider_name = provider.INFO.get("name")
84                 assert provider_name
85
86                 logger.debug("Registered new provider: %s (%s)" % (provider_name, provider_handle))
87                 self.providers[provider_handle] = provider
88
89         def register_all_providers(self):
90                 """
91                         Simply registers all providers.
92                 """
93                 for provider in (
94                         DDNSProviderDHS,
95                         DDNSProviderDNSpark,
96                         DDNSProviderDtDNS,
97                         DDNSProviderDynDNS,
98                         DDNSProviderNOIP,
99                         DDNSProviderLightningWireLabs,
100                         DDNSProviderSelfhost,
101                 ):
102                         self.register_provider(provider)
103
104         def get_provider_names(self):
105                 """
106                         Returns a list of names of all registered providers.
107                 """
108                 return sorted(self.providers.keys())
109
110         def load_configuration(self, filename):
111                 logger.debug(_("Loading configuration file %s") % filename)
112
113                 configs = ConfigParser.SafeConfigParser()
114                 configs.read([filename,])
115
116                 # First apply all global configuration settings.
117                 for k, v in configs.items("config"):
118                         self.settings[k] = v
119
120                 for entry in configs.sections():
121                         # Skip the special config section.
122                         if entry == "config":
123                                 continue
124
125                         settings = {}
126                         for k, v in configs.items(entry):
127                                 settings[k] = v
128                         settings["hostname"] = entry
129
130                         # Get the name of the provider.
131                         provider = settings.get("provider", None)
132                         if not provider:
133                                 logger.warning("Entry '%s' lacks a provider setting. Skipping." % entry)
134                                 continue
135
136                         # Try to find the provider with the wanted name.
137                         try:
138                                 provider = self.providers[provider]
139                         except KeyError:
140                                 logger.warning("Could not find provider '%s' for entry '%s'." % (provider, entry))
141                                 continue
142
143                         # Create an instance of the provider object with settings from the
144                         # configuration file.
145                         entry = provider(self, **settings)
146
147                         # Add new entry to list (if not already exists).
148                         if not entry in self.entries:
149                                 self.entries.append(entry)
150
151         def updateone(self, hostname, **kwargs):
152                 for entry in self.entries:
153                         if not entry.hostname == hostname:
154                                 continue
155
156                         return self._update(entry, **kwargs)
157
158                 raise DDNSHostNotFoundError(hostname)
159
160         def updateall(self, **kwargs):
161                 """
162                         Update all configured entries.
163                 """
164                 # If there are no entries, there is nothing to do.
165                 if not self.entries:
166                         logger.debug(_("Found no entries in the configuration file. Exiting."))
167                         return
168
169                 for entry in self.entries:
170                         self._update(entry, **kwargs)
171
172         def _update(self, entry, force=False):
173                 try:
174                         entry(force=force)
175
176                 except DDNSUpdateError, e:
177                         logger.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) failed:") % \
178                                 { "hostname" : entry.hostname, "provider" : entry.name })
179                         logger.error("  %s" % e)
180
181                 except Exception, e:
182                         logger.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) throwed an unhandled exception:") % \
183                                 { "hostname" : entry.hostname, "provider" : entry.name })
184                         logger.error("  %s" % e)
185
186                 else:
187                         logger.info(_("Dynamic DNS update for %(hostname)s (%(provider)s) successful") % \
188                                 { "hostname" : entry.hostname, "provider" : entry.name })