send_request(): Allow passing a dict with data for GET requests.
[oddments/ddns.git] / ddns / providers.py
CommitLineData
f22ab085 1#!/usr/bin/python
3fdcb9d1
MT
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###############################################################################
f22ab085
MT
21
22# Import all possible exception types.
23from .errors import *
24
25class DDNSProvider(object):
26 INFO = {
27 # A short string that uniquely identifies
28 # this provider.
29 "handle" : None,
30
31 # The full name of the provider.
32 "name" : None,
33
34 # A weburl to the homepage of the provider.
35 # (Where to register a new account?)
36 "website" : None,
37
38 # A list of supported protocols.
39 "protocols" : ["ipv6", "ipv4"],
40 }
41
42 DEFAULT_SETTINGS = {}
43
44 def __init__(self, core, **settings):
45 self.core = core
46
47 # Copy a set of default settings and
48 # update them by those from the configuration file.
49 self.settings = self.DEFAULT_SETTINGS.copy()
50 self.settings.update(settings)
51
52 def __repr__(self):
53 return "<DDNS Provider %s (%s)>" % (self.name, self.handle)
54
55 def __cmp__(self, other):
56 return cmp(self.hostname, other.hostname)
57
58 @property
59 def name(self):
60 """
61 Returns the name of the provider.
62 """
63 return self.INFO.get("name")
64
65 @property
66 def website(self):
67 """
68 Returns the website URL of the provider
69 or None if that is not available.
70 """
71 return self.INFO.get("website", None)
72
73 @property
74 def handle(self):
75 """
76 Returns the handle of this provider.
77 """
78 return self.INFO.get("handle")
79
80 def get(self, key, default=None):
81 """
82 Get a setting from the settings dictionary.
83 """
84 return self.settings.get(key, default)
85
86 @property
87 def hostname(self):
88 """
89 Fast access to the hostname.
90 """
91 return self.get("hostname")
92
93 @property
94 def username(self):
95 """
96 Fast access to the username.
97 """
98 return self.get("username")
99
100 @property
101 def password(self):
102 """
103 Fast access to the password.
104 """
105 return self.get("password")
106
107 def __call__(self):
108 raise NotImplementedError
109
110 def send_request(self, *args, **kwargs):
111 """
112 Proxy connection to the send request
113 method.
114 """
115 return self.core.system.send_request(*args, **kwargs)
116
117 def get_address(self, proto):
118 """
119 Proxy method to get the current IP address.
120 """
121 return self.core.system.get_address(proto)
122
123
124class DDNSProviderNOIP(DDNSProvider):
125 INFO = {
126 "handle" : "no-ip.com",
127 "name" : "No-IP",
128 "website" : "http://www.no-ip.com/",
129 "protocols" : ["ipv4",]
130 }
131
132 # Information about the format of the HTTP request is to be found
133 # here: http://www.no-ip.com/integrate/request and
134 # here: http://www.no-ip.com/integrate/response
135
136 url = "http://%(username)s:%(password)s@dynupdate.no-ip.com/nic/update?hostname=%(hostname)s&myip=%(address)s"
137
138 def __call__(self):
139 url = self.url % {
140 "hostname" : self.hostname,
141 "username" : self.username,
142 "password" : self.password,
143 "address" : self.get_address("ipv4"),
144 }
145
146 # Send update to the server.
147 response = self.send_request(url)
148
149 # Get the full response message.
150 output = response.read()
151
152 # Handle success messages.
153 if output.startswith("good") or output.startswith("nochg"):
154 return
155
156 # Handle error codes.
157 if output == "badauth":
158 raise DDNSAuthenticationError
159 elif output == "aduse":
160 raise DDNSAbuseError
161 elif output == "911":
162 raise DDNSInternalServerError
163
164 # If we got here, some other update error happened.
165 raise DDNSUpdateError
166
167
168class DDNSProviderSelfhost(DDNSProvider):
169 INFO = {
170 "handle" : "selfhost.de",
171 "name" : "Selfhost.de",
172 "website" : "http://www.selfhost.de/",
173 "protocols" : ["ipv4",],
174 }
175
176 url = "https://carol.selfhost.de/update?username=%(username)s&password=%(password)s&textmodi=1"
177
178 def __call__(self):
179 url = self.url % { "username" : self.username, "password" : self.password }
180
181 response = self.send_request(url)
182
183 match = re.search("status=20(0|4)", response.read())
184 if not match:
185 raise DDNSUpdateError