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