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 rootlogger
= logging
.getLogger("ddns")
56 rootlogger
.setLevel(logging
.DEBUG
)
57 for handler
in rootlogger
.handlers
:
58 handler
.setLevel(logging
.DEBUG
)
60 logger
.debug(_("Debugging mode enabled"))
62 # Initialize the settings array.
65 # Dict with all providers, that are supported.
67 self
.register_all_providers()
69 # List of configuration entries.
72 # Add the system class.
73 self
.system
= DDNSSystem(self
)
75 def register_provider(self
, provider
):
77 Registers a new provider.
79 assert issubclass(provider
, DDNSProvider
)
81 if not all((provider
.handle
, provider
.name
, provider
.website
)):
82 raise DDNSError(_("Provider is not properly configured"))
84 assert not self
.providers
.has_key(provider
.handle
), \
85 "Provider '%s' has already been registered" % provider
.handle
87 logger
.debug("Registered new provider: %s (%s)" % (provider
.name
, provider
.handle
))
88 self
.providers
[provider
.handle
] = provider
90 def register_all_providers(self
):
92 Simply registers all providers.
102 DDNSProviderFreeDNSAfraidOrg
,
103 DDNSProviderNamecheap
,
105 DDNSProviderLightningWireLabs
,
108 DDNSProviderSelfhost
,
113 DDNSProviderVariomedia
,
114 DDNSProviderZoneedit
,
116 self
.register_provider(provider
)
118 def get_provider_names(self
):
120 Returns a list of names of all registered providers.
122 return sorted(self
.providers
.keys())
124 def load_configuration(self
, filename
):
125 logger
.debug(_("Loading configuration file %s") % filename
)
127 configs
= ConfigParser
.SafeConfigParser()
128 configs
.read([filename
,])
130 # First apply all global configuration settings.
131 for k
, v
in configs
.items("config"):
134 for entry
in configs
.sections():
135 # Skip the special config section.
136 if entry
== "config":
140 for k
, v
in configs
.items(entry
):
142 settings
["hostname"] = entry
144 # Get the name of the provider.
145 provider
= settings
.get("provider", None)
147 logger
.warning("Entry '%s' lacks a provider setting. Skipping." % entry
)
150 # Try to find the provider with the wanted name.
152 provider
= self
.providers
[provider
]
154 logger
.warning("Could not find provider '%s' for entry '%s'." % (provider
, entry
))
157 # Create an instance of the provider object with settings from the
158 # configuration file.
159 entry
= provider(self
, **settings
)
161 # Add new entry to list (if not already exists).
162 if not entry
in self
.entries
:
163 self
.entries
.append(entry
)
165 def updateone(self
, hostname
, **kwargs
):
166 for entry
in self
.entries
:
167 if not entry
.hostname
== hostname
:
170 return self
._update
(entry
, **kwargs
)
172 raise DDNSHostNotFoundError(hostname
)
174 def updateall(self
, **kwargs
):
176 Update all configured entries.
178 # If there are no entries, there is nothing to do.
180 logger
.debug(_("Found no entries in the configuration file. Exiting."))
183 for entry
in self
.entries
:
184 self
._update
(entry
, **kwargs
)
186 def _update(self
, entry
, force
=False):
191 logger
.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) failed:") % \
192 { "hostname" : entry
.hostname
, "provider" : entry
.name
})
193 logger
.error(" %s: %s" % (e
.__class
__.__name
__, e
.reason
))
195 logger
.error(" %s" % e
.message
)
198 logger
.error(_("Dynamic DNS update for %(hostname)s (%(provider)s) throwed an unhandled exception:") % \
199 { "hostname" : entry
.hostname
, "provider" : entry
.name
}, exc_info
=True)
202 logger
.info(_("Dynamic DNS update for %(hostname)s (%(provider)s) successful") % \
203 { "hostname" : entry
.hostname
, "provider" : entry
.name
})