--- /dev/null
+#!/usr/bin/python
+###############################################################################
+# #
+# ddns - A dynamic DNS client for IPFire #
+# Copyright (C) 2014 IPFire development team #
+# #
+# This program is free software: you can redistribute it and/or modify #
+# it under the terms of the GNU General Public License as published by #
+# the Free Software Foundation, either version 3 of the License, or #
+# (at your option) any later version. #
+# #
+# This program is distributed in the hope that it will be useful, #
+# but WITHOUT ANY WARRANTY; without even the implied warranty of #
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
+# GNU General Public License for more details. #
+# #
+# You should have received a copy of the GNU General Public License #
+# along with this program. If not, see <http://www.gnu.org/licenses/>. #
+# #
+###############################################################################
+
+import datetime
+import os.path
+import sqlite3
+
+# Initialize the logger.
+import logging
+logger = logging.getLogger("ddns.database")
+logger.propagate = 1
+
+class DDNSDatabase(object):
+ def __init__(self, core, path):
+ self.core = core
+
+ # Open the database file
+ self._db = self._open_database(path)
+
+ def __del__(self):
+ self._close_database()
+
+ def _open_database(self, path):
+ logger.debug("Opening database %s" % path)
+
+ exists = os.path.exists(path)
+
+ conn = sqlite3.connect(path, detect_types=sqlite3.PARSE_DECLTYPES|sqlite3.PARSE_COLNAMES)
+ conn.isolation_level = None
+
+ if not exists:
+ logger.debug("Initialising database layout")
+ c = conn.cursor()
+ c.executescript("""
+ CREATE TABLE updates (
+ hostname TEXT NOT NULL,
+ status TEXT NOT NULL,
+ message TEXT,
+ timestamp timestamp NOT NULL
+ );
+
+ CREATE TABLE settings (
+ k TEXT NOT NULL,
+ v TEXT NOT NULL
+ );
+ """)
+ c.execute("INSERT INTO settings(k, v) VALUES(?, ?)", ("version", "1"))
+
+ return conn
+
+ def _close_database(self):
+ if self._db:
+ self._db_close()
+ self._db = None
+
+ def _execute(self, query, *parameters):
+ c = self._db.cursor()
+ try:
+ c.execute(query, parameters)
+ finally:
+ c.close()
+
+ def add_update(self, hostname, status, message=None):
+ self._execute("INSERT INTO updates(hostname, status, message, timestamp) \
+ VALUES(?, ?, ?, ?)", hostname, status, message, datetime.datetime.utcnow())
+
+ def log_success(self, hostname):
+ logger.debug("Logging successful update for %s" % hostname)
+
+ return self.add_update(hostname, "success")
+
+ def log_failure(self, hostname, exception):
+ if exception:
+ message = "%s: %s" % (exception.__class__.__name__, exception.reason)
+ else:
+ message = None
+
+ logger.debug("Logging failed update for %s: %s" % (hostname, message or ""))
+
+ return self.add_update(hostname, "failure", message=message)
+
+ def last_update(self, hostname, status="success"):
+ c = self._db.cursor()
+
+ try:
+ c.execute("SELECT timestamp FROM updates WHERE hostname = ? AND status = ? \
+ ORDER BY timestamp DESC LIMIT 1", (hostname, status))
+
+ for row in c:
+ return row[0]
+ finally:
+ c.close()
# #
###############################################################################
+import datetime
import logging
import subprocess
import urllib2
DEFAULT_SETTINGS = {}
+ # holdoff time - Number of days no update is performed unless
+ # the IP address has changed.
+ holdoff_days = 30
+
# Automatically register all providers.
class __metaclass__(type):
def __init__(provider, name, bases, dict):
def __cmp__(self, other):
return cmp(self.hostname, other.hostname)
+ @property
+ def db(self):
+ return self.core.db
+
def get(self, key, default=None):
"""
Get a setting from the settings dictionary.
if force:
logger.debug(_("Updating %s forced") % self.hostname)
- # Check if we actually need to update this host.
- elif self.is_uptodate(self.protocols):
- logger.debug(_("The dynamic host %(hostname)s (%(provider)s) is already up to date") % \
- { "hostname" : self.hostname, "provider" : self.name })
+ # Do nothing if no update is required
+ elif not self.requires_update:
return
# Execute the update.
- self.update()
+ try:
+ self.update()
+
+ # In case of any errors, log the failed request and
+ # raise the exception.
+ except DDNSError as e:
+ self.core.db.log_failure(self.hostname, e)
+ raise
logger.info(_("Dynamic DNS update for %(hostname)s (%(provider)s) successful") % \
{ "hostname" : self.hostname, "provider" : self.name })
+ self.core.db.log_success(self.hostname)
def update(self):
for protocol in self.protocols:
# Maybe this will raise NotImplementedError at some time
#raise NotImplementedError
- def is_uptodate(self, protos):
+ @property
+ def requires_update(self):
+ # If the IP addresses have changed, an update is required
+ if self.ip_address_changed(self.protocols):
+ logger.debug(_("An update for %(hostname)s (%(provider)s)"
+ " is performed because of an IP address change") % \
+ { "hostname" : self.hostname, "provider" : self.name })
+
+ return True
+
+ # If the holdoff time has expired, an update is required, too
+ if self.holdoff_time_expired():
+ logger.debug(_("An update for %(hostname)s (%(provider)s)"
+ " is performed because the holdoff time has expired") % \
+ { "hostname" : self.hostname, "provider" : self.name })
+
+ return True
+
+ # Otherwise, we don't need to perform an update
+ logger.debug(_("No update required for %(hostname)s (%(provider)s)") % \
+ { "hostname" : self.hostname, "provider" : self.name })
+
+ return False
+
+ def ip_address_changed(self, protos):
"""
Returns True if this host is already up to date
and does not need to change the IP address on the
continue
if not current_address in addresses:
- return False
+ return True
+
+ return False
+
+ def holdoff_time_expired(self):
+ """
+ Returns true if the holdoff time has expired
+ and the host requires an update
+ """
+ # If no holdoff days is defined, we cannot go on
+ if not self.holdoff_days:
+ return False
+
+ # Get the timestamp of the last successfull update
+ last_update = self.db.last_update(self.hostname)
+
+ # If no timestamp has been recorded, no update has been
+ # performed. An update should be performed now.
+ if not last_update:
+ return True
- return True
+ # Determine when the holdoff time ends
+ holdoff_end = last_update + datetime.timedelta(days=self.holdoff_days)
+
+ now = datetime.datetime.utcnow()
+
+ if now >= holdoff_end:
+ logger.debug("The holdoff time has expired for %s" % self.hostname)
+ return True
+ else:
+ logger.debug("Updates for %s are held off until %s" % \
+ (self.hostname, holdoff_end))
+ return False
def send_request(self, *args, **kwargs):
"""
projects / people / ms / ddns.git / commitdiff
