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