]>
Commit | Line | Data |
---|---|---|
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 | rootlogger = logging.getLogger("ddns") | |
56 | rootlogger.setLevel(logging.DEBUG) | |
57 | ||
58 | logger.debug(_("Debugging mode enabled")) | |
59 | ||
60 | # Initialize the settings array. | |
61 | self.settings = {} | |
62 | ||
63 | # Dict with all providers, that are supported. | |
64 | self.providers = {} | |
65 | self.register_all_providers() | |
66 | ||
67 | # List of configuration entries. | |
68 | self.entries = [] | |
69 | ||
70 | # Add the system class. | |
71 | self.system = DDNSSystem(self) | |
72 | ||
73 | def register_provider(self, provider): | |
74 | """ | |
75 | Registers a new provider. | |
76 | """ | |
77 | assert issubclass(provider, DDNSProvider) | |
78 | ||
79 | if not all((provider.handle, provider.name, provider.website)): | |
80 | raise DDNSError(_("Provider is not properly configured")) | |
81 | ||
82 | assert not self.providers.has_key(provider.handle), \ | |
83 | "Provider '%s' has already been registered" % provider.handle | |
84 | ||
85 | logger.debug("Registered new provider: %s (%s)" % (provider.name, provider.handle)) | |
86 | self.providers[provider.handle] = provider | |
87 | ||
88 | def register_all_providers(self): | |
89 | """ | |
90 | Simply registers all providers. | |
91 | """ | |
92 | for provider in ( | |
93 | DDNSProviderAllInkl, | |
94 | DDNSProviderDHS, | |
95 | DDNSProviderDNSpark, | |
96 | DDNSProviderDtDNS, | |
97 | DDNSProviderDynDNS, | |
98 | DDNSProviderDynU, | |
99 | DDNSProviderEasyDNS, | |
100 | DDNSProviderFreeDNSAfraidOrg, | |
101 | DDNSProviderNamecheap, | |
102 | DDNSProviderNOIP, | |
103 | DDNSProviderLightningWireLabs, | |
104 | DDNSProviderOVH, | |
105 | DDNSProviderRegfish, | |
106 | DDNSProviderSelfhost, | |
107 | DDNSProviderSPDNS, | |
108 | DDNSProviderStrato, | |
109 | DDNSProviderTwoDNS, | |
110 | DDNSProviderUdmedia, | |
111 | DDNSProviderVariomedia, | |
112 | DDNSProviderZoneedit, | |
113 | ): | |
114 | self.register_provider(provider) | |
115 | ||
116 | def get_provider_names(self): | |
117 | """ | |
118 | Returns a list of names of all registered providers. | |
119 | """ | |
120 | return sorted(self.providers.keys()) | |
121 | ||
122 | def load_configuration(self, filename): | |
123 | logger.debug(_("Loading configuration file %s") % filename) | |
124 | ||
125 | configs = ConfigParser.SafeConfigParser() | |
126 | configs.read([filename,]) | |
127 | ||
128 | # First apply all global configuration settings. | |
129 | for k, v in configs.items("config"): | |
130 | self.settings[k] = v | |
131 | ||
132 | for entry in configs.sections(): | |
133 | # Skip the special config section. | |
134 | if entry == "config": | |
135 | continue | |
136 | ||
137 | settings = {} | |
138 | for k, v in configs.items(entry): | |
139 | settings[k] = v | |
140 | settings["hostname"] = entry | |
141 | ||
142 | # Get the name of the provider. | |
143 | provider = settings.get("provider", None) | |
144 | if not provider: | |
145 | logger.warning("Entry '%s' lacks a provider setting. Skipping." % entry) | |
146 | continue | |
147 | ||
148 | # Try to find the provider with the wanted name. | |
149 | try: | |
150 | provider = self.providers[provider] | |
151 | except KeyError: | |
152 | logger.warning("Could not find provider '%s' for entry '%s'." % (provider, entry)) | |
153 | continue | |
154 | ||
155 | # Create an instance of the provider object with settings from the | |
156 | # configuration file. | |
157 | entry = provider(self, **settings) | |
158 | ||
159 | # Add new entry to list (if not already exists). | |
160 | if not entry in self.entries: | |
161 | self.entries.append(entry) | |
162 | ||
163 | def updateone(self, hostname, **kwargs): | |
164 | for entry in self.entries: | |
165 | if not entry.hostname == hostname: | |
166 | continue | |
167 | ||
168 | return self._update(entry, **kwargs) | |
169 | ||
170 | raise DDNSHostNotFoundError(hostname) | |
171 | ||
172 | def updateall(self, **kwargs): | |
173 | """ | |
174 | Update all configured entries. | |
175 | """ | |
176 | # If there are no entries, there is nothing to do. | |
177 | if not self.entries: | |
178 | logger.debug(_("Found no entries in the configuration file. Exiting.")) | |
179 | return | |
180 | ||
181 | for entry in self.entries: | |
182 | self._update(entry, **kwargs) | |
183 | ||
184 | def _update(self, entry, force=False): | |
185 | try: | |
186 | entry(force=force) | |
187 | ||
188 | except DDNSError, e: | |
189 | logger.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) failed:") % \ | |
190 | { "hostname" : entry.hostname, "provider" : entry.name }) | |
191 | logger.error(" %s: %s" % (e.__class__.__name__, e.reason)) | |
192 | if e.message: | |
193 | logger.error(" %s" % e.message) | |
194 | ||
195 | except Exception, e: | |
196 | logger.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) throwed an unhandled exception:") % \ | |
197 | { "hostname" : entry.hostname, "provider" : entry.name }, exc_info=True) | |
198 | ||
199 | else: | |
200 | logger.info(_("Dynamic DNS update for %(hostname)s (%(provider)s) successful") % \ | |
201 | { "hostname" : entry.hostname, "provider" : entry.name }) |