Mercurial > hg
annotate hgext/zeroconf/Zeroconf.py @ 28300:15c5f50e7e13
zeroconf: add whitespace around operator
author | timeless <timeless@mozdev.org> |
---|---|
date | Tue, 01 Mar 2016 09:48:11 +0000 |
parents | acea9dd8cf7e |
children | fd8a4d2d6541 |
rev | line source |
---|---|
28296
a73394e7b47c
zeroconf: use absolute_import
timeless <timeless@mozdev.org>
parents:
28295
diff
changeset
|
1 from __future__ import absolute_import, print_function |
28295
01815c159856
zeroconf: use print function
timeless <timeless@mozdev.org>
parents:
28249
diff
changeset
|
2 |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
3 """ Multicast DNS Service Discovery for Python, v0.12 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
4 Copyright (C) 2003, Paul Scott-Murphy |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
5 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
6 This module provides a framework for the use of DNS Service Discovery |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
7 using IP multicast. It has been tested against the JRendezvous |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
8 implementation from <a href="http://strangeberry.com">StrangeBerry</a>, |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
9 and against the mDNSResponder from Mac OS X 10.3.8. |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
10 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
11 This library is free software; you can redistribute it and/or |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
12 modify it under the terms of the GNU Lesser General Public |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
13 License as published by the Free Software Foundation; either |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
14 version 2.1 of the License, or (at your option) any later version. |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
15 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
16 This library is distributed in the hope that it will be useful, |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
17 but WITHOUT ANY WARRANTY; without even the implied warranty of |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
19 Lesser General Public License for more details. |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
20 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
21 You should have received a copy of the GNU Lesser General Public |
15782
7de7630053cb
Remove FSF mailing address from GPL headers
Martin Geisler <mg@aragost.com>
parents:
14494
diff
changeset
|
22 License along with this library; if not, see |
7de7630053cb
Remove FSF mailing address from GPL headers
Martin Geisler <mg@aragost.com>
parents:
14494
diff
changeset
|
23 <http://www.gnu.org/licenses/>. |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
24 |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
25 """ |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
26 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
27 """0.12 update - allow selection of binding interface |
28298 | 28 typo fix - Thanks A. M. Kuchlingi |
29 removed all use of word 'Rendezvous' - this is an API change""" | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
30 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
31 """0.11 update - correction to comments for addListener method |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
32 support for new record types seen from OS X |
28298 | 33 - IPv6 address |
34 - hostinfo | |
35 ignore unknown DNS record types | |
36 fixes to name decoding | |
28299 | 37 works alongside other processes using port 5353 (e.g. Mac OS X) |
28298 | 38 tested against Mac OS X 10.3.2's mDNSResponder |
39 corrections to removal of list entries for service browser""" | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
40 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
41 """0.10 update - Jonathon Paisley contributed these corrections: |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
42 always multicast replies, even when query is unicast |
28298 | 43 correct a pointer encoding problem |
44 can now write records in any order | |
45 traceback shown on failure | |
46 better TXT record parsing | |
47 server is now separate from name | |
48 can cancel a service browser | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
49 |
28298 | 50 modified some unit tests to accommodate these changes""" |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
51 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
52 """0.09 update - remove all records on service unregistration |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
53 fix DOS security problem with readName""" |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
54 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
55 """0.08 update - changed licensing to LGPL""" |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
56 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
57 """0.07 update - faster shutdown on engine |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
58 pointer encoding of outgoing names |
28298 | 59 ServiceBrowser now works |
60 new unit tests""" | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
61 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
62 """0.06 update - small improvements with unit tests |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
63 added defined exception types |
28298 | 64 new style objects |
65 fixed hostname/interface problem | |
66 fixed socket timeout problem | |
67 fixed addServiceListener() typo bug | |
68 using select() for socket reads | |
69 tested on Debian unstable with Python 2.2.2""" | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
70 |
17424
e7cfe3587ea4
fix trivial spelling errors
Mads Kiilerich <mads@kiilerich.com>
parents:
15782
diff
changeset
|
71 """0.05 update - ensure case insensitivity on domain names |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
72 support for unicast DNS queries""" |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
73 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
74 """0.04 update - added some unit tests |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
75 added __ne__ adjuncts where required |
28298 | 76 ensure names end in '.local.' |
77 timeout on receiving socket for clean shutdown""" | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
78 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
79 __author__ = "Paul Scott-Murphy" |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
80 __email__ = "paul at scott dash murphy dot com" |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
81 __version__ = "0.12" |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
82 |
28296
a73394e7b47c
zeroconf: use absolute_import
timeless <timeless@mozdev.org>
parents:
28295
diff
changeset
|
83 import select |
a73394e7b47c
zeroconf: use absolute_import
timeless <timeless@mozdev.org>
parents:
28295
diff
changeset
|
84 import socket |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
85 import string |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
86 import struct |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
87 import threading |
28296
a73394e7b47c
zeroconf: use absolute_import
timeless <timeless@mozdev.org>
parents:
28295
diff
changeset
|
88 import time |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
89 import traceback |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
90 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
91 __all__ = ["Zeroconf", "ServiceInfo", "ServiceBrowser"] |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
92 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
93 # hook for threads |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
94 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
95 globals()['_GLOBAL_DONE'] = 0 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
96 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
97 # Some timing constants |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
98 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
99 _UNREGISTER_TIME = 125 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
100 _CHECK_TIME = 175 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
101 _REGISTER_TIME = 225 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
102 _LISTENER_TIME = 200 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
103 _BROWSER_TIME = 500 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
104 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
105 # Some DNS constants |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
106 |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
107 _MDNS_ADDR = '224.0.0.251' |
28297 | 108 _MDNS_PORT = 5353 |
109 _DNS_PORT = 53 | |
110 _DNS_TTL = 60 * 60 # one hour default TTL | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
111 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
112 _MAX_MSG_TYPICAL = 1460 # unused |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
113 _MAX_MSG_ABSOLUTE = 8972 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
114 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
115 _FLAGS_QR_MASK = 0x8000 # query response mask |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
116 _FLAGS_QR_QUERY = 0x0000 # query |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
117 _FLAGS_QR_RESPONSE = 0x8000 # response |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
118 |
17476 | 119 _FLAGS_AA = 0x0400 # Authoritative answer |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
120 _FLAGS_TC = 0x0200 # Truncated |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
121 _FLAGS_RD = 0x0100 # Recursion desired |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
122 _FLAGS_RA = 0x8000 # Recursion available |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
123 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
124 _FLAGS_Z = 0x0040 # Zero |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
125 _FLAGS_AD = 0x0020 # Authentic data |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
126 _FLAGS_CD = 0x0010 # Checking disabled |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
127 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
128 _CLASS_IN = 1 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
129 _CLASS_CS = 2 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
130 _CLASS_CH = 3 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
131 _CLASS_HS = 4 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
132 _CLASS_NONE = 254 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
133 _CLASS_ANY = 255 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
134 _CLASS_MASK = 0x7FFF |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
135 _CLASS_UNIQUE = 0x8000 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
136 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
137 _TYPE_A = 1 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
138 _TYPE_NS = 2 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
139 _TYPE_MD = 3 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
140 _TYPE_MF = 4 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
141 _TYPE_CNAME = 5 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
142 _TYPE_SOA = 6 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
143 _TYPE_MB = 7 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
144 _TYPE_MG = 8 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
145 _TYPE_MR = 9 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
146 _TYPE_NULL = 10 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
147 _TYPE_WKS = 11 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
148 _TYPE_PTR = 12 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
149 _TYPE_HINFO = 13 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
150 _TYPE_MINFO = 14 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
151 _TYPE_MX = 15 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
152 _TYPE_TXT = 16 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
153 _TYPE_AAAA = 28 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
154 _TYPE_SRV = 33 |
27637
b502138f5faa
cleanup: remove superfluous space after space after equals (python)
timeless <timeless@mozdev.org>
parents:
17537
diff
changeset
|
155 _TYPE_ANY = 255 |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
156 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
157 # Mapping constants to names |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
158 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
159 _CLASSES = { _CLASS_IN : "in", |
28298 | 160 _CLASS_CS : "cs", |
161 _CLASS_CH : "ch", | |
162 _CLASS_HS : "hs", | |
163 _CLASS_NONE : "none", | |
164 _CLASS_ANY : "any" } | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
165 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
166 _TYPES = { _TYPE_A : "a", |
28298 | 167 _TYPE_NS : "ns", |
168 _TYPE_MD : "md", | |
169 _TYPE_MF : "mf", | |
170 _TYPE_CNAME : "cname", | |
171 _TYPE_SOA : "soa", | |
172 _TYPE_MB : "mb", | |
173 _TYPE_MG : "mg", | |
174 _TYPE_MR : "mr", | |
175 _TYPE_NULL : "null", | |
176 _TYPE_WKS : "wks", | |
177 _TYPE_PTR : "ptr", | |
178 _TYPE_HINFO : "hinfo", | |
179 _TYPE_MINFO : "minfo", | |
180 _TYPE_MX : "mx", | |
181 _TYPE_TXT : "txt", | |
182 _TYPE_AAAA : "quada", | |
183 _TYPE_SRV : "srv", | |
184 _TYPE_ANY : "any" } | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
185 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
186 # utility functions |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
187 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
188 def currentTimeMillis(): |
28298 | 189 """Current system time in milliseconds""" |
190 return time.time() * 1000 | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
191 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
192 # Exceptions |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
193 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
194 class NonLocalNameException(Exception): |
28298 | 195 pass |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
196 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
197 class NonUniqueNameException(Exception): |
28298 | 198 pass |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
199 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
200 class NamePartTooLongException(Exception): |
28298 | 201 pass |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
202 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
203 class AbstractMethodException(Exception): |
28298 | 204 pass |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
205 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
206 class BadTypeInNameException(Exception): |
28298 | 207 pass |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
208 |
11435
7c58cde598fe
zeroconf: Use BadDomainName exception instead of string exceptions
Javi Merino <cibervicho@gmail.com>
parents:
10514
diff
changeset
|
209 class BadDomainName(Exception): |
28298 | 210 def __init__(self, pos): |
211 Exception.__init__(self, "at position %s" % pos) | |
11435
7c58cde598fe
zeroconf: Use BadDomainName exception instead of string exceptions
Javi Merino <cibervicho@gmail.com>
parents:
10514
diff
changeset
|
212 |
7c58cde598fe
zeroconf: Use BadDomainName exception instead of string exceptions
Javi Merino <cibervicho@gmail.com>
parents:
10514
diff
changeset
|
213 class BadDomainNameCircular(BadDomainName): |
28298 | 214 pass |
11435
7c58cde598fe
zeroconf: Use BadDomainName exception instead of string exceptions
Javi Merino <cibervicho@gmail.com>
parents:
10514
diff
changeset
|
215 |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
216 # implementation classes |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
217 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
218 class DNSEntry(object): |
28298 | 219 """A DNS entry""" |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
220 |
28298 | 221 def __init__(self, name, type, clazz): |
222 self.key = string.lower(name) | |
223 self.name = name | |
224 self.type = type | |
225 self.clazz = clazz & _CLASS_MASK | |
226 self.unique = (clazz & _CLASS_UNIQUE) != 0 | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
227 |
28298 | 228 def __eq__(self, other): |
229 """Equality test on name, type, and class""" | |
230 if isinstance(other, DNSEntry): | |
28299 | 231 return (self.name == other.name and self.type == other.type and |
232 self.clazz == other.clazz) | |
28298 | 233 return 0 |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
234 |
28298 | 235 def __ne__(self, other): |
236 """Non-equality test""" | |
237 return not self.__eq__(other) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
238 |
28298 | 239 def getClazz(self, clazz): |
240 """Class accessor""" | |
241 try: | |
242 return _CLASSES[clazz] | |
243 except KeyError: | |
244 return "?(%s)" % (clazz) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
245 |
28298 | 246 def getType(self, type): |
247 """Type accessor""" | |
248 try: | |
249 return _TYPES[type] | |
250 except KeyError: | |
251 return "?(%s)" % (type) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
252 |
28298 | 253 def toString(self, hdr, other): |
254 """String representation with additional information""" | |
28299 | 255 result = ("%s[%s,%s" % |
256 (hdr, self.getType(self.type), self.getClazz(self.clazz))) | |
28298 | 257 if self.unique: |
258 result += "-unique," | |
259 else: | |
260 result += "," | |
261 result += self.name | |
262 if other is not None: | |
263 result += ",%s]" % (other) | |
264 else: | |
265 result += "]" | |
266 return result | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
267 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
268 class DNSQuestion(DNSEntry): |
28298 | 269 """A DNS question entry""" |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
270 |
28298 | 271 def __init__(self, name, type, clazz): |
272 if not name.endswith(".local."): | |
273 raise NonLocalNameException(name) | |
274 DNSEntry.__init__(self, name, type, clazz) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
275 |
28298 | 276 def answeredBy(self, rec): |
277 """Returns true if the question is answered by the record""" | |
28299 | 278 return (self.clazz == rec.clazz and |
279 (self.type == rec.type or self.type == _TYPE_ANY) and | |
280 self.name == rec.name) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
281 |
28298 | 282 def __repr__(self): |
283 """String representation""" | |
284 return DNSEntry.toString(self, "question", None) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
285 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
286 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
287 class DNSRecord(DNSEntry): |
28298 | 288 """A DNS record - like a DNS entry, but has a TTL""" |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
289 |
28298 | 290 def __init__(self, name, type, clazz, ttl): |
291 DNSEntry.__init__(self, name, type, clazz) | |
292 self.ttl = ttl | |
293 self.created = currentTimeMillis() | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
294 |
28298 | 295 def __eq__(self, other): |
296 """Tests equality as per DNSRecord""" | |
297 if isinstance(other, DNSRecord): | |
298 return DNSEntry.__eq__(self, other) | |
299 return 0 | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
300 |
28298 | 301 def suppressedBy(self, msg): |
302 """Returns true if any answer in a message can suffice for the | |
303 information held in this record.""" | |
304 for record in msg.answers: | |
305 if self.suppressedByAnswer(record): | |
306 return 1 | |
307 return 0 | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
308 |
28298 | 309 def suppressedByAnswer(self, other): |
310 """Returns true if another record has same name, type and class, | |
311 and if its TTL is at least half of this record's.""" | |
312 if self == other and other.ttl > (self.ttl / 2): | |
313 return 1 | |
314 return 0 | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
315 |
28298 | 316 def getExpirationTime(self, percent): |
317 """Returns the time at which this record will have expired | |
318 by a certain percentage.""" | |
319 return self.created + (percent * self.ttl * 10) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
320 |
28298 | 321 def getRemainingTTL(self, now): |
322 """Returns the remaining TTL in seconds.""" | |
323 return max(0, (self.getExpirationTime(100) - now) / 1000) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
324 |
28298 | 325 def isExpired(self, now): |
326 """Returns true if this record has expired.""" | |
327 return self.getExpirationTime(100) <= now | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
328 |
28298 | 329 def isStale(self, now): |
330 """Returns true if this record is at least half way expired.""" | |
331 return self.getExpirationTime(50) <= now | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
332 |
28298 | 333 def resetTTL(self, other): |
334 """Sets this record's TTL and created time to that of | |
335 another record.""" | |
336 self.created = other.created | |
337 self.ttl = other.ttl | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
338 |
28298 | 339 def write(self, out): |
340 """Abstract method""" | |
341 raise AbstractMethodException | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
342 |
28298 | 343 def toString(self, other): |
344 """String representation with additional information""" | |
28299 | 345 arg = ("%s/%s,%s" % |
346 (self.ttl, self.getRemainingTTL(currentTimeMillis()), other)) | |
28298 | 347 return DNSEntry.toString(self, "record", arg) |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
348 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
349 class DNSAddress(DNSRecord): |
28298 | 350 """A DNS address record""" |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
351 |
28298 | 352 def __init__(self, name, type, clazz, ttl, address): |
353 DNSRecord.__init__(self, name, type, clazz, ttl) | |
354 self.address = address | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
355 |
28298 | 356 def write(self, out): |
357 """Used in constructing an outgoing packet""" | |
358 out.writeString(self.address, len(self.address)) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
359 |
28298 | 360 def __eq__(self, other): |
361 """Tests equality on address""" | |
362 if isinstance(other, DNSAddress): | |
363 return self.address == other.address | |
364 return 0 | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
365 |
28298 | 366 def __repr__(self): |
367 """String representation""" | |
368 try: | |
369 return socket.inet_ntoa(self.address) | |
370 except Exception: | |
371 return self.address | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
372 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
373 class DNSHinfo(DNSRecord): |
28298 | 374 """A DNS host information record""" |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
375 |
28298 | 376 def __init__(self, name, type, clazz, ttl, cpu, os): |
377 DNSRecord.__init__(self, name, type, clazz, ttl) | |
378 self.cpu = cpu | |
379 self.os = os | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
380 |
28298 | 381 def write(self, out): |
382 """Used in constructing an outgoing packet""" | |
383 out.writeString(self.cpu, len(self.cpu)) | |
384 out.writeString(self.os, len(self.os)) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
385 |
28298 | 386 def __eq__(self, other): |
387 """Tests equality on cpu and os""" | |
388 if isinstance(other, DNSHinfo): | |
389 return self.cpu == other.cpu and self.os == other.os | |
390 return 0 | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
391 |
28298 | 392 def __repr__(self): |
393 """String representation""" | |
394 return self.cpu + " " + self.os | |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
395 |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
396 class DNSPointer(DNSRecord): |
28298 | 397 """A DNS pointer record""" |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
398 |
28298 | 399 def __init__(self, name, type, clazz, ttl, alias): |
400 DNSRecord.__init__(self, name, type, clazz, ttl) | |
401 self.alias = alias | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
402 |
28298 | 403 def write(self, out): |
404 """Used in constructing an outgoing packet""" | |
405 out.writeName(self.alias) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
406 |
28298 | 407 def __eq__(self, other): |
408 """Tests equality on alias""" | |
409 if isinstance(other, DNSPointer): | |
410 return self.alias == other.alias | |
411 return 0 | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
412 |
28298 | 413 def __repr__(self): |
414 """String representation""" | |
415 return self.toString(self.alias) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
416 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
417 class DNSText(DNSRecord): |
28298 | 418 """A DNS text record""" |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
419 |
28298 | 420 def __init__(self, name, type, clazz, ttl, text): |
421 DNSRecord.__init__(self, name, type, clazz, ttl) | |
422 self.text = text | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
423 |
28298 | 424 def write(self, out): |
425 """Used in constructing an outgoing packet""" | |
426 out.writeString(self.text, len(self.text)) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
427 |
28298 | 428 def __eq__(self, other): |
429 """Tests equality on text""" | |
430 if isinstance(other, DNSText): | |
431 return self.text == other.text | |
432 return 0 | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
433 |
28298 | 434 def __repr__(self): |
435 """String representation""" | |
436 if len(self.text) > 10: | |
437 return self.toString(self.text[:7] + "...") | |
438 else: | |
439 return self.toString(self.text) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
440 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
441 class DNSService(DNSRecord): |
28298 | 442 """A DNS service record""" |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
443 |
28298 | 444 def __init__(self, name, type, clazz, ttl, priority, weight, port, server): |
445 DNSRecord.__init__(self, name, type, clazz, ttl) | |
446 self.priority = priority | |
447 self.weight = weight | |
448 self.port = port | |
449 self.server = server | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
450 |
28298 | 451 def write(self, out): |
452 """Used in constructing an outgoing packet""" | |
453 out.writeShort(self.priority) | |
454 out.writeShort(self.weight) | |
455 out.writeShort(self.port) | |
456 out.writeName(self.server) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
457 |
28298 | 458 def __eq__(self, other): |
459 """Tests equality on priority, weight, port and server""" | |
460 if isinstance(other, DNSService): | |
28299 | 461 return (self.priority == other.priority and |
462 self.weight == other.weight and | |
463 self.port == other.port and | |
464 self.server == other.server) | |
28298 | 465 return 0 |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
466 |
28298 | 467 def __repr__(self): |
468 """String representation""" | |
469 return self.toString("%s:%s" % (self.server, self.port)) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
470 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
471 class DNSIncoming(object): |
28298 | 472 """Object representation of an incoming DNS packet""" |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
473 |
28298 | 474 def __init__(self, data): |
475 """Constructor from string holding bytes of packet""" | |
476 self.offset = 0 | |
477 self.data = data | |
478 self.questions = [] | |
479 self.answers = [] | |
480 self.numQuestions = 0 | |
481 self.numAnswers = 0 | |
482 self.numAuthorities = 0 | |
483 self.numAdditionals = 0 | |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
484 |
28298 | 485 self.readHeader() |
486 self.readQuestions() | |
487 self.readOthers() | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
488 |
28298 | 489 def readHeader(self): |
490 """Reads header portion of packet""" | |
491 format = '!HHHHHH' | |
492 length = struct.calcsize(format) | |
28300
15c5f50e7e13
zeroconf: add whitespace around operator
timeless <timeless@mozdev.org>
parents:
28299
diff
changeset
|
493 info = struct.unpack(format, |
15c5f50e7e13
zeroconf: add whitespace around operator
timeless <timeless@mozdev.org>
parents:
28299
diff
changeset
|
494 self.data[self.offset:self.offset + length]) |
28298 | 495 self.offset += length |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
496 |
28298 | 497 self.id = info[0] |
498 self.flags = info[1] | |
499 self.numQuestions = info[2] | |
500 self.numAnswers = info[3] | |
501 self.numAuthorities = info[4] | |
502 self.numAdditionals = info[5] | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
503 |
28298 | 504 def readQuestions(self): |
505 """Reads questions section of packet""" | |
506 format = '!HH' | |
507 length = struct.calcsize(format) | |
508 for i in range(0, self.numQuestions): | |
509 name = self.readName() | |
28299 | 510 info = struct.unpack(format, |
28300
15c5f50e7e13
zeroconf: add whitespace around operator
timeless <timeless@mozdev.org>
parents:
28299
diff
changeset
|
511 self.data[self.offset:self.offset + length]) |
28298 | 512 self.offset += length |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
513 |
28298 | 514 try: |
515 question = DNSQuestion(name, info[0], info[1]) | |
516 self.questions.append(question) | |
517 except NonLocalNameException: | |
518 pass | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
519 |
28298 | 520 def readInt(self): |
521 """Reads an integer from the packet""" | |
522 format = '!I' | |
523 length = struct.calcsize(format) | |
28300
15c5f50e7e13
zeroconf: add whitespace around operator
timeless <timeless@mozdev.org>
parents:
28299
diff
changeset
|
524 info = struct.unpack(format, |
15c5f50e7e13
zeroconf: add whitespace around operator
timeless <timeless@mozdev.org>
parents:
28299
diff
changeset
|
525 self.data[self.offset:self.offset + length]) |
28298 | 526 self.offset += length |
527 return info[0] | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
528 |
28298 | 529 def readCharacterString(self): |
530 """Reads a character string from the packet""" | |
531 length = ord(self.data[self.offset]) | |
532 self.offset += 1 | |
533 return self.readString(length) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
534 |
28298 | 535 def readString(self, len): |
536 """Reads a string of a given length from the packet""" | |
537 format = '!' + str(len) + 's' | |
538 length = struct.calcsize(format) | |
28300
15c5f50e7e13
zeroconf: add whitespace around operator
timeless <timeless@mozdev.org>
parents:
28299
diff
changeset
|
539 info = struct.unpack(format, |
15c5f50e7e13
zeroconf: add whitespace around operator
timeless <timeless@mozdev.org>
parents:
28299
diff
changeset
|
540 self.data[self.offset:self.offset + length]) |
28298 | 541 self.offset += length |
542 return info[0] | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
543 |
28298 | 544 def readUnsignedShort(self): |
545 """Reads an unsigned short from the packet""" | |
546 format = '!H' | |
547 length = struct.calcsize(format) | |
28300
15c5f50e7e13
zeroconf: add whitespace around operator
timeless <timeless@mozdev.org>
parents:
28299
diff
changeset
|
548 info = struct.unpack(format, |
15c5f50e7e13
zeroconf: add whitespace around operator
timeless <timeless@mozdev.org>
parents:
28299
diff
changeset
|
549 self.data[self.offset:self.offset + length]) |
28298 | 550 self.offset += length |
551 return info[0] | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
552 |
28298 | 553 def readOthers(self): |
28299 | 554 """Reads answers, authorities and additionals section of the packet""" |
28298 | 555 format = '!HHiH' |
556 length = struct.calcsize(format) | |
557 n = self.numAnswers + self.numAuthorities + self.numAdditionals | |
558 for i in range(0, n): | |
559 domain = self.readName() | |
28299 | 560 info = struct.unpack(format, |
28300
15c5f50e7e13
zeroconf: add whitespace around operator
timeless <timeless@mozdev.org>
parents:
28299
diff
changeset
|
561 self.data[self.offset:self.offset + length]) |
28298 | 562 self.offset += length |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
563 |
28298 | 564 rec = None |
565 if info[0] == _TYPE_A: | |
28299 | 566 rec = DNSAddress(domain, info[0], info[1], info[2], |
567 self.readString(4)) | |
28298 | 568 elif info[0] == _TYPE_CNAME or info[0] == _TYPE_PTR: |
28299 | 569 rec = DNSPointer(domain, info[0], info[1], info[2], |
570 self.readName()) | |
28298 | 571 elif info[0] == _TYPE_TXT: |
28299 | 572 rec = DNSText(domain, info[0], info[1], info[2], |
573 self.readString(info[3])) | |
28298 | 574 elif info[0] == _TYPE_SRV: |
28299 | 575 rec = DNSService(domain, info[0], info[1], info[2], |
576 self.readUnsignedShort(), | |
577 self.readUnsignedShort(), | |
578 self.readUnsignedShort(), | |
579 self.readName()) | |
28298 | 580 elif info[0] == _TYPE_HINFO: |
28299 | 581 rec = DNSHinfo(domain, info[0], info[1], info[2], |
582 self.readCharacterString(), | |
583 self.readCharacterString()) | |
28298 | 584 elif info[0] == _TYPE_AAAA: |
28299 | 585 rec = DNSAddress(domain, info[0], info[1], info[2], |
586 self.readString(16)) | |
28298 | 587 else: |
588 # Try to ignore types we don't know about | |
589 # this may mean the rest of the name is | |
590 # unable to be parsed, and may show errors | |
591 # so this is left for debugging. New types | |
592 # encountered need to be parsed properly. | |
593 # | |
594 #print "UNKNOWN TYPE = " + str(info[0]) | |
595 #raise BadTypeInNameException | |
596 self.offset += info[3] | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
597 |
28298 | 598 if rec is not None: |
599 self.answers.append(rec) | |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
600 |
28298 | 601 def isQuery(self): |
602 """Returns true if this is a query""" | |
603 return (self.flags & _FLAGS_QR_MASK) == _FLAGS_QR_QUERY | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
604 |
28298 | 605 def isResponse(self): |
606 """Returns true if this is a response""" | |
607 return (self.flags & _FLAGS_QR_MASK) == _FLAGS_QR_RESPONSE | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
608 |
28298 | 609 def readUTF(self, offset, len): |
610 """Reads a UTF-8 string of a given length from the packet""" | |
28300
15c5f50e7e13
zeroconf: add whitespace around operator
timeless <timeless@mozdev.org>
parents:
28299
diff
changeset
|
611 return self.data[offset:offset + len].decode('utf-8') |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
612 |
28298 | 613 def readName(self): |
614 """Reads a domain name from the packet""" | |
615 result = '' | |
616 off = self.offset | |
617 next = -1 | |
618 first = off | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
619 |
28298 | 620 while True: |
621 len = ord(self.data[off]) | |
622 off += 1 | |
623 if len == 0: | |
624 break | |
625 t = len & 0xC0 | |
626 if t == 0x00: | |
627 result = ''.join((result, self.readUTF(off, len) + '.')) | |
628 off += len | |
629 elif t == 0xC0: | |
630 if next < 0: | |
631 next = off + 1 | |
632 off = ((len & 0x3F) << 8) | ord(self.data[off]) | |
633 if off >= first: | |
634 raise BadDomainNameCircular(off) | |
635 first = off | |
636 else: | |
637 raise BadDomainName(off) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
638 |
28298 | 639 if next >= 0: |
640 self.offset = next | |
641 else: | |
642 self.offset = off | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
643 |
28298 | 644 return result |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
645 |
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
646 |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
647 class DNSOutgoing(object): |
28298 | 648 """Object representation of an outgoing packet""" |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
649 |
28298 | 650 def __init__(self, flags, multicast = 1): |
651 self.finished = 0 | |
652 self.id = 0 | |
653 self.multicast = multicast | |
654 self.flags = flags | |
655 self.names = {} | |
656 self.data = [] | |
657 self.size = 12 | |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
658 |
28298 | 659 self.questions = [] |
660 self.answers = [] | |
661 self.authorities = [] | |
662 self.additionals = [] | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
663 |
28298 | 664 def addQuestion(self, record): |
665 """Adds a question""" | |
666 self.questions.append(record) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
667 |
28298 | 668 def addAnswer(self, inp, record): |
669 """Adds an answer""" | |
670 if not record.suppressedBy(inp): | |
671 self.addAnswerAtTime(record, 0) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
672 |
28298 | 673 def addAnswerAtTime(self, record, now): |
674 """Adds an answer if if does not expire by a certain time""" | |
675 if record is not None: | |
676 if now == 0 or not record.isExpired(now): | |
677 self.answers.append((record, now)) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
678 |
28298 | 679 def addAuthoritativeAnswer(self, record): |
680 """Adds an authoritative answer""" | |
681 self.authorities.append(record) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
682 |
28298 | 683 def addAdditionalAnswer(self, record): |
684 """Adds an additional answer""" | |
685 self.additionals.append(record) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
686 |
28298 | 687 def writeByte(self, value): |
688 """Writes a single byte to the packet""" | |
689 format = '!c' | |
690 self.data.append(struct.pack(format, chr(value))) | |
691 self.size += 1 | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
692 |
28298 | 693 def insertShort(self, index, value): |
694 """Inserts an unsigned short in a certain position in the packet""" | |
695 format = '!H' | |
696 self.data.insert(index, struct.pack(format, value)) | |
697 self.size += 2 | |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
698 |
28298 | 699 def writeShort(self, value): |
700 """Writes an unsigned short to the packet""" | |
701 format = '!H' | |
702 self.data.append(struct.pack(format, value)) | |
703 self.size += 2 | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
704 |
28298 | 705 def writeInt(self, value): |
706 """Writes an unsigned integer to the packet""" | |
707 format = '!I' | |
708 self.data.append(struct.pack(format, int(value))) | |
709 self.size += 4 | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
710 |
28298 | 711 def writeString(self, value, length): |
712 """Writes a string to the packet""" | |
713 format = '!' + str(length) + 's' | |
714 self.data.append(struct.pack(format, value)) | |
715 self.size += length | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
716 |
28298 | 717 def writeUTF(self, s): |
718 """Writes a UTF-8 string of a given length to the packet""" | |
719 utfstr = s.encode('utf-8') | |
720 length = len(utfstr) | |
721 if length > 64: | |
722 raise NamePartTooLongException | |
723 self.writeByte(length) | |
724 self.writeString(utfstr, length) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
725 |
28298 | 726 def writeName(self, name): |
727 """Writes a domain name to the packet""" | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
728 |
28298 | 729 try: |
730 # Find existing instance of this name in packet | |
731 # | |
732 index = self.names[name] | |
733 except KeyError: | |
734 # No record of this name already, so write it | |
735 # out as normal, recording the location of the name | |
736 # for future pointers to it. | |
737 # | |
738 self.names[name] = self.size | |
739 parts = name.split('.') | |
740 if parts[-1] == '': | |
741 parts = parts[:-1] | |
742 for part in parts: | |
743 self.writeUTF(part) | |
744 self.writeByte(0) | |
745 return | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
746 |
28298 | 747 # An index was found, so write a pointer to it |
748 # | |
749 self.writeByte((index >> 8) | 0xC0) | |
750 self.writeByte(index) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
751 |
28298 | 752 def writeQuestion(self, question): |
753 """Writes a question to the packet""" | |
754 self.writeName(question.name) | |
755 self.writeShort(question.type) | |
756 self.writeShort(question.clazz) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
757 |
28298 | 758 def writeRecord(self, record, now): |
759 """Writes a record (answer, authoritative answer, additional) to | |
760 the packet""" | |
761 self.writeName(record.name) | |
762 self.writeShort(record.type) | |
763 if record.unique and self.multicast: | |
764 self.writeShort(record.clazz | _CLASS_UNIQUE) | |
765 else: | |
766 self.writeShort(record.clazz) | |
767 if now == 0: | |
768 self.writeInt(record.ttl) | |
769 else: | |
770 self.writeInt(record.getRemainingTTL(now)) | |
771 index = len(self.data) | |
772 # Adjust size for the short we will write before this record | |
773 # | |
774 self.size += 2 | |
775 record.write(self) | |
776 self.size -= 2 | |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
777 |
28298 | 778 length = len(''.join(self.data[index:])) |
779 self.insertShort(index, length) # Here is the short we adjusted for | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
780 |
28298 | 781 def packet(self): |
782 """Returns a string containing the packet's bytes | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
783 |
28298 | 784 No further parts should be added to the packet once this |
785 is done.""" | |
786 if not self.finished: | |
787 self.finished = 1 | |
788 for question in self.questions: | |
789 self.writeQuestion(question) | |
790 for answer, time_ in self.answers: | |
791 self.writeRecord(answer, time_) | |
792 for authority in self.authorities: | |
793 self.writeRecord(authority, 0) | |
794 for additional in self.additionals: | |
795 self.writeRecord(additional, 0) | |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
796 |
28298 | 797 self.insertShort(0, len(self.additionals)) |
798 self.insertShort(0, len(self.authorities)) | |
799 self.insertShort(0, len(self.answers)) | |
800 self.insertShort(0, len(self.questions)) | |
801 self.insertShort(0, self.flags) | |
802 if self.multicast: | |
803 self.insertShort(0, 0) | |
804 else: | |
805 self.insertShort(0, self.id) | |
806 return ''.join(self.data) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
807 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
808 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
809 class DNSCache(object): |
28298 | 810 """A cache of DNS entries""" |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
811 |
28298 | 812 def __init__(self): |
813 self.cache = {} | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
814 |
28298 | 815 def add(self, entry): |
816 """Adds an entry""" | |
817 try: | |
818 list = self.cache[entry.key] | |
819 except KeyError: | |
820 list = self.cache[entry.key] = [] | |
821 list.append(entry) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
822 |
28298 | 823 def remove(self, entry): |
824 """Removes an entry""" | |
825 try: | |
826 list = self.cache[entry.key] | |
827 list.remove(entry) | |
828 except KeyError: | |
829 pass | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
830 |
28298 | 831 def get(self, entry): |
832 """Gets an entry by key. Will return None if there is no | |
833 matching entry.""" | |
834 try: | |
835 list = self.cache[entry.key] | |
836 return list[list.index(entry)] | |
837 except (KeyError, ValueError): | |
838 return None | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
839 |
28298 | 840 def getByDetails(self, name, type, clazz): |
841 """Gets an entry by details. Will return None if there is | |
842 no matching entry.""" | |
843 entry = DNSEntry(name, type, clazz) | |
844 return self.get(entry) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
845 |
28298 | 846 def entriesWithName(self, name): |
847 """Returns a list of entries whose key matches the name.""" | |
848 try: | |
849 return self.cache[name] | |
850 except KeyError: | |
851 return [] | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
852 |
28298 | 853 def entries(self): |
854 """Returns a list of all entries""" | |
28300
15c5f50e7e13
zeroconf: add whitespace around operator
timeless <timeless@mozdev.org>
parents:
28299
diff
changeset
|
855 def add(x, y): return x + y |
28298 | 856 try: |
857 return reduce(add, self.cache.values()) | |
858 except Exception: | |
859 return [] | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
860 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
861 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
862 class Engine(threading.Thread): |
28298 | 863 """An engine wraps read access to sockets, allowing objects that |
864 need to receive data from sockets to be called back when the | |
865 sockets are ready. | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
866 |
28298 | 867 A reader needs a handle_read() method, which is called when the socket |
868 it is interested in is ready for reading. | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
869 |
28298 | 870 Writers are not implemented here, because we only send short |
871 packets. | |
872 """ | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
873 |
28298 | 874 def __init__(self, zeroconf): |
875 threading.Thread.__init__(self) | |
876 self.zeroconf = zeroconf | |
877 self.readers = {} # maps socket to reader | |
878 self.timeout = 5 | |
879 self.condition = threading.Condition() | |
880 self.start() | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
881 |
28298 | 882 def run(self): |
883 while not globals()['_GLOBAL_DONE']: | |
884 rs = self.getReaders() | |
885 if len(rs) == 0: | |
886 # No sockets to manage, but we wait for the timeout | |
887 # or addition of a socket | |
888 # | |
889 self.condition.acquire() | |
890 self.condition.wait(self.timeout) | |
891 self.condition.release() | |
892 else: | |
893 try: | |
894 rr, wr, er = select.select(rs, [], [], self.timeout) | |
895 for sock in rr: | |
896 try: | |
897 self.readers[sock].handle_read() | |
898 except Exception: | |
899 if not globals()['_GLOBAL_DONE']: | |
900 traceback.print_exc() | |
901 except Exception: | |
902 pass | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
903 |
28298 | 904 def getReaders(self): |
905 self.condition.acquire() | |
906 result = self.readers.keys() | |
907 self.condition.release() | |
908 return result | |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
909 |
28298 | 910 def addReader(self, reader, socket): |
911 self.condition.acquire() | |
912 self.readers[socket] = reader | |
913 self.condition.notify() | |
914 self.condition.release() | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
915 |
28298 | 916 def delReader(self, socket): |
917 self.condition.acquire() | |
918 del(self.readers[socket]) | |
919 self.condition.notify() | |
920 self.condition.release() | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
921 |
28298 | 922 def notify(self): |
923 self.condition.acquire() | |
924 self.condition.notify() | |
925 self.condition.release() | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
926 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
927 class Listener(object): |
28298 | 928 """A Listener is used by this module to listen on the multicast |
929 group to which DNS messages are sent, allowing the implementation | |
930 to cache information as it arrives. | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
931 |
28298 | 932 It requires registration with an Engine object in order to have |
933 the read() method called when a socket is available for reading.""" | |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
934 |
28298 | 935 def __init__(self, zeroconf): |
936 self.zeroconf = zeroconf | |
937 self.zeroconf.engine.addReader(self, self.zeroconf.socket) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
938 |
28298 | 939 def handle_read(self): |
940 data, (addr, port) = self.zeroconf.socket.recvfrom(_MAX_MSG_ABSOLUTE) | |
941 self.data = data | |
942 msg = DNSIncoming(data) | |
943 if msg.isQuery(): | |
944 # Always multicast responses | |
945 # | |
946 if port == _MDNS_PORT: | |
947 self.zeroconf.handleQuery(msg, _MDNS_ADDR, _MDNS_PORT) | |
948 # If it's not a multicast query, reply via unicast | |
949 # and multicast | |
950 # | |
951 elif port == _DNS_PORT: | |
952 self.zeroconf.handleQuery(msg, addr, port) | |
953 self.zeroconf.handleQuery(msg, _MDNS_ADDR, _MDNS_PORT) | |
954 else: | |
955 self.zeroconf.handleResponse(msg) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
956 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
957 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
958 class Reaper(threading.Thread): |
28298 | 959 """A Reaper is used by this module to remove cache entries that |
960 have expired.""" | |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
961 |
28298 | 962 def __init__(self, zeroconf): |
963 threading.Thread.__init__(self) | |
964 self.zeroconf = zeroconf | |
965 self.start() | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
966 |
28298 | 967 def run(self): |
968 while True: | |
969 self.zeroconf.wait(10 * 1000) | |
970 if globals()['_GLOBAL_DONE']: | |
971 return | |
972 now = currentTimeMillis() | |
973 for record in self.zeroconf.cache.entries(): | |
974 if record.isExpired(now): | |
975 self.zeroconf.updateRecord(now, record) | |
976 self.zeroconf.cache.remove(record) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
977 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
978 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
979 class ServiceBrowser(threading.Thread): |
28298 | 980 """Used to browse for a service of a specific type. |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
981 |
28298 | 982 The listener object will have its addService() and |
983 removeService() methods called when this browser | |
984 discovers changes in the services availability.""" | |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
985 |
28298 | 986 def __init__(self, zeroconf, type, listener): |
987 """Creates a browser for a specific type""" | |
988 threading.Thread.__init__(self) | |
989 self.zeroconf = zeroconf | |
990 self.type = type | |
991 self.listener = listener | |
992 self.services = {} | |
993 self.nextTime = currentTimeMillis() | |
994 self.delay = _BROWSER_TIME | |
995 self.list = [] | |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
996 |
28298 | 997 self.done = 0 |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
998 |
28299 | 999 self.zeroconf.addListener(self, DNSQuestion(self.type, _TYPE_PTR, |
1000 _CLASS_IN)) | |
28298 | 1001 self.start() |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1002 |
28298 | 1003 def updateRecord(self, zeroconf, now, record): |
1004 """Callback invoked by Zeroconf when new information arrives. | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1005 |
28298 | 1006 Updates information required by browser in the Zeroconf cache.""" |
1007 if record.type == _TYPE_PTR and record.name == self.type: | |
1008 expired = record.isExpired(now) | |
1009 try: | |
1010 oldrecord = self.services[record.alias.lower()] | |
1011 if not expired: | |
1012 oldrecord.resetTTL(record) | |
1013 else: | |
1014 del(self.services[record.alias.lower()]) | |
28299 | 1015 callback = (lambda x: |
1016 self.listener.removeService(x, self.type, record.alias)) | |
28298 | 1017 self.list.append(callback) |
1018 return | |
1019 except Exception: | |
1020 if not expired: | |
1021 self.services[record.alias.lower()] = record | |
28299 | 1022 callback = (lambda x: |
1023 self.listener.addService(x, self.type, record.alias)) | |
28298 | 1024 self.list.append(callback) |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1025 |
28298 | 1026 expires = record.getExpirationTime(75) |
1027 if expires < self.nextTime: | |
1028 self.nextTime = expires | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1029 |
28298 | 1030 def cancel(self): |
1031 self.done = 1 | |
1032 self.zeroconf.notifyAll() | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1033 |
28298 | 1034 def run(self): |
1035 while True: | |
1036 event = None | |
1037 now = currentTimeMillis() | |
1038 if len(self.list) == 0 and self.nextTime > now: | |
1039 self.zeroconf.wait(self.nextTime - now) | |
1040 if globals()['_GLOBAL_DONE'] or self.done: | |
1041 return | |
1042 now = currentTimeMillis() | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1043 |
28298 | 1044 if self.nextTime <= now: |
1045 out = DNSOutgoing(_FLAGS_QR_QUERY) | |
1046 out.addQuestion(DNSQuestion(self.type, _TYPE_PTR, _CLASS_IN)) | |
1047 for record in self.services.values(): | |
1048 if not record.isExpired(now): | |
1049 out.addAnswerAtTime(record, now) | |
1050 self.zeroconf.send(out) | |
1051 self.nextTime = now + self.delay | |
1052 self.delay = min(20 * 1000, self.delay * 2) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1053 |
28298 | 1054 if len(self.list) > 0: |
1055 event = self.list.pop(0) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1056 |
28298 | 1057 if event is not None: |
1058 event(self.zeroconf) | |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
1059 |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1060 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1061 class ServiceInfo(object): |
28298 | 1062 """Service information""" |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
1063 |
28299 | 1064 def __init__(self, type, name, address=None, port=None, weight=0, |
1065 priority=0, properties=None, server=None): | |
28298 | 1066 """Create a service description. |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1067 |
28298 | 1068 type: fully qualified service type name |
1069 name: fully qualified service name | |
1070 address: IP address as unsigned short, network byte order | |
1071 port: port that the service runs on | |
1072 weight: weight of the service | |
1073 priority: priority of the service | |
28299 | 1074 properties: dictionary of properties (or a string holding the bytes for |
1075 the text field) | |
28298 | 1076 server: fully qualified name for service host (defaults to name)""" |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1077 |
28298 | 1078 if not name.endswith(type): |
1079 raise BadTypeInNameException | |
1080 self.type = type | |
1081 self.name = name | |
1082 self.address = address | |
1083 self.port = port | |
1084 self.weight = weight | |
1085 self.priority = priority | |
1086 if server: | |
1087 self.server = server | |
1088 else: | |
1089 self.server = name | |
1090 self.setProperties(properties) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1091 |
28298 | 1092 def setProperties(self, properties): |
1093 """Sets properties and text of this info from a dictionary""" | |
1094 if isinstance(properties, dict): | |
1095 self.properties = properties | |
1096 list = [] | |
1097 result = '' | |
1098 for key in properties: | |
1099 value = properties[key] | |
1100 if value is None: | |
1101 suffix = '' | |
1102 elif isinstance(value, str): | |
1103 suffix = value | |
1104 elif isinstance(value, int): | |
1105 if value: | |
1106 suffix = 'true' | |
1107 else: | |
1108 suffix = 'false' | |
1109 else: | |
1110 suffix = '' | |
1111 list.append('='.join((key, suffix))) | |
1112 for item in list: | |
28299 | 1113 result = ''.join((result, struct.pack('!c', chr(len(item))), |
1114 item)) | |
28298 | 1115 self.text = result |
1116 else: | |
1117 self.text = properties | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1118 |
28298 | 1119 def setText(self, text): |
1120 """Sets properties and text given a text field""" | |
1121 self.text = text | |
1122 try: | |
1123 result = {} | |
1124 end = len(text) | |
1125 index = 0 | |
1126 strs = [] | |
1127 while index < end: | |
1128 length = ord(text[index]) | |
1129 index += 1 | |
28300
15c5f50e7e13
zeroconf: add whitespace around operator
timeless <timeless@mozdev.org>
parents:
28299
diff
changeset
|
1130 strs.append(text[index:index + length]) |
28298 | 1131 index += length |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
1132 |
28298 | 1133 for s in strs: |
1134 eindex = s.find('=') | |
1135 if eindex == -1: | |
1136 # No equals sign at all | |
1137 key = s | |
1138 value = 0 | |
1139 else: | |
1140 key = s[:eindex] | |
28300
15c5f50e7e13
zeroconf: add whitespace around operator
timeless <timeless@mozdev.org>
parents:
28299
diff
changeset
|
1141 value = s[eindex + 1:] |
28298 | 1142 if value == 'true': |
1143 value = 1 | |
1144 elif value == 'false' or not value: | |
1145 value = 0 | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1146 |
28298 | 1147 # Only update non-existent properties |
1148 if key and result.get(key) == None: | |
1149 result[key] = value | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1150 |
28298 | 1151 self.properties = result |
1152 except Exception: | |
1153 traceback.print_exc() | |
1154 self.properties = None | |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
1155 |
28298 | 1156 def getType(self): |
1157 """Type accessor""" | |
1158 return self.type | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1159 |
28298 | 1160 def getName(self): |
1161 """Name accessor""" | |
1162 if self.type is not None and self.name.endswith("." + self.type): | |
1163 return self.name[:len(self.name) - len(self.type) - 1] | |
1164 return self.name | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1165 |
28298 | 1166 def getAddress(self): |
1167 """Address accessor""" | |
1168 return self.address | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1169 |
28298 | 1170 def getPort(self): |
1171 """Port accessor""" | |
1172 return self.port | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1173 |
28298 | 1174 def getPriority(self): |
1175 """Priority accessor""" | |
1176 return self.priority | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1177 |
28298 | 1178 def getWeight(self): |
1179 """Weight accessor""" | |
1180 return self.weight | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1181 |
28298 | 1182 def getProperties(self): |
1183 """Properties accessor""" | |
1184 return self.properties | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1185 |
28298 | 1186 def getText(self): |
1187 """Text accessor""" | |
1188 return self.text | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1189 |
28298 | 1190 def getServer(self): |
1191 """Server accessor""" | |
1192 return self.server | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1193 |
28298 | 1194 def updateRecord(self, zeroconf, now, record): |
1195 """Updates service information from a DNS record""" | |
1196 if record is not None and not record.isExpired(now): | |
1197 if record.type == _TYPE_A: | |
1198 #if record.name == self.name: | |
1199 if record.name == self.server: | |
1200 self.address = record.address | |
1201 elif record.type == _TYPE_SRV: | |
1202 if record.name == self.name: | |
1203 self.server = record.server | |
1204 self.port = record.port | |
1205 self.weight = record.weight | |
1206 self.priority = record.priority | |
1207 #self.address = None | |
28299 | 1208 self.updateRecord(zeroconf, now, |
1209 zeroconf.cache.getByDetails(self.server, | |
1210 _TYPE_A, _CLASS_IN)) | |
28298 | 1211 elif record.type == _TYPE_TXT: |
1212 if record.name == self.name: | |
1213 self.setText(record.text) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1214 |
28298 | 1215 def request(self, zeroconf, timeout): |
1216 """Returns true if the service could be discovered on the | |
1217 network, and updates this object with details discovered. | |
1218 """ | |
1219 now = currentTimeMillis() | |
1220 delay = _LISTENER_TIME | |
1221 next = now + delay | |
1222 last = now + timeout | |
1223 result = 0 | |
1224 try: | |
28299 | 1225 zeroconf.addListener(self, DNSQuestion(self.name, _TYPE_ANY, |
1226 _CLASS_IN)) | |
1227 while (self.server is None or self.address is None or | |
1228 self.text is None): | |
28298 | 1229 if last <= now: |
1230 return 0 | |
1231 if next <= now: | |
1232 out = DNSOutgoing(_FLAGS_QR_QUERY) | |
28299 | 1233 out.addQuestion(DNSQuestion(self.name, _TYPE_SRV, |
1234 _CLASS_IN)) | |
1235 out.addAnswerAtTime( | |
1236 zeroconf.cache.getByDetails(self.name, | |
1237 _TYPE_SRV, | |
1238 _CLASS_IN), | |
1239 now) | |
1240 out.addQuestion(DNSQuestion(self.name, _TYPE_TXT, | |
1241 _CLASS_IN)) | |
1242 out.addAnswerAtTime( | |
1243 zeroconf.cache.getByDetails(self.name, _TYPE_TXT, | |
1244 _CLASS_IN), | |
1245 now) | |
28298 | 1246 if self.server is not None: |
28299 | 1247 out.addQuestion( |
1248 DNSQuestion(self.server, _TYPE_A, _CLASS_IN)) | |
1249 out.addAnswerAtTime( | |
1250 zeroconf.cache.getByDetails(self.server, _TYPE_A, | |
1251 _CLASS_IN), | |
1252 now) | |
28298 | 1253 zeroconf.send(out) |
1254 next = now + delay | |
1255 delay = delay * 2 | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1256 |
28298 | 1257 zeroconf.wait(min(next, last) - now) |
1258 now = currentTimeMillis() | |
1259 result = 1 | |
1260 finally: | |
1261 zeroconf.removeListener(self) | |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
1262 |
28298 | 1263 return result |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1264 |
28298 | 1265 def __eq__(self, other): |
1266 """Tests equality of service name""" | |
1267 if isinstance(other, ServiceInfo): | |
1268 return other.name == self.name | |
1269 return 0 | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1270 |
28298 | 1271 def __ne__(self, other): |
1272 """Non-equality test""" | |
1273 return not self.__eq__(other) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1274 |
28298 | 1275 def __repr__(self): |
1276 """String representation""" | |
28299 | 1277 result = ("service[%s,%s:%s," % |
1278 (self.name, socket.inet_ntoa(self.getAddress()), self.port)) | |
28298 | 1279 if self.text is None: |
1280 result += "None" | |
1281 else: | |
1282 if len(self.text) < 20: | |
1283 result += self.text | |
1284 else: | |
1285 result += self.text[:17] + "..." | |
1286 result += "]" | |
1287 return result | |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
1288 |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1289 |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1290 class Zeroconf(object): |
28298 | 1291 """Implementation of Zeroconf Multicast DNS Service Discovery |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1292 |
28298 | 1293 Supports registration, unregistration, queries and browsing. |
1294 """ | |
1295 def __init__(self, bindaddress=None): | |
1296 """Creates an instance of the Zeroconf class, establishing | |
1297 multicast communications, listening and reaping threads.""" | |
1298 globals()['_GLOBAL_DONE'] = 0 | |
1299 if bindaddress is None: | |
1300 self.intf = socket.gethostbyname(socket.gethostname()) | |
1301 else: | |
1302 self.intf = bindaddress | |
1303 self.group = ('', _MDNS_PORT) | |
1304 self.socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) | |
1305 try: | |
1306 self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) | |
1307 self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1) | |
1308 except Exception: | |
1309 # SO_REUSEADDR should be equivalent to SO_REUSEPORT for | |
1310 # multicast UDP sockets (p 731, "TCP/IP Illustrated, | |
1311 # Volume 2"), but some BSD-derived systems require | |
1312 # SO_REUSEPORT to be specified explicitly. Also, not all | |
1313 # versions of Python have SO_REUSEPORT available. So | |
1314 # if you're on a BSD-based system, and haven't upgraded | |
1315 # to Python 2.3 yet, you may find this library doesn't | |
1316 # work as expected. | |
1317 # | |
1318 pass | |
1319 self.socket.setsockopt(socket.SOL_IP, socket.IP_MULTICAST_TTL, "\xff") | |
1320 self.socket.setsockopt(socket.SOL_IP, socket.IP_MULTICAST_LOOP, "\x01") | |
1321 try: | |
1322 self.socket.bind(self.group) | |
1323 except Exception: | |
1324 # Some versions of linux raise an exception even though | |
1325 # SO_REUSEADDR and SO_REUSEPORT have been set, so ignore it | |
1326 pass | |
28299 | 1327 self.socket.setsockopt(socket.SOL_IP, socket.IP_ADD_MEMBERSHIP, |
1328 socket.inet_aton(_MDNS_ADDR) + socket.inet_aton('0.0.0.0')) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1329 |
28298 | 1330 self.listeners = [] |
1331 self.browsers = [] | |
1332 self.services = {} | |
1333 self.servicetypes = {} | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1334 |
28298 | 1335 self.cache = DNSCache() |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1336 |
28298 | 1337 self.condition = threading.Condition() |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
1338 |
28298 | 1339 self.engine = Engine(self) |
1340 self.listener = Listener(self) | |
1341 self.reaper = Reaper(self) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1342 |
28298 | 1343 def isLoopback(self): |
1344 return self.intf.startswith("127.0.0.1") | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1345 |
28298 | 1346 def isLinklocal(self): |
1347 return self.intf.startswith("169.254.") | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1348 |
28298 | 1349 def wait(self, timeout): |
1350 """Calling thread waits for a given number of milliseconds or | |
1351 until notified.""" | |
1352 self.condition.acquire() | |
28300
15c5f50e7e13
zeroconf: add whitespace around operator
timeless <timeless@mozdev.org>
parents:
28299
diff
changeset
|
1353 self.condition.wait(timeout / 1000) |
28298 | 1354 self.condition.release() |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1355 |
28298 | 1356 def notifyAll(self): |
1357 """Notifies all waiting threads""" | |
1358 self.condition.acquire() | |
1359 self.condition.notifyAll() | |
1360 self.condition.release() | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1361 |
28298 | 1362 def getServiceInfo(self, type, name, timeout=3000): |
1363 """Returns network's service information for a particular | |
1364 name and type, or None if no service matches by the timeout, | |
1365 which defaults to 3 seconds.""" | |
1366 info = ServiceInfo(type, name) | |
1367 if info.request(self, timeout): | |
1368 return info | |
1369 return None | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1370 |
28298 | 1371 def addServiceListener(self, type, listener): |
1372 """Adds a listener for a particular service type. This object | |
1373 will then have its updateRecord method called when information | |
1374 arrives for that type.""" | |
1375 self.removeServiceListener(listener) | |
1376 self.browsers.append(ServiceBrowser(self, type, listener)) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1377 |
28298 | 1378 def removeServiceListener(self, listener): |
1379 """Removes a listener from the set that is currently listening.""" | |
1380 for browser in self.browsers: | |
1381 if browser.listener == listener: | |
1382 browser.cancel() | |
1383 del(browser) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1384 |
28298 | 1385 def registerService(self, info, ttl=_DNS_TTL): |
1386 """Registers service information to the network with a default TTL | |
1387 of 60 seconds. Zeroconf will then respond to requests for | |
1388 information for that service. The name of the service may be | |
1389 changed if needed to make it unique on the network.""" | |
1390 self.checkService(info) | |
1391 self.services[info.name.lower()] = info | |
1392 if self.servicetypes.has_key(info.type): | |
28300
15c5f50e7e13
zeroconf: add whitespace around operator
timeless <timeless@mozdev.org>
parents:
28299
diff
changeset
|
1393 self.servicetypes[info.type] += 1 |
28298 | 1394 else: |
28300
15c5f50e7e13
zeroconf: add whitespace around operator
timeless <timeless@mozdev.org>
parents:
28299
diff
changeset
|
1395 self.servicetypes[info.type] = 1 |
28298 | 1396 now = currentTimeMillis() |
1397 nextTime = now | |
1398 i = 0 | |
1399 while i < 3: | |
1400 if now < nextTime: | |
1401 self.wait(nextTime - now) | |
1402 now = currentTimeMillis() | |
1403 continue | |
1404 out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA) | |
28299 | 1405 out.addAnswerAtTime(DNSPointer(info.type, _TYPE_PTR, |
1406 _CLASS_IN, ttl, info.name), 0) | |
1407 out.addAnswerAtTime( | |
1408 DNSService( | |
1409 info.name, _TYPE_SRV, | |
1410 _CLASS_IN, ttl, info.priority, info.weight, info.port, | |
1411 info.server), | |
1412 0) | |
1413 out.addAnswerAtTime( | |
1414 DNSText(info.name, _TYPE_TXT, _CLASS_IN, ttl, info.text), | |
1415 0) | |
28298 | 1416 if info.address: |
28299 | 1417 out.addAnswerAtTime(DNSAddress(info.server, _TYPE_A, |
1418 _CLASS_IN, ttl, info.address), 0) | |
28298 | 1419 self.send(out) |
1420 i += 1 | |
1421 nextTime += _REGISTER_TIME | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1422 |
28298 | 1423 def unregisterService(self, info): |
1424 """Unregister a service.""" | |
1425 try: | |
1426 del(self.services[info.name.lower()]) | |
28300
15c5f50e7e13
zeroconf: add whitespace around operator
timeless <timeless@mozdev.org>
parents:
28299
diff
changeset
|
1427 if self.servicetypes[info.type] > 1: |
15c5f50e7e13
zeroconf: add whitespace around operator
timeless <timeless@mozdev.org>
parents:
28299
diff
changeset
|
1428 self.servicetypes[info.type] -= 1 |
28298 | 1429 else: |
1430 del self.servicetypes[info.type] | |
1431 except KeyError: | |
1432 pass | |
1433 now = currentTimeMillis() | |
1434 nextTime = now | |
1435 i = 0 | |
1436 while i < 3: | |
1437 if now < nextTime: | |
1438 self.wait(nextTime - now) | |
1439 now = currentTimeMillis() | |
1440 continue | |
1441 out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA) | |
28299 | 1442 out.addAnswerAtTime( |
1443 DNSPointer(info.type, _TYPE_PTR, _CLASS_IN, 0, info.name), 0) | |
1444 out.addAnswerAtTime( | |
1445 DNSService(info.name, _TYPE_SRV, | |
1446 _CLASS_IN, 0, info.priority, info.weight, info.port, | |
1447 info.name), | |
1448 0) | |
1449 out.addAnswerAtTime(DNSText(info.name, _TYPE_TXT, | |
1450 _CLASS_IN, 0, info.text), 0) | |
28298 | 1451 if info.address: |
28299 | 1452 out.addAnswerAtTime(DNSAddress(info.server, _TYPE_A, |
1453 _CLASS_IN, 0, info.address), 0) | |
28298 | 1454 self.send(out) |
1455 i += 1 | |
1456 nextTime += _UNREGISTER_TIME | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1457 |
28298 | 1458 def unregisterAllServices(self): |
1459 """Unregister all registered services.""" | |
1460 if len(self.services) > 0: | |
1461 now = currentTimeMillis() | |
1462 nextTime = now | |
1463 i = 0 | |
1464 while i < 3: | |
1465 if now < nextTime: | |
1466 self.wait(nextTime - now) | |
1467 now = currentTimeMillis() | |
1468 continue | |
1469 out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA) | |
1470 for info in self.services.values(): | |
28299 | 1471 out.addAnswerAtTime(DNSPointer(info.type, _TYPE_PTR, |
1472 _CLASS_IN, 0, info.name), 0) | |
1473 out.addAnswerAtTime( | |
1474 DNSService(info.name, _TYPE_SRV, | |
1475 _CLASS_IN, 0, info.priority, info.weight, | |
1476 info.port, info.server), | |
1477 0) | |
1478 out.addAnswerAtTime(DNSText(info.name, _TYPE_TXT, | |
1479 _CLASS_IN, 0, info.text), 0) | |
28298 | 1480 if info.address: |
28299 | 1481 out.addAnswerAtTime(DNSAddress(info.server, _TYPE_A, |
1482 _CLASS_IN, 0, info.address), 0) | |
28298 | 1483 self.send(out) |
1484 i += 1 | |
1485 nextTime += _UNREGISTER_TIME | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1486 |
28298 | 1487 def checkService(self, info): |
1488 """Checks the network for a unique service name, modifying the | |
1489 ServiceInfo passed in if it is not unique.""" | |
1490 now = currentTimeMillis() | |
1491 nextTime = now | |
1492 i = 0 | |
1493 while i < 3: | |
1494 for record in self.cache.entriesWithName(info.type): | |
28299 | 1495 if (record.type == _TYPE_PTR and not record.isExpired(now) and |
1496 record.alias == info.name): | |
28298 | 1497 if (info.name.find('.') < 0): |
28299 | 1498 info.name = ("%w.[%s:%d].%s" % |
1499 (info.name, info.address, info.port, info.type)) | |
28298 | 1500 self.checkService(info) |
1501 return | |
1502 raise NonUniqueNameException | |
1503 if now < nextTime: | |
1504 self.wait(nextTime - now) | |
1505 now = currentTimeMillis() | |
1506 continue | |
1507 out = DNSOutgoing(_FLAGS_QR_QUERY | _FLAGS_AA) | |
1508 self.debug = out | |
1509 out.addQuestion(DNSQuestion(info.type, _TYPE_PTR, _CLASS_IN)) | |
28299 | 1510 out.addAuthoritativeAnswer(DNSPointer(info.type, _TYPE_PTR, |
1511 _CLASS_IN, _DNS_TTL, info.name)) | |
28298 | 1512 self.send(out) |
1513 i += 1 | |
1514 nextTime += _CHECK_TIME | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1515 |
28298 | 1516 def addListener(self, listener, question): |
1517 """Adds a listener for a given question. The listener will have | |
1518 its updateRecord method called when information is available to | |
1519 answer the question.""" | |
1520 now = currentTimeMillis() | |
1521 self.listeners.append(listener) | |
1522 if question is not None: | |
1523 for record in self.cache.entriesWithName(question.name): | |
1524 if question.answeredBy(record) and not record.isExpired(now): | |
1525 listener.updateRecord(self, now, record) | |
1526 self.notifyAll() | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1527 |
28298 | 1528 def removeListener(self, listener): |
1529 """Removes a listener.""" | |
1530 try: | |
1531 self.listeners.remove(listener) | |
1532 self.notifyAll() | |
1533 except Exception: | |
1534 pass | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1535 |
28298 | 1536 def updateRecord(self, now, rec): |
1537 """Used to notify listeners of new information that has updated | |
1538 a record.""" | |
1539 for listener in self.listeners: | |
1540 listener.updateRecord(self, now, rec) | |
1541 self.notifyAll() | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1542 |
28298 | 1543 def handleResponse(self, msg): |
1544 """Deal with incoming response packets. All answers | |
1545 are held in the cache, and listeners are notified.""" | |
1546 now = currentTimeMillis() | |
1547 for record in msg.answers: | |
1548 expired = record.isExpired(now) | |
1549 if record in self.cache.entries(): | |
1550 if expired: | |
1551 self.cache.remove(record) | |
1552 else: | |
1553 entry = self.cache.get(record) | |
1554 if entry is not None: | |
1555 entry.resetTTL(record) | |
1556 record = entry | |
1557 else: | |
1558 self.cache.add(record) | |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
1559 |
28298 | 1560 self.updateRecord(now, record) |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1561 |
28298 | 1562 def handleQuery(self, msg, addr, port): |
1563 """Deal with incoming query packets. Provides a response if | |
1564 possible.""" | |
1565 out = None | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1566 |
28298 | 1567 # Support unicast client responses |
1568 # | |
1569 if port != _MDNS_PORT: | |
1570 out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA, 0) | |
1571 for question in msg.questions: | |
1572 out.addQuestion(question) | |
7874
d812029cda85
cleanup: drop variables for unused return values
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7071
diff
changeset
|
1573 |
28298 | 1574 for question in msg.questions: |
1575 if question.type == _TYPE_PTR: | |
1576 if question.name == "_services._dns-sd._udp.local.": | |
1577 for stype in self.servicetypes.keys(): | |
1578 if out is None: | |
1579 out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA) | |
28299 | 1580 out.addAnswer(msg, |
1581 DNSPointer( | |
1582 "_services._dns-sd._udp.local.", | |
1583 _TYPE_PTR, _CLASS_IN, | |
1584 _DNS_TTL, stype)) | |
28298 | 1585 for service in self.services.values(): |
1586 if question.name == service.type: | |
1587 if out is None: | |
1588 out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA) | |
28299 | 1589 out.addAnswer(msg, DNSPointer(service.type, _TYPE_PTR, |
1590 _CLASS_IN, _DNS_TTL, service.name)) | |
28298 | 1591 else: |
1592 try: | |
1593 if out is None: | |
1594 out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA) | |
7874
d812029cda85
cleanup: drop variables for unused return values
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7071
diff
changeset
|
1595 |
28298 | 1596 # Answer A record queries for any service addresses we know |
1597 if question.type == _TYPE_A or question.type == _TYPE_ANY: | |
1598 for service in self.services.values(): | |
1599 if service.server == question.name.lower(): | |
28299 | 1600 out.addAnswer(msg, |
1601 DNSAddress(question.name, _TYPE_A, | |
1602 _CLASS_IN | _CLASS_UNIQUE, | |
1603 _DNS_TTL, service.address)) | |
7874
d812029cda85
cleanup: drop variables for unused return values
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7071
diff
changeset
|
1604 |
28298 | 1605 service = self.services.get(question.name.lower(), None) |
1606 if not service: continue | |
7874
d812029cda85
cleanup: drop variables for unused return values
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7071
diff
changeset
|
1607 |
28299 | 1608 if (question.type == _TYPE_SRV or |
1609 question.type == _TYPE_ANY): | |
1610 out.addAnswer(msg, | |
1611 DNSService(question.name, _TYPE_SRV, | |
1612 _CLASS_IN | _CLASS_UNIQUE, | |
1613 _DNS_TTL, service.priority, | |
1614 service.weight, service.port, | |
1615 service.server)) | |
1616 if (question.type == _TYPE_TXT or | |
1617 question.type == _TYPE_ANY): | |
1618 out.addAnswer(msg, DNSText(question.name, _TYPE_TXT, | |
1619 _CLASS_IN | _CLASS_UNIQUE, _DNS_TTL, service.text)) | |
28298 | 1620 if question.type == _TYPE_SRV: |
28299 | 1621 out.addAdditionalAnswer( |
1622 DNSAddress(service.server, _TYPE_A, | |
1623 _CLASS_IN | _CLASS_UNIQUE, | |
1624 _DNS_TTL, service.address)) | |
28298 | 1625 except Exception: |
1626 traceback.print_exc() | |
7874
d812029cda85
cleanup: drop variables for unused return values
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7071
diff
changeset
|
1627 |
28298 | 1628 if out is not None and out.answers: |
1629 out.id = msg.id | |
1630 self.send(out, addr, port) | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1631 |
28298 | 1632 def send(self, out, addr = _MDNS_ADDR, port = _MDNS_PORT): |
1633 """Sends an outgoing packet.""" | |
1634 # This is a quick test to see if we can parse the packets we generate | |
1635 #temp = DNSIncoming(out.packet()) | |
1636 try: | |
1637 self.socket.sendto(out.packet(), 0, (addr, port)) | |
1638 except Exception: | |
1639 # Ignore this, it may be a temporary loss of network connection | |
1640 pass | |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1641 |
28298 | 1642 def close(self): |
1643 """Ends the background threads, and prevent this instance from | |
1644 servicing further queries.""" | |
1645 if globals()['_GLOBAL_DONE'] == 0: | |
1646 globals()['_GLOBAL_DONE'] = 1 | |
1647 self.notifyAll() | |
1648 self.engine.notify() | |
1649 self.unregisterAllServices() | |
28299 | 1650 self.socket.setsockopt(socket.SOL_IP, socket.IP_DROP_MEMBERSHIP, |
1651 socket.inet_aton(_MDNS_ADDR) + socket.inet_aton('0.0.0.0')) | |
28298 | 1652 self.socket.close() |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
1653 |
7071
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1654 # Test a few module features, including service registration, service |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1655 # query (for Zoe), and service unregistration. |
643c751e60b2
zeroconf: initial implementation
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1656 |
7877
eba7f12b0c51
cleanup: whitespace cleanup
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
7874
diff
changeset
|
1657 if __name__ == '__main__': |
28298 | 1658 print("Multicast DNS Service Discovery for Python, version", __version__) |
1659 r = Zeroconf() | |
1660 print("1. Testing registration of a service...") | |
1661 desc = {'version':'0.10','a':'test value', 'b':'another value'} | |
28299 | 1662 info = ServiceInfo("_http._tcp.local.", |
1663 "My Service Name._http._tcp.local.", | |
1664 socket.inet_aton("127.0.0.1"), 1234, 0, 0, desc) | |
28298 | 1665 print(" Registering service...") |
1666 r.registerService(info) | |
1667 print(" Registration done.") | |
1668 print("2. Testing query of service information...") | |
28299 | 1669 print(" Getting ZOE service:", |
1670 str(r.getServiceInfo("_http._tcp.local.", "ZOE._http._tcp.local."))) | |
28298 | 1671 print(" Query done.") |
1672 print("3. Testing query of own service...") | |
28299 | 1673 print(" Getting self:", |
1674 str(r.getServiceInfo("_http._tcp.local.", | |
1675 "My Service Name._http._tcp.local."))) | |
28298 | 1676 print(" Query done.") |
1677 print("4. Testing unregister of service information...") | |
1678 r.unregisterService(info) | |
1679 print(" Unregister done.") | |
1680 r.close() | |
10288
e0121ad90b57
zeroconf: flag third-party Zeroconf.py for ignore in check-code
Matt Mackall <mpm@selenic.com>
parents:
8131
diff
changeset
|
1681 |
e0121ad90b57
zeroconf: flag third-party Zeroconf.py for ignore in check-code
Matt Mackall <mpm@selenic.com>
parents:
8131
diff
changeset
|
1682 # no-check-code |