]>
Commit | Line | Data |
---|---|---|
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 | |
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") | |
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 | ||
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) | |
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 ( | |
3b16fdb1 | 94 | DDNSProviderAllInkl, |
f3cf1f70 | 95 | DDNSProviderDHS, |
39301272 | 96 | DDNSProviderDNSpark, |
43b2cd59 | 97 | DDNSProviderDtDNS, |
bfed6701 | 98 | DDNSProviderDynDNS, |
3a8407fa | 99 | DDNSProviderDynU, |
ee071271 | 100 | DDNSProviderEasyDNS, |
aa21a4c6 | 101 | DDNSProviderFreeDNSAfraidOrg, |
d1cd57eb | 102 | DDNSProviderNamecheap, |
f22ab085 | 103 | DDNSProviderNOIP, |
a36d8df8 | 104 | DDNSProviderLightningWireLabs, |
a508bda6 | 105 | DDNSProviderOVH, |
ef33455e | 106 | DDNSProviderRegfish, |
f22ab085 | 107 | DDNSProviderSelfhost, |
b09b1545 | 108 | DDNSProviderSPDNS, |
7488825c | 109 | DDNSProviderStrato, |
c8c7ca8f | 110 | DDNSProviderVariomedia, |
f22ab085 MT |
111 | ): |
112 | self.register_provider(provider) | |
113 | ||
2dae4713 MT |
114 | def get_provider_names(self): |
115 | """ | |
116 | Returns a list of names of all registered providers. | |
117 | """ | |
118 | return sorted(self.providers.keys()) | |
119 | ||
f22ab085 | 120 | def load_configuration(self, filename): |
332fd7cc MT |
121 | logger.debug(_("Loading configuration file %s") % filename) |
122 | ||
f22ab085 MT |
123 | configs = ConfigParser.SafeConfigParser() |
124 | configs.read([filename,]) | |
125 | ||
126 | # First apply all global configuration settings. | |
127 | for k, v in configs.items("config"): | |
128 | self.settings[k] = v | |
129 | ||
130 | for entry in configs.sections(): | |
131 | # Skip the special config section. | |
132 | if entry == "config": | |
133 | continue | |
134 | ||
135 | settings = {} | |
136 | for k, v in configs.items(entry): | |
137 | settings[k] = v | |
138 | settings["hostname"] = entry | |
139 | ||
140 | # Get the name of the provider. | |
141 | provider = settings.get("provider", None) | |
142 | if not provider: | |
143 | logger.warning("Entry '%s' lacks a provider setting. Skipping." % entry) | |
144 | continue | |
145 | ||
146 | # Try to find the provider with the wanted name. | |
147 | try: | |
148 | provider = self.providers[provider] | |
149 | except KeyError: | |
150 | logger.warning("Could not find provider '%s' for entry '%s'." % (provider, entry)) | |
151 | continue | |
152 | ||
153 | # Create an instance of the provider object with settings from the | |
154 | # configuration file. | |
155 | entry = provider(self, **settings) | |
156 | ||
157 | # Add new entry to list (if not already exists). | |
158 | if not entry in self.entries: | |
159 | self.entries.append(entry) | |
160 | ||
1b8c6925 MT |
161 | def updateone(self, hostname, **kwargs): |
162 | for entry in self.entries: | |
163 | if not entry.hostname == hostname: | |
164 | continue | |
165 | ||
166 | return self._update(entry, **kwargs) | |
167 | ||
168 | raise DDNSHostNotFoundError(hostname) | |
169 | ||
170 | def updateall(self, **kwargs): | |
171 | """ | |
172 | Update all configured entries. | |
173 | """ | |
f22ab085 MT |
174 | # If there are no entries, there is nothing to do. |
175 | if not self.entries: | |
176 | logger.debug(_("Found no entries in the configuration file. Exiting.")) | |
177 | return | |
178 | ||
f22ab085 | 179 | for entry in self.entries: |
1b8c6925 | 180 | self._update(entry, **kwargs) |
f22ab085 | 181 | |
1b8c6925 | 182 | def _update(self, entry, force=False): |
f22ab085 | 183 | try: |
9da3e685 | 184 | entry(force=force) |
f22ab085 MT |
185 | |
186 | except DDNSUpdateError, e: | |
187 | logger.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) failed:") % \ | |
188 | { "hostname" : entry.hostname, "provider" : entry.name }) | |
189 | logger.error(" %s" % e) | |
190 | ||
191 | except Exception, e: | |
192 | logger.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) throwed an unhandled exception:") % \ | |
193 | { "hostname" : entry.hostname, "provider" : entry.name }) | |
194 | logger.error(" %s" % e) | |
195 | ||
cbebe191 MT |
196 | else: |
197 | logger.info(_("Dynamic DNS update for %(hostname)s (%(provider)s) successful") % \ | |
198 | { "hostname" : entry.hostname, "provider" : entry.name }) |