2 ###############################################################################
4 # ddns - A dynamic DNS client for IPFire #
5 # Copyright (C) 2012 IPFire development team #
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. #
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. #
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/>. #
20 ###############################################################################
23 import logging
.handlers
28 logger
= logging
.getLogger("ddns.core")
31 from .providers
import *
32 from .system
import DDNSSystem
36 rootlogger
= logging
.getLogger("ddns")
37 rootlogger
.setLevel(logging
.INFO
)
39 # Setup a logger that logs to syslog.
40 handler
= logging
.handlers
.SysLogHandler(address
="/dev/log",
41 facility
=logging
.handlers
.SysLogHandler
.LOG_DAEMON
43 handler
.setLevel(logging
.INFO
)
44 rootlogger
.addHandler(handler
)
46 handler
= logging
.StreamHandler()
47 rootlogger
.addHandler(handler
)
51 class DDNSCore(object):
52 def __init__(self
, debug
=False):
53 # In debug mode, enable debug logging.
55 logger
.setLevel(logging
.DEBUG
)
56 logger
.debug(_("Debugging mode enabled"))
58 # Initialize the settings array.
61 # Dict with all providers, that are supported.
63 self
.register_all_providers()
65 # List of configuration entries.
68 # Add the system class.
69 self
.system
= DDNSSystem(self
)
71 def register_provider(self
, provider
):
73 Registers a new provider.
75 assert issubclass(provider
, DDNSProvider
)
77 provider_handle
= provider
.INFO
.get("handle")
78 assert provider_handle
80 assert not self
.providers
.has_key(provider_handle
), \
81 "Provider '%s' has already been registered" % provider_handle
83 provider_name
= provider
.INFO
.get("name")
86 logger
.debug("Registered new provider: %s (%s)" % (provider_name
, provider_handle
))
87 self
.providers
[provider_handle
] = provider
89 def register_all_providers(self
):
91 Simply registers all providers.
98 DDNSProviderLightningWireLabs
,
101 self
.register_provider(provider
)
103 def get_provider_names(self
):
105 Returns a list of names of all registered providers.
107 return sorted(self
.providers
.keys())
109 def load_configuration(self
, filename
):
110 logger
.debug(_("Loading configuration file %s") % filename
)
112 configs
= ConfigParser
.SafeConfigParser()
113 configs
.read([filename
,])
115 # First apply all global configuration settings.
116 for k
, v
in configs
.items("config"):
119 for entry
in configs
.sections():
120 # Skip the special config section.
121 if entry
== "config":
125 for k
, v
in configs
.items(entry
):
127 settings
["hostname"] = entry
129 # Get the name of the provider.
130 provider
= settings
.get("provider", None)
132 logger
.warning("Entry '%s' lacks a provider setting. Skipping." % entry
)
135 # Try to find the provider with the wanted name.
137 provider
= self
.providers
[provider
]
139 logger
.warning("Could not find provider '%s' for entry '%s'." % (provider
, entry
))
142 # Create an instance of the provider object with settings from the
143 # configuration file.
144 entry
= provider(self
, **settings
)
146 # Add new entry to list (if not already exists).
147 if not entry
in self
.entries
:
148 self
.entries
.append(entry
)
150 def updateone(self
, hostname
, **kwargs
):
151 for entry
in self
.entries
:
152 if not entry
.hostname
== hostname
:
155 return self
._update
(entry
, **kwargs
)
157 raise DDNSHostNotFoundError(hostname
)
159 def updateall(self
, **kwargs
):
161 Update all configured entries.
163 # If there are no entries, there is nothing to do.
165 logger
.debug(_("Found no entries in the configuration file. Exiting."))
168 for entry
in self
.entries
:
169 self
._update
(entry
, **kwargs
)
171 def _update(self
, entry
, force
=False):
175 except DDNSUpdateError
, e
:
176 logger
.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) failed:") % \
177 { "hostname" : entry
.hostname
, "provider" : entry
.name
})
178 logger
.error(" %s" % e
)
181 logger
.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) throwed an unhandled exception:") % \
182 { "hostname" : entry
.hostname
, "provider" : entry
.name
})
183 logger
.error(" %s" % e
)
186 logger
.info(_("Dynamic DNS update for %(hostname)s (%(provider)s) successful") % \
187 { "hostname" : entry
.hostname
, "provider" : entry
.name
})