Log which configuration file is loaded.
[oddments/ddns.git] / src / ddns / __init__.py
CommitLineData
f22ab085 1#!/usr/bin/python
3fdcb9d1
MT
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###############################################################################
f22ab085
MT
21
22import logging
23import logging.handlers
24import ConfigParser
25
26from i18n import _
27
28logger = logging.getLogger("ddns.core")
29logger.propagate = 1
30
31from .providers import *
32from .system import DDNSSystem
33
34# Setup the logger.
35def setup_logging():
36 rootlogger = logging.getLogger("ddns")
4bba8ae2 37 rootlogger.setLevel(logging.INFO)
f22ab085
MT
38
39 # Setup a logger that logs to syslog.
5ad24917
MT
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)
f22ab085
MT
45
46 handler = logging.StreamHandler()
47 rootlogger.addHandler(handler)
48
49setup_logging()
50
51class DDNSCore(object):
52 def __init__(self, debug=False):
53 # In debug mode, enable debug logging.
54 if debug:
55 logger.setLevel(logging.DEBUG)
4bba8ae2 56 logger.debug(_("Debugging mode enabled"))
f22ab085
MT
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 (
f3cf1f70 94 DDNSProviderDHS,
39301272 95 DDNSProviderDNSpark,
f22ab085 96 DDNSProviderNOIP,
a36d8df8 97 DDNSProviderLightningWireLabs,
f22ab085
MT
98 DDNSProviderSelfhost,
99 ):
100 self.register_provider(provider)
101
2dae4713
MT
102 def get_provider_names(self):
103 """
104 Returns a list of names of all registered providers.
105 """
106 return sorted(self.providers.keys())
107
f22ab085 108 def load_configuration(self, filename):
332fd7cc
MT
109 logger.debug(_("Loading configuration file %s") % filename)
110
f22ab085
MT
111 configs = ConfigParser.SafeConfigParser()
112 configs.read([filename,])
113
114 # First apply all global configuration settings.
115 for k, v in configs.items("config"):
116 self.settings[k] = v
117
118 for entry in configs.sections():
119 # Skip the special config section.
120 if entry == "config":
121 continue
122
123 settings = {}
124 for k, v in configs.items(entry):
125 settings[k] = v
126 settings["hostname"] = entry
127
128 # Get the name of the provider.
129 provider = settings.get("provider", None)
130 if not provider:
131 logger.warning("Entry '%s' lacks a provider setting. Skipping." % entry)
132 continue
133
134 # Try to find the provider with the wanted name.
135 try:
136 provider = self.providers[provider]
137 except KeyError:
138 logger.warning("Could not find provider '%s' for entry '%s'." % (provider, entry))
139 continue
140
141 # Create an instance of the provider object with settings from the
142 # configuration file.
143 entry = provider(self, **settings)
144
145 # Add new entry to list (if not already exists).
146 if not entry in self.entries:
147 self.entries.append(entry)
148
1b8c6925
MT
149 def updateone(self, hostname, **kwargs):
150 for entry in self.entries:
151 if not entry.hostname == hostname:
152 continue
153
154 return self._update(entry, **kwargs)
155
156 raise DDNSHostNotFoundError(hostname)
157
158 def updateall(self, **kwargs):
159 """
160 Update all configured entries.
161 """
f22ab085
MT
162 # If there are no entries, there is nothing to do.
163 if not self.entries:
164 logger.debug(_("Found no entries in the configuration file. Exiting."))
165 return
166
f22ab085 167 for entry in self.entries:
1b8c6925 168 self._update(entry, **kwargs)
f22ab085 169
1b8c6925 170 def _update(self, entry, force=False):
f22ab085 171 try:
9da3e685 172 entry(force=force)
f22ab085
MT
173
174 except DDNSUpdateError, e:
175 logger.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) failed:") % \
176 { "hostname" : entry.hostname, "provider" : entry.name })
177 logger.error(" %s" % e)
178
179 except Exception, e:
180 logger.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) throwed an unhandled exception:") % \
181 { "hostname" : entry.hostname, "provider" : entry.name })
182 logger.error(" %s" % e)
183
cbebe191
MT
184 else:
185 logger.info(_("Dynamic DNS update for %(hostname)s (%(provider)s) successful") % \
186 { "hostname" : entry.hostname, "provider" : entry.name })