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
.DEBUG
)
39 # Setup a logger that logs to syslog.
40 #handler = logging.handlers.SysLogHandler(address="/dev/log")
42 handler
= logging
.StreamHandler()
43 rootlogger
.addHandler(handler
)
47 class DDNSCore(object):
48 def __init__(self
, debug
=False):
49 # In debug mode, enable debug logging.
51 logger
.setLevel(logging
.DEBUG
)
53 # Initialize the settings array.
56 # Dict with all providers, that are supported.
58 self
.register_all_providers()
60 # List of configuration entries.
63 # Add the system class.
64 self
.system
= DDNSSystem(self
)
66 def register_provider(self
, provider
):
68 Registers a new provider.
70 assert issubclass(provider
, DDNSProvider
)
72 provider_handle
= provider
.INFO
.get("handle")
73 assert provider_handle
75 assert not self
.providers
.has_key(provider_handle
), \
76 "Provider '%s' has already been registered" % provider_handle
78 provider_name
= provider
.INFO
.get("name")
81 logger
.debug("Registered new provider: %s (%s)" % (provider_name
, provider_handle
))
82 self
.providers
[provider_handle
] = provider
84 def register_all_providers(self
):
86 Simply registers all providers.
92 DDNSProviderLightningWireLabs
,
95 self
.register_provider(provider
)
97 def get_provider_names(self
):
99 Returns a list of names of all registered providers.
101 return sorted(self
.providers
.keys())
103 def load_configuration(self
, filename
):
104 configs
= ConfigParser
.SafeConfigParser()
105 configs
.read([filename
,])
107 # First apply all global configuration settings.
108 for k
, v
in configs
.items("config"):
111 for entry
in configs
.sections():
112 # Skip the special config section.
113 if entry
== "config":
117 for k
, v
in configs
.items(entry
):
119 settings
["hostname"] = entry
121 # Get the name of the provider.
122 provider
= settings
.get("provider", None)
124 logger
.warning("Entry '%s' lacks a provider setting. Skipping." % entry
)
127 # Try to find the provider with the wanted name.
129 provider
= self
.providers
[provider
]
131 logger
.warning("Could not find provider '%s' for entry '%s'." % (provider
, entry
))
134 # Create an instance of the provider object with settings from the
135 # configuration file.
136 entry
= provider(self
, **settings
)
138 # Add new entry to list (if not already exists).
139 if not entry
in self
.entries
:
140 self
.entries
.append(entry
)
142 def updateone(self
, hostname
, **kwargs
):
143 for entry
in self
.entries
:
144 if not entry
.hostname
== hostname
:
147 return self
._update
(entry
, **kwargs
)
149 raise DDNSHostNotFoundError(hostname
)
151 def updateall(self
, **kwargs
):
153 Update all configured entries.
155 # If there are no entries, there is nothing to do.
157 logger
.debug(_("Found no entries in the configuration file. Exiting."))
160 for entry
in self
.entries
:
161 self
._update
(entry
, **kwargs
)
163 def _update(self
, entry
, force
=False):
167 except DDNSUpdateError
, e
:
168 logger
.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) failed:") % \
169 { "hostname" : entry
.hostname
, "provider" : entry
.name
})
170 logger
.error(" %s" % e
)
173 logger
.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) throwed an unhandled exception:") % \
174 { "hostname" : entry
.hostname
, "provider" : entry
.name
})
175 logger
.error(" %s" % e
)
177 logger
.info(_("Dynamic DNS update for %(hostname)s (%(provider)s) successful") % \
178 { "hostname" : entry
.hostname
, "provider" : entry
.name
})