diff --git a/CHANGELOG b/CHANGELOG new file mode 100644 index 0000000..e52126b --- /dev/null +++ b/CHANGELOG @@ -0,0 +1,295 @@ +pysmb-1.1.19, 13 Nov 2016 +======================== +- Ignore STATUS_PENDING during delete and file store operations + +pysmb-1.1.18, 9 Apr 2016 +======================== + +- Rollback fixes to NTLMv2 response algorithm in pysmb 1.1.17. The fixes + fail to work with some servers. +- Add missing errno imports in SMBConnection.py +- Fix UnboundLocalError raised when using type() in SMBConnection.py + +pysmb-1.1.17, 11 Nov 2015 +========================= + +- Fix crashes in directory listing with keyerror 'support_dfs' +- Fix bugs in NTLMv2 response algorithm. +- Fix bugs where client domain is not included as part of the session negotiation. + +pysmb-1.1.16, 10 May 2015 +========================= + +- Fix typo errors in authentication error messages +- Improve share listings on SMB2 protocol by ignoring interim STATUS_PENDING responses. + +pysmb-1.1.15, 15 Feb 2015 +========================= + +- Add new parameter to SMBConnection's storeFileFromOffset method to determine + whether the remote file is to be truncated before writing. + +pysmb-1.1.14, 1 Feb 2015 +======================== + +- Add support for DFS shares in listPath() +- Bug fix for python3's _listPath_SMB2 implementation + +pysmb-1.1.13, 18 Oct 2014 +========================= + +- Add missing methods and improve compatibility with python3 +- Fix bug in SMB2 rename implementation which fails to rename directory + +pysmb-1.1.12, 21 Sep 2014 +========================= + +- Fix syntax error for python3 NBNSProtocol implementation +- Fix bug in SMB1 implementation which results in access denied errors with Samba 3.0 + +pysmb-1.1.11, 13 Sep 2014 +========================= + +- Add support for unicode characters in domain, username and password. +- Add storeFileFromOffset method to SMB API +- Fix bug in getAttributes implementation for SMB1 +- Fix bug for NMB which uses broadcast flag for unicast queries +- Update the Tree Connect Andx request implementation to MS-SMB 2.2.4.7.1 extensions + +pysmb-1.1.10, 29 Jun 2014 +========================= + +- Add getAttributes() method to SMBConnection and SMBProtocolFactory class +- Add isReadOnly property to SharedFile class + +pysmb-1.1.9, 1 Jun 2014 +======================= + +- Add support for domains in smb:// URLs +- Fix a bug which fails to test for the correct GSS security provider OID values + +pysmb-1.1.8, 21 Dec 2013 +======================== + +- Fix a bug in storeFile() method when the destination file is not overwritten if + it exists in SMB1 communication +- Fix a SMB1 authentication problem when extended negotation is not carried out + because the remote server has specified its support for extended security in the + payload, instead of in the message flags2. + +pysmb-1.1.7, 27 Sep 2013 +======================== + +- Improve listShares() function which can fail with the listing response is + separated into multiple SMB packets for large number of shares. +- Fix bug in python3 implementation where session connection can fail when + remote server supports message signing. + +pysmb-1.1.6, 16 Aug 2013 +======================== + +- Fix bug where the status of the SMB_COM_NEGOTIATE reply is not checked for error + before allowing further processing. + +pysmb-1.1.5, 19 June 2013 +========================= + +- Adds support for Direct hosting of SMB over TCP/IP (TCP port: 445) + +pysmb-1.1.4, 31 May 2013 +======================== + +- Improve query performance for query IP addresses for NetBIOS names in + NetBIOSProtocol.py +- Fix bugs in SMBConnection when sending large data packets can result in + AssertionError. + +pysmb-1.1.3, 18 Mar 2013 +======================== + +- Fix bug which results in endless loop in SMBConnection when remote CIFS + server closes the connection. + +pysmb-1.1.2, 28 Sep 2012 +======================== + +- Improve queryIPForName() in nmb.NetBIOS and nmb.NBNSProtocol class to + return only server machine name and ignore workgroup names. + +pysmb-1.1.1, 9 June 2012 +======================== + +- Adds support for Python3. Noted that the Python3 SMB/NMB protocol implementations + for Twisted are not well-tested as Twisted (as of v12.1) is not Python3 ready yet. +- Adds support for retrieving list of shadow copies (also known as + "previous versions" in Windows). Note that not all Windows editions support shadow + copies. + + +pysmb-1.1.0, 1 June 2012 +======================== + +- Adds SMB2 protocol implementation with signing for outgoing SMB2 messages. + pysmb will utilize SMB2 protocol with servers that support SMB2 + (eg. Windows Vista, Windows 7 and Samba 3). + If the remote server does not support SMB2, pysmb will fall back automatically + to using SMB1 protocol. + + +pysmb-1.0.5, 7 May 2012 +======================= + +- Add supports for SMB message signing. pysmb will sign all SMB messages from + the CIFS client to the server, but it does not verify the signatures of the + SMB messages from the server. + + +pysmb-1.0.4, 1 May 2012 +======================= + +- Adds support for "smb://" URL in urllib2 python packages to retrieve or upload + files from/to remote CIFS servers. +- Improve documentation + + +pysmb-1.0.3, 28 April 2012 +=========================== + +- Fix a crash in SMB._storFile() method which occurs when the remote CIFS server + utilizes a max raw size larger than 65535 bytes. The bug was discovered with + Windows 7 Pro SP1. +- Fix a bug in SMB._listPath() method where the files/folders time information are + not properly converted to Epoch time. +- Add NBNSProtocol.queryIPForName() and NetBIOS.queryIPForName() methods to + query for a machine's NetBIOS name at the given IP address. +- Add SMBProtocol.retrieveFileFromOffset() and SMBConnection.retrieveFileFromOffset() + methods for a finer control of file retrieval operation with read offset and write + limits. + + +pysmb-1.0.2, 31 March 2012 +========================== + +- Fix a bug in SMB._handleSessionChallenge() method in base.py where the domain attribute + was not used to generate the corresponding NTLM authentication packets, resulting in + the default WORKGROUP domain for used for all subsequent authentications. + +pysmb-1.0.1, 25 Jan 2012 +======================== + +- Fixes a bug in listPath() method which causes directory listing for + sub-directories to return an empty list. +- Fixes an incorrect implementation of the TRANS2_FIND_FIRST2 and + TRANS2_FIND_NEXT2 request/response handling which causes directory listing + to crash when the remote directory contains a certain number of entries. + + +pysmb-1.0.0, 25 Dec 2011 +======================== + +- Completely rewrites pysmb. API is not compatible with previous pysmb-0.x.x +- Supports NTLMv1 and NTLMv2 authentication +- Adds in NMB/SMB protocol implementation for use with Twisted framework +- Tested with Windows XP SP3, Windows Vista, Windows 7 and Samba 3.x +- Requires Python 2.4.4 or later, and pyasn1. Not tested with Python3 + +pysmb-0.4.5, 22 Jun 2009 +======================== + +- Prevents pysmb from failing when there are too many files/folders to + be returned in a single SMB TRANS2 call. pysmb will "resume" requesting + for more files/folders information in subsequent SMB TRANS2 requests. + +pysmb-0.4.4, 12 Jan 2004 +======================== + +- Add in support for AMK's Python Cryptography Toolkit which will be used + for DES password hashing. If AMK's pycrypto is found, it will be used + instead of mxCrypto. + +pysmb-0.4.3, 22 Feb 2003 +======================== + +- Fix a bug which fails to close the socket in nmb.py on socket exception +- Fix a bug which fails to close the NetBIOSSession in smb.py if the session + has not been properly established yet. + +pysmb-0.4.2, 03 Aug 2002 +======================== + +- Add new methods to SharedFile instances, get_mtime_epoch, get_atime_epoch + and get_ctime_epoch. These methods will return the mtime, atime and ctime in + epoch time rather than SMB time. +- Remove debugging printout in smb.py which has been released accidentally + with the last release. +- Fix a bug in smbcp which causes to local to remote copy to fail + +pysmb-0.4.1, 22 Jun 2002 +======================== + +- Fix a bug in smb.py which does not return the correct file size for files + with their archive bits turned off. This results in these files not being + retrieved or sent properly. +- Fix some typo error in the documentations + +pysmb-0.4.0, 17 Apr 2002 +======================== + +- Use NT LM0.12 dialect. +- New smb.SMBMachine class +- Add SMB.get_server_domain(), smb.get_server_os(), SMB.get_server_lanman() + +pysmb-0.3.1, 12 Nov 2001 +======================== + +- Fix a problem with some Windows server where an UID is required when server is in share mode. + Now, pysmb calls login() with empty authentication information when server is in share mode. +- Add TYPE_DOMAIN_MASTER constant and description to nmb.py. + +pysmb-0.3.0, 10 Nov 2001 +======================== + +- Add support for services in share mode. Minor changes to smb.SMB class API. +- Fix a bug in smb.py's __raw_retr_file which has failed to initialize the max_buf_size prior to usage. +- Fix a bug in smblistshare which fails to print the correct NMB error message +- Modify smb.py not throw AttributeError in the destructor when there is an error while creating a session + in the constructor + +pysmb-0.2.0, 04 Oct 2001 +======================== + +- Add support for encrypted authentication using DES +- Fix a bug(?) which treats all services and filenames as case-sensitive + +pysmb-0.1.3, 03 Sep 2001 +======================== + +- Fix a bug in smblistshare and smbdu which fails to catch the nmb.NetBIOSError raised when session + setup fails. +- Fix a bug in smb.SMB that arises from the change in nmb.NetBIOSSession which sends + the session port number as the remote host type. + +pysmb-0.1.2, 01 Sep 2001 +======================== + +- Fix a bug in nmb.NetBIOSSession which specifies a TYPE_WORKSTATION for remote host instead of TYPE_SERVER. +- Minor change to nmb.NetBIOSSession constructor API. +- Fix a bug in smbdu which raises OverflowError when printing long file size values. +- Fix a bug in smbcp which does not handle the destination path correctly when + the source file is copied to a different filename. + +pysmb-0.1.1, 25 Aug 2001 +======================== + +- Change nmb's NetBIOS and NetBIOSSession class such that they raise a NetBIOSError + with a tuple of ( err_msg, err_class, err_code ) +- Add a function strerror() in both smb and nmb to return human readable messages + for error codes. +- Fix a bug in smbcp which fails to print an error message and terminate when the + remote source path is not found. +- Add in another utility, smblistshare. + +pysmb-0.1.0, 20 Aug 2001 +======================== + +- First public release diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d183506 --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ + +Copyright (C) 2001-2015 Michael Teo + +This software is provided 'as-is', without any express or implied warranty. +In no event will the author be held liable for any damages arising from the +use of this software. + +Permission is granted to anyone to use this software for any purpose, +including commercial applications, and to alter it and redistribute it +freely, subject to the following restrictions: + +1. The origin of this software must not be misrepresented; you must not + claim that you wrote the original software. If you use this software + in a product, an acknowledgment in the product documentation would be + appreciated but is not required. + +2. Altered source versions must be plainly marked as such, and must not be + misrepresented as being the original software. + +3. This notice cannot be removed or altered from any source distribution. diff --git a/PKG-INFO b/PKG-INFO new file mode 100644 index 0000000..ba886a1 --- /dev/null +++ b/PKG-INFO @@ -0,0 +1,26 @@ +Metadata-Version: 1.1 +Name: pysmb +Version: 1.1.19 +Summary: pysmb is an experimental SMB/CIFS library written in Python to support file sharing between Windows and Linux machines +Home-page: https://miketeo.net/projects/pysmb +Author: Michael Teo +Author-email: miketeo@miketeo.net +License: zlib/libpng +Description: pysmb is an experimental SMB/CIFS library written in Python. It implements the client-side SMB/CIFS protocol which allows your Python application to access and transfer files to/from SMB/CIFS shared folders like your Windows file sharing and Samba folders. +Keywords: windows samba cifs sharing ftp smb linux +Platform: UNKNOWN +Classifier: Development Status :: 5 - Production/Stable +Classifier: Environment :: Win32 (MS Windows) +Classifier: Environment :: Console +Classifier: License :: OSI Approved :: zlib/libpng License +Classifier: Operating System :: Microsoft :: Windows +Classifier: Operating System :: POSIX +Classifier: Programming Language :: Python +Classifier: Programming Language :: Python :: 2.4 +Classifier: Programming Language :: Python :: 2.5 +Classifier: Programming Language :: Python :: 2.6 +Classifier: Programming Language :: Python :: 2.7 +Classifier: Programming Language :: Python :: 3 +Classifier: Topic :: Communications :: File Sharing +Classifier: Topic :: Software Development :: Libraries :: Python Modules +Classifier: Topic :: System :: Networking diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..a23a4b2 --- /dev/null +++ b/README.txt @@ -0,0 +1,3 @@ +pysmb is an experimental SMB/CIFS library written in Python. +It implements the client-side SMB/CIFS protocol (SMB1 and SMB2) which allows your Python application to access +and transfer files to/from SMB/CIFS shared folders like your Windows file sharing and Samba folders. diff --git a/docs/doctrees/api/nmb_NBNSProtocol.doctree b/docs/doctrees/api/nmb_NBNSProtocol.doctree new file mode 100644 index 0000000..63a5cd0 Binary files /dev/null and b/docs/doctrees/api/nmb_NBNSProtocol.doctree differ diff --git a/docs/doctrees/api/nmb_NetBIOS.doctree b/docs/doctrees/api/nmb_NetBIOS.doctree new file mode 100644 index 0000000..9b279b3 Binary files /dev/null and b/docs/doctrees/api/nmb_NetBIOS.doctree differ diff --git a/docs/doctrees/api/smb_SMBConnection.doctree b/docs/doctrees/api/smb_SMBConnection.doctree new file mode 100644 index 0000000..383d6bf Binary files /dev/null and b/docs/doctrees/api/smb_SMBConnection.doctree differ diff --git a/docs/doctrees/api/smb_SMBHandler.doctree b/docs/doctrees/api/smb_SMBHandler.doctree new file mode 100644 index 0000000..2fb06a4 Binary files /dev/null and b/docs/doctrees/api/smb_SMBHandler.doctree differ diff --git a/docs/doctrees/api/smb_SMBProtocolFactory.doctree b/docs/doctrees/api/smb_SMBProtocolFactory.doctree new file mode 100644 index 0000000..d424daa Binary files /dev/null and b/docs/doctrees/api/smb_SMBProtocolFactory.doctree differ diff --git a/docs/doctrees/api/smb_SharedDevice.doctree b/docs/doctrees/api/smb_SharedDevice.doctree new file mode 100644 index 0000000..eb0fa96 Binary files /dev/null and b/docs/doctrees/api/smb_SharedDevice.doctree differ diff --git a/docs/doctrees/api/smb_SharedFile.doctree b/docs/doctrees/api/smb_SharedFile.doctree new file mode 100644 index 0000000..faa32e5 Binary files /dev/null and b/docs/doctrees/api/smb_SharedFile.doctree differ diff --git a/docs/doctrees/api/smb_exceptions.doctree b/docs/doctrees/api/smb_exceptions.doctree new file mode 100644 index 0000000..aec1229 Binary files /dev/null and b/docs/doctrees/api/smb_exceptions.doctree differ diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle new file mode 100644 index 0000000..987c4bf Binary files /dev/null and b/docs/doctrees/environment.pickle differ diff --git a/docs/doctrees/extending.doctree b/docs/doctrees/extending.doctree new file mode 100644 index 0000000..dc0b3fc Binary files /dev/null and b/docs/doctrees/extending.doctree differ diff --git a/docs/doctrees/index.doctree b/docs/doctrees/index.doctree new file mode 100644 index 0000000..807f40d Binary files /dev/null and b/docs/doctrees/index.doctree differ diff --git a/docs/html/.buildinfo b/docs/html/.buildinfo new file mode 100644 index 0000000..bf80f8a --- /dev/null +++ b/docs/html/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 8ec856095809db2990831edf01ebc5a4 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/html/_modules/index.html b/docs/html/_modules/index.html new file mode 100644 index 0000000..c518f1e --- /dev/null +++ b/docs/html/_modules/index.html @@ -0,0 +1,89 @@ + + + + + + + + Overview: module code — pysmb 1.1.18 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

All modules for which code is available

+ + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/html/_modules/nmb/NetBIOS.html b/docs/html/_modules/nmb/NetBIOS.html new file mode 100644 index 0000000..82bdf75 --- /dev/null +++ b/docs/html/_modules/nmb/NetBIOS.html @@ -0,0 +1,230 @@ + + + + + + + + nmb.NetBIOS — pysmb 1.1.18 documentation + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for nmb.NetBIOS

+
+import os, logging, random, socket, time, select
+from base import NBNS, NotConnectedError
+from nmb_constants import TYPE_CLIENT, TYPE_SERVER, TYPE_WORKSTATION
+
+
[docs]class NetBIOS(NBNS):
+
+    log = logging.getLogger('NMB.NetBIOS')
+
+
[docs]    def __init__(self, broadcast = True, listen_port = 0):
+        """
+        Instantiate a NetBIOS instance, and creates a IPv4 UDP socket to listen/send NBNS packets.
+
+        :param boolean broadcast: A boolean flag to indicate if we should setup the listening UDP port in broadcast mode
+        :param integer listen_port: Specifies the UDP port number to bind to for listening. If zero, OS will automatically select a free port number.
+        """
+        self.broadcast = broadcast
+        self.sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+        if self.broadcast:
+            self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
+        if listen_port:
+            self.sock.bind(( '', listen_port ))

+
+
[docs]    def close(self):
+        """
+        Close the underlying and free resources.
+
+        The NetBIOS instance should not be used to perform any operations after this method returns.
+
+        :return: None
+        """
+        self.sock.close()
+        self.sock = None

+
+    def write(self, data, ip, port):
+        assert self.sock, 'Socket is already closed'
+        self.sock.sendto(data, ( ip, port ))
+
+
[docs]    def queryName(self, name, ip = '', port = 137, timeout = 30):
+        """
+        Send a query on the network and hopes that if machine matching the *name* will reply with its IP address.
+
+        :param string ip: If the NBNSProtocol instance was instianted with broadcast=True, then this parameter can be an empty string. We will leave it to the OS to determine an appropriate broadcast address.
+                          If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.
+        :param integer port: The NetBIOS-NS port (IANA standard defines this port to be 137). You should not touch this parameter unless you know what you are doing.
+        :param integer/float timeout: Number of seconds to wait for a reply, after which the method will return None
+        :return: A list of IP addresses in dotted notation (aaa.bbb.ccc.ddd). On timeout, returns None.
+        """
+        assert self.sock, 'Socket is already closed'
+
+        trn_id = random.randint(1, 0xFFFF)
+        data = self.prepareNameQuery(trn_id, name)
+        if self.broadcast and not ip:
+            ip = '<broadcast>'
+        elif not ip:
+            self.log.warning('queryName: ip parameter is empty. OS might not transmit this query to the network')
+
+        self.write(data, ip, port)
+
+        return self._pollForNetBIOSPacket(trn_id, timeout)

+
+
[docs]    def queryIPForName(self, ip, port = 137, timeout = 30):
+        """
+        Send a query to the machine with *ip* and hopes that the machine will reply back with its name.
+
+        The implementation of this function is contributed by Jason Anderson.
+
+        :param string ip: If the NBNSProtocol instance was instianted with broadcast=True, then this parameter can be an empty string. We will leave it to the OS to determine an appropriate broadcast address.
+                          If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.
+        :param integer port: The NetBIOS-NS port (IANA standard defines this port to be 137). You should not touch this parameter unless you know what you are doing.
+        :param integer/float timeout: Number of seconds to wait for a reply, after which the method will return None
+        :return: A list of string containing the names of the machine at *ip*. On timeout, returns None.
+        """
+        assert self.sock, 'Socket is already closed'
+
+        trn_id = random.randint(1, 0xFFFF)
+        data = self.prepareNetNameQuery(trn_id, False)
+        self.write(data, ip, port)
+        ret = self._pollForQueryPacket(trn_id, timeout)
+        if ret:
+            return map(lambda s: s[0], filter(lambda s: s[1] == TYPE_SERVER, ret))
+        else:
+            return None

+
+    #
+    # Protected Methods
+    #
+
+    def _pollForNetBIOSPacket(self, wait_trn_id, timeout):
+        end_time = time.time() + timeout
+        while True:
+            try:
+                _timeout = end_time - time.time()
+                if _timeout <= 0:
+                    return None
+
+                ready, _, _ = select.select([ self.sock.fileno() ], [ ], [ ], _timeout)
+                if not ready:
+                    return None
+
+                data, _ = self.sock.recvfrom(0xFFFF)
+                if len(data) == 0:
+                    raise NotConnectedError
+
+                trn_id, ret = self.decodePacket(data)
+
+                if trn_id == wait_trn_id:
+                    return ret
+            except select.error, ex:
+                if type(ex) is types.TupleType:
+                    if ex[0] != errno.EINTR and ex[0] != errno.EAGAIN:
+                        raise ex
+                else:
+                    raise ex
+
+    #
+    # Contributed by Jason Anderson
+    #
+    def _pollForQueryPacket(self, wait_trn_id, timeout):
+        end_time = time.time() + timeout
+        while True:
+            try:
+                _timeout = end_time - time.time()
+                if _timeout <= 0:
+                    return None
+
+                ready, _, _ = select.select([ self.sock.fileno() ], [ ], [ ], _timeout)
+                if not ready:
+                    return None
+
+                data, _ = self.sock.recvfrom(0xFFFF)
+                if len(data) == 0:
+                    raise NotConnectedError
+
+                trn_id, ret = self.decodeIPQueryPacket(data)
+
+                if trn_id == wait_trn_id:
+                    return ret
+            except select.error, ex:
+                if type(ex) is types.TupleType:
+                    if ex[0] != errno.EINTR and ex[0] != errno.EAGAIN:
+                        raise ex
+                else:
+                    raise ex

+
+ +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/html/_modules/nmb/NetBIOSProtocol.html b/docs/html/_modules/nmb/NetBIOSProtocol.html new file mode 100644 index 0000000..50dade2 --- /dev/null +++ b/docs/html/_modules/nmb/NetBIOSProtocol.html @@ -0,0 +1,222 @@ + + + + + + + + nmb.NetBIOSProtocol — pysmb 1.1.18 documentation + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for nmb.NetBIOSProtocol

+
+import os, logging, random, socket, time
+from twisted.internet import reactor, defer
+from twisted.internet.protocol import DatagramProtocol
+from nmb_constants import TYPE_SERVER
+from base import NBNS
+
+IP_QUERY, NAME_QUERY = range(2)
+
+
[docs]class NetBIOSTimeout(Exception):
+    """Raised in NBNSProtocol via Deferred.errback method when queryName method has timeout waiting for reply"""
+    pass

+
+
[docs]class NBNSProtocol(DatagramProtocol, NBNS):
+
+    log = logging.getLogger('NMB.NBNSProtocol')
+
+
[docs]    def __init__(self, broadcast = True, listen_port = 0):
+        """
+        Instantiate a NBNSProtocol instance.
+
+        This automatically calls reactor.listenUDP method to start listening for incoming packets, so you **must not** call the listenUDP method again.
+
+        :param boolean broadcast: A boolean flag to indicate if we should setup the listening UDP port in broadcast mode
+        :param integer listen_port: Specifies the UDP port number to bind to for listening. If zero, OS will automatically select a free port number.
+        """
+        self.broadcast = broadcast
+        self.pending_trns = { }  # TRN ID -> ( expiry_time, name, Deferred instance )
+        self.transport = reactor.listenUDP(listen_port, self)
+        if self.broadcast:
+            self.transport.getHandle().setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
+        reactor.callLater(1, self.cleanupPendingTrns)

+
+    def datagramReceived(self, data, from_info):
+        host, port = from_info
+        trn_id, ret = self.decodePacket(data)
+
+        # pending transaction exists for trn_id - handle it and remove from queue
+        if trn_id in self.pending_trns:
+            _, ip, d = self.pending_trns.pop(trn_id)
+            if ip is NAME_QUERY:
+                # decode as query packet
+                trn_id, ret = self.decodeIPQueryPacket(data)
+            d.callback(ret)
+
+    def write(self, data, ip, port):
+        # We don't use the transport.write method directly as it keeps raising DeprecationWarning for ip='<broadcast>'
+        self.transport.getHandle().sendto(data, ( ip, port ))
+
+
[docs]    def queryName(self, name, ip = '', port = 137, timeout = 30):
+        """
+        Send a query on the network and hopes that if machine matching the *name* will reply with its IP address.
+
+        :param string ip: If the NBNSProtocol instance was instianted with broadcast=True, then this parameter can be an empty string. We will leave it to the OS to determine an appropriate broadcast address.
+                          If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.
+        :param integer port: The NetBIOS-NS port (IANA standard defines this port to be 137). You should not touch this parameter unless you know what you are doing.
+        :param integer/float timeout: Number of seconds to wait for a reply, after which the returned Deferred instance will be called with a NetBIOSTimeout exception.
+        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of IP addresses in dotted notation (aaa.bbb.ccc.ddd).
+                 On timeout, the errback function will be called with a Failure instance wrapping around a NetBIOSTimeout exception
+        """
+        trn_id = random.randint(1, 0xFFFF)
+        while True:
+            if not self.pending_trns.has_key(trn_id):
+                break
+            else:
+                trn_id = (trn_id + 1) & 0xFFFF
+
+        data = self.prepareNameQuery(trn_id, name)
+        if self.broadcast and not ip:
+            ip = '<broadcast>'
+        elif not ip:
+            self.log.warning('queryName: ip parameter is empty. OS might not transmit this query to the network')
+
+        self.write(data, ip, port)
+
+        d = defer.Deferred()
+        self.pending_trns[trn_id] = ( time.time()+timeout, name, d )
+        return d

+
+
[docs]    def queryIPForName(self, ip, port = 137, timeout = 30):
+        """
+        Send a query to the machine with *ip* and hopes that the machine will reply back with its name.
+
+        The implementation of this function is contributed by Jason Anderson.
+
+        :param string ip: If the NBNSProtocol instance was instianted with broadcast=True, then this parameter can be an empty string. We will leave it to the OS to determine an appropriate broadcast address.
+                          If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.
+        :param integer port: The NetBIOS-NS port (IANA standard defines this port to be 137). You should not touch this parameter unless you know what you are doing.
+        :param integer/float timeout: Number of seconds to wait for a reply, after which the method will return None
+        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of names of the machine at *ip*.
+                 On timeout, the errback function will be called with a Failure instance wrapping around a NetBIOSTimeout exception
+        """
+        trn_id = random.randint(1, 0xFFFF)
+        while True:
+            if not self.pending_trns.has_key(trn_id):
+                break
+            else:
+                trn_id = (trn_id + 1) & 0xFFFF
+
+        data = self.prepareNetNameQuery(trn_id)
+        self.write(data, ip, port)
+
+        d = defer.Deferred()
+        d2 = defer.Deferred()
+        d2.addErrback(d.errback)
+
+        def stripCode(ret):
+            if ret is not None: # got valid response. Somehow the callback is also called when there is an error.
+                d.callback(map(lambda s: s[0], filter(lambda s: s[1] == TYPE_SERVER, ret)))
+
+        d2.addCallback(stripCode)
+        self.pending_trns[trn_id] = ( time.time()+timeout, NAME_QUERY, d2 )
+        return d

+
+    def stopProtocol(self):
+        DatagramProtocol.stopProtocol(self)
+
+    def cleanupPendingTrns(self):
+        now = time.time()
+
+        # reply should have been received in the past
+        expired = filter(lambda (trn_id, (expiry_time, name, d)): expiry_time < now, self.pending_trns.iteritems())
+
+        # remove expired items from dict + call errback
+        def expire_item(item):
+            trn_id, (expiry_time, name, d) = item
+
+            del self.pending_trns[trn_id]
+            try:
+                d.errback(NetBIOSTimeout(name))
+            except: pass
+
+        map(expire_item, expired)
+
+        if self.transport:
+            reactor.callLater(1, self.cleanupPendingTrns)

+
+ +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/html/_modules/smb/SMBConnection.html b/docs/html/_modules/smb/SMBConnection.html new file mode 100644 index 0000000..1df1ca8 --- /dev/null +++ b/docs/html/_modules/smb/SMBConnection.html @@ -0,0 +1,668 @@ + + + + + + + + smb.SMBConnection — pysmb 1.1.18 documentation + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for smb.SMBConnection

+
+import os, logging, select, socket, struct, errno
+from smb_constants import *
+from smb_structs import *
+from base import SMB, NotConnectedError, NotReadyError, SMBTimeout
+
+
+
[docs]class SMBConnection(SMB):
+
+    log = logging.getLogger('SMB.SMBConnection')
+
+    #: SMB messages will never be signed regardless of remote server's configurations; access errors will occur if the remote server requires signing.
+    SIGN_NEVER = 0
+    #: SMB messages will be signed when remote server supports signing but not requires signing.
+    SIGN_WHEN_SUPPORTED = 1
+    #: SMB messages will only be signed when remote server requires signing.
+    SIGN_WHEN_REQUIRED = 2
+
+
[docs]    def __init__(self, username, password, my_name, remote_name, domain = '', use_ntlm_v2 = True, sign_options = SIGN_WHEN_REQUIRED, is_direct_tcp = False):
+        """
+        Create a new SMBConnection instance.
+
+        *username* and *password* are the user credentials required to authenticate the underlying SMB connection with the remote server.
+        File operations can only be proceeded after the connection has been authenticated successfully.
+
+        Note that you need to call *connect* method to actually establish the SMB connection to the remote server and perform authentication.
+
+        The default TCP port for most SMB/CIFS servers using NetBIOS over TCP/IP is 139.
+        Some newer server installations might also support Direct hosting of SMB over TCP/IP; for these servers, the default TCP port is 445.
+
+        :param string my_name: The local NetBIOS machine name that will identify where this connection is originating from.
+                               You can freely choose a name as long as it contains a maximum of 15 alphanumeric characters and does not contain spaces and any of ``\/:*?";|+``
+        :param string remote_name: The NetBIOS machine name of the remote server.
+                                   On windows, you can find out the machine name by right-clicking on the "My Computer" and selecting "Properties".
+                                   This parameter must be the same as what has been configured on the remote server, or else the connection will be rejected.
+        :param string domain: The network domain. On windows, it is known as the workgroup. Usually, it is safe to leave this parameter as an empty string.
+        :param boolean use_ntlm_v2: Indicates whether pysmb should be NTLMv1 or NTLMv2 authentication algorithm for authentication.
+                                    The choice of NTLMv1 and NTLMv2 is configured on the remote server, and there is no mechanism to auto-detect which algorithm has been configured.
+                                    Hence, we can only "guess" or try both algorithms.
+                                    On Sambda, Windows Vista and Windows 7, NTLMv2 is enabled by default. On Windows XP, we can use NTLMv1 before NTLMv2.
+        :param int sign_options: Determines whether SMB messages will be signed. Default is *SIGN_WHEN_REQUIRED*.
+                                 If *SIGN_WHEN_REQUIRED* (value=2), SMB messages will only be signed when remote server requires signing.
+                                 If *SIGN_WHEN_SUPPORTED* (value=1), SMB messages will be signed when remote server supports signing but not requires signing.
+                                 If *SIGN_NEVER* (value=0), SMB messages will never be signed regardless of remote server's configurations; access errors will occur if the remote server requires signing.
+        :param boolean is_direct_tcp: Controls whether the NetBIOS over TCP/IP (is_direct_tcp=False) or the newer Direct hosting of SMB over TCP/IP (is_direct_tcp=True) will be used for the communication.
+                                      The default parameter is False which will use NetBIOS over TCP/IP for wider compatibility (TCP port: 139).
+        """
+        SMB.__init__(self, username, password, my_name, remote_name, domain, use_ntlm_v2, sign_options, is_direct_tcp)
+        self.sock = None
+        self.auth_result = None
+        self.is_busy = False
+        self.is_direct_tcp = is_direct_tcp

+
+    #
+    # SMB (and its superclass) Methods
+    #
+
+    def onAuthOK(self):
+        self.auth_result = True
+
+    def onAuthFailed(self):
+        self.auth_result = False
+
+    def write(self, data):
+        assert self.sock
+        data_len = len(data)
+        total_sent = 0
+        while total_sent < data_len:
+            sent = self.sock.send(data[total_sent:])
+            if sent == 0:
+                raise NotConnectedError('Server disconnected')
+            total_sent = total_sent + sent
+
+    #
+    # Misc Properties
+    #
+
+    @property
+    def isUsingSMB2(self):
+        """A convenient property to return True if the underlying SMB connection is using SMB2 protocol."""
+        return self.is_using_smb2
+
+
+    #
+    # Public Methods
+    #
+
+
[docs]    def connect(self, ip, port = 139, sock_family = socket.AF_INET, timeout = 60):
+        """
+        Establish the SMB connection to the remote SMB/CIFS server.
+
+        You must call this method before attempting any of the file operations with the remote server.
+        This method will block until the SMB connection has attempted at least one authentication.
+
+        :return: A boolean value indicating the result of the authentication atttempt: True if authentication is successful; False, if otherwise.
+        """
+        if self.sock:
+            self.sock.close()
+
+        self.auth_result = None
+        self.sock = socket.socket(sock_family)
+        self.sock.settimeout(timeout)
+        self.sock.connect(( ip, port ))
+
+        self.is_busy = True
+        try:
+            if not self.is_direct_tcp:
+                self.requestNMBSession()
+            else:
+                self.onNMBSessionOK()
+            while self.auth_result is None:
+                self._pollForNetBIOSPacket(timeout)
+        finally:
+            self.is_busy = False
+
+        return self.auth_result

+
+
[docs]    def close(self):
+        """
+        Terminate the SMB connection (if it has been started) and release any sources held by the underlying socket.
+        """
+        if self.sock:
+            self.sock.close()
+            self.sock = None

+
+
[docs]    def listShares(self, timeout = 30):
+        """
+        Retrieve a list of shared resources on remote server.
+
+        :return: A list of :doc:`smb.base.SharedDevice<smb_SharedDevice>` instances describing the shared resource
+        """
+        if not self.sock:
+            raise NotConnectedError('Not connected to server')
+
+        results = [ ]
+
+        def cb(entries):
+            self.is_busy = False
+            results.extend(entries)
+
+        def eb(failure):
+            self.is_busy = False
+            raise failure
+
+        self.is_busy = True
+        try:
+            self._listShares(cb, eb, timeout)
+            while self.is_busy:
+                self._pollForNetBIOSPacket(timeout)
+        finally:
+            self.is_busy = False
+
+        return results

+
+
[docs]    def listPath(self, service_name, path,
+                 search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE,
+                 pattern = '*', timeout = 30):
+        """
+        Retrieve a directory listing of files/folders at *path*
+
+        :param string/unicode service_name: the name of the shared folder for the *path*
+        :param string/unicode path: path relative to the *service_name* where we are interested to learn about its files/sub-folders.
+        :param integer search: integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py).
+                               The default *search* value will query for all read-only, hidden, system, archive files and directories.
+        :param string/unicode pattern: the filter to apply to the results before returning to the client.
+        :return: A list of :doc:`smb.base.SharedFile<smb_SharedFile>` instances.
+        """
+        if not self.sock:
+            raise NotConnectedError('Not connected to server')
+
+        results = [ ]
+
+        def cb(entries):
+            self.is_busy = False
+            results.extend(entries)
+
+        def eb(failure):
+            self.is_busy = False
+            raise failure
+
+        self.is_busy = True
+        try:
+            self._listPath(service_name, path, cb, eb, search = search, pattern = pattern, timeout = timeout)
+            while self.is_busy:
+                self._pollForNetBIOSPacket(timeout)
+        finally:
+            self.is_busy = False
+
+        return results

+
+
[docs]    def listSnapshots(self, service_name, path, timeout = 30):
+        """
+        Retrieve a list of available snapshots (shadow copies) for *path*.
+
+        Note that snapshot features are only supported on Windows Vista Business, Enterprise and Ultimate, and on all Windows 7 editions.
+
+        :param string/unicode service_name: the name of the shared folder for the *path*
+        :param string/unicode path: path relative to the *service_name* where we are interested in the list of available snapshots
+        :return: A list of python *datetime.DateTime* instances in GMT/UTC time zone
+        """
+        if not self.sock:
+            raise NotConnectedError('Not connected to server')
+
+        results = [ ]
+
+        def cb(entries):
+            self.is_busy = False
+            results.extend(entries)
+
+        def eb(failure):
+            self.is_busy = False
+            raise failure
+
+        self.is_busy = True
+        try:
+            self._listSnapshots(service_name, path, cb, eb, timeout = timeout)
+            while self.is_busy:
+                self._pollForNetBIOSPacket(timeout)
+        finally:
+            self.is_busy = False
+
+        return results

+
+
[docs]    def getAttributes(self, service_name, path, timeout = 30):
+        """
+        Retrieve information about the file at *path* on the *service_name*.
+
+        :param string/unicode service_name: the name of the shared folder for the *path*
+        :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure<smb_exceptions>` will be raised.
+        :return: A :doc:`smb.base.SharedFile<smb_SharedFile>` instance containing the attributes of the file.
+        """
+        if not self.sock:
+            raise NotConnectedError('Not connected to server')
+
+        results = [ ]
+
+        def cb(info):
+            self.is_busy = False
+            results.append(info)
+
+        def eb(failure):
+            self.is_busy = False
+            raise failure
+
+        self.is_busy = True
+        try:
+            self._getAttributes(service_name, path, cb, eb, timeout)
+            while self.is_busy:
+                self._pollForNetBIOSPacket(timeout)
+        finally:
+            self.is_busy = False
+
+        return results[0]

+
+
[docs]    def retrieveFile(self, service_name, path, file_obj, timeout = 30):
+        """
+        Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.
+
+        Use *retrieveFileFromOffset()* method if you wish to specify the offset to read from the remote *path* and/or the number of bytes to write to the *file_obj*.
+
+        :param string/unicode service_name: the name of the shared folder for the *path*
+        :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure<smb_exceptions>` will be raised.
+        :param file_obj: A file-like object that has a *write* method. Data will be written continuously to *file_obj* until EOF is received from the remote service.
+        :return: A 2-element tuple of ( file attributes of the file on server, number of bytes written to *file_obj* ).
+                 The file attributes is an integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py)
+        """
+        return self.retrieveFileFromOffset(service_name, path, file_obj, 0L, -1L, timeout)

+
+
[docs]    def retrieveFileFromOffset(self, service_name, path, file_obj, offset = 0L, max_length = -1L, timeout = 30):
+        """
+        Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.
+
+        :param string/unicode service_name: the name of the shared folder for the *path*
+        :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure<smb_exceptions>` will be raised.
+        :param file_obj: A file-like object that has a *write* method. Data will be written continuously to *file_obj* up to *max_length* number of bytes.
+        :param integer/long offset: the offset in the remote *path* where the first byte will be read and written to *file_obj*. Must be either zero or a positive integer/long value.
+        :param integer/long max_length: maximum number of bytes to read from the remote *path* and write to the *file_obj*. Specify a negative value to read from *offset* to the EOF.
+                                        If zero, the method returns immediately after the file is opened successfully for reading.
+        :return: A 2-element tuple of ( file attributes of the file on server, number of bytes written to *file_obj* ).
+                 The file attributes is an integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py)
+        """
+        if not self.sock:
+            raise NotConnectedError('Not connected to server')
+
+        results = [ ]
+
+        def cb(r):
+            self.is_busy = False
+            results.append(r[1:])
+
+        def eb(failure):
+            self.is_busy = False
+            raise failure
+
+        self.is_busy = True
+        try:
+            self._retrieveFileFromOffset(service_name, path, file_obj, cb, eb, offset, max_length, timeout = timeout)
+            while self.is_busy:
+                self._pollForNetBIOSPacket(timeout)
+        finally:
+            self.is_busy = False
+
+        return results[0]

+
+
[docs]    def storeFile(self, service_name, path, file_obj, timeout = 30):
+        """
+        Store the contents of the *file_obj* at *path* on the *service_name*.
+        If the file already exists on the remote server, it will be truncated and overwritten.
+
+        :param string/unicode service_name: the name of the shared folder for the *path*
+        :param string/unicode path: Path of the file on the remote server. If the file at *path* does not exist, it will be created. Otherwise, it will be overwritten.
+                                    If the *path* refers to a folder or the file cannot be opened for writing, an :doc:`OperationFailure<smb_exceptions>` will be raised.
+        :param file_obj: A file-like object that has a *read* method. Data will read continuously from *file_obj* until EOF.
+        :return: Number of bytes uploaded
+        """
+        return self.storeFileFromOffset(service_name, path, file_obj, 0L, True, timeout)

+
+
[docs]    def storeFileFromOffset(self, service_name, path, file_obj, offset = 0L, truncate = False, timeout = 30):
+        """
+        Store the contents of the *file_obj* at *path* on the *service_name*.
+
+        :param string/unicode service_name: the name of the shared folder for the *path*
+        :param string/unicode path: Path of the file on the remote server. If the file at *path* does not exist, it will be created.
+                                    If the *path* refers to a folder or the file cannot be opened for writing, an :doc:`OperationFailure<smb_exceptions>` will be raised.
+        :param file_obj: A file-like object that has a *read* method. Data will read continuously from *file_obj* until EOF.
+        :param offset: Long integer value which specifies the offset in the remote server to start writing. First byte of the file is 0.
+        :param truncate: Boolean value. If True and the file exists on the remote server, it will be truncated first before writing. Default is False.
+        :return: the file position where the next byte will be written.
+        """
+        if not self.sock:
+            raise NotConnectedError('Not connected to server')
+
+        results = [ ]
+
+        def cb(r):
+            self.is_busy = False
+            results.append(r[1])
+
+        def eb(failure):
+            self.is_busy = False
+            raise failure
+
+        self.is_busy = True
+        try:
+            self._storeFileFromOffset(service_name, path, file_obj, cb, eb, offset, truncate = truncate, timeout = timeout)
+            while self.is_busy:
+                self._pollForNetBIOSPacket(timeout)
+        finally:
+            self.is_busy = False
+
+        return results[0]

+
+
[docs]    def deleteFiles(self, service_name, path_file_pattern, timeout = 30):
+        """
+        Delete one or more regular files. It supports the use of wildcards in file names, allowing for deletion of multiple files in a single request.
+
+        :param string/unicode service_name: Contains the name of the shared folder.
+        :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name.
+                                                 Wildcards may be used in th filename component of the path.
+                                                 If your path/filename contains non-English characters, you must pass in an unicode string.
+        :return: None
+        """
+        if not self.sock:
+            raise NotConnectedError('Not connected to server')
+
+        def cb(r):
+            self.is_busy = False
+
+        def eb(failure):
+            self.is_busy = False
+            raise failure
+
+        self.is_busy = True
+        try:
+            self._deleteFiles(service_name, path_file_pattern, cb, eb, timeout = timeout)
+            while self.is_busy:
+                self._pollForNetBIOSPacket(timeout)
+        finally:
+            self.is_busy = False

+
+
[docs]    def resetFileAttributes(self, service_name, path_file_pattern, timeout = 30):
+        """
+        Reset file attributes of one or more regular files or folders.
+        It supports the use of wildcards in file names, allowing for unlocking of multiple files/folders in a single request.
+        This function is very helpful when deleting files/folders that are read-only.
+        Note: this function is currently only implemented for SMB2! Technically, it sets the FILE_ATTRIBUTE_NORMAL flag, therefore clearing all other flags. (See https://msdn.microsoft.com/en-us/library/cc232110.aspx for further information)
+
+        :param string/unicode service_name: Contains the name of the shared folder.
+        :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name.
+                                                 Wildcards may be used in the filename component of the path.
+                                                 If your path/filename contains non-English characters, you must pass in an unicode string.
+        :return: None
+        """
+        if not self.sock:
+            raise NotConnectedError('Not connected to server')
+
+        def cb(r):
+            self.is_busy = False
+
+        def eb(failure):
+            self.is_busy = False
+            raise failure
+
+        self.is_busy = True
+        try:
+            self._resetFileAttributes(service_name, path_file_pattern, cb, eb, timeout = timeout)
+            while self.is_busy:
+                self._pollForNetBIOSPacket(timeout)
+        finally:
+            self.is_busy = False

+
+
[docs]    def createDirectory(self, service_name, path, timeout = 30):
+        """
+        Creates a new directory *path* on the *service_name*.
+
+        :param string/unicode service_name: Contains the name of the shared folder.
+        :param string/unicode path: The path of the new folder (relative to) the shared folder.
+                                    If the path contains non-English characters, an unicode string must be used to pass in the path.
+        :return: None
+        """
+        if not self.sock:
+            raise NotConnectedError('Not connected to server')
+
+        def cb(r):
+            self.is_busy = False
+
+        def eb(failure):
+            self.is_busy = False
+            raise failure
+
+        self.is_busy = True
+        try:
+            self._createDirectory(service_name, path, cb, eb, timeout = timeout)
+            while self.is_busy:
+                self._pollForNetBIOSPacket(timeout)
+        finally:
+            self.is_busy = False

+
+
[docs]    def deleteDirectory(self, service_name, path, timeout = 30):
+        """
+        Delete the empty folder at *path* on *service_name*
+
+        :param string/unicode service_name: Contains the name of the shared folder.
+        :param string/unicode path: The path of the to-be-deleted folder (relative to) the shared folder.
+                                    If the path contains non-English characters, an unicode string must be used to pass in the path.
+        :return: None
+        """
+        if not self.sock:
+            raise NotConnectedError('Not connected to server')
+
+        def cb(r):
+            self.is_busy = False
+
+        def eb(failure):
+            self.is_busy = False
+            raise failure
+
+        self.is_busy = True
+        try:
+            self._deleteDirectory(service_name, path, cb, eb, timeout = timeout)
+            while self.is_busy:
+                self._pollForNetBIOSPacket(timeout)
+        finally:
+            self.is_busy = False

+
+
[docs]    def rename(self, service_name, old_path, new_path, timeout = 30):
+        """
+        Rename a file or folder at *old_path* to *new_path* shared at *service_name*. Note that this method cannot be used to rename file/folder across different shared folders
+
+        *old_path* and *new_path* are string/unicode referring to the old and new path of the renamed resources (relative to) the shared folder.
+        If the path contains non-English characters, an unicode string must be used to pass in the path.
+
+        :param string/unicode service_name: Contains the name of the shared folder.
+        :return: None
+        """
+        if not self.sock:
+            raise NotConnectedError('Not connected to server')
+
+        def cb(r):
+            self.is_busy = False
+
+        def eb(failure):
+            self.is_busy = False
+            raise failure
+
+        self.is_busy = True
+        try:
+            self._rename(service_name, old_path, new_path, cb, eb)
+            while self.is_busy:
+                self._pollForNetBIOSPacket(timeout)
+        finally:
+            self.is_busy = False

+
+
[docs]    def echo(self, data, timeout = 10):
+        """
+        Send an echo command containing *data* to the remote SMB/CIFS server. The remote SMB/CIFS will reply with the same *data*.
+
+        :param string data: Data to send to the remote server.
+        :return: The *data* parameter
+        """
+        if not self.sock:
+            raise NotConnectedError('Not connected to server')
+
+        results = [ ]
+
+        def cb(r):
+            self.is_busy = False
+            results.append(r)
+
+        def eb(failure):
+            self.is_busy = False
+            raise failure
+
+        self.is_busy = True
+        try:
+            self._echo(data, cb, eb)
+            while self.is_busy:
+                self._pollForNetBIOSPacket(timeout)
+        finally:
+            self.is_busy = False
+
+        return results[0]

+
+    #
+    # Protected Methods
+    #
+
+    def _pollForNetBIOSPacket(self, timeout):
+        expiry_time = time.time() + timeout
+        read_len = 4
+        data = ''
+
+        while read_len > 0:
+            try:
+                if expiry_time < time.time():
+                    raise SMBTimeout
+
+                ready, _, _ = select.select([ self.sock.fileno() ], [ ], [ ], timeout)
+                if not ready:
+                    raise SMBTimeout
+
+                d = self.sock.recv(read_len)
+                if len(d) == 0:
+                    raise NotConnectedError
+
+                data = data + d
+                read_len -= len(d)
+            except select.error, ex:
+                if isinstance(ex, types.TupleType):
+                    if ex[0] != errno.EINTR and ex[0] != errno.EAGAIN:
+                        raise ex
+                else:
+                    raise ex
+
+        type_, flags, length = struct.unpack('>BBH', data)
+        if flags & 0x01:
+            length = length | 0x10000
+
+        read_len = length
+        while read_len > 0:
+            try:
+                if expiry_time < time.time():
+                    raise SMBTimeout
+
+                ready, _, _ = select.select([ self.sock.fileno() ], [ ], [ ], timeout)
+                if not ready:
+                    raise SMBTimeout
+
+                d = self.sock.recv(read_len)
+                if len(d) == 0:
+                    raise NotConnectedError
+
+                data = data + d
+                read_len -= len(d)
+            except select.error, ex:
+                if isinstance(ex, types.TupleType):
+                    if ex[0] != errno.EINTR and ex[0] != errno.EAGAIN:
+                        raise ex
+                else:
+                    raise ex
+
+        self.feedData(data)

+
+ +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/html/_modules/smb/SMBProtocol.html b/docs/html/_modules/smb/SMBProtocol.html new file mode 100644 index 0000000..20cbc73 --- /dev/null +++ b/docs/html/_modules/smb/SMBProtocol.html @@ -0,0 +1,487 @@ + + + + + + + + smb.SMBProtocol — pysmb 1.1.18 documentation + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for smb.SMBProtocol

+
+import os, logging, time
+from twisted.internet import reactor, defer
+from twisted.internet.protocol import ClientFactory, Protocol
+from smb_constants import *
+from smb_structs import *
+from base import SMB, NotConnectedError, NotReadyError, SMBTimeout
+
+
+__all__ = [ 'SMBProtocolFactory', 'NotConnectedError', 'NotReadyError' ]
+
+
+class SMBProtocol(Protocol, SMB):
+
+    log = logging.getLogger('SMB.SMBProtocol')
+
+    #
+    # Protocol Methods
+    #
+
+    def connectionMade(self):
+        self.factory.instance = self
+        if not self.is_direct_tcp:
+            self.requestNMBSession()
+        else:
+            self.onNMBSessionOK()
+
+    def connectionLost(self, reason):
+        if self.factory.instance == self:
+            self.instance = None
+
+    def dataReceived(self, data):
+        self.feedData(data)
+
+    #
+    # SMB (and its superclass) Methods
+    #
+
+    def write(self, data):
+        self.transport.write(data)
+
+    def onAuthOK(self):
+        if self.factory.instance == self:
+            self.factory.onAuthOK()
+            reactor.callLater(1, self._cleanupPendingRequests)
+
+    def onAuthFailed(self):
+        if self.factory.instance == self:
+            self.factory.onAuthFailed()
+
+    def onNMBSessionFailed(self):
+        self.log.error('Cannot establish NetBIOS session. You might have provided a wrong remote_name')
+
+    #
+    # Protected Methods
+    #
+
+    def _cleanupPendingRequests(self):
+        if self.factory.instance == self:
+            now = time.time()
+            to_remove = []
+            for mid, r in self.pending_requests.iteritems():
+                if r.expiry_time < now:
+                    try:
+                        r.errback(SMBTimeout())
+                    except Exception: pass
+                    to_remove.append(mid)
+
+            for mid in to_remove:
+                del self.pending_requests[mid]
+
+            reactor.callLater(1, self._cleanupPendingRequests)
+
+
+
[docs]class SMBProtocolFactory(ClientFactory):
+
+    protocol = SMBProtocol
+    log = logging.getLogger('SMB.SMBFactory')
+
+    #: SMB messages will never be signed regardless of remote server's configurations; access errors will occur if the remote server requires signing.
+    SIGN_NEVER = 0
+    #: SMB messages will be signed when remote server supports signing but not requires signing.
+    SIGN_WHEN_SUPPORTED = 1
+    #: SMB messages will only be signed when remote server requires signing.
+    SIGN_WHEN_REQUIRED = 2
+
+
[docs]    def __init__(self, username, password, my_name, remote_name, domain = '', use_ntlm_v2 = True, sign_options = SIGN_WHEN_REQUIRED, is_direct_tcp = False):
+        """
+        Create a new SMBProtocolFactory instance. You will pass this instance to *reactor.connectTCP()* which will then instantiate the TCP connection to the remote SMB/CIFS server.
+        Note that the default TCP port for most SMB/CIFS servers using NetBIOS over TCP/IP is 139.
+        Some newer server installations might also support Direct hosting of SMB over TCP/IP; for these servers, the default TCP port is 445.
+
+        *username* and *password* are the user credentials required to authenticate the underlying SMB connection with the remote server.
+        File operations can only be proceeded after the connection has been authenticated successfully.
+
+        :param string my_name: The local NetBIOS machine name that will identify where this connection is originating from.
+                               You can freely choose a name as long as it contains a maximum of 15 alphanumeric characters and does not contain spaces and any of ``\/:*?";|+``.
+        :param string remote_name: The NetBIOS machine name of the remote server.
+                                   On windows, you can find out the machine name by right-clicking on the "My Computer" and selecting "Properties".
+                                   This parameter must be the same as what has been configured on the remote server, or else the connection will be rejected.
+        :param string domain: The network domain. On windows, it is known as the workgroup. Usually, it is safe to leave this parameter as an empty string.
+        :param boolean use_ntlm_v2: Indicates whether pysmb should be NTLMv1 or NTLMv2 authentication algorithm for authentication.
+                                    The choice of NTLMv1 and NTLMv2 is configured on the remote server, and there is no mechanism to auto-detect which algorithm has been configured.
+                                    Hence, we can only "guess" or try both algorithms.
+                                    On Sambda, Windows Vista and Windows 7, NTLMv2 is enabled by default. On Windows XP, we can use NTLMv1 before NTLMv2.
+        :param int sign_options: Determines whether SMB messages will be signed. Default is *SIGN_WHEN_REQUIRED*.
+                                 If *SIGN_WHEN_REQUIRED* (value=2), SMB messages will only be signed when remote server requires signing.
+                                 If *SIGN_WHEN_SUPPORTED* (value=1), SMB messages will be signed when remote server supports signing but not requires signing.
+                                 If *SIGN_NEVER* (value=0), SMB messages will never be signed regardless of remote server's configurations; access errors will occur if the remote server requires signing.
+        :param boolean is_direct_tcp: Controls whether the NetBIOS over TCP/IP (is_direct_tcp=False) or the newer Direct hosting of SMB over TCP/IP (is_direct_tcp=True) will be used for the communication.
+                                      The default parameter is False which will use NetBIOS over TCP/IP for wider compatibility (TCP port: 139).
+        """
+        self.username = username
+        self.password = password
+        self.my_name = my_name
+        self.remote_name = remote_name
+        self.domain = domain
+        self.use_ntlm_v2 = use_ntlm_v2
+        self.sign_options = sign_options
+        self.is_direct_tcp = is_direct_tcp
+        self.instance = None    #: The single SMBProtocol instance for each SMBProtocolFactory instance. Usually, you should not need to touch this attribute directly.

+
+    #
+    # Public Property
+    #
+
+    @property
+    def isReady(self):
+        """A convenient property to return True if the underlying SMB connection has connected to remote server, has successfully authenticated itself and is ready for file operations."""
+        return bool(self.instance and self.instance.has_authenticated)
+
+    @property
+    def isUsingSMB2(self):
+        """A convenient property to return True if the underlying SMB connection is using SMB2 protocol."""
+        return self.instance and self.instance.is_using_smb2
+
+    #
+    # Public Methods for Callbacks
+    #
+
+
[docs]    def onAuthOK(self):
+        """
+        Override this method in your *SMBProtocolFactory* subclass to add in post-authentication handling.
+        This method will be called when the server has replied that the SMB connection has been successfully authenticated.
+        File operations can proceed when this method has been called.
+        """
+        pass

+
+
[docs]    def onAuthFailed(self):
+        """
+        Override this method in your *SMBProtocolFactory* subclass to add in post-authentication handling.
+        This method will be called when the server has replied that the SMB connection has been successfully authenticated.
+
+        If you want to retry authenticating from this method,
+         1. Disconnect the underlying SMB connection (call ``self.instance.transport.loseConnection()``)
+         2. Create a new SMBProtocolFactory subclass instance with different user credientials or different NTLM algorithm flag.
+         3. Call ``reactor.connectTCP`` with the new instance to re-establish the SMB connection
+        """
+        pass

+
+    #
+    # Public Methods
+    #
+
+
[docs]    def listShares(self, timeout = 30):
+        """
+        Retrieve a list of shared resources on remote server.
+
+        :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.
+        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of :doc:`smb.base.SharedDevice<smb_SharedDevice>` instances.
+        """
+        if not self.instance:
+            raise NotConnectedError('Not connected to server')
+
+        d = defer.Deferred()
+        self.instance._listShares(d.callback, d.errback, timeout)
+        return d

+
+
[docs]    def listPath(self, service_name, path,
+                 search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE,
+                 pattern = '*', timeout = 30):
+        """
+        Retrieve a directory listing of files/folders at *path*
+
+        :param string/unicode service_name: the name of the shared folder for the *path*
+        :param string/unicode path: path relative to the *service_name* where we are interested to learn about its files/sub-folders.
+        :param integer search: integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py).
+                               The default *search* value will query for all read-only, hidden, system, archive files and directories.
+        :param string/unicode pattern: the filter to apply to the results before returning to the client.
+        :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.
+        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of :doc:`smb.base.SharedFile<smb_SharedFile>` instances.
+        """
+        if not self.instance:
+            raise NotConnectedError('Not connected to server')
+
+        d = defer.Deferred()
+        self.instance._listPath(service_name, path, d.callback, d.errback, search = search, pattern = pattern, timeout = timeout)
+        return d

+
+
[docs]    def listSnapshots(self, service_name, path, timeout = 30):
+        """
+        Retrieve a list of available snapshots (a.k.a. shadow copies) for *path*.
+
+        Note that snapshot features are only supported on Windows Vista Business, Enterprise and Ultimate, and on all Windows 7 editions.
+
+        :param string/unicode service_name: the name of the shared folder for the *path*
+        :param string/unicode path: path relative to the *service_name* where we are interested in the list of available snapshots
+        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of python *datetime.DateTime*
+                 instances in GMT/UTC time zone
+        """
+        if not self.instance:
+            raise NotConnectedError('Not connected to server')
+
+        d = defer.Deferred()
+        self.instance._listSnapshots(service_name, path, d.callback, d.errback, timeout = timeout)
+        return d

+
+
[docs]    def getAttributes(self, service_name, path, timeout = 30):
+        """
+        Retrieve information about the file at *path* on the *service_name*.
+
+        :param string/unicode service_name: the name of the shared folder for the *path*
+        :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure<smb_exceptions>` will be raised.
+        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a :doc:`smb.base.SharedFile<smb_SharedFile>` instance containing the attributes of the file.
+        """
+        if not self.instance:
+            raise NotConnectedError('Not connected to server')
+
+        d = defer.Deferred()
+        self.instance._getAttributes(service_name, path, d.callback, d.errback, timeout = timeout)
+        return d

+
+
[docs]    def retrieveFile(self, service_name, path, file_obj, timeout = 30):
+        """
+        Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.
+
+        Use *retrieveFileFromOffset()* method if you need to specify the offset to read from the remote *path* and/or the maximum number of bytes to write to the *file_obj*.
+
+        The meaning of the *timeout* parameter will be different from other file operation methods. As the downloaded file usually exceeeds the maximum size
+        of each SMB/CIFS data message, it will be packetized into a series of request messages (each message will request about about 60kBytes).
+        The *timeout* parameter is an integer/float value that specifies the timeout interval for these individual SMB/CIFS message to be transmitted and downloaded from the remote SMB/CIFS server.
+
+        :param string/unicode service_name: the name of the shared folder for the *path*
+        :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure<smb_exceptions>` will be called in the returned *Deferred* errback.
+        :param file_obj: A file-like object that has a *write* method. Data will be written continuously to *file_obj* until EOF is received from the remote service.
+        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a 3-element tuple of ( *file_obj*, file attributes of the file on server, number of bytes written to *file_obj* ).
+                 The file attributes is an integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py)
+        """
+        return self.retrieveFileFromOffset(service_name, path, file_obj, 0L, -1L, timeout)

+
+
[docs]    def retrieveFileFromOffset(self, service_name, path, file_obj, offset = 0L, max_length = -1L, timeout = 30):
+        """
+        Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.
+
+        The meaning of the *timeout* parameter will be different from other file operation methods. As the downloaded file usually exceeeds the maximum size
+        of each SMB/CIFS data message, it will be packetized into a series of request messages (each message will request about about 60kBytes).
+        The *timeout* parameter is an integer/float value that specifies the timeout interval for these individual SMB/CIFS message to be transmitted and downloaded from the remote SMB/CIFS server.
+
+        :param string/unicode service_name: the name of the shared folder for the *path*
+        :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure<smb_exceptions>` will be called in the returned *Deferred* errback.
+        :param file_obj: A file-like object that has a *write* method. Data will be written continuously to *file_obj* until EOF is received from the remote service.
+        :param integer/long offset: the offset in the remote *path* where the first byte will be read and written to *file_obj*. Must be either zero or a positive integer/long value.
+        :param integer/long max_length: maximum number of bytes to read from the remote *path* and write to the *file_obj*. Specify a negative value to read from *offset* to the EOF.
+                                        If zero, the *Deferred* callback is invoked immediately after the file is opened successfully for reading.
+        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a 3-element tuple of ( *file_obj*, file attributes of the file on server, number of bytes written to *file_obj* ).
+                 The file attributes is an integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py)
+        """
+        if not self.instance:
+            raise NotConnectedError('Not connected to server')
+
+        d = defer.Deferred()
+        self.instance._retrieveFileFromOffset(service_name, path, file_obj, d.callback, d.errback, offset, max_length, timeout = timeout)
+        return d

+
+
[docs]    def storeFile(self, service_name, path, file_obj, timeout = 30):
+        """
+        Store the contents of the *file_obj* at *path* on the *service_name*.
+
+        The meaning of the *timeout* parameter will be different from other file operation methods. As the uploaded file usually exceeeds the maximum size
+        of each SMB/CIFS data message, it will be packetized into a series of messages (usually about 60kBytes).
+        The *timeout* parameter is an integer/float value that specifies the timeout interval for these individual SMB/CIFS message to be transmitted and acknowledged
+        by the remote SMB/CIFS server.
+
+        :param string/unicode service_name: the name of the shared folder for the *path*
+        :param string/unicode path: Path of the file on the remote server. If the file at *path* does not exist, it will be created. Otherwise, it will be overwritten.
+                                    If the *path* refers to a folder or the file cannot be opened for writing, an :doc:`OperationFailure<smb_exceptions>` will be called in the returned *Deferred* errback.
+        :param file_obj: A file-like object that has a *read* method. Data will read continuously from *file_obj* until EOF.
+        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a 2-element tuple of ( *file_obj*, number of bytes uploaded ).
+        """
+        if not self.instance:
+            raise NotConnectedError('Not connected to server')
+
+        d = defer.Deferred()
+        self.instance._storeFile(service_name, path, file_obj, d.callback, d.errback, timeout = timeout)
+        return d

+
+
[docs]    def deleteFiles(self, service_name, path_file_pattern, timeout = 30):
+        """
+        Delete one or more regular files. It supports the use of wildcards in file names, allowing for deletion of multiple files in a single request.
+
+        :param string/unicode service_name: Contains the name of the shared folder.
+        :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name.
+                                                 Wildcards may be used in th filename component of the path.
+                                                 If your path/filename contains non-English characters, you must pass in an unicode string.
+        :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.
+        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with the *path_file_pattern* parameter.
+        """
+        if not self.instance:
+            raise NotConnectedError('Not connected to server')
+
+        d = defer.Deferred()
+        self.instance._deleteFiles(service_name, path_file_pattern, d.callback, d.errback, timeout = timeout)
+        return d

+
+
[docs]    def createDirectory(self, service_name, path):
+        """
+        Creates a new directory *path* on the *service_name*.
+
+        :param string/unicode service_name: Contains the name of the shared folder.
+        :param string/unicode path: The path of the new folder (relative to) the shared folder.
+                                    If the path contains non-English characters, an unicode string must be used to pass in the path.
+        :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.
+        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with the *path* parameter.
+        """
+        if not self.instance:
+            raise NotConnectedError('Not connected to server')
+
+        d = defer.Deferred()
+        self.instance._createDirectory(service_name, path, d.callback, d.errback)
+        return d

+
+
[docs]    def deleteDirectory(self, service_name, path):
+        """
+        Delete the empty folder at *path* on *service_name*
+
+        :param string/unicode service_name: Contains the name of the shared folder.
+        :param string/unicode path: The path of the to-be-deleted folder (relative to) the shared folder.
+                                    If the path contains non-English characters, an unicode string must be used to pass in the path.
+        :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.
+        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with the *path* parameter.
+        """
+        if not self.instance:
+            raise NotConnectedError('Not connected to server')
+
+        d = defer.Deferred()
+        self.instance._deleteDirectory(service_name, path, d.callback, d.errback)
+        return d

+
+
[docs]    def rename(self, service_name, old_path, new_path):
+        """
+        Rename a file or folder at *old_path* to *new_path* shared at *service_name*. Note that this method cannot be used to rename file/folder across different shared folders
+
+        *old_path* and *new_path* are string/unicode referring to the old and new path of the renamed resources (relative to) the shared folder.
+        If the path contains non-English characters, an unicode string must be used to pass in the path.
+
+        :param string/unicode service_name: Contains the name of the shared folder.
+        :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.
+        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a 2-element tuple of ( *old_path*, *new_path* ).
+        """
+        if not self.instance:
+            raise NotConnectedError('Not connected to server')
+
+        d = defer.Deferred()
+        self.instance._rename(service_name, old_path, new_path, d.callback, d.errback)
+        return d

+
+
[docs]    def echo(self, data, timeout = 10):
+        """
+        Send an echo command containing *data* to the remote SMB/CIFS server. The remote SMB/CIFS will reply with the same *data*.
+
+        :param string data: Data to send to the remote server.
+        :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.
+        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with the *data* parameter.
+        """
+        if not self.instance:
+            raise NotConnectedError('Not connected to server')
+
+        d = defer.Deferred()
+        self.instance._echo(data, d.callback, d.errback, timeout)
+        return d

+
+
[docs]    def closeConnection(self):
+        """
+        Disconnect from the remote SMB/CIFS server. The TCP connection will be closed at the earliest opportunity after this method returns.
+
+        :return: None
+        """
+        if not self.instance:
+            raise NotConnectedError('Not connected to server')
+
+        self.instance.transport.loseConnection()

+
+    #
+    # ClientFactory methods
+    # (Do not touch these unless you know what you are doing)
+    #
+
+    def buildProtocol(self, addr):
+        p = self.protocol(self.username, self.password, self.my_name, self.remote_name, self.domain, self.use_ntlm_v2, self.sign_options, self.is_direct_tcp)
+        p.factory = self
+        return p

+
+ +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/html/_modules/smb/base.html b/docs/html/_modules/smb/base.html new file mode 100644 index 0000000..9b94c8d --- /dev/null +++ b/docs/html/_modules/smb/base.html @@ -0,0 +1,2746 @@ + + + + + + + + smb.base — pysmb 1.1.18 documentation + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for smb.base

+
+import logging, binascii, time, hmac
+from datetime import datetime
+from smb_constants import *
+from smb2_constants import *
+from smb_structs import *
+from smb2_structs import *
+from nmb.base import NMBSession
+from utils import convertFILETIMEtoEpoch
+import ntlm, securityblob
+
+try:
+    import hashlib
+    sha256 = hashlib.sha256
+except ImportError:
+    from utils import sha256
+
+
+
[docs]class NotReadyError(Exception):
+    """Raised when SMB connection is not ready (i.e. not authenticated or authentication failed)"""
+    pass

+
+
[docs]class NotConnectedError(Exception):
+    """Raised when underlying SMB connection has been disconnected or not connected yet"""
+    pass

+
+
[docs]class SMBTimeout(Exception):
+    """Raised when a timeout has occurred while waiting for a response or for a SMB/CIFS operation to complete."""
+    pass

+
+
+def _convert_to_unicode(string):
+    if not isinstance(string, unicode):
+        string = unicode(string, "utf-8")
+    return string
+
+
+class SMB(NMBSession):
+    """
+    This class represents a "connection" to the remote SMB/CIFS server.
+    It is not meant to be used directly in an application as it does not have any network transport implementations.
+
+    For application use, please refer to
+      - L{SMBProtocol.SMBProtocolFactory<smb.SMBProtocol>} if you are using Twisted framework
+
+    In [MS-CIFS], this class will contain attributes of Client, Client.Connection and Client.Session abstract data models.
+
+    References:
+    ===========
+      - [MS-CIFS]: 3.2.1
+    """
+
+    log = logging.getLogger('SMB.SMB')
+
+    SIGN_NEVER = 0
+    SIGN_WHEN_SUPPORTED = 1
+    SIGN_WHEN_REQUIRED = 2
+
+    def __init__(self, username, password, my_name, remote_name, domain = '', use_ntlm_v2 = True, sign_options = SIGN_WHEN_REQUIRED, is_direct_tcp = False):
+        NMBSession.__init__(self, my_name, remote_name, is_direct_tcp = is_direct_tcp)
+        self.username = _convert_to_unicode(username)
+        self.password = _convert_to_unicode(password)
+        self.domain = _convert_to_unicode(domain)
+        self.sign_options = sign_options
+        self.is_direct_tcp = is_direct_tcp
+        self.use_ntlm_v2 = use_ntlm_v2 #: Similar to LMAuthenticationPolicy and NTAuthenticationPolicy as described in [MS-CIFS] 3.2.1.1
+        self.smb_message = SMBMessage()
+        self.is_using_smb2 = False   #: Are we communicating using SMB2 protocol? self.smb_message will be a SMB2Message instance if this flag is True
+        self.pending_requests = { }  #: MID mapped to _PendingRequest instance
+        self.connected_trees = { }   #: Share name mapped to TID
+        self.next_rpc_call_id = 1    #: Next RPC callID value. Not used directly in SMB message. Usually encapsulated in sub-commands under SMB_COM_TRANSACTION or SMB_COM_TRANSACTION2 messages
+
+        self.has_negotiated = False
+        self.has_authenticated = False
+        self.is_signing_active = False           #: True if the remote server accepts message signing. All outgoing messages will be signed. Simiar to IsSigningActive as described in [MS-CIFS] 3.2.1.2
+        self.signing_session_key = None          #: Session key for signing packets, if signing is active. Similar to SigningSessionKey as described in [MS-CIFS] 3.2.1.2
+        self.signing_challenge_response = None   #: Contains the challenge response for signing, if signing is active. Similar to SigningChallengeResponse as described in [MS-CIFS] 3.2.1.2
+        self.mid = 0
+        self.uid = 0
+        self.next_signing_id = 2     #: Similar to ClientNextSendSequenceNumber as described in [MS-CIFS] 3.2.1.2
+
+        # SMB1 and SMB2 attributes
+        # Note that the interpretations of the values may differ between SMB1 and SMB2 protocols
+        self.capabilities = 0
+        self.security_mode = 0     #: Initialized from the SecurityMode field of the SMB_COM_NEGOTIATE message
+
+        # SMB1 attributes
+        # Most of the following attributes will be initialized upon receipt of SMB_COM_NEGOTIATE message from server (via self._updateServerInfo_SMB1 method)
+        self.use_plaintext_authentication = False  #: Similar to PlaintextAuthenticationPolicy in in [MS-CIFS] 3.2.1.1
+        self.max_raw_size = 0
+        self.max_buffer_size = 0   #: Similar to MaxBufferSize as described in [MS-CIFS] 3.2.1.1
+        self.max_mpx_count = 0     #: Similar to MaxMpxCount as described in [MS-CIFS] 3.2.1.1
+
+        # SMB2 attributes
+        self.max_read_size = 0      #: Similar to MaxReadSize as described in [MS-SMB2] 2.2.4
+        self.max_write_size = 0     #: Similar to MaxWriteSize as described in [MS-SMB2] 2.2.4
+        self.max_transact_size = 0  #: Similar to MaxTransactSize as described in [MS-SMB2] 2.2.4
+        self.session_id = 0         #: Similar to SessionID as described in [MS-SMB2] 2.2.4. This will be set in _updateState_SMB2 method
+
+        self._setupSMB1Methods()
+
+        self.log.info('Authentication with remote machine "%s" for user "%s" will be using NTLM %s authentication (%s extended security)',
+                      self.remote_name, self.username,
+                      (self.use_ntlm_v2 and 'v2') or 'v1',
+                      (SUPPORT_EXTENDED_SECURITY and 'with') or 'without')
+
+
+    #
+    # NMBSession Methods
+    #
+
+    def onNMBSessionOK(self):
+        self._sendSMBMessage(SMBMessage(ComNegotiateRequest()))
+
+    def onNMBSessionFailed(self):
+        pass
+
+    def onNMBSessionMessage(self, flags, data):
+        while True:
+            try:
+                i = self.smb_message.decode(data)
+            except SMB2ProtocolHeaderError:
+                self.log.info('Now switching over to SMB2 protocol communication')
+                self.is_using_smb2 = True
+                self.mid = 0  # Must reset messageID counter, or else remote SMB2 server will disconnect
+                self._setupSMB2Methods()
+                self.smb_message = self._klassSMBMessage()
+                i = self.smb_message.decode(data)
+
+            next_message_offset = 0
+            if self.is_using_smb2:
+                next_message_offset = self.smb_message.next_command_offset
+
+            if i > 0:
+                if not self.is_using_smb2:
+                    self.log.debug('Received SMB message "%s" (command:0x%2X flags:0x%02X flags2:0x%04X TID:%d UID:%d)',
+                                   SMB_COMMAND_NAMES.get(self.smb_message.command, '<unknown>'),
+                                   self.smb_message.command, self.smb_message.flags, self.smb_message.flags2, self.smb_message.tid, self.smb_message.uid)
+                else:
+                    self.log.debug('Received SMB2 message "%s" (command:0x%04X flags:0x%04x)',
+                                   SMB2_COMMAND_NAMES.get(self.smb_message.command, '<unknown>'),
+                                   self.smb_message.command, self.smb_message.flags)
+                if self._updateState(self.smb_message):
+                    # We need to create a new instance instead of calling reset() because the instance could be captured in the message history.
+                    self.smb_message = self._klassSMBMessage()
+
+            if next_message_offset > 0:
+                data = data[next_message_offset:]
+            else:
+                break
+
+    #
+    # Public Methods for Overriding in Subclasses
+    #
+
+    def onAuthOK(self):
+        pass
+
+    def onAuthFailed(self):
+        pass
+
+    #
+    # Protected Methods
+    #
+
+    def _setupSMB1Methods(self):
+        self._klassSMBMessage = SMBMessage
+        self._updateState = self._updateState_SMB1
+        self._updateServerInfo = self._updateServerInfo_SMB1
+        self._handleNegotiateResponse = self._handleNegotiateResponse_SMB1
+        self._sendSMBMessage = self._sendSMBMessage_SMB1
+        self._handleSessionChallenge = self._handleSessionChallenge_SMB1
+        self._listShares = self._listShares_SMB1
+        self._listPath = self._listPath_SMB1
+        self._listSnapshots = self._listSnapshots_SMB1
+        self._getAttributes = self._getAttributes_SMB1
+        self._retrieveFile = self._retrieveFile_SMB1
+        self._retrieveFileFromOffset = self._retrieveFileFromOffset_SMB1
+        self._storeFile = self._storeFile_SMB1
+        self._storeFileFromOffset = self._storeFileFromOffset_SMB1
+        self._deleteFiles = self._deleteFiles_SMB1
+        self._resetFileAttributes = self._resetFileAttributes_SMB1
+        self._createDirectory = self._createDirectory_SMB1
+        self._deleteDirectory = self._deleteDirectory_SMB1
+        self._rename = self._rename_SMB1
+        self._echo = self._echo_SMB1
+
+    def _setupSMB2Methods(self):
+        self._klassSMBMessage = SMB2Message
+        self._updateState = self._updateState_SMB2
+        self._updateServerInfo = self._updateServerInfo_SMB2
+        self._handleNegotiateResponse = self._handleNegotiateResponse_SMB2
+        self._sendSMBMessage = self._sendSMBMessage_SMB2
+        self._handleSessionChallenge = self._handleSessionChallenge_SMB2
+        self._listShares = self._listShares_SMB2
+        self._listPath = self._listPath_SMB2
+        self._listSnapshots = self._listSnapshots_SMB2
+        self._getAttributes = self._getAttributes_SMB2
+        self._retrieveFile = self._retrieveFile_SMB2
+        self._retrieveFileFromOffset = self._retrieveFileFromOffset_SMB2
+        self._storeFile = self._storeFile_SMB2
+        self._storeFileFromOffset = self._storeFileFromOffset_SMB2
+        self._deleteFiles = self._deleteFiles_SMB2
+        self._resetFileAttributes = self._resetFileAttributes_SMB2
+        self._createDirectory = self._createDirectory_SMB2
+        self._deleteDirectory = self._deleteDirectory_SMB2
+        self._rename = self._rename_SMB2
+        self._echo = self._echo_SMB2
+
+    def _getNextRPCCallID(self):
+        self.next_rpc_call_id += 1
+        return self.next_rpc_call_id
+
+    #
+    # SMB2 Methods Family
+    #
+
+    def _sendSMBMessage_SMB2(self, smb_message):
+        if smb_message.mid == 0:
+            smb_message.mid = self._getNextMID_SMB2()
+
+        if smb_message.command != SMB2_COM_NEGOTIATE and smb_message.command != SMB2_COM_ECHO:
+            smb_message.session_id = self.session_id
+
+        if self.is_signing_active:
+            smb_message.flags |= SMB2_FLAGS_SIGNED
+            raw_data = smb_message.encode()
+            smb_message.signature = hmac.new(self.signing_session_key, raw_data, sha256).digest()[:16]
+
+            smb_message.raw_data = smb_message.encode()
+            self.log.debug('MID is %d. Signature is %s. Total raw message is %d bytes', smb_message.mid, binascii.hexlify(smb_message.signature), len(smb_message.raw_data))
+        else:
+            smb_message.raw_data = smb_message.encode()
+        self.sendNMBMessage(smb_message.raw_data)
+
+    def _getNextMID_SMB2(self):
+        self.mid += 1
+        return self.mid
+
+    def _updateState_SMB2(self, message):
+        if message.isReply:
+            if message.command == SMB2_COM_NEGOTIATE:
+                if message.status == 0:
+                    self.has_negotiated = True
+                    self.log.info('SMB2 dialect negotiation successful')
+                    self._updateServerInfo(message.payload)
+                    self._handleNegotiateResponse(message)
+                else:
+                    raise ProtocolError('Unknown status value (0x%08X) in SMB2_COM_NEGOTIATE' % message.status,
+                                        message.raw_data, message)
+            elif message.command == SMB2_COM_SESSION_SETUP:
+                if message.status == 0:
+                    self.session_id = message.session_id
+                    try:
+                        result = securityblob.decodeAuthResponseSecurityBlob(message.payload.security_blob)
+                        if result == securityblob.RESULT_ACCEPT_COMPLETED:
+                            self.has_authenticated = True
+                            self.log.info('Authentication (on SMB2) successful!')
+                            self.onAuthOK()
+                        else:
+                            raise ProtocolError('SMB2_COM_SESSION_SETUP status is 0 but security blob negResult value is %d' % result, message.raw_data, message)
+                    except securityblob.BadSecurityBlobError, ex:
+                        raise ProtocolError(str(ex), message.raw_data, message)
+                elif message.status == 0xc0000016:  # STATUS_MORE_PROCESSING_REQUIRED
+                    self.session_id = message.session_id
+                    try:
+                        result, ntlm_token = securityblob.decodeChallengeSecurityBlob(message.payload.security_blob)
+                        if result == securityblob.RESULT_ACCEPT_INCOMPLETE:
+                            self._handleSessionChallenge(message, ntlm_token)
+                    except ( securityblob.BadSecurityBlobError, securityblob.UnsupportedSecurityProvider ), ex:
+                        raise ProtocolError(str(ex), message.raw_data, message)
+                elif message.status == 0xc000006d:  # STATUS_LOGON_FAILURE
+                    self.has_authenticated = False
+                    self.log.info('Authentication (on SMB2) failed. Please check username and password.')
+                    self.onAuthFailed()
+                else:
+                    raise ProtocolError('Unknown status value (0x%08X) in SMB_COM_SESSION_SETUP_ANDX (with extended security)' % message.status,
+                                        message.raw_data, message)
+
+            req = self.pending_requests.pop(message.mid, None)
+            if req:
+                req.callback(message, **req.kwargs)
+                return True
+
+
+    def _updateServerInfo_SMB2(self, payload):
+        self.capabilities = payload.capabilities
+        self.security_mode = payload.security_mode
+        self.max_transact_size = payload.max_transact_size
+        self.max_read_size = payload.max_read_size
+        self.max_write_size = payload.max_write_size
+        self.use_plaintext_authentication = False   # SMB2 never allows plaintext authentication
+
+
+    def _handleNegotiateResponse_SMB2(self, message):
+        ntlm_data = ntlm.generateNegotiateMessage()
+        blob = securityblob.generateNegotiateSecurityBlob(ntlm_data)
+        self._sendSMBMessage(SMB2Message(SMB2SessionSetupRequest(blob)))
+
+
+    def _handleSessionChallenge_SMB2(self, message, ntlm_token):
+        server_challenge, server_flags, server_info = ntlm.decodeChallengeMessage(ntlm_token)
+
+        self.log.info('Performing NTLMv2 authentication (on SMB2) with server challenge "%s"', binascii.hexlify(server_challenge))
+
+        if self.use_ntlm_v2:
+            self.log.info('Performing NTLMv2 authentication (on SMB2) with server challenge "%s"', binascii.hexlify(server_challenge))
+            nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV2(self.password,
+                                                                                                         self.username,
+                                                                                                         server_challenge,
+                                                                                                         server_info,
+                                                                                                         self.domain)
+
+        else:
+            self.log.info('Performing NTLMv1 authentication (on SMB2) with server challenge "%s"', binascii.hexlify(server_challenge))
+            nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV1(self.password, server_challenge, True)
+
+        ntlm_data = ntlm.generateAuthenticateMessage(server_flags,
+                                                     nt_challenge_response,
+                                                     lm_challenge_response,
+                                                     session_key,
+                                                     self.username,
+                                                     self.domain)
+
+        if self.log.isEnabledFor(logging.DEBUG):
+            self.log.debug('NT challenge response is "%s" (%d bytes)', binascii.hexlify(nt_challenge_response), len(nt_challenge_response))
+            self.log.debug('LM challenge response is "%s" (%d bytes)', binascii.hexlify(lm_challenge_response), len(lm_challenge_response))
+
+        blob = securityblob.generateAuthSecurityBlob(ntlm_data)
+        self._sendSMBMessage(SMB2Message(SMB2SessionSetupRequest(blob)))
+
+        if self.security_mode & SMB2_NEGOTIATE_SIGNING_REQUIRED:
+            self.log.info('Server requires all SMB messages to be signed')
+            self.is_signing_active = (self.sign_options != SMB.SIGN_NEVER)
+        elif self.security_mode & SMB2_NEGOTIATE_SIGNING_ENABLED:
+            self.log.info('Server supports SMB signing')
+            self.is_signing_active = (self.sign_options == SMB.SIGN_WHEN_SUPPORTED)
+        else:
+            self.is_signing_active = False
+
+        if self.is_signing_active:
+            self.log.info("SMB signing activated. All SMB messages will be signed.")
+            self.signing_session_key = (session_key + '\0'*16)[:16]
+            if self.capabilities & CAP_EXTENDED_SECURITY:
+                self.signing_challenge_response = None
+            else:
+                self.signing_challenge_response = blob
+        else:
+            self.log.info("SMB signing deactivated. SMB messages will NOT be signed.")
+
+
+    def _listShares_SMB2(self, callback, errback, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        expiry_time = time.time() + timeout
+        path = 'IPC$'
+        messages_history = [ ]
+
+        def connectSrvSvc(tid):
+            m = SMB2Message(SMB2CreateRequest('srvsvc',
+                                              file_attributes = 0,
+                                              access_mask = FILE_READ_DATA | FILE_WRITE_DATA | FILE_APPEND_DATA | FILE_READ_EA | FILE_WRITE_EA | READ_CONTROL | FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | SYNCHRONIZE,
+                                              share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
+                                              oplock = SMB2_OPLOCK_LEVEL_NONE,
+                                              impersonation = SEC_IMPERSONATE,
+                                              create_options = FILE_NON_DIRECTORY_FILE | FILE_OPEN_NO_RECALL,
+                                              create_disp = FILE_OPEN))
+
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectSrvSvcCB, errback)
+            messages_history.append(m)
+
+        def connectSrvSvcCB(create_message, **kwargs):
+            messages_history.append(create_message)
+            if create_message.status == 0:
+                call_id = self._getNextRPCCallID()
+                # The data_bytes are binding call to Server Service RPC using DCE v1.1 RPC over SMB. See [MS-SRVS] and [C706]
+                # If you wish to understand the meanings of the byte stream, I would suggest you use a recent version of WireShark to packet capture the stream
+                data_bytes = \
+                    binascii.unhexlify("""05 00 0b 03 10 00 00 00 74 00 00 00""".replace(' ', '')) + \
+                    struct.pack('<I', call_id) + \
+                    binascii.unhexlify("""
+b8 10 b8 10 00 00 00 00 02 00 00 00 00 00 01 00
+c8 4f 32 4b 70 16 d3 01 12 78 5a 47 bf 6e e1 88
+03 00 00 00 04 5d 88 8a eb 1c c9 11 9f e8 08 00
+2b 10 48 60 02 00 00 00 01 00 01 00 c8 4f 32 4b
+70 16 d3 01 12 78 5a 47 bf 6e e1 88 03 00 00 00
+2c 1c b7 6c 12 98 40 45 03 00 00 00 00 00 00 00
+01 00 00 00
+""".replace(' ', '').replace('\n', ''))
+                m = SMB2Message(SMB2WriteRequest(create_message.payload.fid, data_bytes, 0))
+                m.tid = create_message.tid
+                self._sendSMBMessage(m)
+                self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, rpcBindCB, errback, fid = create_message.payload.fid)
+                messages_history.append(m)
+            else:
+                errback(OperationFailure('Failed to list shares: Unable to locate Server Service RPC endpoint', messages_history))
+
+        def rpcBindCB(trans_message, **kwargs):
+            messages_history.append(trans_message)
+            if trans_message.status == 0:
+                m = SMB2Message(SMB2ReadRequest(kwargs['fid'], read_len = 1024, read_offset = 0))
+                m.tid = trans_message.tid
+                self._sendSMBMessage(m)
+                self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, rpcReadCB, errback, fid = kwargs['fid'])
+                messages_history.append(m)
+            else:
+                closeFid(trans_message.tid, kwargs['fid'], error = 'Failed to list shares: Unable to read from Server Service RPC endpoint')
+
+        def rpcReadCB(read_message, **kwargs):
+            messages_history.append(read_message)
+            if read_message.status == 0:
+                call_id = self._getNextRPCCallID()
+
+                padding = ''
+                remote_name = '\\\\' + self.remote_name
+                server_len = len(remote_name) + 1
+                server_bytes_len = server_len * 2
+                if server_len % 2 != 0:
+                    padding = '\0\0'
+                    server_bytes_len += 2
+
+                # The data bytes are the RPC call to NetrShareEnum (Opnum 15) at Server Service RPC.
+                # If you wish to understand the meanings of the byte stream, I would suggest you use a recent version of WireShark to packet capture the stream
+                data_bytes = \
+                    binascii.unhexlify("""05 00 00 03 10 00 00 00""".replace(' ', '')) + \
+                    struct.pack('<HHI', 72+server_bytes_len, 0, call_id) + \
+                    binascii.unhexlify("""4c 00 00 00 00 00 0f 00 00 00 02 00""".replace(' ', '')) + \
+                    struct.pack('<III', server_len, 0, server_len) + \
+                    (remote_name + '\0').encode('UTF-16LE') + padding + \
+                    binascii.unhexlify("""
+01 00 00 00 01 00 00 00 04 00 02 00 00 00 00 00
+00 00 00 00 ff ff ff ff 08 00 02 00 00 00 00 00
+""".replace(' ', '').replace('\n', ''))
+                m = SMB2Message(SMB2IoctlRequest(kwargs['fid'], 0x0011C017, flags = 0x01, max_out_size = 8196, in_data = data_bytes))
+                m.tid = read_message.tid
+                self._sendSMBMessage(m)
+                self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, listShareResultsCB, errback, fid = kwargs['fid'])
+                messages_history.append(m)
+            else:
+                closeFid(read_message.tid, kwargs['fid'], error = 'Failed to list shares: Unable to bind to Server Service RPC endpoint')
+
+        def listShareResultsCB(result_message, **kwargs):
+            messages_history.append(result_message)
+            if result_message.status == 0:
+                # The payload.data_bytes will contain the results of the RPC call to NetrShareEnum (Opnum 15) at Server Service RPC.
+                data_bytes = result_message.payload.out_data
+
+                if ord(data_bytes[3]) & 0x02 == 0:
+                    sendReadRequest(result_message.tid, kwargs['fid'], data_bytes)
+                else:
+                    decodeResults(result_message.tid, kwargs['fid'], data_bytes)
+            elif result_message.status == 0x0103:   # STATUS_PENDING
+                self.pending_requests[result_message.mid] = _PendingRequest(result_message.mid, expiry_time, listShareResultsCB, errback, fid = kwargs['fid'])
+            else:
+                closeFid(result_message.tid, kwargs['fid'])
+                errback(OperationFailure('Failed to list shares: Unable to retrieve shared device list', messages_history))
+
+        def decodeResults(tid, fid, data_bytes):
+            shares_count = struct.unpack('<I', data_bytes[36:40])[0]
+            results = [ ]     # A list of SharedDevice instances
+            offset = 36 + 12  # You need to study the byte stream to understand the meaning of these constants
+            for i in range(0, shares_count):
+                results.append(SharedDevice(struct.unpack('<I', data_bytes[offset+4:offset+8])[0], None, None))
+                offset += 12
+
+            for i in range(0, shares_count):
+                max_length, _, length = struct.unpack('<III', data_bytes[offset:offset+12])
+                offset += 12
+                results[i].name = unicode(data_bytes[offset:offset+length*2-2], 'UTF-16LE')
+
+                if length % 2 != 0:
+                    offset += (length * 2 + 2)
+                else:
+                    offset += (length * 2)
+
+                max_length, _, length = struct.unpack('<III', data_bytes[offset:offset+12])
+                offset += 12
+                results[i].comments = unicode(data_bytes[offset:offset+length*2-2], 'UTF-16LE')
+
+                if length % 2 != 0:
+                    offset += (length * 2 + 2)
+                else:
+                    offset += (length * 2)
+
+            closeFid(tid, fid)
+            callback(results)
+
+        def sendReadRequest(tid, fid, data_bytes):
+            read_count = min(4280, self.max_read_size)
+            m = SMB2Message(SMB2ReadRequest(fid, 0, read_count))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, readCB, errback,
+                                                           fid = fid, data_bytes = data_bytes)
+
+        def readCB(read_message, **kwargs):
+            messages_history.append(read_message)
+            if read_message.status == 0:
+                data_len = read_message.payload.data_length
+                data_bytes = read_message.payload.data
+
+                if ord(data_bytes[3]) & 0x02 == 0:
+                    sendReadRequest(read_message.tid, kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:data_len-24])
+                else:
+                    decodeResults(read_message.tid, kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:data_len-24])
+            else:
+                closeFid(read_message.tid, kwargs['fid'])
+                errback(OperationFailure('Failed to list shares: Unable to retrieve shared device list', messages_history))
+
+        def closeFid(tid, fid, results = None, error = None):
+            m = SMB2Message(SMB2CloseRequest(fid))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, results = results, error = error)
+            messages_history.append(m)
+
+        def closeCB(close_message, **kwargs):
+            if kwargs['results'] is not None:
+                callback(kwargs['results'])
+            elif kwargs['error'] is not None:
+                errback(OperationFailure(kwargs['error'], messages_history))
+
+        if not self.connected_trees.has_key(path):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if connect_message.status == 0:
+                    self.connected_trees[path] = connect_message.tid
+                    connectSrvSvc(connect_message.tid)
+                else:
+                    errback(OperationFailure('Failed to list shares: Unable to connect to IPC$', messages_history))
+
+            m = SMB2Message(SMB2TreeConnectRequest(r'\\%s\%s' % ( self.remote_name.upper(), path )))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = path)
+            messages_history.append(m)
+        else:
+            connectSrvSvc(self.connected_trees[path])
+
+    def _listPath_SMB2(self, service_name, path, callback, errback, search, pattern, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        expiry_time = time.time() + timeout
+        path = path.replace('/', '\\')
+        if path.startswith('\\'):
+            path = path[1:]
+        if path.endswith('\\'):
+            path = path[:-1]
+        messages_history = [ ]
+        results = [ ]
+
+        def sendCreate(tid):
+            create_context_data = binascii.unhexlify("""
+28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00
+44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00
+00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00
+00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00
+00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00
+51 46 69 64 00 00 00 00
+""".replace(' ', '').replace('\n', ''))
+            m = SMB2Message(SMB2CreateRequest(path,
+                                              file_attributes = 0,
+                                              access_mask = FILE_READ_DATA | FILE_READ_EA | FILE_READ_ATTRIBUTES | SYNCHRONIZE,
+                                              share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
+                                              oplock = SMB2_OPLOCK_LEVEL_NONE,
+                                              impersonation = SEC_IMPERSONATE,
+                                              create_options = FILE_DIRECTORY_FILE,
+                                              create_disp = FILE_OPEN,
+                                              create_context_data = create_context_data))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback)
+            messages_history.append(m)
+
+        def createCB(create_message, **kwargs):
+            messages_history.append(create_message)
+            if create_message.status == 0:
+                sendQuery(create_message.tid, create_message.payload.fid, '')
+            else:
+                errback(OperationFailure('Failed to list %s on %s: Unable to open directory' % ( path, service_name ), messages_history))
+
+        def sendQuery(tid, fid, data_buf):
+            m = SMB2Message(SMB2QueryDirectoryRequest(fid, pattern,
+                                                      info_class = 0x03,   # FileBothDirectoryInformation
+                                                      flags = 0,
+                                                      output_buf_len = self.max_transact_size))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, queryCB, errback, fid = fid, data_buf = data_buf)
+            messages_history.append(m)
+
+        def queryCB(query_message, **kwargs):
+            messages_history.append(query_message)
+            if query_message.status == 0:
+                data_buf = decodeQueryStruct(kwargs['data_buf'] + query_message.payload.data)
+                sendQuery(query_message.tid, kwargs['fid'], data_buf)
+            elif query_message.status == 0x80000006L:  # STATUS_NO_MORE_FILES
+                closeFid(query_message.tid, kwargs['fid'], results = results)
+            else:
+                closeFid(query_message.tid, kwargs['fid'], error = query_message.status)
+
+        def decodeQueryStruct(data_bytes):
+            # SMB_FIND_FILE_BOTH_DIRECTORY_INFO structure. See [MS-CIFS]: 2.2.8.1.7 and [MS-SMB]: 2.2.8.1.1
+            info_format = '<IIQQQQQQIIIBB24s'
+            info_size = struct.calcsize(info_format)
+
+            data_length = len(data_bytes)
+            offset = 0
+            while offset < data_length:
+                if offset + info_size > data_length:
+                    return data_bytes[offset:]
+
+                next_offset, _, \
+                create_time, last_access_time, last_write_time, last_attr_change_time, \
+                file_size, alloc_size, file_attributes, filename_length, ea_size, \
+                short_name_length, _, short_name = struct.unpack(info_format, data_bytes[offset:offset+info_size])
+
+                offset2 = offset + info_size
+                if offset2 + filename_length > data_length:
+                    return data_bytes[offset:]
+
+                filename = data_bytes[offset2:offset2+filename_length].decode('UTF-16LE')
+                short_name = short_name.decode('UTF-16LE')
+                results.append(SharedFile(convertFILETIMEtoEpoch(create_time), convertFILETIMEtoEpoch(last_access_time),
+                                          convertFILETIMEtoEpoch(last_write_time), convertFILETIMEtoEpoch(last_attr_change_time),
+                                          file_size, alloc_size, file_attributes, short_name, filename))
+
+                if next_offset:
+                    offset += next_offset
+                else:
+                    break
+            return ''
+
+        def closeFid(tid, fid, results = None, error = None):
+            m = SMB2Message(SMB2CloseRequest(fid))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, results = results, error = error)
+            messages_history.append(m)
+
+        def closeCB(close_message, **kwargs):
+            if kwargs['results'] is not None:
+                callback(kwargs['results'])
+            elif kwargs['error'] is not None:
+                errback(OperationFailure('Failed to list %s on %s: Query failed with errorcode 0x%08x' % ( path, service_name, kwargs['error'] ), messages_history))
+
+        if not self.connected_trees.has_key(service_name):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if connect_message.status == 0:
+                    self.connected_trees[service_name] = connect_message.tid
+                    sendCreate(connect_message.tid)
+                else:
+                    errback(OperationFailure('Failed to list %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))
+
+            m = SMB2Message(SMB2TreeConnectRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name )))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)
+            messages_history.append(m)
+        else:
+            sendCreate(self.connected_trees[service_name])
+
+    def _getAttributes_SMB2(self, service_name, path, callback, errback, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        expiry_time = time.time() + timeout
+        path = path.replace('/', '\\')
+        if path.startswith('\\'):
+            path = path[1:]
+        if path.endswith('\\'):
+            path = path[:-1]
+        messages_history = [ ]
+
+        def sendCreate(tid):
+            create_context_data = binascii.unhexlify("""
+28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00
+44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00
+00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00
+00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00
+00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00
+51 46 69 64 00 00 00 00
+""".replace(' ', '').replace('\n', ''))
+            m = SMB2Message(SMB2CreateRequest(path,
+                                              file_attributes = 0,
+                                              access_mask = FILE_READ_DATA | FILE_READ_EA | FILE_READ_ATTRIBUTES | SYNCHRONIZE,
+                                              share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
+                                              oplock = SMB2_OPLOCK_LEVEL_NONE,
+                                              impersonation = SEC_IMPERSONATE,
+                                              create_options = 0,
+                                              create_disp = FILE_OPEN,
+                                              create_context_data = create_context_data))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback)
+            messages_history.append(m)
+
+        def createCB(create_message, **kwargs):
+            messages_history.append(create_message)
+            if create_message.status == 0:
+                p = create_message.payload
+                info = SharedFile(p.create_time, p.lastaccess_time, p.lastwrite_time, p.change_time,
+                                  p.file_size, p.allocation_size, p.file_attributes,
+                                  unicode(path), unicode(path))
+                closeFid(create_message.tid, p.fid, info = info)
+            else:
+                errback(OperationFailure('Failed to get attributes for %s on %s: Unable to open remote file object' % ( path, service_name ), messages_history))
+
+        def closeFid(tid, fid, info = None, error = None):
+            m = SMB2Message(SMB2CloseRequest(fid))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, info = info, error = error)
+            messages_history.append(m)
+
+        def closeCB(close_message, **kwargs):
+            if kwargs['info'] is not None:
+                callback(kwargs['info'])
+            elif kwargs['error'] is not None:
+                errback(OperationFailure('Failed to get attributes for %s on %s: Query failed with errorcode 0x%08x' % ( path, service_name, kwargs['error'] ), messages_history))
+
+        if not self.connected_trees.has_key(service_name):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if connect_message.status == 0:
+                    self.connected_trees[service_name] = connect_message.tid
+                    sendCreate(connect_message.tid)
+                else:
+                    errback(OperationFailure('Failed to get attributes for %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))
+
+            m = SMB2Message(SMB2TreeConnectRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name )))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)
+            messages_history.append(m)
+        else:
+            sendCreate(self.connected_trees[service_name])
+
+    def _retrieveFile_SMB2(self, service_name, path, file_obj, callback, errback, timeout = 30):
+        return self._retrieveFileFromOffset(service_name, path, file_obj, callback, errback, 0L, -1L, timeout)
+
+    def _retrieveFileFromOffset_SMB2(self, service_name, path, file_obj, callback, errback, starting_offset, max_length, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        expiry_time = time.time() + timeout
+        path = path.replace('/', '\\')
+        if path.startswith('\\'):
+            path = path[1:]
+        if path.endswith('\\'):
+            path = path[:-1]
+        messages_history = [ ]
+        results = [ ]
+
+        def sendCreate(tid):
+            create_context_data = binascii.unhexlify("""
+28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00
+44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00
+00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00
+00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00
+00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00
+51 46 69 64 00 00 00 00
+""".replace(' ', '').replace('\n', ''))
+            m = SMB2Message(SMB2CreateRequest(path,
+                                              file_attributes = 0,
+                                              access_mask = FILE_READ_DATA | FILE_READ_EA | FILE_READ_ATTRIBUTES | READ_CONTROL | SYNCHRONIZE,
+                                              share_access = FILE_SHARE_READ,
+                                              oplock = SMB2_OPLOCK_LEVEL_NONE,
+                                              impersonation = SEC_IMPERSONATE,
+                                              create_options = FILE_SEQUENTIAL_ONLY | FILE_NON_DIRECTORY_FILE,
+                                              create_disp = FILE_OPEN,
+                                              create_context_data = create_context_data))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback, tid = tid)
+            messages_history.append(m)
+
+        def createCB(create_message, **kwargs):
+            messages_history.append(create_message)
+            if create_message.status == 0:
+                m = SMB2Message(SMB2QueryInfoRequest(create_message.payload.fid,
+                                                     flags = 0,
+                                                     additional_info = 0,
+                                                     info_type = SMB2_INFO_FILE,
+                                                     file_info_class = 0x16,  # FileStreamInformation [MS-FSCC] 2.4
+                                                     input_buf = '',
+                                                     output_buf_len = 4096))
+                m.tid = create_message.tid
+                self._sendSMBMessage(m)
+                self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, infoCB, errback,
+                                                               fid = create_message.payload.fid, file_attributes = create_message.payload.file_attributes)
+                messages_history.append(m)
+            else:
+                errback(OperationFailure('Failed to list %s on %s: Unable to open file' % ( path, service_name ), messages_history))
+
+        def infoCB(info_message, **kwargs):
+            messages_history.append(info_message)
+            if info_message.status == 0:
+                file_len = struct.unpack('<Q', info_message.payload.data[8:16])[0]
+                if max_length == 0 or starting_offset > file_len:
+                    closeFid(info_message.tid, kwargs['fid'])
+                    callback(( file_obj, kwargs['file_attributes'], 0 ))  # Note that this is a tuple of 3-elements
+                else:
+                    remaining_len = max_length
+                    if remaining_len < 0:
+                        remaining_len = file_len
+                    if starting_offset + remaining_len > file_len:
+                        remaining_len = file_len - starting_offset
+                    sendRead(info_message.tid, kwargs['fid'], starting_offset, remaining_len, 0, kwargs['file_attributes'])
+            else:
+                errback(OperationFailure('Failed to list %s on %s: Unable to retrieve information on file' % ( path, service_name ), messages_history))
+
+        def sendRead(tid, fid, offset, remaining_len, read_len, file_attributes):
+            read_count = min(self.max_read_size, remaining_len)
+            m = SMB2Message(SMB2ReadRequest(fid, offset, read_count))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, readCB, errback,
+                                                           fid = fid, offset = offset,
+                                                           remaining_len = remaining_len,
+                                                           read_len = read_len,
+                                                           file_attributes = file_attributes)
+
+        def readCB(read_message, **kwargs):
+            # To avoid crazy memory usage when retrieving large files, we do not save every read_message in messages_history.
+            if read_message.status == 0:
+                data_len = read_message.payload.data_length
+                file_obj.write(read_message.payload.data)
+
+                remaining_len = kwargs['remaining_len'] - data_len
+
+                if remaining_len > 0:
+                    sendRead(read_message.tid, kwargs['fid'], kwargs['offset'] + data_len, remaining_len, kwargs['read_len'] + data_len, kwargs['file_attributes'])
+                else:
+                    closeFid(read_message.tid, kwargs['fid'], ret = ( file_obj, kwargs['file_attributes'], kwargs['read_len'] + data_len ))
+            else:
+                messages_history.append(read_message)
+                closeFid(read_message.tid, kwargs['fid'], error = read_message.status)
+
+        def closeFid(tid, fid, ret = None, error = None):
+            m = SMB2Message(SMB2CloseRequest(fid))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, ret = ret, error = error)
+            messages_history.append(m)
+
+        def closeCB(close_message, **kwargs):
+            if kwargs['ret'] is not None:
+                callback(kwargs['ret'])
+            elif kwargs['error'] is not None:
+                errback(OperationFailure('Failed to retrieve %s on %s: Read failed' % ( path, service_name ), messages_history))
+
+        if not self.connected_trees.has_key(service_name):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if connect_message.status == 0:
+                    self.connected_trees[service_name] = connect_message.tid
+                    sendCreate(connect_message.tid)
+                else:
+                    errback(OperationFailure('Failed to retrieve %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))
+
+            m = SMB2Message(SMB2TreeConnectRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name )))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)
+            messages_history.append(m)
+        else:
+            sendCreate(self.connected_trees[service_name])
+
+    def _storeFile_SMB2(self, service_name, path, file_obj, callback, errback, timeout = 30):
+        self._storeFileFromOffset_SMB2(service_name, path, file_obj, callback, errback, 0L, True, timeout)
+
+    def _storeFileFromOffset_SMB2(self, service_name, path, file_obj, callback, errback, starting_offset, truncate = False, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        path = path.replace('/', '\\')
+        if path.startswith('\\'):
+            path = path[1:]
+        if path.endswith('\\'):
+            path = path[:-1]
+        messages_history = [ ]
+
+        def sendCreate(tid):
+            create_context_data = binascii.unhexlify("""
+28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00
+44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00
+00 00 00 00 00 00 00 00 20 00 00 00 10 00 04 00
+00 00 18 00 08 00 00 00 41 6c 53 69 00 00 00 00
+85 62 00 00 00 00 00 00 18 00 00 00 10 00 04 00
+00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00
+00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00
+51 46 69 64 00 00 00 00
+""".replace(' ', '').replace('\n', ''))
+            m = SMB2Message(SMB2CreateRequest(path,
+                                              file_attributes = ATTR_ARCHIVE,
+                                              access_mask = FILE_READ_DATA | FILE_WRITE_DATA | FILE_APPEND_DATA | FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | FILE_READ_EA | FILE_WRITE_EA | READ_CONTROL | SYNCHRONIZE,
+                                              share_access = 0,
+                                              oplock = SMB2_OPLOCK_LEVEL_NONE,
+                                              impersonation = SEC_IMPERSONATE,
+                                              create_options = FILE_SEQUENTIAL_ONLY | FILE_NON_DIRECTORY_FILE,
+                                              create_disp = FILE_OVERWRITE_IF if truncate else FILE_OPEN_IF,
+                                              create_context_data = create_context_data))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)
+            messages_history.append(m)
+
+        def createCB(create_message, **kwargs):
+            messages_history.append(create_message)
+            if create_message.status == 0:
+                sendWrite(create_message.tid, create_message.payload.fid, starting_offset)
+            else:
+                errback(OperationFailure('Failed to store %s on %s: Unable to open file' % ( path, service_name ), messages_history))
+
+        def sendWrite(tid, fid, offset):
+            write_count = self.max_write_size
+            data = file_obj.read(write_count)
+            data_len = len(data)
+            if data_len > 0:
+                m = SMB2Message(SMB2WriteRequest(fid, data, offset))
+                m.tid = tid
+                self._sendSMBMessage(m)
+                self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, writeCB, errback, fid = fid, offset = offset+data_len)
+            else:
+                closeFid(tid, fid, offset = offset)
+
+        def writeCB(write_message, **kwargs):
+            # To avoid crazy memory usage when saving large files, we do not save every write_message in messages_history.
+            if write_message.status == 0:
+                sendWrite(write_message.tid, kwargs['fid'], kwargs['offset'])
+            else:
+                messages_history.append(write_message)
+                closeFid(write_message.tid, kwargs['fid'])
+                errback(OperationFailure('Failed to store %s on %s: Write failed' % ( path, service_name ), messages_history))
+
+        def closeFid(tid, fid, error = None, offset = None):
+            m = SMB2Message(SMB2CloseRequest(fid))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, closeCB, errback, fid = fid, offset = offset, error = error)
+            messages_history.append(m)
+
+        def closeCB(close_message, **kwargs):
+            if kwargs['offset'] is not None:
+                callback(( file_obj, kwargs['offset'] ))  # Note that this is a tuple of 2-elements
+            elif kwargs['error'] is not None:
+                errback(OperationFailure('Failed to store %s on %s: Write failed' % ( path, service_name ), messages_history))
+
+        if not self.connected_trees.has_key(service_name):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if connect_message.status == 0:
+                    self.connected_trees[service_name] = connect_message.tid
+                    sendCreate(connect_message.tid)
+                else:
+                    errback(OperationFailure('Failed to store %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))
+
+            m = SMB2Message(SMB2TreeConnectRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name )))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)
+            messages_history.append(m)
+        else:
+            sendCreate(self.connected_trees[service_name])
+
+
+    def _deleteFiles_SMB2(self, service_name, path_file_pattern, callback, errback, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        expiry_time = time.time() + timeout
+        path = path_file_pattern.replace('/', '\\')
+        if path.startswith('\\'):
+            path = path[1:]
+        if path.endswith('\\'):
+            path = path[:-1]
+        messages_history = [ ]
+
+        def sendCreate(tid):
+            create_context_data = binascii.unhexlify("""
+28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00
+44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00
+00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00
+00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00
+00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00
+51 46 69 64 00 00 00 00
+""".replace(' ', '').replace('\n', ''))
+            m = SMB2Message(SMB2CreateRequest(path,
+                                              file_attributes = 0,
+                                              access_mask = DELETE | FILE_READ_ATTRIBUTES,
+                                              share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
+                                              oplock = SMB2_OPLOCK_LEVEL_NONE,
+                                              impersonation = SEC_IMPERSONATE,
+                                              create_options = FILE_NON_DIRECTORY_FILE,
+                                              create_disp = FILE_OPEN,
+                                              create_context_data = create_context_data))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)
+            messages_history.append(m)
+
+        def createCB(open_message, **kwargs):
+            messages_history.append(open_message)
+            if open_message.status == 0:
+                sendDelete(open_message.tid, open_message.payload.fid)
+            else:
+                errback(OperationFailure('Failed to delete %s on %s: Unable to open file' % ( path, service_name ), messages_history))
+
+        def sendDelete(tid, fid):
+            m = SMB2Message(SMB2SetInfoRequest(fid,
+                                               additional_info = 0,
+                                               info_type = SMB2_INFO_FILE,
+                                               file_info_class = 0x0d,  # SMB2_FILE_DISPOSITION_INFO
+                                               data = '\x01'))
+            '''
+                Resources:
+                https://msdn.microsoft.com/en-us/library/cc246560.aspx
+                https://msdn.microsoft.com/en-us/library/cc232098.aspx
+            '''
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback, fid = fid)
+            messages_history.append(m)
+
+        def deleteCB(delete_message, **kwargs):
+            messages_history.append(delete_message)
+            if delete_message.status == 0:
+                closeFid(delete_message.tid, kwargs['fid'], status = 0)
+            else:
+                closeFid(delete_message.tid, kwargs['fid'], status = delete_message.status)
+
+        def closeFid(tid, fid, status = None):
+            m = SMB2Message(SMB2CloseRequest(fid))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, closeCB, errback, status = status)
+            messages_history.append(m)
+
+        def closeCB(close_message, **kwargs):
+            if kwargs['status'] == 0:
+                callback(path_file_pattern)
+            else:
+                errback(OperationFailure('Failed to delete %s on %s: Delete failed' % ( path, service_name ), messages_history))
+
+        if not self.connected_trees.has_key(service_name):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if connect_message.status == 0:
+                    self.connected_trees[service_name] = connect_message.tid
+                    sendCreate(connect_message.tid)
+                else:
+                    errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))
+
+            m = SMB2Message(SMB2TreeConnectRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name )))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)
+            messages_history.append(m)
+        else:
+            sendCreate(self.connected_trees[service_name])
+
+    def _resetFileAttributes_SMB2(self, service_name, path_file_pattern, callback, errback, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        expiry_time = time.time() + timeout
+        path = path_file_pattern.replace('/', '\\')
+        if path.startswith('\\'):
+            path = path[1:]
+        if path.endswith('\\'):
+            path = path[:-1]
+        messages_history = [ ]
+
+        def sendCreate(tid):
+            create_context_data = binascii.unhexlify("""
+28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00
+44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00
+00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00
+00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00
+00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00
+51 46 69 64 00 00 00 00
+""".replace(' ', '').replace('\n', ''))
+
+            m = SMB2Message(SMB2CreateRequest(path,
+                                              file_attributes = 0,
+                                              access_mask = FILE_WRITE_ATTRIBUTES,
+                                              share_access = FILE_SHARE_READ | FILE_SHARE_WRITE,
+                                              oplock = SMB2_OPLOCK_LEVEL_NONE,
+                                              impersonation = SEC_IMPERSONATE,
+                                              create_options = 0,
+                                              create_disp = FILE_OPEN,
+                                              create_context_data = create_context_data))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)
+            messages_history.append(m)
+
+        def createCB(open_message, **kwargs):
+            messages_history.append(open_message)
+            if open_message.status == 0:
+                sendReset(open_message.tid, open_message.payload.fid)
+            else:
+                errback(OperationFailure('Failed to reset attributes of %s on %s: Unable to open file' % ( path, service_name ), messages_history))
+
+        def sendReset(tid, fid):
+            m = SMB2Message(SMB2SetInfoRequest(fid,
+                                               additional_info = 0,
+                                               info_type = SMB2_INFO_FILE,
+                                               file_info_class = 4,  # FileBasicInformation
+                                               data = struct.pack('qqqqii',0,0,0,0,0x80,0))) # FILE_ATTRIBUTE_NORMAL
+            '''
+                Resources:
+                https://msdn.microsoft.com/en-us/library/cc246560.aspx
+                https://msdn.microsoft.com/en-us/library/cc232064.aspx
+                https://msdn.microsoft.com/en-us/library/cc232094.aspx
+                https://msdn.microsoft.com/en-us/library/cc232110.aspx
+            '''
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, resetCB, errback, fid = fid)
+            messages_history.append(m)
+
+        def resetCB(reset_message, **kwargs):
+            messages_history.append(reset_message)
+            if reset_message.status == 0:
+                closeFid(reset_message.tid, kwargs['fid'], status = 0)
+            else:
+                closeFid(reset_message.tid, kwargs['fid'], status = reset_message.status)
+
+        def closeFid(tid, fid, status = None):
+            m = SMB2Message(SMB2CloseRequest(fid))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, closeCB, errback, status = status)
+            messages_history.append(m)
+
+        def closeCB(close_message, **kwargs):
+            if kwargs['status'] == 0:
+                callback(path_file_pattern)
+            else:
+                errback(OperationFailure('Failed to reset attributes of %s on %s: Reset failed' % ( path, service_name ), messages_history))
+
+        if not self.connected_trees.has_key(service_name):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if connect_message.status == 0:
+                    self.connected_trees[service_name] = connect_message.tid
+                    sendCreate(connect_message.tid)
+                else:
+                    errback(OperationFailure('Failed to reset attributes of %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))
+
+            m = SMB2Message(SMB2TreeConnectRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name )))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)
+            messages_history.append(m)
+        else:
+            sendCreate(self.connected_trees[service_name])
+
+    def _createDirectory_SMB2(self, service_name, path, callback, errback, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        expiry_time = time.time() + timeout
+        path = path.replace('/', '\\')
+        if path.startswith('\\'):
+            path = path[1:]
+        if path.endswith('\\'):
+            path = path[:-1]
+        messages_history = [ ]
+
+        def sendCreate(tid):
+            create_context_data = binascii.unhexlify("""
+28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00
+44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00
+00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00
+00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00
+00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00
+51 46 69 64 00 00 00 00
+""".replace(' ', '').replace('\n', ''))
+            m = SMB2Message(SMB2CreateRequest(path,
+                                              file_attributes = 0,
+                                              access_mask = FILE_READ_DATA | FILE_WRITE_DATA | FILE_READ_EA | FILE_WRITE_EA | FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | READ_CONTROL | DELETE | SYNCHRONIZE,
+                                              share_access = 0,
+                                              oplock = SMB2_OPLOCK_LEVEL_NONE,
+                                              impersonation = SEC_IMPERSONATE,
+                                              create_options = FILE_DIRECTORY_FILE | FILE_SYNCHRONOUS_IO_NONALERT,
+                                              create_disp = FILE_CREATE,
+                                              create_context_data = create_context_data))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback)
+            messages_history.append(m)
+
+        def createCB(create_message, **kwargs):
+            messages_history.append(create_message)
+            if create_message.status == 0:
+                closeFid(create_message.tid, create_message.payload.fid)
+            else:
+                errback(OperationFailure('Failed to create directory %s on %s: Create failed' % ( path, service_name ), messages_history))
+
+        def closeFid(tid, fid):
+            m = SMB2Message(SMB2CloseRequest(fid))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, closeCB, errback)
+            messages_history.append(m)
+
+        def closeCB(close_message, **kwargs):
+            callback(path)
+
+        if not self.connected_trees.has_key(service_name):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if connect_message.status == 0:
+                    self.connected_trees[service_name] = connect_message.tid
+                    sendCreate(connect_message.tid)
+                else:
+                    errback(OperationFailure('Failed to create directory %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))
+
+            m = SMB2Message(SMB2TreeConnectRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name )))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)
+            messages_history.append(m)
+        else:
+            sendCreate(self.connected_trees[service_name])
+
+    def _deleteDirectory_SMB2(self, service_name, path, callback, errback, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        expiry_time = time.time() + timeout
+        path = path.replace('/', '\\')
+        if path.startswith('\\'):
+            path = path[1:]
+        if path.endswith('\\'):
+            path = path[:-1]
+        messages_history = [ ]
+
+        def sendCreate(tid):
+            create_context_data = binascii.unhexlify("""
+28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00
+44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00
+00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00
+00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00
+00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00
+51 46 69 64 00 00 00 00
+""".replace(' ', '').replace('\n', ''))
+            m = SMB2Message(SMB2CreateRequest(path,
+                                              file_attributes = 0,
+                                              access_mask = DELETE | FILE_READ_ATTRIBUTES,
+                                              share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
+                                              oplock = SMB2_OPLOCK_LEVEL_NONE,
+                                              impersonation = SEC_IMPERSONATE,
+                                              create_options = FILE_DIRECTORY_FILE,
+                                              create_disp = FILE_OPEN,
+                                              create_context_data = create_context_data))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)
+            messages_history.append(m)
+
+        def createCB(open_message, **kwargs):
+            messages_history.append(open_message)
+            if open_message.status == 0:
+                sendDelete(open_message.tid, open_message.payload.fid)
+            else:
+                errback(OperationFailure('Failed to delete %s on %s: Unable to open directory' % ( path, service_name ), messages_history))
+
+        def sendDelete(tid, fid):
+            m = SMB2Message(SMB2SetInfoRequest(fid,
+                                               additional_info = 0,
+                                               info_type = SMB2_INFO_FILE,
+                                               file_info_class = 0x0d,  # SMB2_FILE_DISPOSITION_INFO
+                                               data = '\x01'))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback, fid = fid)
+            messages_history.append(m)
+
+        def deleteCB(delete_message, **kwargs):
+            messages_history.append(delete_message)
+            if delete_message.status == 0:
+                closeFid(delete_message.tid, kwargs['fid'], status = 0)
+            else:
+                closeFid(delete_message.tid, kwargs['fid'], status = delete_message.status)
+
+        def closeFid(tid, fid, status = None):
+            m = SMB2Message(SMB2CloseRequest(fid))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, status = status)
+            messages_history.append(m)
+
+        def closeCB(close_message, **kwargs):
+            if kwargs['status'] == 0:
+                callback(path)
+            else:
+                errback(OperationFailure('Failed to delete %s on %s: Delete failed' % ( path, service_name ), messages_history))
+
+        if not self.connected_trees.has_key(service_name):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if connect_message.status == 0:
+                    self.connected_trees[service_name] = connect_message.tid
+                    sendCreate(connect_message.tid)
+                else:
+                    errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))
+
+            m = SMB2Message(SMB2TreeConnectRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name )))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)
+            messages_history.append(m)
+        else:
+            sendCreate(self.connected_trees[service_name])
+
+    def _rename_SMB2(self, service_name, old_path, new_path, callback, errback, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        expiry_time = time.time() + timeout
+        messages_history = [ ]
+
+        new_path = new_path.replace('/', '\\')
+        if new_path.startswith('\\'):
+            new_path = new_path[1:]
+        if new_path.endswith('\\'):
+            new_path = new_path[:-1]
+
+        old_path = old_path.replace('/', '\\')
+        if old_path.startswith('\\'):
+            old_path = old_path[1:]
+        if old_path.endswith('\\'):
+            old_path = old_path[:-1]
+
+        def sendCreate(tid):
+            create_context_data = binascii.unhexlify("""
+28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00
+44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00
+00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00
+00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00
+00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00
+51 46 69 64 00 00 00 00
+""".replace(' ', '').replace('\n', ''))
+            m = SMB2Message(SMB2CreateRequest(old_path,
+                                              file_attributes = 0,
+                                              access_mask = DELETE | FILE_READ_ATTRIBUTES | SYNCHRONIZE,
+                                              share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
+                                              oplock = SMB2_OPLOCK_LEVEL_NONE,
+                                              impersonation = SEC_IMPERSONATE,
+                                              create_options = FILE_SYNCHRONOUS_IO_NONALERT,
+                                              create_disp = FILE_OPEN,
+                                              create_context_data = create_context_data))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)
+            messages_history.append(m)
+
+        def createCB(create_message, **kwargs):
+            messages_history.append(create_message)
+            if create_message.status == 0:
+                sendRename(create_message.tid, create_message.payload.fid)
+            else:
+                errback(OperationFailure('Failed to rename %s on %s: Unable to open file/directory' % ( old_path, service_name ), messages_history))
+
+        def sendRename(tid, fid):
+            data = '\x00'*16 + struct.pack('<I', len(new_path)*2) + new_path.encode('UTF-16LE')
+            m = SMB2Message(SMB2SetInfoRequest(fid,
+                                               additional_info = 0,
+                                               info_type = SMB2_INFO_FILE,
+                                               file_info_class = 0x0a,  # SMB2_FILE_RENAME_INFO
+                                               data = data))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, renameCB, errback, fid = fid)
+            messages_history.append(m)
+
+        def renameCB(rename_message, **kwargs):
+            messages_history.append(rename_message)
+            if rename_message.status == 0:
+                closeFid(rename_message.tid, kwargs['fid'], status = 0)
+            else:
+                closeFid(rename_message.tid, kwargs['fid'], status = rename_message.status)
+
+        def closeFid(tid, fid, status = None):
+            m = SMB2Message(SMB2CloseRequest(fid))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, status = status)
+            messages_history.append(m)
+
+        def closeCB(close_message, **kwargs):
+            if kwargs['status'] == 0:
+                callback(( old_path, new_path ))
+            else:
+                errback(OperationFailure('Failed to rename %s on %s: Rename failed' % ( old_path, service_name ), messages_history))
+
+        if not self.connected_trees.has_key(service_name):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if connect_message.status == 0:
+                    self.connected_trees[service_name] = connect_message.tid
+                    sendCreate(connect_message.tid)
+                else:
+                    errback(OperationFailure('Failed to rename %s on %s: Unable to connect to shared device' % ( old_path, service_name ), messages_history))
+
+            m = SMB2Message(SMB2TreeConnectRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name )))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)
+            messages_history.append(m)
+        else:
+            sendCreate(self.connected_trees[service_name])
+
+    def _listSnapshots_SMB2(self, service_name, path, callback, errback, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        expiry_time = time.time() + timeout
+        path = path.replace('/', '\\')
+        if path.startswith('\\'):
+            path = path[1:]
+        if path.endswith('\\'):
+            path = path[:-1]
+        messages_history = [ ]
+
+        def sendCreate(tid):
+            create_context_data = binascii.unhexlify("""
+28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00
+44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00
+00 00 00 00 00 00 00 00 00 00 00 00 10 00 04 00
+00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00
+""".replace(' ', '').replace('\n', ''))
+            m = SMB2Message(SMB2CreateRequest(path,
+                                              file_attributes = 0,
+                                              access_mask = FILE_READ_DATA | FILE_READ_ATTRIBUTES | SYNCHRONIZE,
+                                              share_access = FILE_SHARE_READ | FILE_SHARE_WRITE,
+                                              oplock = SMB2_OPLOCK_LEVEL_NONE,
+                                              impersonation = SEC_IMPERSONATE,
+                                              create_options = FILE_SYNCHRONOUS_IO_NONALERT,
+                                              create_disp = FILE_OPEN,
+                                              create_context_data = create_context_data))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)
+            messages_history.append(m)
+
+        def createCB(create_message, **kwargs):
+            messages_history.append(create_message)
+            if create_message.status == 0:
+                sendEnumSnapshots(create_message.tid, create_message.payload.fid)
+            else:
+                errback(OperationFailure('Failed to list snapshots %s on %s: Unable to open file/directory' % ( old_path, service_name ), messages_history))
+
+        def sendEnumSnapshots(tid, fid):
+            m = SMB2Message(SMB2IoctlRequest(fid,
+                                             ctlcode = 0x00144064,  # FSCTL_SRV_ENUMERATE_SNAPSHOTS
+                                             flags = 0x0001,
+                                             in_data = ''))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, enumSnapshotsCB, errback, tid = tid, fid = fid)
+            messages_history.append(m)
+
+        def enumSnapshotsCB(enum_message, **kwargs):
+            messages_history.append(enum_message)
+            if enum_message.status == 0:
+                results = [ ]
+                snapshots_count = struct.unpack('<I', enum_message.payload.out_data[4:8])[0]
+                for i in range(0, snapshots_count):
+                    s = enum_message.payload.out_data[12+i*50:12+48+i*50].decode('UTF-16LE')
+                    results.append(datetime(*map(int, ( s[5:9], s[10:12], s[13:15], s[16:18], s[19:21], s[22:24] ))))
+                closeFid(kwargs['tid'], kwargs['fid'], results = results)
+            else:
+                closeFid(kwargs['tid'], kwargs['fid'], status = enum_message.status)
+
+        def closeFid(tid, fid, status = None, results = None):
+            m = SMB2Message(SMB2CloseRequest(fid))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, status = status, results = results)
+            messages_history.append(m)
+
+        def closeCB(close_message, **kwargs):
+            if kwargs['results'] is not None:
+                callback(kwargs['results'])
+            else:
+                errback(OperationFailure('Failed to list snapshots %s on %s: List failed' % ( path, service_name ), messages_history))
+
+        if not self.connected_trees.has_key(service_name):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if connect_message.status == 0:
+                    self.connected_trees[service_name] = connect_message.tid
+                    sendCreate(connect_message.tid)
+                else:
+                    errback(OperationFailure('Failed to list snapshots %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))
+
+            m = SMB2Message(SMB2TreeConnectRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name )))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)
+            messages_history.append(m)
+        else:
+            sendCreate(self.connected_trees[service_name])
+
+    def _echo_SMB2(self, data, callback, errback, timeout = 30):
+        messages_history = [ ]
+
+        def echoCB(echo_message, **kwargs):
+            messages_history.append(echo_message)
+            if echo_message.status == 0:
+                callback(data)
+            else:
+                errback(OperationFailure('Echo failed', messages_history))
+
+        m = SMB2Message(SMB2EchoRequest())
+        self._sendSMBMessage(m)
+        self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, echoCB, errback)
+        messages_history.append(m)
+
+
+    #
+    # SMB1 Methods Family
+    #
+
+    def _sendSMBMessage_SMB1(self, smb_message):
+        if smb_message.mid == 0:
+            smb_message.mid = self._getNextMID_SMB1()
+        if not smb_message.uid:
+            smb_message.uid = self.uid
+        if self.is_signing_active:
+            smb_message.flags2 |= SMB_FLAGS2_SMB_SECURITY_SIGNATURE
+
+            # Increment the next_signing_id as described in [MS-CIFS] 3.2.4.1.3
+            smb_message.security = self.next_signing_id
+            self.next_signing_id += 2  # All our defined messages currently have responses, so always increment by 2
+            raw_data = smb_message.encode()
+
+            md = ntlm.MD5(self.signing_session_key)
+            if self.signing_challenge_response:
+                md.update(self.signing_challenge_response)
+            md.update(raw_data)
+            signature = md.digest()[:8]
+
+            self.log.debug('MID is %d. Signing ID is %d. Signature is %s. Total raw message is %d bytes', smb_message.mid, smb_message.security, binascii.hexlify(signature), len(raw_data))
+            smb_message.raw_data = raw_data[:14] + signature + raw_data[22:]
+        else:
+            smb_message.raw_data = smb_message.encode()
+        self.sendNMBMessage(smb_message.raw_data)
+
+    def _getNextMID_SMB1(self):
+        self.mid += 1
+        if self.mid >= 0xFFFF: # MID cannot be 0xFFFF. [MS-CIFS]: 2.2.1.6.2
+            # We don't use MID of 0 as MID can be reused for SMB_COM_TRANSACTION2_SECONDARY messages
+            # where if mid=0, _sendSMBMessage will re-assign new MID values again
+            self.mid = 1
+        return self.mid
+
+    def _updateState_SMB1(self, message):
+        if message.isReply:
+            if message.command == SMB_COM_NEGOTIATE:
+                if not message.status.hasError:
+                    self.has_negotiated = True
+                    self.log.info('SMB dialect negotiation successful (ExtendedSecurity:%s)', message.hasExtendedSecurity)
+                    self._updateServerInfo(message.payload)
+                    self._handleNegotiateResponse(message)
+                else:
+                    raise ProtocolError('Unknown status value (0x%08X) in SMB_COM_NEGOTIATE' % message.status.internal_value,
+                                        message.raw_data, message)
+            elif message.command == SMB_COM_SESSION_SETUP_ANDX:
+                if message.hasExtendedSecurity:
+                    if not message.status.hasError:
+                        try:
+                            result = securityblob.decodeAuthResponseSecurityBlob(message.payload.security_blob)
+                            if result == securityblob.RESULT_ACCEPT_COMPLETED:
+                                self.log.debug('SMB uid is now %d', message.uid)
+                                self.uid = message.uid
+                                self.has_authenticated = True
+                                self.log.info('Authentication (with extended security) successful!')
+                                self.onAuthOK()
+                            else:
+                                raise ProtocolError('SMB_COM_SESSION_SETUP_ANDX status is 0 but security blob negResult value is %d' % result, message.raw_data, message)
+                        except securityblob.BadSecurityBlobError, ex:
+                            raise ProtocolError(str(ex), message.raw_data, message)
+                    elif message.status.internal_value == 0xc0000016:  # STATUS_MORE_PROCESSING_REQUIRED
+                        try:
+                            result, ntlm_token = securityblob.decodeChallengeSecurityBlob(message.payload.security_blob)
+                            if result == securityblob.RESULT_ACCEPT_INCOMPLETE:
+                                self._handleSessionChallenge(message, ntlm_token)
+                        except ( securityblob.BadSecurityBlobError, securityblob.UnsupportedSecurityProvider ), ex:
+                            raise ProtocolError(str(ex), message.raw_data, message)
+                    elif message.status.internal_value == 0xc000006d:  # STATUS_LOGON_FAILURE
+                        self.has_authenticated = False
+                        self.log.info('Authentication (with extended security) failed. Please check username and password. You may need to enable/disable NTLMv2 authentication.')
+                        self.onAuthFailed()
+                    else:
+                        raise ProtocolError('Unknown status value (0x%08X) in SMB_COM_SESSION_SETUP_ANDX (with extended security)' % message.status.internal_value,
+                                            message.raw_data, message)
+                else:
+                    if message.status.internal_value == 0:
+                        self.log.debug('SMB uid is now %d', message.uid)
+                        self.uid = message.uid
+                        self.has_authenticated = True
+                        self.log.info('Authentication (without extended security) successful!')
+                        self.onAuthOK()
+                    else:
+                        self.has_authenticated = False
+                        self.log.info('Authentication (without extended security) failed. Please check username and password')
+                        self.onAuthFailed()
+            elif message.command == SMB_COM_TREE_CONNECT_ANDX:
+                try:
+                    req = self.pending_requests[message.mid]
+                except KeyError:
+                    pass
+                else:
+                    if not message.status.hasError:
+                        self.connected_trees[req.kwargs['path']] = message.tid
+
+            req = self.pending_requests.pop(message.mid, None)
+            if req:
+                req.callback(message, **req.kwargs)
+                return True
+
+
+    def _updateServerInfo_SMB1(self, payload):
+        self.capabilities = payload.capabilities
+        self.security_mode = payload.security_mode
+        self.max_raw_size = payload.max_raw_size
+        self.max_buffer_size = payload.max_buffer_size
+        self.max_mpx_count = payload.max_mpx_count
+        self.use_plaintext_authentication = not bool(payload.security_mode & NEGOTIATE_ENCRYPT_PASSWORDS)
+
+        if self.use_plaintext_authentication:
+            self.log.warning('Remote server only supports plaintext authentication. Your password can be stolen easily over the network.')
+
+
+    def _handleSessionChallenge_SMB1(self, message, ntlm_token):
+        assert message.hasExtendedSecurity
+
+        if message.uid and not self.uid:
+            self.uid = message.uid
+
+        server_challenge, server_flags, server_info = ntlm.decodeChallengeMessage(ntlm_token)
+        if self.use_ntlm_v2:
+            self.log.info('Performing NTLMv2 authentication (with extended security) with server challenge "%s"', binascii.hexlify(server_challenge))
+            nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV2(self.password,
+                                                                                                         self.username,
+                                                                                                         server_challenge,
+                                                                                                         server_info,
+                                                                                                         self.domain)
+
+        else:
+            self.log.info('Performing NTLMv1 authentication (with extended security) with server challenge "%s"', binascii.hexlify(server_challenge))
+            nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV1(self.password, server_challenge, True)
+
+        ntlm_data = ntlm.generateAuthenticateMessage(server_flags,
+                                                     nt_challenge_response,
+                                                     lm_challenge_response,
+                                                     session_key,
+                                                     self.username,
+                                                     self.domain)
+
+        if self.log.isEnabledFor(logging.DEBUG):
+            self.log.debug('NT challenge response is "%s" (%d bytes)', binascii.hexlify(nt_challenge_response), len(nt_challenge_response))
+            self.log.debug('LM challenge response is "%s" (%d bytes)', binascii.hexlify(lm_challenge_response), len(lm_challenge_response))
+
+        blob = securityblob.generateAuthSecurityBlob(ntlm_data)
+        self._sendSMBMessage(SMBMessage(ComSessionSetupAndxRequest__WithSecurityExtension(0, blob)))
+
+        if self.security_mode & NEGOTIATE_SECURITY_SIGNATURES_REQUIRE:
+            self.log.info('Server requires all SMB messages to be signed')
+            self.is_signing_active = (self.sign_options != SMB.SIGN_NEVER)
+        elif self.security_mode & NEGOTIATE_SECURITY_SIGNATURES_ENABLE:
+            self.log.info('Server supports SMB signing')
+            self.is_signing_active = (self.sign_options == SMB.SIGN_WHEN_SUPPORTED)
+        else:
+            self.is_signing_active = False
+
+        if self.is_signing_active:
+            self.log.info("SMB signing activated. All SMB messages will be signed.")
+            self.signing_session_key = session_key
+            if self.capabilities & CAP_EXTENDED_SECURITY:
+                self.signing_challenge_response = None
+            else:
+                self.signing_challenge_response = blob
+        else:
+            self.log.info("SMB signing deactivated. SMB messages will NOT be signed.")
+
+
+    def _handleNegotiateResponse_SMB1(self, message):
+        if message.uid and not self.uid:
+            self.uid = message.uid
+
+        if message.hasExtendedSecurity or message.payload.supportsExtendedSecurity:
+            ntlm_data = ntlm.generateNegotiateMessage()
+            blob = securityblob.generateNegotiateSecurityBlob(ntlm_data)
+            self._sendSMBMessage(SMBMessage(ComSessionSetupAndxRequest__WithSecurityExtension(message.payload.session_key, blob)))
+        else:
+            nt_password, _, _ = ntlm.generateChallengeResponseV1(self.password, message.payload.challenge, False)
+            self.log.info('Performing NTLMv1 authentication (without extended security) with challenge "%s" and hashed password of "%s"',
+                          binascii.hexlify(message.payload.challenge),
+                          binascii.hexlify(nt_password))
+            self._sendSMBMessage(SMBMessage(ComSessionSetupAndxRequest__NoSecurityExtension(message.payload.session_key,
+                                                                                           self.username,
+                                                                                           nt_password,
+                                                                                           True,
+                                                                                           self.domain)))
+
+    def _listShares_SMB1(self, callback, errback, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        expiry_time = time.time() + timeout
+        path = 'IPC$'
+        messages_history = [ ]
+
+        def connectSrvSvc(tid):
+            m = SMBMessage(ComNTCreateAndxRequest('\\srvsvc',
+                                                  flags = NT_CREATE_REQUEST_EXTENDED_RESPONSE,
+                                                  access_mask = READ_CONTROL | FILE_WRITE_ATTRIBUTES | FILE_READ_ATTRIBUTES | FILE_WRITE_EA | FILE_READ_EA | FILE_APPEND_DATA | FILE_WRITE_DATA | FILE_READ_DATA,
+                                                  share_access = FILE_SHARE_READ | FILE_SHARE_WRITE,
+                                                  create_disp = FILE_OPEN,
+                                                  create_options = FILE_OPEN_NO_RECALL | FILE_NON_DIRECTORY_FILE,
+                                                  impersonation = SEC_IMPERSONATE,
+                                                  security_flags = 0))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectSrvSvcCB, errback)
+            messages_history.append(m)
+
+        def connectSrvSvcCB(create_message, **kwargs):
+            messages_history.append(create_message)
+            if not create_message.status.hasError:
+                call_id = self._getNextRPCCallID()
+                # See [MS-CIFS]: 2.2.5.6.1 for more information on TRANS_TRANSACT_NMPIPE (0x0026) parameters
+                setup_bytes = struct.pack('<HH', 0x0026, create_message.payload.fid)
+                # The data_bytes are binding call to Server Service RPC using DCE v1.1 RPC over SMB. See [MS-SRVS] and [C706]
+                # If you wish to understand the meanings of the byte stream, I would suggest you use a recent version of WireShark to packet capture the stream
+                data_bytes = \
+                    binascii.unhexlify("""05 00 0b 03 10 00 00 00 48 00 00 00""".replace(' ', '')) + \
+                    struct.pack('<I', call_id) + \
+                    binascii.unhexlify("""
+b8 10 b8 10 00 00 00 00 01 00 00 00 00 00 01 00
+c8 4f 32 4b 70 16 d3 01 12 78 5a 47 bf 6e e1 88
+03 00 00 00 04 5d 88 8a eb 1c c9 11 9f e8 08 00
+2b 10 48 60 02 00 00 00""".replace(' ', '').replace('\n', ''))
+                m = SMBMessage(ComTransactionRequest(max_params_count = 0,
+                                                     max_data_count = 4280,
+                                                     max_setup_count = 0,
+                                                     data_bytes = data_bytes,
+                                                     setup_bytes = setup_bytes))
+                m.tid = create_message.tid
+                self._sendSMBMessage(m)
+                self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, rpcBindCB, errback, fid = create_message.payload.fid)
+                messages_history.append(m)
+            else:
+                errback(OperationFailure('Failed to list shares: Unable to locate Server Service RPC endpoint', messages_history))
+
+        def rpcBindCB(trans_message, **kwargs):
+            messages_history.append(trans_message)
+            if not trans_message.status.hasError:
+                call_id = self._getNextRPCCallID()
+
+                padding = ''
+                server_len = len(self.remote_name) + 1
+                server_bytes_len = server_len * 2
+                if server_len % 2 != 0:
+                    padding = '\0\0'
+                    server_bytes_len += 2
+
+                # See [MS-CIFS]: 2.2.5.6.1 for more information on TRANS_TRANSACT_NMPIPE (0x0026) parameters
+                setup_bytes = struct.pack('<HH', 0x0026, kwargs['fid'])
+                # The data bytes are the RPC call to NetrShareEnum (Opnum 15) at Server Service RPC.
+                # If you wish to understand the meanings of the byte stream, I would suggest you use a recent version of WireShark to packet capture the stream
+                data_bytes = \
+                    binascii.unhexlify("""05 00 00 03 10 00 00 00""".replace(' ', '')) + \
+                    struct.pack('<HHI', 72+server_bytes_len, 0, call_id) + \
+                    binascii.unhexlify("""4c 00 00 00 00 00 0f 00 00 00 02 00""".replace(' ', '')) + \
+                    struct.pack('<III', server_len, 0, server_len) + \
+                    (self.remote_name + '\0').encode('UTF-16LE') + padding + \
+                    binascii.unhexlify("""
+01 00 00 00 01 00 00 00 04 00 02 00 00 00 00 00
+00 00 00 00 ff ff ff ff 08 00 02 00 00 00 00 00
+""".replace(' ', '').replace('\n', ''))
+                m = SMBMessage(ComTransactionRequest(max_params_count = 0,
+                                                     max_data_count = 4280,
+                                                     max_setup_count = 0,
+                                                     data_bytes = data_bytes,
+                                                     setup_bytes = setup_bytes))
+                m.tid = trans_message.tid
+                self._sendSMBMessage(m)
+                self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, listShareResultsCB, errback, fid = kwargs['fid'])
+                messages_history.append(m)
+            else:
+                closeFid(trans_message.tid, kwargs['fid'])
+                errback(OperationFailure('Failed to list shares: Unable to bind to Server Service RPC endpoint', messages_history))
+
+        def listShareResultsCB(result_message, **kwargs):
+            messages_history.append(result_message)
+            if not result_message.status.hasError:
+                # The payload.data_bytes will contain the results of the RPC call to NetrShareEnum (Opnum 15) at Server Service RPC.
+                data_bytes = result_message.payload.data_bytes
+
+                if ord(data_bytes[3]) & 0x02 == 0:
+                    sendReadRequest(result_message.tid, kwargs['fid'], data_bytes)
+                else:
+                    decodeResults(result_message.tid, kwargs['fid'], data_bytes)
+            else:
+                closeFid(result_message.tid, kwargs['fid'])
+                errback(OperationFailure('Failed to list shares: Unable to retrieve shared device list', messages_history))
+
+        def decodeResults(tid, fid, data_bytes):
+            shares_count = struct.unpack('<I', data_bytes[36:40])[0]
+            results = [ ]     # A list of SharedDevice instances
+            offset = 36 + 12  # You need to study the byte stream to understand the meaning of these constants
+            for i in range(0, shares_count):
+                results.append(SharedDevice(struct.unpack('<I', data_bytes[offset+4:offset+8])[0], None, None))
+                offset += 12
+
+            for i in range(0, shares_count):
+                max_length, _, length = struct.unpack('<III', data_bytes[offset:offset+12])
+                offset += 12
+                results[i].name = unicode(data_bytes[offset:offset+length*2-2], 'UTF-16LE')
+
+                if length % 2 != 0:
+                    offset += (length * 2 + 2)
+                else:
+                    offset += (length * 2)
+
+                max_length, _, length = struct.unpack('<III', data_bytes[offset:offset+12])
+                offset += 12
+                results[i].comments = unicode(data_bytes[offset:offset+length*2-2], 'UTF-16LE')
+
+                if length % 2 != 0:
+                    offset += (length * 2 + 2)
+                else:
+                    offset += (length * 2)
+
+            closeFid(tid, fid)
+            callback(results)
+
+        def sendReadRequest(tid, fid, data_bytes):
+            read_count = min(4280, self.max_raw_size - 2)
+            m = SMBMessage(ComReadAndxRequest(fid = fid,
+                                              offset = 0,
+                                              max_return_bytes_count = read_count,
+                                              min_return_bytes_count = read_count))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, readCB, errback, fid = fid, data_bytes = data_bytes)
+
+        def readCB(read_message, **kwargs):
+            messages_history.append(read_message)
+            if not read_message.status.hasError:
+                data_len = read_message.payload.data_length
+                data_bytes = read_message.payload.data
+
+                if ord(data_bytes[3]) & 0x02 == 0:
+                    sendReadRequest(read_message.tid, kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:data_len-24])
+                else:
+                    decodeResults(read_message.tid, kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:data_len-24])
+            else:
+                closeFid(read_message.tid, kwargs['fid'])
+                errback(OperationFailure('Failed to list shares: Unable to retrieve shared device list', messages_history))
+
+        def closeFid(tid, fid):
+            m = SMBMessage(ComCloseRequest(fid))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            messages_history.append(m)
+
+        def connectCB(connect_message, **kwargs):
+            messages_history.append(connect_message)
+            if not connect_message.status.hasError:
+                self.connected_trees[path] = connect_message.tid
+                connectSrvSvc(connect_message.tid)
+            else:
+                errback(OperationFailure('Failed to list shares: Unable to connect to IPC$', messages_history))
+
+        m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), path ), SERVICE_ANY, ''))
+        self._sendSMBMessage(m)
+        self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = path)
+        messages_history.append(m)
+
+    def _listPath_SMB1(self, service_name, path, callback, errback, search, pattern, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        expiry_time = time.time() + timeout
+        path = path.replace('/', '\\')
+        if not path.endswith('\\'):
+            path += '\\'
+        messages_history = [ ]
+        results = [ ]
+
+        def sendFindFirst(tid, support_dfs=False):
+            setup_bytes = struct.pack('<H', 0x0001)  # TRANS2_FIND_FIRST2 sub-command. See [MS-CIFS]: 2.2.6.2.1
+            params_bytes = \
+                struct.pack('<HHHHI',
+                            search, # SearchAttributes
+                            100,    # SearchCount
+                            0x0006, # Flags: SMB_FIND_CLOSE_AT_EOS | SMB_FIND_RETURN_RESUME_KEYS
+                            0x0104, # InfoLevel: SMB_FIND_FILE_BOTH_DIRECTORY_INFO
+                            0x0000) # SearchStorageType
+            if support_dfs:
+                params_bytes += ("\\" + self.remote_name + "\\" + service_name + path + pattern + '\0').encode('UTF-16LE')
+            else:
+                params_bytes += (path + pattern).encode('UTF-16LE')
+
+            m = SMBMessage(ComTransaction2Request(max_params_count = 10,
+                                                  max_data_count = 16644,
+                                                  max_setup_count = 0,
+                                                  params_bytes = params_bytes,
+                                                  setup_bytes = setup_bytes))
+            m.tid = tid
+            if support_dfs:
+                m.flags2 |= SMB_FLAGS2_DFS
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, findFirstCB, errback, support_dfs=support_dfs)
+            messages_history.append(m)
+
+        def decodeFindStruct(data_bytes):
+            # SMB_FIND_FILE_BOTH_DIRECTORY_INFO structure. See [MS-CIFS]: 2.2.8.1.7 and [MS-SMB]: 2.2.8.1.1
+            info_format = '<IIQQQQQQIIIBB24s'
+            info_size = struct.calcsize(info_format)
+
+            data_length = len(data_bytes)
+            offset = 0
+            while offset < data_length:
+                if offset + info_size > data_length:
+                    return data_bytes[offset:]
+
+                next_offset, _, \
+                create_time, last_access_time, last_write_time, last_attr_change_time, \
+                file_size, alloc_size, file_attributes, filename_length, ea_size, \
+                short_name_length, _, short_name = struct.unpack(info_format, data_bytes[offset:offset+info_size])
+
+                offset2 = offset + info_size
+                if offset2 + filename_length > data_length:
+                    return data_bytes[offset:]
+
+                filename = data_bytes[offset2:offset2+filename_length].decode('UTF-16LE')
+                short_name = short_name.decode('UTF-16LE')
+                results.append(SharedFile(convertFILETIMEtoEpoch(create_time), convertFILETIMEtoEpoch(last_access_time),
+                                          convertFILETIMEtoEpoch(last_write_time), convertFILETIMEtoEpoch(last_attr_change_time),
+                                          file_size, alloc_size, file_attributes, short_name, filename))
+
+                if next_offset:
+                    offset += next_offset
+                else:
+                    break
+            return ''
+
+        def findFirstCB(find_message, **kwargs):
+            messages_history.append(find_message)
+            if not find_message.status.hasError:
+                if not kwargs.has_key('total_count'):
+                    # TRANS2_FIND_FIRST2 response. [MS-CIFS]: 2.2.6.2.2
+                    sid, search_count, end_of_search, _, last_name_offset = struct.unpack('<HHHHH', find_message.payload.params_bytes[:10])
+                    kwargs.update({ 'sid': sid, 'end_of_search': end_of_search, 'last_name_offset': last_name_offset, 'data_buf': '' })
+                else:
+                    sid, end_of_search, last_name_offset = kwargs['sid'], kwargs['end_of_search'], kwargs['last_name_offset']
+
+                send_next = True
+                if find_message.payload.data_bytes:
+                    d = decodeFindStruct(kwargs['data_buf'] + find_message.payload.data_bytes)
+                    if not kwargs.has_key('data_count'):
+                        if len(find_message.payload.data_bytes) != find_message.payload.total_data_count:
+                            kwargs.update({ 'data_count': len(find_message.payload.data_bytes),
+                                            'total_count': find_message.payload.total_data_count,
+                                            'data_buf': d,
+                                            })
+                            send_next = False
+                    else:
+                        kwargs['data_count'] += len(find_message.payload.data_bytes)
+                        kwargs['total_count'] = min(find_message.payload.total_data_count, kwargs['total_count'])
+                        kwargs['data_buf'] = d
+                        if kwargs['data_count'] != kwargs['total_count']:
+                            send_next = False
+
+                if not send_next:
+                    self.pending_requests[find_message.mid] = _PendingRequest(find_message.mid, expiry_time, findFirstCB, errback, **kwargs)
+                elif end_of_search:
+                    callback(results)
+                else:
+                    sendFindNext(find_message.tid, sid, last_name_offset, kwargs.get('support_dfs', False))
+            else:
+                errback(OperationFailure('Failed to list %s on %s: Unable to retrieve file list' % ( path, service_name ), messages_history))
+
+        def sendFindNext(tid, sid, resume_key, support_dfs=False):
+            setup_bytes = struct.pack('<H', 0x0002)  # TRANS2_FIND_NEXT2 sub-command. See [MS-CIFS]: 2.2.6.3.1
+            params_bytes = \
+                struct.pack('<HHHIH',
+                            sid,        # SID
+                            100,        # SearchCount
+                            0x0104,     # InfoLevel: SMB_FIND_FILE_BOTH_DIRECTORY_INFO
+                            resume_key, # ResumeKey
+                            0x000a)     # Flags: SMB_FIND_RETURN_RESUME_KEYS | SMB_FIND_CLOSE_AT_EOS | SMB_FIND_RETURN_RESUME_KEYS
+            if support_dfs:
+                params_bytes += ("\\" + self.remote_name + "\\" + service_name + path + pattern + '\0').encode('UTF-16LE')
+            else:
+                params_bytes += (path + pattern).encode('UTF-16LE')
+
+            m = SMBMessage(ComTransaction2Request(max_params_count = 10,
+                                                  max_data_count = 16644,
+                                                  max_setup_count = 0,
+                                                  params_bytes = params_bytes,
+                                                  setup_bytes = setup_bytes))
+            m.tid = tid
+            if support_dfs:
+                m.flags2 |= SMB_FLAGS2_DFS
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, findNextCB, errback, sid = sid, support_dfs = support_dfs)
+            messages_history.append(m)
+
+        def findNextCB(find_message, **kwargs):
+            messages_history.append(find_message)
+            if not find_message.status.hasError:
+                if not kwargs.has_key('total_count'):
+                    # TRANS2_FIND_NEXT2 response. [MS-CIFS]: 2.2.6.3.2
+                    search_count, end_of_search, _, last_name_offset = struct.unpack('<HHHH', find_message.payload.params_bytes[:8])
+                    kwargs.update({ 'end_of_search': end_of_search, 'last_name_offset': last_name_offset, 'data_buf': '' })
+                else:
+                    end_of_search, last_name_offset = kwargs['end_of_search'], kwargs['last_name_offset']
+
+                send_next = True
+                if find_message.payload.data_bytes:
+                    d = decodeFindStruct(kwargs['data_buf'] + find_message.payload.data_bytes)
+                    if not kwargs.has_key('data_count'):
+                        if len(find_message.payload.data_bytes) != find_message.payload.total_data_count:
+                            kwargs.update({ 'data_count': len(find_message.payload.data_bytes),
+                                            'total_count': find_message.payload.total_data_count,
+                                            'data_buf': d,
+                                            })
+                            send_next = False
+                    else:
+                        kwargs['data_count'] += len(find_message.payload.data_bytes)
+                        kwargs['total_count'] = min(find_message.payload.total_data_count, kwargs['total_count'])
+                        kwargs['data_buf'] = d
+                        if kwargs['data_count'] != kwargs['total_count']:
+                            send_next = False
+
+                if not send_next:
+                    self.pending_requests[find_message.mid] = _PendingRequest(find_message.mid, expiry_time, findNextCB, errback, **kwargs)
+                elif end_of_search:
+                    callback(results)
+                else:
+                    sendFindNext(find_message.tid, kwargs['sid'], last_name_offset, kwargs.get('support_dfs', False))
+            else:
+                errback(OperationFailure('Failed to list %s on %s: Unable to retrieve file list' % ( path, service_name ), messages_history))
+
+        def sendDFSReferral(tid):
+            setup_bytes = struct.pack('<H', 0x0010)  # TRANS2_GET_DFS_REFERRAL sub-command. See [MS-CIFS]: 2.2.6.16.1
+            params_bytes = struct.pack('<H', 3)      # Max referral level 3
+            params_bytes += ("\\" + self.remote_name + "\\" + service_name).encode('UTF-16LE')
+
+            m = SMBMessage(ComTransaction2Request(max_params_count = 10,
+                                                  max_data_count = 16644,
+                                                  max_setup_count = 0,
+                                                  params_bytes = params_bytes,
+                                                  setup_bytes = setup_bytes))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, dfsReferralCB, errback)
+            messages_history.append(m)
+
+        def dfsReferralCB(dfs_message, **kwargs):
+            sendFindFirst(dfs_message.tid, True)
+
+        if not self.connected_trees.has_key(service_name):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if not connect_message.status.hasError:
+                    self.connected_trees[service_name] = connect_message.tid
+                    if connect_message.payload.optional_support & SMB_TREE_CONNECTX_SUPPORT_DFS:
+                        sendDFSReferral(connect_message.tid)
+                    else:
+                        sendFindFirst(connect_message.tid, False)
+                else:
+                    errback(OperationFailure('Failed to list %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))
+
+            m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)
+            messages_history.append(m)
+        else:
+            sendFindFirst(self.connected_trees[service_name])
+
+    def _getAttributes_SMB1(self, service_name, path, callback, errback, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        expiry_time = time.time() + timeout
+        path = path.replace('/', '\\')
+        if path.startswith('\\'):
+            path = path[1:]
+        if path.endswith('\\'):
+            path = path[:-1]
+        messages_history = [ ]
+
+        def sendQuery(tid):
+            setup_bytes = struct.pack('<H', 0x0005)  # TRANS2_QUERY_PATH_INFORMATION sub-command. See [MS-CIFS]: 2.2.6.6.1
+            params_bytes = \
+                struct.pack('<HI',
+                            0x0107, # SMB_QUERY_FILE_ALL_INFO ([MS-CIFS] 2.2.2.3.3)
+                            0x0000) # Reserved
+            params_bytes += (path + '\0').encode('UTF-16LE')
+
+            m = SMBMessage(ComTransaction2Request(max_params_count = 2,
+                                                  max_data_count = 65535,
+                                                  max_setup_count = 0,
+                                                  params_bytes = params_bytes,
+                                                  setup_bytes = setup_bytes))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, queryCB, errback)
+            messages_history.append(m)
+
+        def queryCB(query_message, **kwargs):
+            messages_history.append(query_message)
+            if not query_message.status.hasError:
+                info_format = '<QQQQIIQQ'
+                info_size = struct.calcsize(info_format)
+                create_time, last_access_time, last_write_time, last_attr_change_time, \
+                file_attributes, _, alloc_size, file_size = struct.unpack(info_format, query_message.payload.data_bytes[:info_size])
+
+                info = SharedFile(create_time, last_access_time, last_write_time, last_attr_change_time,
+                                  file_size, alloc_size, file_attributes, unicode(path), unicode(path))
+                callback(info)
+            else:
+                errback(OperationFailure('Failed to get attributes for %s on %s: Read failed' % ( path, service_name ), messages_history))
+
+        if not self.connected_trees.has_key(service_name):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if not connect_message.status.hasError:
+                    self.connected_trees[service_name] = connect_message.tid
+                    sendQuery(connect_message.tid)
+                else:
+                    errback(OperationFailure('Failed to get attributes for %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))
+
+            m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)
+            messages_history.append(m)
+        else:
+            sendQuery(self.connected_trees[service_name])
+
+    def _retrieveFile_SMB1(self, service_name, path, file_obj, callback, errback, timeout = 30):
+        return self._retrieveFileFromOffset(service_name, path, file_obj, callback, errback, 0L, -1L, timeout)
+
+    def _retrieveFileFromOffset_SMB1(self, service_name, path, file_obj, callback, errback, starting_offset, max_length, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        path = path.replace('/', '\\')
+        messages_history = [ ]
+
+        def sendOpen(tid):
+            m = SMBMessage(ComOpenAndxRequest(filename = path,
+                                              access_mode = 0x0040,  # Sharing mode: Deny nothing to others
+                                              open_mode = 0x0001,    # Failed if file does not exist
+                                              search_attributes = SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM,
+                                              timeout = timeout * 1000))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, openCB, errback)
+            messages_history.append(m)
+
+        def openCB(open_message, **kwargs):
+            messages_history.append(open_message)
+            if not open_message.status.hasError:
+                if max_length == 0:
+                    closeFid(open_message.tid, open_message.payload.fid)
+                    callback(( file_obj, open_message.payload.file_attributes, 0L ))
+                else:
+                    sendRead(open_message.tid, open_message.payload.fid, starting_offset, open_message.payload.file_attributes, 0L, max_length)
+            else:
+                errback(OperationFailure('Failed to retrieve %s on %s: Unable to open file' % ( path, service_name ), messages_history))
+
+        def sendRead(tid, fid, offset, file_attributes, read_len, remaining_len):
+            read_count = self.max_raw_size - 2
+            m = SMBMessage(ComReadAndxRequest(fid = fid,
+                                              offset = offset,
+                                              max_return_bytes_count = read_count,
+                                              min_return_bytes_count = min(0xFFFF, read_count)))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, readCB, errback, fid = fid, offset = offset, file_attributes = file_attributes,
+                                                           read_len = read_len, remaining_len = remaining_len)
+
+        def readCB(read_message, **kwargs):
+            # To avoid crazy memory usage when retrieving large files, we do not save every read_message in messages_history.
+            if not read_message.status.hasError:
+                read_len = kwargs['read_len']
+                remaining_len = kwargs['remaining_len']
+                data_len = read_message.payload.data_length
+                if max_length > 0:
+                    if data_len > remaining_len:
+                        file_obj.write(read_message.payload.data[:remaining_len])
+                        read_len += remaining_len
+                        remaining_len = 0
+                    else:
+                        file_obj.write(read_message.payload.data)
+                        remaining_len -= data_len
+                        read_len += data_len
+                else:
+                    file_obj.write(read_message.payload.data)
+                    read_len += data_len
+
+                if (max_length > 0 and remaining_len <= 0) or data_len < (self.max_raw_size - 2):
+                    closeFid(read_message.tid, kwargs['fid'])
+                    callback(( file_obj, kwargs['file_attributes'], read_len ))  # Note that this is a tuple of 3-elements
+                else:
+                    sendRead(read_message.tid, kwargs['fid'], kwargs['offset']+data_len, kwargs['file_attributes'], read_len, remaining_len)
+            else:
+                messages_history.append(read_message)
+                closeFid(read_message.tid, kwargs['fid'])
+                errback(OperationFailure('Failed to retrieve %s on %s: Read failed' % ( path, service_name ), messages_history))
+
+        def closeFid(tid, fid):
+            m = SMBMessage(ComCloseRequest(fid))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            messages_history.append(m)
+
+        if not self.connected_trees.has_key(service_name):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if not connect_message.status.hasError:
+                    self.connected_trees[service_name] = connect_message.tid
+                    sendOpen(connect_message.tid)
+                else:
+                    errback(OperationFailure('Failed to retrieve %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))
+
+            m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)
+            messages_history.append(m)
+        else:
+            sendOpen(self.connected_trees[service_name])
+
+    def _storeFile_SMB1(self, service_name, path, file_obj, callback, errback, timeout = 30):
+        self._storeFileFromOffset_SMB1(service_name, path, file_obj, callback, errback, 0L, True, timeout)
+
+    def _storeFileFromOffset_SMB1(self, service_name, path, file_obj, callback, errback, starting_offset, truncate = False, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        path = path.replace('/', '\\')
+        messages_history = [ ]
+
+        def sendOpen(tid):
+            m = SMBMessage(ComOpenAndxRequest(filename = path,
+                                              access_mode = 0x0041,  # Sharing mode: Deny nothing to others + Open for writing
+                                              open_mode = 0x0012 if truncate else 0x0011,    # Create file if file does not exist. Overwrite or append depending on truncate parameter.
+                                              search_attributes = SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM,
+                                              timeout = timeout * 1000))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, openCB, errback)
+            messages_history.append(m)
+
+        def openCB(open_message, **kwargs):
+            messages_history.append(open_message)
+            if not open_message.status.hasError:
+                sendWrite(open_message.tid, open_message.payload.fid, starting_offset)
+            else:
+                errback(OperationFailure('Failed to store %s on %s: Unable to open file' % ( path, service_name ), messages_history))
+
+        def sendWrite(tid, fid, offset):
+            # For message signing, the total SMB message size must be not exceed the max_buffer_size. Non-message signing does not have this limitation
+            write_count = min((self.is_signing_active and (self.max_buffer_size-64)) or self.max_raw_size, 0xFFFF-1)  # Need to minus 1 byte from 0xFFFF because of the first NULL byte in the ComWriteAndxRequest message data
+            data_bytes = file_obj.read(write_count)
+            data_len = len(data_bytes)
+            if data_len > 0:
+                m = SMBMessage(ComWriteAndxRequest(fid = fid, offset = offset, data_bytes = data_bytes))
+                m.tid = tid
+                self._sendSMBMessage(m)
+                self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, writeCB, errback, fid = fid, offset = offset+data_len)
+            else:
+                closeFid(tid, fid)
+                callback(( file_obj, offset ))  # Note that this is a tuple of 2-elements
+
+        def writeCB(write_message, **kwargs):
+            # To avoid crazy memory usage when saving large files, we do not save every write_message in messages_history.
+            if not write_message.status.hasError:
+                sendWrite(write_message.tid, kwargs['fid'], kwargs['offset'])
+            else:
+                messages_history.append(write_message)
+                closeFid(write_message.tid, kwargs['fid'])
+                errback(OperationFailure('Failed to store %s on %s: Write failed' % ( path, service_name ), messages_history))
+
+        def closeFid(tid, fid):
+            m = SMBMessage(ComCloseRequest(fid))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            messages_history.append(m)
+
+        if not self.connected_trees.has_key(service_name):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if not connect_message.status.hasError:
+                    self.connected_trees[service_name] = connect_message.tid
+                    sendOpen(connect_message.tid)
+                else:
+                    errback(OperationFailure('Failed to store %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))
+
+            m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)
+            messages_history.append(m)
+        else:
+            sendOpen(self.connected_trees[service_name])
+
+    def _deleteFiles_SMB1(self, service_name, path_file_pattern, callback, errback, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        path = path_file_pattern.replace('/', '\\')
+        messages_history = [ ]
+
+        def sendDelete(tid):
+            m = SMBMessage(ComDeleteRequest(filename_pattern = path,
+                                            search_attributes = SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback)
+            messages_history.append(m)
+
+        def deleteCB(delete_message, **kwargs):
+            messages_history.append(delete_message)
+            if not delete_message.status.hasError:
+                callback(path_file_pattern)
+            else:
+                errback(OperationFailure('Failed to store %s on %s: Delete failed' % ( path, service_name ), messages_history))
+
+        if not self.connected_trees.has_key(service_name):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if not connect_message.status.hasError:
+                    self.connected_trees[service_name] = connect_message.tid
+                    sendDelete(connect_message.tid)
+                else:
+                    errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))
+
+            m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)
+            messages_history.append(m)
+        else:
+            sendDelete(self.connected_trees[service_name])
+
+    def _resetFileAttributes_SMB1(self, service_name, path_file_pattern, callback, errback, timeout = 30):
+        raise NotReadyError('resetFileAttributes is not yet implemented for SMB1')
+
+    def _createDirectory_SMB1(self, service_name, path, callback, errback, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        path = path.replace('/', '\\')
+        messages_history = [ ]
+
+        def sendCreate(tid):
+            m = SMBMessage(ComCreateDirectoryRequest(path))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback)
+            messages_history.append(m)
+
+        def createCB(create_message, **kwargs):
+            messages_history.append(create_message)
+            if not create_message.status.hasError:
+                callback(path)
+            else:
+                errback(OperationFailure('Failed to create directory %s on %s: Create failed' % ( path, service_name ), messages_history))
+
+        if not self.connected_trees.has_key(service_name):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if not connect_message.status.hasError:
+                    self.connected_trees[service_name] = connect_message.tid
+                    sendCreate(connect_message.tid)
+                else:
+                    errback(OperationFailure('Failed to create directory %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))
+
+            m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)
+            messages_history.append(m)
+        else:
+            sendCreate(self.connected_trees[service_name])
+
+    def _deleteDirectory_SMB1(self, service_name, path, callback, errback, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        path = path.replace('/', '\\')
+        messages_history = [ ]
+
+        def sendDelete(tid):
+            m = SMBMessage(ComDeleteDirectoryRequest(path))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback)
+            messages_history.append(m)
+
+        def deleteCB(delete_message, **kwargs):
+            messages_history.append(delete_message)
+            if not delete_message.status.hasError:
+                callback(path)
+            else:
+                errback(OperationFailure('Failed to delete directory %s on %s: Delete failed' % ( path, service_name ), messages_history))
+
+        if not self.connected_trees.has_key(service_name):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if not connect_message.status.hasError:
+                    self.connected_trees[service_name] = connect_message.tid
+                    sendDelete(connect_message.tid)
+                else:
+                    errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))
+
+            m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)
+            messages_history.append(m)
+        else:
+            sendDelete(self.connected_trees[service_name])
+
+    def _rename_SMB1(self, service_name, old_path, new_path, callback, errback, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        new_path = new_path.replace('/', '\\')
+        old_path = old_path.replace('/', '\\')
+        messages_history = [ ]
+
+        def sendRename(tid):
+            m = SMBMessage(ComRenameRequest(old_path = old_path,
+                                            new_path = new_path,
+                                            search_attributes = SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, renameCB, errback)
+            messages_history.append(m)
+
+        def renameCB(rename_message, **kwargs):
+            messages_history.append(rename_message)
+            if not rename_message.status.hasError:
+                callback(( old_path, new_path ))  # Note that this is a tuple of 2-elements
+            else:
+                errback(OperationFailure('Failed to rename %s on %s: Rename failed' % ( old_path, service_name ), messages_history))
+
+        if not self.connected_trees.has_key(service_name):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if not connect_message.status.hasError:
+                    self.connected_trees[service_name] = connect_message.tid
+                    sendRename(connect_message.tid)
+                else:
+                    errback(OperationFailure('Failed to rename %s on %s: Unable to connect to shared device' % ( old_path, service_name ), messages_history))
+
+            m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)
+            messages_history.append(m)
+        else:
+            sendRename(self.connected_trees[service_name])
+
+    def _listSnapshots_SMB1(self, service_name, path, callback, errback, timeout = 30):
+        if not self.has_authenticated:
+            raise NotReadyError('SMB connection not authenticated')
+
+        expiry_time = time.time() + timeout
+        path = path.replace('/', '\\')
+        if not path.endswith('\\'):
+            path += '\\'
+        messages_history = [ ]
+        results = [ ]
+
+        def sendOpen(tid):
+            m = SMBMessage(ComOpenAndxRequest(filename = path,
+                                              access_mode = 0x0040,  # Sharing mode: Deny nothing to others
+                                              open_mode = 0x0001,    # Failed if file does not exist
+                                              search_attributes = 0,
+                                              timeout = timeout * 1000))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, openCB, errback)
+            messages_history.append(m)
+
+        def openCB(open_message, **kwargs):
+            messages_history.append(open_message)
+            if not open_message.status.hasError:
+                sendEnumSnapshots(open_message.tid, open_message.payload.fid)
+            else:
+                errback(OperationFailure('Failed to list snapshots %s on %s: Unable to open path' % ( path, service_name ), messages_history))
+
+        def sendEnumSnapshots(tid, fid):
+            # [MS-CIFS]: 2.2.7.2
+            # [MS-SMB]: 2.2.7.2.1
+            setup_bytes = struct.pack('<IHBB',
+                                      0x00144064,  # [MS-SMB]: 2.2.7.2.1
+                                      fid,         # FID
+                                      0x01,        # IsFctl
+                                      0)           # IsFlags
+            m = SMBMessage(ComNTTransactRequest(function = 0x0002,  # NT_TRANSACT_IOCTL. [MS-CIFS]: 2.2.7.2.1
+                                                max_params_count = 0,
+                                                max_data_count = 0xFFFF,
+                                                max_setup_count = 0,
+                                                setup_bytes = setup_bytes))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, enumSnapshotsCB, errback, tid = tid, fid = fid)
+            messages_history.append(m)
+
+        def enumSnapshotsCB(enum_message, **kwargs):
+            messages_history.append(enum_message)
+            if not enum_message.status.hasError:
+                results = [ ]
+                snapshots_count = struct.unpack('<I', enum_message.payload.data_bytes[4:8])[0]
+                for i in range(0, snapshots_count):
+                    s = enum_message.payload.data_bytes[12+i*50:12+48+i*50].decode('UTF-16LE')
+                    results.append(datetime(*map(int, ( s[5:9], s[10:12], s[13:15], s[16:18], s[19:21], s[22:24] ))))
+                closeFid(kwargs['tid'], kwargs['fid'])
+                callback(results)
+            else:
+                closeFid(kwargs['tid'], kwargs['fid'])
+                errback(OperationFailure('Failed to list snapshots %s on %s: Unable to list snapshots on path' % ( path, service_name ), messages_history))
+
+        def closeFid(tid, fid):
+            m = SMBMessage(ComCloseRequest(fid))
+            m.tid = tid
+            self._sendSMBMessage(m)
+            messages_history.append(m)
+
+        if not self.connected_trees.has_key(service_name):
+            def connectCB(connect_message, **kwargs):
+                messages_history.append(connect_message)
+                if not connect_message.status.hasError:
+                    self.connected_trees[service_name] = connect_message.tid
+                    sendOpen(connect_message.tid)
+                else:
+                    errback(OperationFailure('Failed to list snapshots %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))
+
+            m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))
+            self._sendSMBMessage(m)
+            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)
+            messages_history.append(m)
+        else:
+            sendOpen(self.connected_trees[service_name])
+
+    def _echo_SMB1(self, data, callback, errback, timeout = 30):
+        messages_history = [ ]
+
+        def echoCB(echo_message, **kwargs):
+            messages_history.append(echo_message)
+            if not echo_message.status.hasError:
+                callback(echo_message.payload.data)
+            else:
+                errback(OperationFailure('Echo failed', messages_history))
+
+        m = SMBMessage(ComEchoRequest(echo_data = data))
+        self._sendSMBMessage(m)
+        self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, echoCB, errback)
+        messages_history.append(m)
+
+
+
[docs]class SharedDevice:
+    """
+    Contains information about a single shared device on the remote server.
+    """
+
+    # The following constants are taken from [MS-SRVS]: 2.2.2.4
+    # They are used to identify the type of shared resource from the results from the NetrShareEnum in Server Service RPC
+    DISK_TREE   = 0x00
+    PRINT_QUEUE = 0x01
+    COMM_DEVICE = 0x02
+    IPC         = 0x03
+
+    def __init__(self, type, name, comments):
+        self._type = type
+        self.name = name         #: An unicode string containing the name of the shared device
+        self.comments = comments #: An unicode string containing the user description of the shared device
+
+    @property
+    def type(self):
+        """
+        Returns one of the following integral constants.
+         - SharedDevice.DISK_TREE
+         - SharedDevice.PRINT_QUEUE
+         - SharedDevice.COMM_DEVICE
+         - SharedDevice.IPC
+        """
+        return self._type & 0xFFFF
+
+    @property
+    def isSpecial(self):
+        """
+        Returns True if this shared device is a special share reserved for interprocess communication (IPC$)
+        or remote administration of the server (ADMIN$). Can also refer to administrative shares such as
+        C$, D$, E$, and so forth
+        """
+        return bool(self._type & 0x80000000)
+
+    @property
+    def isTemporary(self):
+        """
+        Returns True if this is a temporary share that is not persisted for creation each time the file server initializes.
+        """
+        return bool(self._type & 0x40000000)
+
+    def __unicode__(self):
+        return u'Shared device: %s (type:0x%02x comments:%s)' % (self.name, self.type, self.comments )

+
+
+
[docs]class SharedFile:
+    """
+    Contain information about a file/folder entry that is shared on the shared device.
+
+    As an application developer, you should not need to instantiate a *SharedFile* instance directly in your application.
+    These *SharedFile* instances are usually returned via a call to *listPath* method in :doc:`smb.SMBProtocol.SMBProtocolFactory<smb_SMBProtocolFactory>`.
+
+    If you encounter *SharedFile* instance where its short_name attribute is empty but the filename attribute contains a short name which does not correspond
+    to any files/folders on your remote shared device, it could be that the original filename on the file/folder entry on the shared device contains
+    one of these prohibited characters: "\/[]:+|<>=;?,* (see [MS-CIFS]: 2.2.1.1.1 for more details).
+    """
+
+    def __init__(self, create_time, last_access_time, last_write_time, last_attr_change_time, file_size, alloc_size, file_attributes, short_name, filename):
+        self.create_time = create_time  #: Float value in number of seconds since 1970-01-01 00:00:00 to the time of creation of this file resource on the remote server
+        self.last_access_time = last_access_time  #: Float value in number of seconds since 1970-01-01 00:00:00 to the time of last access of this file resource on the remote server
+        self.last_write_time = last_write_time    #: Float value in number of seconds since 1970-01-01 00:00:00 to the time of last modification of this file resource on the remote server
+        self.last_attr_change_time = last_attr_change_time  #: Float value in number of seconds since 1970-01-01 00:00:00 to the time of last attribute change of this file resource on the remote server
+        self.file_size = file_size   #: File size in number of bytes
+        self.alloc_size = alloc_size #: Total number of bytes allocated to store this file
+        self.file_attributes = file_attributes #: A SMB_EXT_FILE_ATTR integer value. See [MS-CIFS]: 2.2.1.2.3
+        self.short_name = short_name #: Unicode string containing the short name of this file (usually in 8.3 notation)
+        self.filename = filename     #: Unicode string containing the long filename of this file. Each OS has a limit to the length of this file name. On Windows, it is 256 characters.
+
+    @property
+    def isDirectory(self):
+        """A convenient property to return True if this file resource is a directory on the remote server"""
+        return bool(self.file_attributes & ATTR_DIRECTORY)
+
+    @property
+    def isReadOnly(self):
+        """A convenient property to return True if this file resource is read-only on the remote server"""
+        return bool(self.file_attributes & ATTR_READONLY)
+
+    def __unicode__(self):
+        return u'Shared file: %s (FileSize:%d bytes, isDirectory:%s)' % ( self.filename, self.file_size, self.isDirectory )

+
+
+class _PendingRequest:
+
+    def __init__(self, mid, expiry_time, callback, errback, **kwargs):
+        self.mid = mid
+        self.expiry_time = expiry_time
+        self.callback = callback
+        self.errback = errback
+        self.kwargs = kwargs
+
+ +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/html/_modules/smb/smb_structs.html b/docs/html/_modules/smb/smb_structs.html new file mode 100644 index 0000000..61587b1 --- /dev/null +++ b/docs/html/_modules/smb/smb_structs.html @@ -0,0 +1,1506 @@ + + + + + + + + smb.smb_structs — pysmb 1.1.18 documentation + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for smb.smb_structs

+
+import os, sys, struct, types, logging, binascii, time
+from StringIO import StringIO
+from smb_constants import *
+
+
+# Set to True if you want to enable support for extended security. Required for Windows Vista and later
+SUPPORT_EXTENDED_SECURITY = True
+
+# Set to True if you want to enable SMB2 protocol.
+SUPPORT_SMB2 = True
+
+# Supported dialects
+DIALECTS = [ ]
+for i, ( name, dialect ) in enumerate([ ( 'NT_LAN_MANAGER_DIALECT', 'NT LM 0.12' ), ]):
+    DIALECTS.append(dialect)
+    globals()[name] = i
+
+DIALECTS2 = [ ]
+for i, ( name, dialect ) in enumerate([ ( 'SMB2_DIALECT', 'SMB 2.002' ) ]):
+    DIALECTS2.append(dialect)
+    globals()[name] = i + len(DIALECTS)
+
+
+
[docs]class UnsupportedFeature(Exception):
+    """
+    Raised when an supported feature is present/required in the protocol but is not
+    currently supported by pysmb
+    """
+    pass

+
+
+
[docs]class ProtocolError(Exception):
+
+    def __init__(self, message, data_buf = None, smb_message = None):
+        self.message = message
+        self.data_buf = data_buf
+        self.smb_message = smb_message
+
+    def __str__(self):
+        b = StringIO()
+        b.write(self.message + os.linesep)
+        if self.smb_message:
+            b.write('=' * 20 + ' SMB Message ' + '=' * 20 + os.linesep)
+            b.write(str(self.smb_message))
+
+        if self.data_buf:
+            b.write('=' * 20 + ' SMB Data Packet (hex) ' + '=' * 20 + os.linesep)
+            b.write(binascii.hexlify(self.data_buf))
+            b.write(os.linesep)
+
+        return b.getvalue()

+
+class SMB2ProtocolHeaderError(ProtocolError):
+
+    def __init__(self):
+        ProtocolError.__init__(self, "Packet header belongs to SMB2")
+
+
[docs]class OperationFailure(Exception):
+
+    def __init__(self, message, smb_messages):
+        self.args = [ message ]
+        self.message = message
+        self.smb_messages = smb_messages
+
+    def __str__(self):
+        b = StringIO()
+        b.write(self.message + os.linesep)
+
+        for idx, m in enumerate(self.smb_messages):
+            b.write('=' * 20 + ' SMB Message %d ' % idx + '=' * 20 + os.linesep)
+            b.write('SMB Header:' + os.linesep)
+            b.write('-----------' + os.linesep)
+            b.write(str(m))
+            b.write('SMB Data Packet (hex):' + os.linesep)
+            b.write('----------------------' + os.linesep)
+            b.write(binascii.hexlify(m.raw_data))
+            b.write(os.linesep)
+
+        return b.getvalue()

+
+
+class SMBError:
+
+    def __init__(self):
+        self.reset()
+
+    def reset(self):
+        self.internal_value = 0L
+        self.is_ntstatus = True
+
+    def __str__(self):
+        if self.is_ntstatus:
+            return 'NTSTATUS=0x%08X' % self.internal_value
+        else:
+            return 'ErrorClass=0x%02X ErrorCode=0x%04X' % ( self.internal_value >> 24, self.internal_value & 0xFFFF )
+
+    @property
+    def hasError(self):
+        return self.internal_value != 0
+
+
+class SMBMessage:
+
+    HEADER_STRUCT_FORMAT = "<4sBIBHHQxxHHHHB"
+    HEADER_STRUCT_SIZE = struct.calcsize(HEADER_STRUCT_FORMAT)
+
+    log = logging.getLogger('SMB.SMBMessage')
+    protocol = 1
+
+    def __init__(self, payload = None):
+        self.reset()
+        if payload:
+            self.payload = payload
+            self.payload.initMessage(self)
+
+    def __str__(self):
+        b = StringIO()
+        b.write('Command: 0x%02X (%s) %s' % ( self.command, SMB_COMMAND_NAMES.get(self.command, '<unknown>'), os.linesep ))
+        b.write('Status: %s %s' % ( str(self.status), os.linesep ))
+        b.write('Flags: 0x%02X %s' % ( self.flags, os.linesep ))
+        b.write('Flags2: 0x%04X %s' % ( self.flags2, os.linesep ))
+        b.write('PID: %d %s' % ( self.pid, os.linesep ))
+        b.write('UID: %d %s' % ( self.uid, os.linesep ))
+        b.write('MID: %d %s' % ( self.mid, os.linesep ))
+        b.write('TID: %d %s' % ( self.tid, os.linesep ))
+        b.write('Security: 0x%016X %s' % ( self.security, os.linesep ))
+        b.write('Parameters: %d bytes %s%s %s' % ( len(self.parameters_data), os.linesep, binascii.hexlify(self.parameters_data), os.linesep ))
+        b.write('Data: %d bytes %s%s %s' % ( len(self.data), os.linesep, binascii.hexlify(self.data), os.linesep ))
+        return b.getvalue()
+
+    def reset(self):
+        self.raw_data = ''
+        self.command = 0
+        self.status = SMBError()
+        self.flags = 0
+        self.flags2 = 0
+        self.pid = 0
+        self.tid = 0
+        self.uid = 0
+        self.mid = 0
+        self.security = 0L
+        self.parameters_data = ''
+        self.data = ''
+        self.payload = None
+
+    @property
+    def isReply(self):
+        return bool(self.flags & SMB_FLAGS_REPLY)
+
+    @property
+    def hasExtendedSecurity(self):
+        return bool(self.flags2 & SMB_FLAGS2_EXTENDED_SECURITY)
+
+    def encode(self):
+        """
+        Encode this SMB message into a series of bytes suitable to be embedded with a NetBIOS session message.
+        AssertionError will be raised if this SMB message has not been initialized with a Payload instance
+
+        @return: a string containing the encoded SMB message
+        """
+        assert self.payload
+
+        self.pid = os.getpid()
+        self.payload.prepare(self)
+
+        parameters_len = len(self.parameters_data)
+        assert parameters_len % 2 == 0
+
+        headers_data = struct.pack(self.HEADER_STRUCT_FORMAT,
+                                   '\xFFSMB', self.command, self.status.internal_value, self.flags,
+                                   self.flags2, (self.pid >> 16) & 0xFFFF, self.security, self.tid,
+                                   self.pid & 0xFFFF, self.uid, self.mid, int(parameters_len / 2))
+        return headers_data + self.parameters_data + struct.pack('<H', len(self.data)) + self.data
+
+    def decode(self, buf):
+        """
+        Decodes the SMB message in buf.
+        All fields of the SMBMessage object will be reset to default values before decoding.
+        On errors, do not assume that the fields will be reinstated back to what they are before
+        this method is invoked.
+
+        @param buf: data containing one complete SMB message
+        @type buf: string
+        @return: a positive integer indicating the number of bytes used in buf to decode this SMB message
+        @raise ProtocolError: raised when decoding fails
+        """
+        buf_len = len(buf)
+        if buf_len < self.HEADER_STRUCT_SIZE:
+            # We need at least 32 bytes (header) + 1 byte (parameter count)
+            raise ProtocolError('Not enough data to decode SMB header', buf)
+
+        self.reset()
+
+        protocol, self.command, status, self.flags, \
+        self.flags2, pid_high, self.security, self.tid, \
+        pid_low, self.uid, self.mid, params_count = struct.unpack(self.HEADER_STRUCT_FORMAT, buf[:self.HEADER_STRUCT_SIZE])
+
+        if protocol == '\xFESMB':
+            raise SMB2ProtocolHeaderError()
+        if protocol != '\xFFSMB':
+            raise ProtocolError('Invalid 4-byte protocol field', buf)
+
+        self.pid = (pid_high << 16) | pid_low
+        self.status.internal_value = status
+        self.status.is_ntstatus = bool(self.flags2 & SMB_FLAGS2_NT_STATUS)
+
+        offset = self.HEADER_STRUCT_SIZE
+        if buf_len < params_count * 2 + 2:
+            # Not enough data in buf to decode up to body length
+            raise ProtocolError('Not enough data. Parameters list decoding failed', buf)
+
+        datalen_offset = offset + params_count*2
+        body_len = struct.unpack('<H', buf[datalen_offset:datalen_offset+2])[0]
+        if body_len > 0 and buf_len < (datalen_offset + 2 + body_len):
+            # Not enough data in buf to decode body
+            raise ProtocolError('Not enough data. Body decoding failed', buf)
+
+        self.parameters_data = buf[offset:datalen_offset]
+
+        if body_len > 0:
+            self.data = buf[datalen_offset+2:datalen_offset+2+body_len]
+
+        self.raw_data = buf
+        self._decodePayload()
+
+        return self.HEADER_STRUCT_SIZE + params_count * 2 + 2 + body_len
+
+    def _decodePayload(self):
+        if self.command == SMB_COM_READ_ANDX:
+            self.payload = ComReadAndxResponse()
+        elif self.command == SMB_COM_WRITE_ANDX:
+            self.payload = ComWriteAndxResponse()
+        elif self.command == SMB_COM_TRANSACTION:
+            self.payload = ComTransactionResponse()
+        elif self.command == SMB_COM_TRANSACTION2:
+            self.payload = ComTransaction2Response()
+        elif self.command == SMB_COM_OPEN_ANDX:
+            self.payload = ComOpenAndxResponse()
+        elif self.command == SMB_COM_NT_CREATE_ANDX:
+            self.payload = ComNTCreateAndxResponse()
+        elif self.command == SMB_COM_TREE_CONNECT_ANDX:
+            self.payload = ComTreeConnectAndxResponse()
+        elif self.command == SMB_COM_ECHO:
+            self.payload = ComEchoResponse()
+        elif self.command == SMB_COM_SESSION_SETUP_ANDX:
+            self.payload = ComSessionSetupAndxResponse()
+        elif self.command == SMB_COM_NEGOTIATE:
+            self.payload = ComNegotiateResponse()
+
+        if self.payload:
+            self.payload.decode(self)
+
+
+class Payload:
+
+    DEFAULT_ANDX_PARAM_HEADER = '\xFF\x00\x00\x00'
+    DEFAULT_ANDX_PARAM_SIZE = 4
+
+    def initMessage(self, message):
+        # SMB_FLAGS2_UNICODE must always be enabled. Without this, almost all the Payload subclasses will need to be
+        # rewritten to check for OEM/Unicode strings which will be tedious. Fortunately, almost all tested CIFS services
+        # support SMB_FLAGS2_UNICODE by default.
+        assert message.payload == self
+        message.flags =  SMB_FLAGS_CASE_INSENSITIVE | SMB_FLAGS_CANONICALIZED_PATHS
+        message.flags2 = SMB_FLAGS2_UNICODE | SMB_FLAGS2_NT_STATUS | SMB_FLAGS2_LONG_NAMES | SMB_FLAGS2_EAS
+
+        if SUPPORT_EXTENDED_SECURITY:
+            message.flags2 |= SMB_FLAGS2_EXTENDED_SECURITY | SMB_FLAGS2_SMB_SECURITY_SIGNATURE
+
+    def prepare(self, message):
+        raise NotImplementedError
+
+    def decode(self, message):
+        raise NotImplementedError
+
+
+class ComNegotiateRequest(Payload):
+    """
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.52.1
+    - [MS-SMB]: 2.2.4.5.1
+    """
+
+    def initMessage(self, message):
+        Payload.initMessage(self, message)
+        message.command = SMB_COM_NEGOTIATE
+
+    def prepare(self, message):
+        assert message.payload == self
+        message.parameters_data = ''
+        if SUPPORT_SMB2:
+            message.data = ''.join(map(lambda s: '\x02'+s+'\x00', DIALECTS + DIALECTS2))
+        else:
+            message.data = ''.join(map(lambda s: '\x02'+s+'\x00', DIALECTS))
+
+
+class ComNegotiateResponse(Payload):
+    """
+    Contains information on the SMB_COM_NEGOTIATE response from server
+
+    After calling the decode method, each instance will contain the following attributes,
+    - security_mode (integer)
+    - max_mpx_count (integer)
+    - max_number_vcs (integer)
+    - max_buffer_size (long)
+    - max_raw_size (long)
+    - session_key (long)
+    - capabilities (long)
+    - system_time (long)
+    - server_time_zone (integer)
+    - challenge_length (integer)
+
+    If the underlying SMB message's flag2 does not have SMB_FLAGS2_EXTENDED_SECURITY bit enabled,
+    then the instance will have the following additional attributes,
+    - challenge (string)
+    - domain (unicode)
+
+    If the underlying SMB message's flags2 has SMB_FLAGS2_EXTENDED_SECURITY bit enabled,
+    then the instance will have the following additional attributes,
+    - server_guid (string)
+    - security_blob (string)
+
+    References:
+    ===========
+    - [MS-SMB]: 2.2.4.5.2.1
+    - [MS-CIFS]: 2.2.4.52.2
+    """
+
+    PAYLOAD_STRUCT_FORMAT = '<HBHHIIIIQHB'
+    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)
+
+    def decode(self, message):
+        assert message.command == SMB_COM_NEGOTIATE
+
+        if not message.isReply:
+            raise ProtocolError('Not a SMB_COM_NEGOTIATE reply', message.raw_data, message)
+
+        self.security_mode, self.max_mpx_count, self.max_number_vcs, self.max_buffer_size, \
+        self.max_raw_size, self.session_key, self.capabilities, self.system_time, self.server_time_zone, \
+        self.challenge_length = ( 0, ) * 10
+
+        data_len = len(message.parameters_data)
+        if data_len < 2:
+            raise ProtocolError('Not enough data to decode SMB_COM_NEGOTIATE dialect_index field', message.raw_data, message)
+
+        self.dialect_index = struct.unpack('<H', message.parameters_data[:2])[0]
+        if self.dialect_index == NT_LAN_MANAGER_DIALECT:
+            if data_len != (0x11 * 2):
+                raise ProtocolError('NT LAN Manager dialect selected in SMB_COM_NEGOTIATE but parameters bytes count (%d) does not meet specs' % data_len,
+                                    message.raw_data, message)
+            else:
+                _, self.security_mode, self.max_mpx_count, self.max_number_vcs, self.max_buffer_size, \
+                self.max_raw_size, self.session_key, self.capabilities, self.system_time, self.server_time_zone, \
+                self.challenge_length = struct.unpack(self.PAYLOAD_STRUCT_FORMAT, message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])
+        elif self.dialect_index == 0xFFFF:
+            raise ProtocolError('Server does not support any of the pysmb dialects. Please email pysmb to add in support for your OS',
+                                message.raw_data, message)
+        else:
+            raise ProtocolError('Unknown dialect index (0x%04X)' % self.dialect_index, message.raw_data, message)
+
+        data_len = len(message.data)
+        if not message.hasExtendedSecurity:
+            self.challenge, self.domain = '', ''
+            if self.challenge_length > 0:
+                if data_len >= self.challenge_length:
+                    self.challenge = message.data[:self.challenge_length]
+
+                    s = ''
+                    offset = self.challenge_length
+                    while offset < data_len:
+                        _s = message.data[offset:offset+2]
+                        if _s == '\0\0':
+                            self.domain = s.decode('UTF-16LE')
+                            break
+                        else:
+                            s += _s
+                            offset += 2
+                else:
+                    raise ProtocolError('Not enough data to decode SMB_COM_NEGOTIATE (without security extensions) Challenge field', message.raw_data, message)
+        else:
+            if data_len < 16:
+                raise ProtocolError('Not enough data to decode SMB_COM_NEGOTIATE (with security extensions) ServerGUID field', message.raw_data, message)
+
+            self.server_guid = message.data[:16]
+            self.security_blob = message.data[16:]
+
+    @property
+    def supportsExtendedSecurity(self):
+        return bool(self.capabilities & CAP_EXTENDED_SECURITY)
+
+
+class ComSessionSetupAndxRequest__WithSecurityExtension(Payload):
+    """
+    References:
+    ===========
+    - [MS-SMB]: 2.2.4.6.1
+    """
+
+    PAYLOAD_STRUCT_FORMAT = '<HHHIHII'
+
+    def __init__(self, session_key, security_blob):
+        self.session_key = session_key
+        self.security_blob = security_blob
+
+    def initMessage(self, message):
+        Payload.initMessage(self, message)
+        message.command = SMB_COM_SESSION_SETUP_ANDX
+
+    def prepare(self, message):
+        assert message.hasExtendedSecurity
+
+        message.flags2 |= SMB_FLAGS2_UNICODE
+
+        cap = CAP_UNICODE | CAP_STATUS32 | CAP_EXTENDED_SECURITY | CAP_NT_SMBS
+
+        message.parameters_data = \
+            self.DEFAULT_ANDX_PARAM_HEADER + \
+            struct.pack(self.PAYLOAD_STRUCT_FORMAT,
+                        16644, 10, 1, self.session_key, len(self.security_blob), 0, cap)
+
+        message.data = self.security_blob
+        if (SMBMessage.HEADER_STRUCT_SIZE + len(message.parameters_data) + len(message.data)) % 2 != 0:
+            message.data = message.data + '\0'
+        message.data = message.data + '\0' * 4
+
+
+class ComSessionSetupAndxRequest__NoSecurityExtension(Payload):
+    """
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.53.1
+    """
+
+    PAYLOAD_STRUCT_FORMAT = '<HHHIHHII'
+
+    def __init__(self, session_key, username, password, is_unicode, domain):
+        self.username = username
+        self.session_key = session_key
+        self.password = password
+        self.is_unicode = is_unicode
+        self.domain = domain
+
+    def initMessage(self, message):
+        Payload.initMessage(self, message)
+        message.command = SMB_COM_SESSION_SETUP_ANDX
+
+    def prepare(self, message):
+        if self.is_unicode:
+            message.flags2 |= SMB_FLAGS2_UNICODE
+        else:
+            message.flags2 &= (~SMB_FLAGS2_UNICODE & 0xFFFF)
+
+        password_len = len(self.password)
+        message.parameters_data = \
+            self.DEFAULT_ANDX_PARAM_HEADER + \
+            struct.pack(self.PAYLOAD_STRUCT_FORMAT,
+                        16644, 10, 0, self.session_key,
+                        (not self.is_unicode and password_len) or 0,
+                        (self.is_unicode and password_len) or 0,
+                        0,
+                        CAP_UNICODE | CAP_LARGE_FILES | CAP_STATUS32)
+
+        est_offset = SMBMessage.HEADER_STRUCT_SIZE + len(message.parameters_data)  # To check if data until SMB paramaters are aligned to a 16-bit boundary
+
+        message.data = self.password
+        if (est_offset + len(message.data)) % 2 != 0 and message.flags2 & SMB_FLAGS2_UNICODE:
+            message.data = message.data + '\0'
+
+        if message.flags2 & SMB_FLAGS2_UNICODE:
+            message.data = message.data + self.username.encode('UTF-16LE') + '\0'
+        else:
+            message.data = message.data + str(self.username) + '\0'
+
+        if (est_offset + len(message.data)) % 2 != 0 and message.flags2 & SMB_FLAGS2_UNICODE:
+            message.data = message.data + '\0'
+
+        if message.flags2 & SMB_FLAGS2_UNICODE:
+            message.data = message.data + self.domain.encode('UTF-16LE') + '\0\0' + 'pysmb'.encode('UTF-16LE') + '\0\0'
+        else:
+            message.data = message.data + self.domain + '\0pysmb\0'
+
+
+class ComSessionSetupAndxResponse(Payload):
+    """
+    Contains information on the SMB_COM_SESSION_SETUP_ANDX response from server
+
+    If the underlying SMB message's flags2 does not have SMB_FLAGS2_EXTENDED_SECURITY bit enabled,
+    then the instance will have the following attributes,
+    - action
+
+    If the underlying SMB message's flags2 has SMB_FLAGS2_EXTENDED_SECURITY bit enabled
+    and the message status is STATUS_MORE_PROCESSING_REQUIRED or equals to 0x00 (no error),
+    then the instance will have the following attributes,
+    - action
+    - securityblob
+
+    If the underlying SMB message's flags2 has SMB_FLAGS2_EXTENDED_SECURITY bit enabled but
+    the message status is not STATUS_MORE_PROCESSING_REQUIRED
+
+    References:
+    ===========
+    - [MS-SMB]: 2.2.4.6.2
+    - [MS-CIFS]: 2.2.4.53.2
+    """
+
+    NOSECURE_PARAMETER_STRUCT_FORMAT = '<BBHH'
+    NOSECURE_PARAMETER_STRUCT_SIZE = struct.calcsize(NOSECURE_PARAMETER_STRUCT_FORMAT)
+
+    SECURE_PARAMETER_STRUCT_FORMAT = '<BBHHH'
+    SECURE_PARAMETER_STRUCT_SIZE = struct.calcsize(SECURE_PARAMETER_STRUCT_FORMAT)
+
+    def decode(self, message):
+        assert message.command == SMB_COM_SESSION_SETUP_ANDX
+        if not message.hasExtendedSecurity:
+            if not message.status.hasError:
+                if len(message.parameters_data) < self.NOSECURE_PARAMETER_STRUCT_SIZE:
+                    raise ProtocolError('Not enough data to decode SMB_COM_SESSION_SETUP_ANDX (no security extensions) parameters', message.raw_data, message)
+
+                _, _, _, self.action = struct.unpack(self.NOSECURE_PARAMETER_STRUCT_FORMAT, message.parameters_data[:self.NOSECURE_PARAMETER_STRUCT_SIZE])
+        else:
+            if not message.status.hasError or message.status.internal_value == 0xc0000016:   # STATUS_MORE_PROCESSING_REQUIRED
+                if len(message.parameters_data) < self.SECURE_PARAMETER_STRUCT_SIZE:
+                    raise ProtocolError('Not enough data to decode SMB_COM_SESSION_SETUP_ANDX (with security extensions) parameters', message.raw_data, message)
+
+                _, _, _, self.action, blob_length = struct.unpack(self.SECURE_PARAMETER_STRUCT_FORMAT, message.parameters_data[:self.SECURE_PARAMETER_STRUCT_SIZE])
+                if len(message.data) < blob_length:
+                    raise ProtocolError('Not enough data to decode SMB_COM_SESSION_SETUP_ANDX (with security extensions) security blob', message.raw_data, message)
+
+                self.security_blob = message.data[:blob_length]
+
+
+class ComTreeConnectAndxRequest(Payload):
+    """
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.55.1
+    - [MS-SMB]: 2.2.4.7.1
+    """
+
+    PAYLOAD_STRUCT_FORMAT = '<HH'
+    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)
+
+    def __init__(self, path, service, password = ''):
+        self.path = path
+        self.service = service
+        self.password = password + '\0'
+
+    def initMessage(self, message):
+        Payload.initMessage(self, message)
+        message.command = SMB_COM_TREE_CONNECT_ANDX
+
+    def prepare(self, message):
+        password_len = len(self.password)
+        message.parameters_data = \
+            self.DEFAULT_ANDX_PARAM_HEADER + \
+            struct.pack(self.PAYLOAD_STRUCT_FORMAT,
+                        0x08 | \
+                            ((message.hasExtendedSecurity and 0x0004) or 0x00) | \
+                            ((message.tid and message.tid != 0xFFFF and 0x0001) or 0x00),  # Disconnect tid, if message.tid must be non-zero
+                        password_len)
+
+        padding = ''
+        if password_len % 2 == 0:
+            padding = '\0'
+
+        # Note that service field is never encoded in UTF-16LE. [MS-CIFS]: 2.2.1.1
+        message.data = self.password + padding + self.path.encode('UTF-16LE') + '\0\0' + self.service + '\0'
+
+
+class ComTreeConnectAndxResponse(Payload):
+    """
+    Contains information about the SMB_COM_TREE_CONNECT_ANDX response from the server.
+
+    If the message has no errors, each instance contains the following attributes:
+    - optional_support
+
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.55.2
+    """
+
+    PAYLOAD_STRUCT_FORMAT = '<BBHH'
+    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)
+
+    def decode(self, message):
+        assert message.command == SMB_COM_TREE_CONNECT_ANDX
+
+        if not message.status.hasError:
+            if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE:
+                raise ProtocolError('Not enough data to decode SMB_COM_TREE_CONNECT_ANDX parameters', message.raw_data, message)
+
+            _, _, _, self.optional_support = struct.unpack(self.PAYLOAD_STRUCT_FORMAT, message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])
+
+
+class ComNTCreateAndxRequest(Payload):
+    """
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.64.1
+    - [MS-SMB]: 2.2.4.9.1
+    """
+
+    PAYLOAD_STRUCT_FORMAT = '<BHIIIQIIIIIB'
+    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)
+
+    def __init__(self, filename, flags = 0, root_fid = 0, access_mask = 0, allocation_size = 0L, ext_attr = 0,
+                 share_access = 0, create_disp = 0, create_options = 0, impersonation = 0, security_flags = 0):
+        self.filename = (filename + '\0').encode('UTF-16LE')
+        self.flags = flags
+        self.root_fid = root_fid
+        self.access_mask = access_mask
+        self.allocation_size = allocation_size
+        self.ext_attr = ext_attr
+        self.share_access = share_access
+        self.create_disp = create_disp
+        self.create_options = create_options
+        self.impersonation = impersonation
+        self.security_flags = security_flags
+
+    def initMessage(self, message):
+        Payload.initMessage(self, message)
+        message.command = SMB_COM_NT_CREATE_ANDX
+
+    def prepare(self, message):
+        filename_len = len(self.filename)
+
+        message.parameters_data = \
+            self.DEFAULT_ANDX_PARAM_HEADER + \
+            struct.pack(self.PAYLOAD_STRUCT_FORMAT,
+                        0x00,                  # reserved
+                        filename_len,          # NameLength
+                        self.flags,            # Flags
+                        self.root_fid,         # RootDirectoryFID
+                        self.access_mask,      # DesiredAccess
+                        self.allocation_size,  # AllocationSize
+                        self.ext_attr,         # ExtFileAttributes
+                        self.share_access,     # ShareAccess
+                        self.create_disp,      # CreateDisposition
+                        self.create_options,   # CreateOptions
+                        self.impersonation,    # ImpersonationLevel
+                        self.security_flags)   # SecurityFlags
+
+        padding = ''
+        if (message.HEADER_STRUCT_SIZE + len(message.parameters_data)) % 2 != 0:
+            padding = '\0'
+
+        message.data = padding + self.filename
+
+
+class ComNTCreateAndxResponse(Payload):
+    """
+    Contains (partial) information about the SMB_COM_NT_CREATE_ANDX response from the server.
+
+    Each instance contains the following attributes after decoding:
+    - oplock_level
+    - fid
+
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.64.2
+    """
+    PAYLOAD_STRUCT_FORMAT = '<BBHBH'
+    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)
+
+    def decode(self, message):
+        assert message.command == SMB_COM_NT_CREATE_ANDX
+
+        if not message.status.hasError:
+            if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE:
+                raise ProtocolError('Not enough data to decode SMB_COM_NT_CREATE_ANDX parameters', message.raw_data, message)
+
+            _, _, _, self.oplock_level, self.fid = struct.unpack(self.PAYLOAD_STRUCT_FORMAT, message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])
+
+
+class ComTransactionRequest(Payload):
+    """
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.33.1
+    """
+
+    PAYLOAD_STRUCT_FORMAT = '<HHHHBBHIHHHHHH'
+    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)
+
+    def __init__(self, max_params_count, max_data_count, max_setup_count,
+                 total_params_count = 0, total_data_count = 0,
+                 params_bytes = '', data_bytes = '', setup_bytes = '',
+                 flags = 0, timeout = 0, name = "\\PIPE\\"):
+        self.total_params_count = total_params_count or len(params_bytes)
+        self.total_data_count = total_data_count or len(data_bytes)
+        self.max_params_count = max_params_count
+        self.max_data_count = max_data_count
+        self.max_setup_count = max_setup_count
+        self.flags = flags
+        self.timeout = timeout
+        self.params_bytes = params_bytes
+        self.data_bytes = data_bytes
+        self.setup_bytes = setup_bytes
+        self.name = name
+
+    def initMessage(self, message):
+        Payload.initMessage(self, message)
+        message.command = SMB_COM_TRANSACTION
+
+    def prepare(self, message):
+        name = (self.name + '\0').encode('UTF-16LE')
+        name_len = len(name)
+        setup_bytes_len = len(self.setup_bytes)
+        params_bytes_len = len(self.params_bytes)
+        data_bytes_len = len(self.data_bytes)
+
+        padding0 = ''
+        offset = message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_bytes_len + 2 # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)
+        if offset % 2 != 0:
+            padding0 = '\0'
+            offset += 1
+
+        offset += name_len  # For the name field
+        padding1 = ''
+        if offset % 4 != 0:
+            padding1 = '\0'*(4-offset%4)
+            offset += (4-offset%4)
+
+        if params_bytes_len > 0:
+            params_bytes_offset = offset
+            offset += params_bytes_len
+        else:
+            params_bytes_offset = 0
+
+        padding2 = ''
+        if offset % 4 != 0:
+            padding2 = '\0'*(4-offset%4)
+            offset += (4-offset%4)
+
+        if data_bytes_len > 0:
+            data_bytes_offset = offset
+        else:
+            data_bytes_offset = 0
+
+        message.parameters_data = \
+            struct.pack(self.PAYLOAD_STRUCT_FORMAT,
+                        self.total_params_count,
+                        self.total_data_count,
+                        self.max_params_count,
+                        self.max_data_count,
+                        self.max_setup_count,
+                        0x00,           # Reserved1. Must be 0x00
+                        self.flags,
+                        self.timeout,
+                        0x0000,         # Reserved2. Must be 0x0000
+                        params_bytes_len,
+                        params_bytes_offset,
+                        data_bytes_len,
+                        data_bytes_offset,
+                        int(setup_bytes_len / 2)) + \
+            self.setup_bytes
+
+        message.data = padding0 + name + padding1 + self.params_bytes + padding2 + self.data_bytes
+
+
+class ComTransactionResponse(Payload):
+    """
+    Contains information about a SMB_COM_TRANSACTION response from the server
+
+    After decoding, each instance contains the following attributes:
+    - total_params_count (integer)
+    - total_data_count (integer)
+    - setup_bytes (string)
+    - data_bytes (string)
+    - params_bytes (string)
+
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.33.2
+    """
+
+    PAYLOAD_STRUCT_FORMAT = '<HHHHHHHHHH'
+    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)
+
+    def decode(self, message):
+        assert message.command == SMB_COM_TRANSACTION
+
+        if not message.status.hasError:
+            if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE:
+                raise ProtocolError('Not enough data to decode SMB_COM_TRANSACTION parameters', message.raw_data, message)
+
+            self.total_params_count, self.total_data_count, _, \
+            params_bytes_len, params_bytes_offset, params_bytes_displ, \
+            data_bytes_len, data_bytes_offset, data_bytes_displ, \
+            setup_count = struct.unpack(self.PAYLOAD_STRUCT_FORMAT, message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])
+
+            if setup_count > 0:
+                setup_bytes_len = setup_count * 2
+
+                if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE + setup_bytes_len:
+                    raise ProtocolError('Not enough data to decode SMB_COM_TRANSACTION parameters', message.raw_data, message)
+
+                self.setup_bytes = message.parameters_data[self.PAYLOAD_STRUCT_SIZE:self.PAYLOAD_STRUCT_SIZE+setup_bytes_len]
+            else:
+                self.setup_bytes = ''
+
+            offset = message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_count * 2 + 2 # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)
+
+            if params_bytes_len > 0:
+                self.params_bytes = message.data[params_bytes_offset-offset:params_bytes_offset-offset+params_bytes_len]
+            else:
+                self.params_bytes = ''
+
+            if data_bytes_len > 0:
+                self.data_bytes = message.data[data_bytes_offset-offset:data_bytes_offset-offset+data_bytes_len]
+            else:
+                self.data_bytes = ''
+
+
+class ComTransaction2Request(Payload):
+    """
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.46.1
+    """
+
+    PAYLOAD_STRUCT_FORMAT = 'HHHHBBHIHHHHHH'
+    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)
+
+    def __init__(self, max_params_count, max_data_count, max_setup_count,
+                 total_params_count = 0, total_data_count = 0,
+                 params_bytes = '', data_bytes = '', setup_bytes = '',
+                 flags = 0, timeout = 0):
+        self.total_params_count = total_params_count or len(params_bytes)
+        self.total_data_count = total_data_count or len(data_bytes)
+        self.max_params_count = max_params_count
+        self.max_data_count = max_data_count
+        self.max_setup_count = max_setup_count
+        self.flags = flags
+        self.timeout = timeout
+        self.params_bytes = params_bytes
+        self.data_bytes = data_bytes
+        self.setup_bytes = setup_bytes
+
+    def initMessage(self, message):
+        Payload.initMessage(self, message)
+        message.command = SMB_COM_TRANSACTION2
+
+    def prepare(self, message):
+        setup_bytes_len = len(self.setup_bytes)
+        params_bytes_len = len(self.params_bytes)
+        data_bytes_len = len(self.data_bytes)
+        name = '\0\0'
+
+        padding0 = ''
+        offset = message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_bytes_len + 2 # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)
+        if offset % 2 != 0:
+            padding0 = '\0'
+            offset += 1
+
+        offset += 2  # For the name field
+        padding1 = ''
+        if offset % 4 != 0:
+            padding1 = '\0'*(4-offset%4)
+
+        if params_bytes_len > 0:
+            params_bytes_offset = offset
+            offset += params_bytes_len
+        else:
+            params_bytes_offset = 0
+
+        padding2 = ''
+        if offset % 4 != 0:
+            padding2 = '\0'*(4-offset%4)
+
+        if data_bytes_len > 0:
+            data_bytes_offset = offset
+        else:
+            data_bytes_offset = 0
+
+        message.parameters_data = \
+            struct.pack(self.PAYLOAD_STRUCT_FORMAT,
+                        self.total_params_count,
+                        self.total_data_count,
+                        self.max_params_count,
+                        self.max_data_count,
+                        self.max_setup_count,
+                        0x00,           # Reserved1. Must be 0x00
+                        self.flags,
+                        self.timeout,
+                        0x0000,         # Reserved2. Must be 0x0000
+                        params_bytes_len,
+                        params_bytes_offset,
+                        data_bytes_len,
+                        data_bytes_offset,
+                        int(setup_bytes_len / 2)) + \
+            self.setup_bytes
+
+        message.data = padding0 + name + padding1 + self.params_bytes + padding2 + self.data_bytes
+
+
+class ComTransaction2Response(Payload):
+    """
+    Contains information about a SMB_COM_TRANSACTION2 response from the server
+
+    After decoding, each instance contains the following attributes:
+    - total_params_count (integer)
+    - total_data_count (integer)
+    - setup_bytes (string)
+    - data_bytes (string)
+    - params_bytes (string)
+
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.46.2
+    """
+
+    PAYLOAD_STRUCT_FORMAT = '<HHHHHHHHHBB'
+    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)
+
+    def decode(self, message):
+        assert message.command == SMB_COM_TRANSACTION2
+
+        if not message.status.hasError:
+            if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE:
+                raise ProtocolError('Not enough data to decode SMB_COM_TRANSACTION2 parameters', message.raw_data, message)
+
+            self.total_params_count, self.total_data_count, _, \
+            params_bytes_len, params_bytes_offset, params_bytes_displ, \
+            data_bytes_len, data_bytes_offset, data_bytes_displ, \
+            setup_count, _ = struct.unpack(self.PAYLOAD_STRUCT_FORMAT, message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])
+
+            if setup_count > 0:
+                setup_bytes_len = setup_count * 2
+
+                if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE + setup_bytes_len:
+                    raise ProtocolError('Not enough data to decode SMB_COM_TRANSACTION parameters', message.raw_data, message)
+
+                self.setup_bytes = message.parameters_data[self.PAYLOAD_STRUCT_SIZE:self.PAYLOAD_STRUCT_SIZE+setup_bytes_len]
+            else:
+                self.setup_bytes = ''
+
+            offset = message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_count * 2 + 2 # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)
+
+            if params_bytes_len > 0:
+                self.params_bytes = message.data[params_bytes_offset-offset:params_bytes_offset-offset+params_bytes_len]
+            else:
+                self.params_bytes = ''
+
+            if data_bytes_len > 0:
+                self.data_bytes = message.data[data_bytes_offset-offset:data_bytes_offset-offset+data_bytes_len]
+            else:
+                self.data_bytes = ''
+
+
+class ComCloseRequest(Payload):
+    """
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.5.1
+    """
+
+    PAYLOAD_STRUCT_FORMAT = '<HI'
+    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)
+
+    def __init__(self, fid, last_modified_time = 0xFFFFFFFF):
+        self.fid = fid
+        self.last_modified_time = last_modified_time
+
+    def initMessage(self, message):
+        Payload.initMessage(self, message)
+        message.command = SMB_COM_CLOSE
+
+    def prepare(self, message):
+        message.parameters_data = struct.pack(self.PAYLOAD_STRUCT_FORMAT, self.fid, self.last_modified_time)
+        message.data = ''
+
+
+class ComOpenAndxRequest(Payload):
+    """
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.41.1
+    """
+
+    PAYLOAD_STRUCT_FORMAT = '<HHHHIHIII'
+    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)
+
+    def __init__(self, filename, access_mode, open_mode, flags = 0x0000, search_attributes = 0, file_attributes = 0, create_time = 0, timeout = 0):
+        """
+        @param create_time: Epoch time value to indicate the time of creation for this file. If zero, we will automatically assign the current time
+        @type create_time: int
+        @param timeout: Number of milliseconds to wait for blocked open request before failing
+        @type timeout: int
+        """
+        self.filename = filename
+        self.access_mode = access_mode
+        self.open_mode = open_mode
+        self.flags = flags
+        self.search_attributes = search_attributes
+        self.file_attributes = file_attributes
+        self.create_time = create_time or int(time.time())
+        self.timeout = timeout
+
+    def initMessage(self, message):
+        Payload.initMessage(self, message)
+        message.command = SMB_COM_OPEN_ANDX
+
+    def prepare(self, message):
+        message.parameters_data = \
+            self.DEFAULT_ANDX_PARAM_HEADER + \
+            struct.pack(self.PAYLOAD_STRUCT_FORMAT,
+                        self.flags,
+                        self.access_mode,
+                        self.search_attributes,
+                        self.file_attributes,
+                        self.create_time,
+                        self.open_mode,
+                        0,  # AllocationSize
+                        0,  # Timeout (in milli-secs)
+                        0)  # Reserved
+
+        message.data = '\0' + self.filename.encode('UTF-16LE') + '\0\0'
+
+
+class ComOpenAndxResponse(Payload):
+    """
+    Contains information about a SMB_COM_OPEN_ANDX response from the server
+
+    After decoding, each instance will contain the following attributes:
+    - fid (integer)
+    - file_attributes (integer)
+    - last_write_time (long)
+    - access_rights (integer)
+    - resource_type (integer)
+    - open_results (integer)
+
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.41.2
+    - [MS-SMB]: 2.2.4.1.2
+    """
+
+    PAYLOAD_STRUCT_FORMAT = '<BBHHHIIHHHHHHH'
+    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)
+
+    def decode(self, message):
+        assert message.command == SMB_COM_OPEN_ANDX
+
+        if not message.status.hasError:
+            if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE:
+                raise ProtocolError('Not enough data to decode SMB_COM_OPEN_ANDX parameters', message.raw_data, message)
+
+            _, _, _, self.fid, self.file_attributes, self.last_write_time, _, \
+            self.access_rights, self.resource_type, _, self.open_results, _, _, _ = struct.unpack(self.PAYLOAD_STRUCT_FORMAT,
+                                                                                                  message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])
+
+
+class ComWriteAndxRequest(Payload):
+    """
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.43.1
+    - [MS-SMB]: 2.2.4.3.1
+    """
+
+    PAYLOAD_STRUCT_FORMAT = '<HIIHHHHHI'
+    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)
+
+    def __init__(self, fid, data_bytes, offset, write_mode = 0, timeout = 0):
+        """
+        @param timeout: Number of milliseconds to wait for blocked write request before failing. Must be zero for writing to regular file
+        @type timeout: int
+        """
+        self.fid = fid
+        self.offset = offset
+        self.data_bytes = data_bytes
+        self.timeout = timeout
+        self.write_mode = write_mode
+
+    def initMessage(self, message):
+        Payload.initMessage(self, message)
+        message.command = SMB_COM_WRITE_ANDX
+
+    def prepare(self, message):
+        # constant 1 is to account for the pad byte in the message.data
+        # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)
+        data_offset = message.HEADER_STRUCT_SIZE + self.DEFAULT_ANDX_PARAM_SIZE + self.PAYLOAD_STRUCT_SIZE + 1 + 2
+        data_len = len(self.data_bytes)
+
+        message.parameters_data = \
+            self.DEFAULT_ANDX_PARAM_HEADER + \
+            struct.pack(self.PAYLOAD_STRUCT_FORMAT,
+                        self.fid,
+                        self.offset & 0xFFFFFFFF,
+                        self.timeout,
+                        self.write_mode,
+                        data_len,   # Remaining
+                        0x0000,     # Reserved
+                        len(self.data_bytes),  # DataLength
+                        data_offset,           # DataOffset
+                        self.offset >> 32)     # OffsetHigh field defined in [MS-SMB]: 2.2.4.3.1
+
+        message.data = '\0' + self.data_bytes
+
+
+class ComWriteAndxResponse(Payload):
+    """
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.43.2
+    - [MS-SMB]: 2.2.4.3.2
+    """
+
+    PAYLOAD_STRUCT_FORMAT = '<BBHHHHH'  # We follow the SMB_COM_WRITEX_ANDX server extensions in [MS-SMB]: 2.2.4.3.2
+    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)
+
+    def decode(self, message):
+        assert message.command == SMB_COM_WRITE_ANDX
+
+        if not message.status.hasError:
+            if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE:
+                raise ProtocolError('Not enough data to decode SMB_COM_WRITE_ANDX parameters', message.raw_data, message)
+
+            _, _, _, count, self.available, high_count, _ = struct.unpack(self.PAYLOAD_STRUCT_FORMAT, message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])
+            self.count = (count & 0xFFFF) | (high_count << 16)
+
+
+class ComReadAndxRequest(Payload):
+    """
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.42.1
+    - [MS-SMB]: 2.2.4.2.1
+    """
+
+    PAYLOAD_STRUCT_FORMAT = '<HIHHIHI'
+    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)
+
+    def __init__(self, fid, offset, max_return_bytes_count, min_return_bytes_count, timeout = 0, remaining = 0):
+        """
+        @param timeout: If reading from a regular file, this parameter must be 0.
+        @type timeout: int
+        """
+        self.fid = fid
+        self.remaining = remaining
+        self.max_return_bytes_count = max_return_bytes_count
+        self.min_return_bytes_count = min_return_bytes_count
+        self.offset = offset
+        self.timeout = timeout
+
+    def initMessage(self, message):
+        Payload.initMessage(self, message)
+        message.command = SMB_COM_READ_ANDX
+
+    def prepare(self, message):
+        message.parameters_data = \
+            self.DEFAULT_ANDX_PARAM_HEADER + \
+            struct.pack(self.PAYLOAD_STRUCT_FORMAT,
+                        self.fid,
+                        self.offset & 0xFFFFFFFF,
+                        self.max_return_bytes_count,
+                        self.min_return_bytes_count,
+                        self.timeout or (self.max_return_bytes_count >> 32),  # Note that in [MS-SMB]: 2.2.4.2.1, this field can also act as MaxCountHigh field
+                        self.remaining, # In [MS-CIFS]: 2.2.4.42.1, this field must be set to 0x0000
+                        self.offset >> 32)
+
+        message.data = ''
+
+
+class ComReadAndxResponse(Payload):
+    """
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.42.2
+    - [MS-SMB]: 2.2.4.2.2
+    """
+
+    PAYLOAD_STRUCT_FORMAT = '<BBHHHHHHHHHHH'
+    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)
+
+    def decode(self, message):
+        assert message.command == SMB_COM_READ_ANDX
+
+        if not message.status.hasError:
+            if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE:
+                raise ProtocolError('Not enough data to decode SMB_COM_READ_ANDX parameters', message.raw_data, message)
+
+            _, _, _, _, _, _, self.data_length, data_offset, _, _, _, _, _ = struct.unpack(self.PAYLOAD_STRUCT_FORMAT,
+                                                                                           message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])
+
+            offset = data_offset - message.HEADER_STRUCT_SIZE - self.PAYLOAD_STRUCT_SIZE - 2  # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)
+            self.data = message.data[offset:offset+self.data_length]
+            assert len(self.data) == self.data_length
+
+
+class ComDeleteRequest(Payload):
+    """
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.7.1
+    """
+
+    def __init__(self, filename_pattern, search_attributes = 0):
+        self.filename_pattern = filename_pattern
+        self.search_attributes = search_attributes
+
+    def initMessage(self, message):
+        Payload.initMessage(self, message)
+        message.command = SMB_COM_DELETE
+
+    def prepare(self, message):
+        message.parameters_data = struct.pack('<H', self.search_attributes)
+        message.data = '\x04' + self.filename_pattern.encode('UTF-16LE') + '\0\0'
+
+
+class ComCreateDirectoryRequest(Payload):
+    """
+    Although this command has been marked deprecated in [MS-CIFS], we continue to use it for its simplicity
+    as compared to its replacement TRANS2_CREATE_DIRECTORY sub-command [MS-CIFS]: 2.2.6.14
+
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.1.1
+    """
+
+    def __init__(self, path):
+        self.path = path
+
+    def initMessage(self, message):
+        Payload.initMessage(self, message)
+        message.command = SMB_COM_CREATE_DIRECTORY
+
+    def prepare(self, message):
+        message.parameters_data = ''
+        message.data = '\x04' + self.path.encode('UTF-16LE') + '\0\0'
+
+
+class ComDeleteDirectoryRequest(Payload):
+    """
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.2.1
+    """
+
+    def __init__(self, path):
+        self.path = path
+
+    def initMessage(self, message):
+        Payload.initMessage(self, message)
+        message.command = SMB_COM_DELETE_DIRECTORY
+
+    def prepare(self, message):
+        message.parameters_data = ''
+        message.data = '\x04' + self.path.encode('UTF-16LE') + '\0\0'
+
+
+class ComRenameRequest(Payload):
+    """
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.8.1
+    """
+
+    def __init__(self, old_path, new_path, search_attributes = 0):
+        self.old_path = old_path
+        self.new_path = new_path
+        self.search_attributes = search_attributes
+
+    def initMessage(self, message):
+        Payload.initMessage(self, message)
+        message.command = SMB_COM_RENAME
+
+    def prepare(self, message):
+        message.parameters_data = struct.pack('<H', self.search_attributes)
+        message.data = '\x04' + self.old_path.encode('UTF-16LE') + '\x00\x00\x04\x00' + self.new_path.encode('UTF-16LE') + '\x00\x00'
+
+
+class ComEchoRequest(Payload):
+    """
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.39.1
+    """
+
+    def __init__(self, echo_data = '', echo_count = 1):
+        self.echo_count = echo_count
+        self.echo_data = echo_data
+
+    def initMessage(self, message):
+        Payload.initMessage(self, message)
+        message.command = SMB_COM_ECHO
+        message.tid = 0xFFFF
+
+    def prepare(self, message):
+        message.parameters_data = struct.pack('<H', self.echo_count)
+        message.data = self.echo_data
+
+
+class ComEchoResponse(Payload):
+    """
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.39.2
+    """
+
+    def decode(self, message):
+        self.sequence_number = struct.unpack('<H', message.parameters_data[:2])[0]
+        self.data = message.data
+
+
+class ComNTTransactRequest(Payload):
+    """
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.62.1
+    """
+    PAYLOAD_STRUCT_FORMAT = '<BHIIIIIIIIBH'
+    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)
+
+    def __init__(self, function, max_params_count, max_data_count, max_setup_count,
+                 total_params_count = 0, total_data_count = 0,
+                 params_bytes = '', setup_bytes = '', data_bytes = ''):
+        self.function = function
+        self.total_params_count = total_params_count or len(params_bytes)
+        self.total_data_count = total_data_count or len(data_bytes)
+        self.max_params_count = max_params_count
+        self.max_data_count = max_data_count
+        self.max_setup_count = max_setup_count
+        self.params_bytes = params_bytes
+        self.setup_bytes = setup_bytes
+        self.data_bytes = data_bytes
+
+    def initMessage(self, message):
+        Payload.initMessage(self, message)
+        message.command = SMB_COM_NT_TRANSACT
+
+    def prepare(self, message):
+        setup_bytes_len = len(self.setup_bytes)
+        params_bytes_len = len(self.params_bytes)
+        data_bytes_len = len(self.data_bytes)
+
+        padding0 = ''
+        offset = message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_bytes_len + 2 # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)
+        if offset % 4 != 0:
+            padding0 = '\0'*(4-offset%4)
+            offset += (4-offset%4)
+
+        if params_bytes_len > 0:
+            params_bytes_offset = offset
+        else:
+            params_bytes_offset = 0
+
+        offset += params_bytes_len
+        padding1 = ''
+        if offset % 4 != 0:
+            padding1 = '\0'*(4-offset%4)
+            offset += (4-offset%4)
+
+        if data_bytes_len > 0:
+            data_bytes_offset = offset
+        else:
+            data_bytes_offset = 0
+
+        message.parameters_data = \
+            struct.pack(self.PAYLOAD_STRUCT_FORMAT,
+                        self.max_setup_count,
+                        0x00,           # Reserved1. Must be 0x00
+                        self.total_params_count,
+                        self.total_data_count,
+                        self.max_params_count,
+                        self.max_data_count,
+                        params_bytes_len,
+                        params_bytes_offset,
+                        data_bytes_len,
+                        data_bytes_offset,
+                        int(setup_bytes_len / 2),
+                        self.function) + \
+            self.setup_bytes
+
+        message.data = padding0 + self.params_bytes + padding1 + self.data_bytes
+
+
+class ComNTTransactResponse(Payload):
+    """
+    Contains information about a SMB_COM_NT_TRANSACT response from the server
+
+    After decoding, each instance contains the following attributes:
+    - total_params_count (integer)
+    - total_data_count (integer)
+    - setup_bytes (string)
+    - data_bytes (string)
+    - params_bytes (string)
+
+    References:
+    ===========
+    - [MS-CIFS]: 2.2.4.62.2
+    """
+    PAYLOAD_STRUCT_FORMAT = '<3sIIIIIIIIBH'
+    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)
+
+    def decode(self, message):
+        assert message.command == SMB_COM_NT_TRANSACT
+
+        if not message.status.hasError:
+            _, self.total_params_count, self.total_data_count, \
+            params_count, params_offset, params_displ, \
+            data_count, data_offset, data_displ, setup_count = struct.unpack(self.PAYLOAD_STRUCT_FORMAT,
+                                                                             message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])
+
+            self.setup_bytes = message.parameters_data[self.PAYLOAD_STRUCT_SIZE:self.PAYLOAD_STRUCT_SIZE+setup_count*2]
+
+            if params_count > 0:
+                params_offset -= message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_count*2 + 2
+                self.params_bytes = message.data[params_offset:params_offset+params_count]
+            else:
+                self.params_bytes = ''
+
+            if data_count > 0:
+                data_offset -= message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_count*2 + 2
+                self.data_bytes = message.data[data_offset:data_offset+data_count]
+            else:
+                self.data_bytes = ''
+
+ +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/html/_sources/api/nmb_NBNSProtocol.txt b/docs/html/_sources/api/nmb_NBNSProtocol.txt new file mode 100644 index 0000000..94323fe --- /dev/null +++ b/docs/html/_sources/api/nmb_NBNSProtocol.txt @@ -0,0 +1,18 @@ + +NBNSProtocol Class +================== + +pysmb has a *NBNSProtocol* implementation for Twisted framework. +This allows you to perform name query asynchronously without having your application to block and wait for the results. + +In your project, + 1. Create a NBNSProtocol instance. + 2. Just call *queryName* method which will return a *Deferred* instance. Add your callback function to the *Deferred* instance via *addCallback* method to receive the results of the name query. + 3. When you are done with the NBNSProtocol instance, call its .transport.stopListening method to remove this instance from the reactor. + +.. autoclass:: nmb.NetBIOSProtocol.NBNSProtocol + :members: + :special-members: + +.. autoclass:: nmb.NetBIOSProtocol.NetBIOSTimeout + :members: diff --git a/docs/html/_sources/api/nmb_NetBIOS.txt b/docs/html/_sources/api/nmb_NetBIOS.txt new file mode 100644 index 0000000..2949d95 --- /dev/null +++ b/docs/html/_sources/api/nmb_NetBIOS.txt @@ -0,0 +1,12 @@ + +NetBIOS class +============= + +To use the NetBIOS class in your application, + 1. Create a new NetBIOS instance + 2. Call *queryName* method for each name you wish to query. The method will block until a reply is received from the remote SMB/CIFS service, or until timeout. + 3. When you are done, call *close* method to release the underlying resources. + +.. autoclass:: nmb.NetBIOS.NetBIOS + :members: + :special-members: diff --git a/docs/html/_sources/api/smb_SMBConnection.txt b/docs/html/_sources/api/smb_SMBConnection.txt new file mode 100644 index 0000000..4478210 --- /dev/null +++ b/docs/html/_sources/api/smb_SMBConnection.txt @@ -0,0 +1,55 @@ + +SMBConnection Class +=================== + +The SMBConnection is suitable for developers who wish to use pysmb to perform file operations with a remote SMB/CIFS server sequentially. + +Each file operation method, when invoked, will block and return after it has completed or has encountered an error. + +Example +------- + +The following illustrates a simple file retrieving implementation.:: + + import tempfile + from smb.SMBConnection import SMBConnection + + # There will be some mechanism to capture userID, password, client_machine_name, server_name and server_ip + # client_machine_name can be an arbitary ASCII string + # server_name should match the remote machine name, or else the connection will be rejected + conn = SMBConnection(userID, password, client_machine_name, server_name, use_ntlm_v2 = True) + assert conn.connect(server_ip, 139) + + file_obj = tempfile.NamedTemporaryFile() + file_attributes, filesize = conn.retrieveFile('smbtest', '/rfc1001.txt', file_obj) + + # Retrieved file contents are inside file_obj + # Do what you need with the file_obj and then close it + # Note that the file obj is positioned at the end-of-file, + # so you might need to perform a file_obj.seek() if you need + # to read from the beginning + file_obj.close() + +SMB2 Support +------------- + +Starting from pysmb 1.1.0, pysmb will utilize SMB2 protocol for communication if the remote SMB/CIFS service supports SMB2. +Otherwise, it will fallback automatically back to using SMB1 protocol. + +To disable SMB2 protocol in pysmb, set the *SUPPORT_SMB2* flag in the *smb_structs* module to *False* before creating the *SMBConnection* instance.:: + + from smb import smb_structs + smb_structs.SUPPORT_SMB2 = False + +Caveats +------- + +* It is not meant to be used asynchronously. +* A single *SMBConnection* instance should not be used to perform more than one operation concurrently at the same time. +* Do not keep a *SMBConnection* instance "idle" for too long, i.e. keeping a *SMBConnection* instance but not using it. + Most SMB/CIFS servers have some sort of keepalive mechanism and impose a timeout limit. + If the clients fail to respond within the timeout limit, the SMB/CIFS server may disconnect the client. + +.. autoclass:: smb.SMBConnection.SMBConnection + :members: + :special-members: diff --git a/docs/html/_sources/api/smb_SMBHandler.txt b/docs/html/_sources/api/smb_SMBHandler.txt new file mode 100644 index 0000000..da106fe --- /dev/null +++ b/docs/html/_sources/api/smb_SMBHandler.txt @@ -0,0 +1,48 @@ + +SMbHandler Class +================ + +The SMBHandler class provides support for "smb://" URLs in the `urllib2 `_ python package. + +Notes +----- +* Note that you need to pass in a valid hostname or IP address for the host component of the URL. + Do not use the Windows/NetBIOS machine name for the host component. +* The first component of the path in the URL points to the name of the shared folder. + Subsequent path components will point to the directory/folder of the file. +* You can retrieve and upload files, but you cannot delete files/folders or create folders. + In uploads, if the parent folders do not exist, an *urllib2.URLError* will be raised. + +Example +------- + +The following code snippet illustrates file retrieval.:: + + # -*- coding: utf-8 -*- + import urllib2 + from smb.SMBHandler import SMBHandler + + director = urllib2.build_opener(SMBHandler) + fh = director.open('smb://myuserID:mypassword@192.168.1.1/sharedfolder/rfc1001.txt') + + # Process fh like a file-like object and then close it. + fh.close() + + # For paths/files with unicode characters, simply pass in the URL as an unicode string + fh2 = director.open(u'smb://myuserID:mypassword@192.168.1.1/sharedfolder/测试文件夹/垃圾文件.dat') + + # Process fh2 like a file-like object and then close it. + fh2.close() + +The following code snippet illustrates file upload. You need to provide a file-like object for the *data* parameter in the *open()* method:: + + import urllib2 + from smb.SMBHandler import SMBHandler + + file_fh = open('local_file.dat', 'rb') + + director = urllib2.build_opener(SMBHandler) + fh = director.open('smb://myuserID:mypassword@192.168.1.1/sharedfolder/upload_file.dat', data = file_fh) + + # Reading from fh will only return an empty string + fh.close() diff --git a/docs/html/_sources/api/smb_SMBProtocolFactory.txt b/docs/html/_sources/api/smb_SMBProtocolFactory.txt new file mode 100644 index 0000000..dc967c3 --- /dev/null +++ b/docs/html/_sources/api/smb_SMBProtocolFactory.txt @@ -0,0 +1,93 @@ + +SMBProtocolFactory Class +======================== + +For those who want to utilize pysmb in Twisted framework, pysmb has a *smb.SMBProtocol.SMBProtocol* implementation. +In most cases, you do not need to touch or import the *SMBProtocol* directly. All the SMB functionalities are exposed in the *SMBProtocolFactory*. + +In your project, + 1. Create a new class and subclass *SMBProtocolFactory*. + 2. Override the *SMBProtocolFactory.onAuthOK* and *SMBProtocolFactory.onAuthFailed* instance methods to provide your own post-authenthentication handling. + Once *SMBProtocolFactory.onAuthOK* has been called by pymsb internals, your application is ready to communicate with the remote SMB/CIFS service through + the *SMBProtocolFactory* public methods such as *SMBProtocolFactory.storeFile*, *SMBProtocolFactory.retrieveFile*, etc. + 3. When you want to disconnect from the remote SMB/CIFS server, just call *SMBProtocolFactory.closeConnection* method. + +All the *SMBProtocolFactory* public methods that provide file functionlities will return a *twisted.internet.defer.Deferred* instance. +A :doc:`NotReadyError` exception is raised when the underlying SMB is not authenticated. +If the underlying SMB connection has been terminated, a :doc:`NotConnectedError` exception is raised. + +All the file operation methods in *SMBProtocolFactory* class accept a *timeout* parameter. This parameter specifies the time limit where pysmb will wait for the +entire file operation (except *storeFile* and *retrieveFile* methods) to complete. If the file operation fails to complete within the timeout period, the returned +*Deferred* instance's *errback* method will be called with a *SMBTimeout* exception. + +If you are interested in learning the results of the operation or to know when the operation has completed, you should +add a handling method to the returned *Deferred* instance via *Deferred.addCallback*. If the file operation fails, the *Deferred.errback* function will be called +with an :doc:`OperationFailure`; on timeout, it will be called with a :doc:`SMBTimeout`. + +Example +------- + +The following illustrates a simple file retrieving implementation.:: + + import tempfile + from twisted.internet import reactor + from smb.SMBProtocol import SMBProtocolFactory + + class RetrieveFileFactory(SMBProtocolFactory): + + def __init__(self, *args, **kwargs): + SMBProtocolFactory.__init__(self, *args, **kwargs) + + def fileRetrieved(self, write_result): + file_obj, file_attributes, file_size = write_result + + # Retrieved file contents are inside file_obj + # Do what you need with the file_obj and then close it + # Note that the file obj is positioned at the end-of-file, + # so you might need to perform a file_obj.seek() to if you + # need to read from the beginning + file_obj.close() + + self.transport.loseConnection() + + def onAuthOK(self): + d = self.retrieveFile(self.service, self.path, tempfile.NamedTemporaryFile()) + d.addCallback(self.fileRetrieved) + d.addErrback(self.d.errback) + + def onAuthFailed(self): + print 'Auth failed' + + # There will be some mechanism to capture userID, password, client_machine_name, server_name and server_ip + # client_machine_name can be an arbitary ASCII string + # server_name should match the remote machine name, or else the connection will be rejected + factory = RetrieveFileFactory(userID, password, client_machine_name, server_name, use_ntlm_v2 = True) + factory.service = 'smbtest' + factory.path = '/rfc1001.txt' + reactor.connectTCP(server_ip, 139, factory) + + + + +SMB2 Support +------------- + +Starting from pysmb 1.1.0, pysmb will utilize SMB2 protocol for communication if the remote SMB/CIFS service supports SMB2. +Otherwise, it will fallback automatically back to using SMB1 protocol. + +To disable SMB2 protocol in pysmb, set the *SUPPORT_SMB2* flag in the *smb_structs* module to *False* before creating the *SMBProtocolFactory* instance.:: + + from smb import smb_structs + smb_structs.SUPPORT_SMB2 = False + +Caveats +------- + +* A new factory instance must be created for each SMB connection to the remote SMB/CIFS service. Avoid reusing the same factory instance for more than one SMB connection. +* The remote SMB/CIFS server usually imposes a limit of the number of concurrent file operations for each client. For example, to transfer a thousand files, you may need to setup a queue in your application and call *storeFile* or *retrieveFile* in batches. +* The *timeout* parameter in the file operation methods are not precise; it is accurate to within 1 second interval, i.e. with a timeout of 0.5 sec, pysmb might raise + *SMBTimeout* exception after 1.5 sec. + +.. autoclass:: smb.SMBProtocol.SMBProtocolFactory + :members: + :special-members: diff --git a/docs/html/_sources/api/smb_SharedDevice.txt b/docs/html/_sources/api/smb_SharedDevice.txt new file mode 100644 index 0000000..9ac39b7 --- /dev/null +++ b/docs/html/_sources/api/smb_SharedDevice.txt @@ -0,0 +1,6 @@ + +SharedDevice Class +================== + +.. autoclass:: smb.base.SharedDevice + :members: diff --git a/docs/html/_sources/api/smb_SharedFile.txt b/docs/html/_sources/api/smb_SharedFile.txt new file mode 100644 index 0000000..d71e43c --- /dev/null +++ b/docs/html/_sources/api/smb_SharedFile.txt @@ -0,0 +1,6 @@ + +SharedFile Class +================ + +.. autoclass:: smb.base.SharedFile + :members: diff --git a/docs/html/_sources/api/smb_exceptions.txt b/docs/html/_sources/api/smb_exceptions.txt new file mode 100644 index 0000000..7340639 --- /dev/null +++ b/docs/html/_sources/api/smb_exceptions.txt @@ -0,0 +1,21 @@ + +SMB Exceptions +============== + +.. autoclass:: smb.base.SMBTimeout + :members: + +.. autoclass:: smb.base.NotReadyError + :members: + +.. autoclass:: smb.base.NotConnectedError + :members: + +.. autoclass:: smb.smb_structs.UnsupportedFeature + :members: + +.. autoclass:: smb.smb_structs.ProtocolError + :members: + +.. autoclass:: smb.smb_structs.OperationFailure + :members: diff --git a/docs/html/_sources/extending.txt b/docs/html/_sources/extending.txt new file mode 100644 index 0000000..9945212 --- /dev/null +++ b/docs/html/_sources/extending.txt @@ -0,0 +1,19 @@ + +Extending pysmb For Other Frameworks +==================================== + +This page briefly describes the steps involved in extending pysmb for other frameworks. + +In general, you need to take care of the SMB TCP connection setup, i.e. finding the IP address of the remote server and connect to the SMB/CIFS service. +Then you need to read/write synchronously or asynchronously from and to the SMB socket. And you need to handle post-authentication callback methods, and from these methods, +initiate file operations with the remote SMB/CIFS server. + +Now the above steps in more technical details: + 1. Create a new class which subclasses the *smb.base.SMB* class. Most often, the connection setup will be part of the *__init__* method. + 2. Override the *write(self, data)* method to provide an implementation which will write *data* to the socket. + 3. Write your own loop handling method to read data from the socket. Once data have been read, call *feedData* method with the parameter. + The *feedData* method has its own internal buffer, so it can accept incomplete NetBIOS session packet data. + 4. Override + * *onAuthOK* method to include your own operations to perform when authentication is successful. You can initiate file operations in this method. + * *onAuthFailed* method to include your own processing on what to do when authentication fails. You can report this as an error, or to try a different NTLM authentication algorithm (*use_ntlm_v2* parameter in the constructor). + * *onNMBSessionFailed* method to include your own processing on what to do when pysmb fails to setup the NetBIOS session with the remote server. Usually, this is due to a wrong *remote_name* parameter in the constructor. diff --git a/docs/html/_sources/index.txt b/docs/html/_sources/index.txt new file mode 100644 index 0000000..7638fcd --- /dev/null +++ b/docs/html/_sources/index.txt @@ -0,0 +1,106 @@ +.. pysmb documentation master file, created by + sphinx-quickstart on Sun Dec 18 15:54:40 2011. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to pysmb's documentation! +================================= + +pysmb is a pure Python implementation of the client-side SMB/CIFS protocol (SMB1 and SMB2) which is the underlying protocol +that facilitates file sharing and printing between Windows machines, as well as with Linux machines via the Samba server application. +pysmb is developed in Python 2.4.6, Python 2.7.1 and Python 3.2.3 and has been tested against shared folders on Windows XP SP3, Windows Vista, Windows 7 and Samba 3.x. + +The latest version of pysmb is always available at the pysmb project page at `miketeo.net `_. + +License +------- +pysmb itself is licensed under an opensource license. +You are free to use pysmb in any applications, including for commercial purposes. +For more details on the terms of use, please read the LICENSE file that comes with your pysmb source. + +pysmb depends on other 3rd-party modules whose terms of use are not covered by pysmb. +Use of these modules could possibly conflict with your licensing needs. Please exercise your own discretion to determine their suitabilities. +I have listed these modules in the following section. + +Credits +------- +pysmb is not alone. It is made possible with support from other modules. + +* **pyasn1** : Pure Python implementation of ASN.1 parsing and encoding (not included together with pysmb; needs to be installed separately) +* **md4** and **U32** : Pure Python implementation of MD4 hashing algorithm and 32-bit unsigned integer by Dmitry Rozmanov. Licensed under LGPL and included together with pysmb. +* **pyDes** : Pure Python implementation of the DES encryption algorithm by Todd Whiteman. Free domain and included together with pysmb. +* **sha256** : Pure Python implementation of SHA-256 message digest by Thomas Dixon. Licensed under MIT and included together with pysmb. This module is imported only when + the Python standard library (usually Python 2.4) does not provide the SHA-256 hash algorithm. + +In various places, there are references to different specifications. Most of these referenced specifications +can be downloaded from Microsoft web site under Microsoft's "Open Specification Promise". If you need to download +a copy of these specifications, please google for it. For example, google for "MS-CIFS" to download the CIFS specification for NT LM dialect. + +Package Contents and Description +================================ + +pysmb is organized into 2 main packages: smb and nmb. +The smb package contains all the functionalities related to Server Message Block (SMB) implementation. +As an application developer, you will be importing this module into your application. +Hence, please take some time to familiarize yourself with the smb package contents. + +* **nmb/base.py** : + Contains the NetBIOSSession and NBNS abstract class which implements NetBIOS session and NetBIOS Name Service communication + without any network transport specifics. +* **nmb/NetBIOS.py**: + Provides a NBNS implementation to query IP addresses for machine names. All operations are blocking I/O. +* **nmb/NetBIOSProtocol.py** : + Provides the NBNS protocol implementation for use in Twisted framework. + +* **smb/base.py** : + Contains the SMB abstract class which implements the SMB communication without any network transport specifics. +* **smb/ntlm.py** : + Contains the NTLMv1 and NTLMv2 authentication routines and the decoding/encoding of NTLM authentication messages within SMB messages. +* **smb/securityblob.py** : + Provides routines to encode/decode the NTLMSSP security blob in the SMB messages. +* **smb/smb_constants.py** : + All the constants used in the smb package for SMB1 protocol +* **smb/smb_structs.py** : + Contains the internal classes used in the SMB package for SMB1 protocol. These classes are usually used to encode/decode the parameter and data blocks of specific SMB1 message. +* **smb/smb2_constants.py** : + All the constants used in the smb package for SMB2 protocol +* **smb/smb2_structs.py** : + Contains the internal classes used in the SMB package for SMB2 protocol. These classes are usually used to encode/decode the parameter and data blocks of specific SMB2 message. +* **smb/SMBConnection.py** : + Contains a SMB protocol implementation. All operations are blocking I/O. +* **smb/SMBProtocol.py** : + Contains the SMB protocol implementation for use in the Twisted framework. +* **smb/SMBHandler.py** : + Provides support for "smb://" URL in the urllib2 python package. + +Using pysmb +=========== + +As an application developer who is looking to use pysmb to translate NetBIOS names to IP addresses, + * To use pysmb in applications where you want the file operations to return after they have completed (synchronous style), please read + :doc:`nmb.NetBIOS.NetBIOS` documentation. + * To use pysmb in Twisted, please read :doc:`nmb.NetBIOSProtocol.NBNSProtocol` documentation. + +As an application developer who is looking to use pysmb to implement file transfer or authentication over SMB: + * To use pysmb in applications where you want the file operations to return after they have completed (synchronous style), please read + :doc:`smb.SMBConnection.SMBConnection` documentation. + * To use pysmb in Twisted, please read :doc:`smb.SMBProtocol.SMBProtocolFactory` documentation. + * To support "smb://" URL in urllib2 python package, read :doc:`smb.SMBHandler.SMBHandler` documentation. + +As a software developer who is looking to modify pysmb so that you can integrate it to other network frameworks: + * Read :doc:`extending` + + + +Indices and tables +================== + +.. toctree:: + :glob: + :maxdepth: 1 + + api/* + extending + +* :ref:`genindex` +* :ref:`search` diff --git a/docs/html/_static/ajax-loader.gif b/docs/html/_static/ajax-loader.gif new file mode 100644 index 0000000..61faf8c Binary files /dev/null and b/docs/html/_static/ajax-loader.gif differ diff --git a/docs/html/_static/basic.css b/docs/html/_static/basic.css new file mode 100644 index 0000000..c89fc7e --- /dev/null +++ b/docs/html/_static/basic.css @@ -0,0 +1,599 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox input[type="text"] { + width: 170px; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + width: 30px; +} + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable dl, table.indextable dd { + margin-top: 0; + margin-bottom: 0; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- general body styles --------------------------------------------------- */ + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.field-list ul { + padding-left: 1em; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px 7px 0 7px; + background-color: #ffe; + width: 40%; + float: right; +} + +p.sidebar-title { + font-weight: bold; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px 7px 0 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +div.admonition dl { + margin-bottom: 0; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + border: 0; + border-collapse: collapse; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.field-list td, table.field-list th { + border: 0 !important; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +dl { + margin-bottom: 15px; +} + +dd p { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dt:target, .highlighted { + background-color: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +td.linenos pre { + padding: 5px 0px; + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + margin-left: 0.5em; +} + +table.highlighttable td { + padding: 0 0.5em 0 0.5em; +} + +div.code-block-caption { + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +div.code-block-caption + div > div.highlight > pre { + margin-top: 0; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + padding: 1em 1em 0; +} + +div.literal-block-wrapper div.highlight { + margin: 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/docs/html/_static/comment-bright.png b/docs/html/_static/comment-bright.png new file mode 100644 index 0000000..551517b Binary files /dev/null and b/docs/html/_static/comment-bright.png differ diff --git a/docs/html/_static/comment-close.png b/docs/html/_static/comment-close.png new file mode 100644 index 0000000..09b54be Binary files /dev/null and b/docs/html/_static/comment-close.png differ diff --git a/docs/html/_static/comment.png b/docs/html/_static/comment.png new file mode 100644 index 0000000..92feb52 Binary files /dev/null and b/docs/html/_static/comment.png differ diff --git a/docs/html/_static/contents.png b/docs/html/_static/contents.png new file mode 100644 index 0000000..7fb8215 Binary files /dev/null and b/docs/html/_static/contents.png differ diff --git a/docs/html/_static/doctools.js b/docs/html/_static/doctools.js new file mode 100644 index 0000000..e2e70cc --- /dev/null +++ b/docs/html/_static/doctools.js @@ -0,0 +1,263 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + */ +jQuery.urldecode = function(x) { + return decodeURIComponent(x).replace(/\+/g, ' '); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s == 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node) { + if (node.nodeType == 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) { + var span = document.createElement("span"); + span.className = className; + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this); + }); + } + } + return this.each(function() { + highlight(this); + }); +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated == 'undefined') + return string; + return (typeof translated == 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated == 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('

' + _('Hide Search Matches') + '

') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) == 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this == '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/docs/html/_static/down-pressed.png b/docs/html/_static/down-pressed.png new file mode 100644 index 0000000..7c30d00 Binary files /dev/null and b/docs/html/_static/down-pressed.png differ diff --git a/docs/html/_static/down.png b/docs/html/_static/down.png new file mode 100644 index 0000000..f48098a Binary files /dev/null and b/docs/html/_static/down.png differ diff --git a/docs/html/_static/file.png b/docs/html/_static/file.png new file mode 100644 index 0000000..254c60b Binary files /dev/null and b/docs/html/_static/file.png differ diff --git a/docs/html/_static/jquery.js b/docs/html/_static/jquery.js new file mode 100644 index 0000000..415ff51 --- /dev/null +++ b/docs/html/_static/jquery.js @@ -0,0 +1,10351 @@ +/*! + * jQuery JavaScript Library v1.11.3 + * http://jquery.com/ + * + * Includes Sizzle.js + * http://sizzlejs.com/ + * + * Copyright 2005, 2014 jQuery Foundation, Inc. and other contributors + * Released under the MIT license + * http://jquery.org/license + * + * Date: 2015-09-23T12:31Z + */ + +(function( global, factory ) { + + if ( typeof module === "object" && typeof module.exports === "object" ) { + // For CommonJS and CommonJS-like environments where a proper window is present, + // execute the factory and get jQuery + // For environments that do not inherently posses a window with a document + // (such as Node.js), expose a jQuery-making factory as module.exports + // This accentuates the need for the creation of a real window + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +}(typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Can't do this because several apps including ASP.NET trace +// the stack via arguments.caller.callee and Firefox dies if +// you try to trace through "use strict" call chains. (#13335) +// Support: Firefox 18+ +// +var deletedIds = []; + +var slice = deletedIds.slice; + +var concat = deletedIds.concat; + +var push = deletedIds.push; + +var indexOf = deletedIds.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var support = {}; + + + +var + version = "1.11.3", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }, + + // Support: Android<4.1, IE<9 + // Make sure we trim BOM and NBSP + rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g, + + // Matches dashed string for camelizing + rmsPrefix = /^-ms-/, + rdashAlpha = /-([\da-z])/gi, + + // Used by jQuery.camelCase as callback to replace() + fcamelCase = function( all, letter ) { + return letter.toUpperCase(); + }; + +jQuery.fn = jQuery.prototype = { + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // Start with an empty selector + selector: "", + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + return num != null ? + + // Return just the one element from the set + ( num < 0 ? this[ num + this.length ] : this[ num ] ) : + + // Return all the elements in a clean array + slice.call( this ); + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + ret.context = this.context; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + // (You can seed the arguments with an array of args, but this is + // only used internally.) + each: function( callback, args ) { + return jQuery.each( this, callback, args ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map(this, function( elem, i ) { + return callback.call( elem, i, elem ); + })); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[j] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(null); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: deletedIds.sort, + splice: deletedIds.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var src, copyIsArray, copy, name, options, clone, + target = arguments[0] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !jQuery.isFunction(target) ) { + target = {}; + } + + // extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + // Only deal with non-null/undefined values + if ( (options = arguments[ i ]) != null ) { + // Extend the base object + for ( name in options ) { + src = target[ name ]; + copy = options[ name ]; + + // Prevent never-ending loop + if ( target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject(copy) || (copyIsArray = jQuery.isArray(copy)) ) ) { + if ( copyIsArray ) { + copyIsArray = false; + clone = src && jQuery.isArray(src) ? src : []; + + } else { + clone = src && jQuery.isPlainObject(src) ? src : {}; + } + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend({ + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + // See test/unit/core.js for details concerning isFunction. + // Since version 1.3, DOM methods and functions like alert + // aren't supported. They return false on IE (#2968). + isFunction: function( obj ) { + return jQuery.type(obj) === "function"; + }, + + isArray: Array.isArray || function( obj ) { + return jQuery.type(obj) === "array"; + }, + + isWindow: function( obj ) { + /* jshint eqeqeq: false */ + return obj != null && obj == obj.window; + }, + + isNumeric: function( obj ) { + // parseFloat NaNs numeric-cast false positives (null|true|false|"") + // ...but misinterprets leading-number strings, particularly hex literals ("0x...") + // subtraction forces infinities to NaN + // adding 1 corrects loss of precision from parseFloat (#15100) + return !jQuery.isArray( obj ) && (obj - parseFloat( obj ) + 1) >= 0; + }, + + isEmptyObject: function( obj ) { + var name; + for ( name in obj ) { + return false; + } + return true; + }, + + isPlainObject: function( obj ) { + var key; + + // Must be an Object. + // Because of IE, we also have to check the presence of the constructor property. + // Make sure that DOM nodes and window objects don't pass through, as well + if ( !obj || jQuery.type(obj) !== "object" || obj.nodeType || jQuery.isWindow( obj ) ) { + return false; + } + + try { + // Not own constructor property must be Object + if ( obj.constructor && + !hasOwn.call(obj, "constructor") && + !hasOwn.call(obj.constructor.prototype, "isPrototypeOf") ) { + return false; + } + } catch ( e ) { + // IE8,9 Will throw exceptions on certain host objects #9897 + return false; + } + + // Support: IE<9 + // Handle iteration over inherited properties before own properties. + if ( support.ownLast ) { + for ( key in obj ) { + return hasOwn.call( obj, key ); + } + } + + // Own properties are enumerated firstly, so to speed up, + // if last one is own, then all properties are own. + for ( key in obj ) {} + + return key === undefined || hasOwn.call( obj, key ); + }, + + type: function( obj ) { + if ( obj == null ) { + return obj + ""; + } + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call(obj) ] || "object" : + typeof obj; + }, + + // Evaluates a script in a global context + // Workarounds based on findings by Jim Driscoll + // http://weblogs.java.net/blog/driscoll/archive/2009/09/08/eval-javascript-global-context + globalEval: function( data ) { + if ( data && jQuery.trim( data ) ) { + // We use execScript on Internet Explorer + // We use an anonymous function so that context is window + // rather than jQuery in Firefox + ( window.execScript || function( data ) { + window[ "eval" ].call( window, data ); + } )( data ); + } + }, + + // Convert dashed to camelCase; used by the css and data modules + // Microsoft forgot to hump their vendor prefix (#9572) + camelCase: function( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); + }, + + nodeName: function( elem, name ) { + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + }, + + // args is for internal usage only + each: function( obj, callback, args ) { + var value, + i = 0, + length = obj.length, + isArray = isArraylike( obj ); + + if ( args ) { + if ( isArray ) { + for ( ; i < length; i++ ) { + value = callback.apply( obj[ i ], args ); + + if ( value === false ) { + break; + } + } + } else { + for ( i in obj ) { + value = callback.apply( obj[ i ], args ); + + if ( value === false ) { + break; + } + } + } + + // A special, fast, case for the most common use of each + } else { + if ( isArray ) { + for ( ; i < length; i++ ) { + value = callback.call( obj[ i ], i, obj[ i ] ); + + if ( value === false ) { + break; + } + } + } else { + for ( i in obj ) { + value = callback.call( obj[ i ], i, obj[ i ] ); + + if ( value === false ) { + break; + } + } + } + } + + return obj; + }, + + // Support: Android<4.1, IE<9 + trim: function( text ) { + return text == null ? + "" : + ( text + "" ).replace( rtrim, "" ); + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArraylike( Object(arr) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + var len; + + if ( arr ) { + if ( indexOf ) { + return indexOf.call( arr, elem, i ); + } + + len = arr.length; + i = i ? i < 0 ? Math.max( 0, len + i ) : i : 0; + + for ( ; i < len; i++ ) { + // Skip accessing in sparse arrays + if ( i in arr && arr[ i ] === elem ) { + return i; + } + } + } + + return -1; + }, + + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + while ( j < len ) { + first[ i++ ] = second[ j++ ]; + } + + // Support: IE<9 + // Workaround casting of .length to NaN on otherwise arraylike objects (e.g., NodeLists) + if ( len !== len ) { + while ( second[j] !== undefined ) { + first[ i++ ] = second[ j++ ]; + } + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var value, + i = 0, + length = elems.length, + isArray = isArraylike( elems ), + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArray ) { + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return concat.apply( [], ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // Bind a function to a context, optionally partially applying any + // arguments. + proxy: function( fn, context ) { + var args, proxy, tmp; + + if ( typeof context === "string" ) { + tmp = fn[ context ]; + context = fn; + fn = tmp; + } + + // Quick check to determine if target is callable, in the spec + // this throws a TypeError, but we will just return undefined. + if ( !jQuery.isFunction( fn ) ) { + return undefined; + } + + // Simulated bind + args = slice.call( arguments, 2 ); + proxy = function() { + return fn.apply( context || this, args.concat( slice.call( arguments ) ) ); + }; + + // Set the guid of unique handler to the same of original handler, so it can be removed + proxy.guid = fn.guid = fn.guid || jQuery.guid++; + + return proxy; + }, + + now: function() { + return +( new Date() ); + }, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +}); + +// Populate the class2type map +jQuery.each("Boolean Number String Function Array Date RegExp Object Error".split(" "), function(i, name) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +}); + +function isArraylike( obj ) { + + // Support: iOS 8.2 (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = "length" in obj && obj.length, + type = jQuery.type( obj ); + + if ( type === "function" || jQuery.isWindow( obj ) ) { + return false; + } + + if ( obj.nodeType === 1 && length ) { + return true; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.2.0-pre + * http://sizzlejs.com/ + * + * Copyright 2008, 2014 jQuery Foundation, Inc. and other contributors + * Released under the MIT license + * http://jquery.org/license + * + * Date: 2014-12-16 + */ +(function( window ) { + +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // General-purpose constants + MAX_NEGATIVE = 1 << 31, + + // Instance methods + hasOwn = ({}).hasOwnProperty, + arr = [], + pop = arr.pop, + push_native = arr.push, + push = arr.push, + slice = arr.slice, + // Use a stripped-down indexOf as it's faster than native + // http://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[i] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // Whitespace characters http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + // http://www.w3.org/TR/css3-syntax/#characters + characterEncoding = "(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+", + + // Loosely modeled on CSS identifier characters + // An unquoted value should be a CSS identifier http://www.w3.org/TR/css3-selectors/#attribute-selectors + // Proper syntax: http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier + identifier = characterEncoding.replace( "w", "w#" ), + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + characterEncoding + ")(?:" + whitespace + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace + + "*\\]", + + pseudos = ":(" + characterEncoding + ")(?:\\((" + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ), + + rattributeQuotes = new RegExp( "=" + whitespace + "*([^\\]'\"]*?)" + whitespace + "*\\]", "g" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + characterEncoding + ")" ), + "CLASS": new RegExp( "^\\.(" + characterEncoding + ")" ), + "TAG": new RegExp( "^(" + characterEncoding.replace( "w", "w*" ) + ")" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace + + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace + + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + + whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + rescape = /'|\\/g, + + // CSS escapes http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ), + funescape = function( _, escaped, escapedWhitespace ) { + var high = "0x" + escaped - 0x10000; + // NaN means non-codepoint + // Support: Firefox<24 + // Workaround erroneous numeric interpretation of +"0x" + return high !== high || escapedWhitespace ? + escaped : + high < 0 ? + // BMP codepoint + String.fromCharCode( high + 0x10000 ) : + // Supplemental Plane codepoint (surrogate pair) + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }; + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + (arr = slice.call( preferredDoc.childNodes )), + preferredDoc.childNodes + ); + // Support: Android<4.0 + // Detect silently failing push.apply + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + push_native.apply( target, slice.call(els) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + // Can't trust NodeList.length + while ( (target[j++] = els[i++]) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var match, elem, m, nodeType, + // QSA vars + i, groups, old, nid, newContext, newSelector; + + if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) { + setDocument( context ); + } + + context = context || document; + results = results || []; + nodeType = context.nodeType; + + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + if ( !seed && documentIsHTML ) { + + // Try to shortcut find operations when possible (e.g., not under DocumentFragment) + if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) { + // Speed-up: Sizzle("#ID") + if ( (m = match[1]) ) { + if ( nodeType === 9 ) { + elem = context.getElementById( m ); + // Check parentNode to catch when Blackberry 4.6 returns + // nodes that are no longer in the document (jQuery #6963) + if ( elem && elem.parentNode ) { + // Handle the case where IE, Opera, and Webkit return items + // by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + } else { + // Context is not a document + if ( context.ownerDocument && (elem = context.ownerDocument.getElementById( m )) && + contains( context, elem ) && elem.id === m ) { + results.push( elem ); + return results; + } + } + + // Speed-up: Sizzle("TAG") + } else if ( match[2] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Speed-up: Sizzle(".CLASS") + } else if ( (m = match[3]) && support.getElementsByClassName ) { + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // QSA path + if ( support.qsa && (!rbuggyQSA || !rbuggyQSA.test( selector )) ) { + nid = old = expando; + newContext = context; + newSelector = nodeType !== 1 && selector; + + // qSA works strangely on Element-rooted queries + // We can work around this by specifying an extra ID on the root + // and working up from there (Thanks to Andrew Dupont for the technique) + // IE 8 doesn't work on object elements + if ( nodeType === 1 && context.nodeName.toLowerCase() !== "object" ) { + groups = tokenize( selector ); + + if ( (old = context.getAttribute("id")) ) { + nid = old.replace( rescape, "\\$&" ); + } else { + context.setAttribute( "id", nid ); + } + nid = "[id='" + nid + "'] "; + + i = groups.length; + while ( i-- ) { + groups[i] = nid + toSelector( groups[i] ); + } + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || context; + newSelector = groups.join(","); + } + + if ( newSelector ) { + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch(qsaError) { + } finally { + if ( !old ) { + context.removeAttribute("id"); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {Function(string, Object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return (cache[ key + " " ] = value); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created div and expects a boolean result + */ +function assert( fn ) { + var div = document.createElement("div"); + + try { + return !!fn( div ); + } catch (e) { + return false; + } finally { + // Remove from its parent by default + if ( div.parentNode ) { + div.parentNode.removeChild( div ); + } + // release memory in IE + div = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split("|"), + i = attrs.length; + + while ( i-- ) { + Expr.attrHandle[ arr[i] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + ( ~b.sourceIndex || MAX_NEGATIVE ) - + ( ~a.sourceIndex || MAX_NEGATIVE ); + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( (cur = cur.nextSibling) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return (name === "input" || name === "button") && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction(function( argument ) { + argument = +argument; + return markFunction(function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ (j = matchIndexes[i]) ] ) { + seed[j] = !(matches[j] = seed[j]); + } + } + }); + }); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + // documentElement is verified for cases where it doesn't yet exist + // (such as loading iframes in IE - #4833) + var documentElement = elem && (elem.ownerDocument || elem).documentElement; + return documentElement ? documentElement.nodeName !== "HTML" : false; +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, parent, + doc = node ? node.ownerDocument || node : preferredDoc; + + // If no document and documentElement is available, return + if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Set our document + document = doc; + docElem = doc.documentElement; + parent = doc.defaultView; + + // Support: IE>8 + // If iframe document is assigned to "document" variable and if iframe has been reloaded, + // IE will throw "permission denied" error when accessing "document" variable, see jQuery #13936 + // IE6-8 do not support the defaultView property so parent will be undefined + if ( parent && parent !== parent.top ) { + // IE11 does not have attachEvent, so all must suffer + if ( parent.addEventListener ) { + parent.addEventListener( "unload", unloadHandler, false ); + } else if ( parent.attachEvent ) { + parent.attachEvent( "onunload", unloadHandler ); + } + } + + /* Support tests + ---------------------------------------------------------------------- */ + documentIsHTML = !isXML( doc ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert(function( div ) { + div.className = "i"; + return !div.getAttribute("className"); + }); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert(function( div ) { + div.appendChild( doc.createComment("") ); + return !div.getElementsByTagName("*").length; + }); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( doc.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert(function( div ) { + docElem.appendChild( div ).id = expando; + return !doc.getElementsByName || !doc.getElementsByName( expando ).length; + }); + + // ID find and filter + if ( support.getById ) { + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var m = context.getElementById( id ); + // Check parentNode to catch when Blackberry 4.6 returns + // nodes that are no longer in the document #6963 + return m && m.parentNode ? [ m ] : []; + } + }; + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute("id") === attrId; + }; + }; + } else { + // Support: IE6/7 + // getElementById is not reliable as a find shortcut + delete Expr.find["ID"]; + + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && elem.getAttributeNode("id"); + return node && node.value === attrId; + }; + }; + } + + // Tag + Expr.find["TAG"] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( (elem = results[i++]) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) { + if ( documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See http://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( (support.qsa = rnative.test( doc.querySelectorAll )) ) { + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert(function( div ) { + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // http://bugs.jquery.com/ticket/12359 + docElem.appendChild( div ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // http://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( div.querySelectorAll("[msallowcapture^='']").length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !div.querySelectorAll("[selected]").length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.2+, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.7+ + if ( !div.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push("~="); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !div.querySelectorAll(":checked").length ) { + rbuggyQSA.push(":checked"); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibing-combinator selector` fails + if ( !div.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push(".#.+[+~]"); + } + }); + + assert(function( div ) { + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = doc.createElement("input"); + input.setAttribute( "type", "hidden" ); + div.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( div.querySelectorAll("[name=d]").length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( !div.querySelectorAll(":enabled").length ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Opera 10-11 does not throw on post-comma invalid pseudos + div.querySelectorAll("*,:x"); + rbuggyQSA.push(",.*:"); + }); + } + + if ( (support.matchesSelector = rnative.test( (matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector) )) ) { + + assert(function( div ) { + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( div, "div" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( div, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + }); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully does not implement inclusive descendent + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + )); + } : + function( a, b ) { + if ( b ) { + while ( (b = b.parentNode) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) { + + // Choose the first element that is related to our preferred document + if ( a === doc || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) { + return -1; + } + if ( b === doc || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + return a === doc ? -1 : + b === doc ? 1 : + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( (cur = cur.parentNode) ) { + ap.unshift( cur ); + } + cur = b; + while ( (cur = cur.parentNode) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[i] === bp[i] ) { + i++; + } + + return i ? + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[i], bp[i] ) : + + // Otherwise nodes in our document sort first + ap[i] === preferredDoc ? -1 : + bp[i] === preferredDoc ? 1 : + 0; + }; + + return doc; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + // Make sure that attribute selectors are quoted + expr = expr.replace( rattributeQuotes, "='$1']" ); + + if ( support.matchesSelector && documentIsHTML && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch (e) {} + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + // Set document vars if needed + if ( ( context.ownerDocument || context ) !== document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + (val = elem.getAttributeNode(name)) && val.specified ? + val.value : + null; +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( (elem = results[i++]) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + // If no nodeType, this is expected to be an array + while ( (node = elem[i++]) ) { + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[1] = match[1].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape ); + + if ( match[2] === "~=" ) { + match[3] = " " + match[3] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[1] = match[1].toLowerCase(); + + if ( match[1].slice( 0, 3 ) === "nth" ) { + // nth-* requires argument + if ( !match[3] ) { + Sizzle.error( match[0] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) ); + match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" ); + + // other types prohibit arguments + } else if ( match[3] ) { + Sizzle.error( match[0] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[6] && match[2]; + + if ( matchExpr["CHILD"].test( match[0] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[3] ) { + match[2] = match[4] || match[5] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + // Get excess from tokenize (recursively) + (excess = tokenize( unquoted, true )) && + // advance to the next closing parenthesis + (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) { + + // excess is a negative index + match[0] = match[0].slice( 0, excess ); + match[2] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { return true; } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) && + classCache( className, function( elem ) { + return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== "undefined" && elem.getAttribute("class") || "" ); + }); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + }; + }, + + "CHILD": function( type, what, argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, context, xml ) { + var cache, outerCache, node, diff, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( (node = node[ dir ]) ) { + if ( ofType ? node.nodeName.toLowerCase() === name : node.nodeType === 1 ) { + return false; + } + } + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + // Seek `elem` from a previously-cached index + outerCache = parent[ expando ] || (parent[ expando ] = {}); + cache = outerCache[ type ] || []; + nodeIndex = cache[0] === dirruns && cache[1]; + diff = cache[0] === dirruns && cache[2]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( (node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + (diff = nodeIndex = 0) || start.pop()) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + outerCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + // Use previously-cached element index if available + } else if ( useCache && (cache = (elem[ expando ] || (elem[ expando ] = {}))[ type ]) && cache[0] === dirruns ) { + diff = cache[1]; + + // xml :nth-child(...) or :nth-last-child(...) or :nth(-last)?-of-type(...) + } else { + // Use the same loop as above to seek `elem` from the start + while ( (node = ++nodeIndex && node && node[ dir ] || + (diff = nodeIndex = 0) || start.pop()) ) { + + if ( ( ofType ? node.nodeName.toLowerCase() === name : node.nodeType === 1 ) && ++diff ) { + // Cache the index of each encountered element + if ( useCache ) { + (node[ expando ] || (node[ expando ] = {}))[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction(function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[i] ); + seed[ idx ] = !( matches[ idx ] = matched[i] ); + } + }) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + // Potentially complex pseudos + "not": markFunction(function( selector ) { + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction(function( seed, matches, context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( (elem = unmatched[i]) ) { + seed[i] = !(matches[i] = elem); + } + } + }) : + function( elem, context, xml ) { + input[0] = elem; + matcher( input, null, xml, results ); + // Don't keep the element (issue #299) + input[0] = null; + return !results.pop(); + }; + }), + + "has": markFunction(function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + }), + + "contains": markFunction(function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || elem.innerText || getText( elem ) ).indexOf( text ) > -1; + }; + }), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + // lang value must be a valid identifier + if ( !ridentifier.test(lang || "") ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( (elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( (elem = elem.parentNode) && elem.nodeType === 1 ); + return false; + }; + }), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex); + }, + + // Boolean properties + "enabled": function( elem ) { + return elem.disabled === false; + }, + + "disabled": function( elem ) { + return elem.disabled === true; + }, + + "checked": function( elem ) { + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected); + }, + + "selected": function( elem ) { + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos["empty"]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo(function() { + return [ 0 ]; + }), + + "last": createPositionalPseudo(function( matchIndexes, length ) { + return [ length - 1 ]; + }), + + "eq": createPositionalPseudo(function( matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + }), + + "even": createPositionalPseudo(function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "odd": createPositionalPseudo(function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "lt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "gt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }) + } +}; + +Expr.pseudos["nth"] = Expr.pseudos["eq"]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || (match = rcomma.exec( soFar )) ) { + if ( match ) { + // Don't consume trailing commas as valid + soFar = soFar.slice( match[0].length ) || soFar; + } + groups.push( (tokens = []) ); + } + + matched = false; + + // Combinators + if ( (match = rcombinators.exec( soFar )) ) { + matched = match.shift(); + tokens.push({ + value: matched, + // Cast descendant combinators to space + type: match[0].replace( rtrim, " " ) + }); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] || + (match = preFilters[ type ]( match ))) ) { + matched = match.shift(); + tokens.push({ + value: matched, + type: type, + matches: match + }); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[i].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + checkNonElements = base && dir === "parentNode", + doneName = done++; + + return combinator.first ? + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from dir caching + if ( xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || (elem[ expando ] = {}); + if ( (oldCache = outerCache[ dir ]) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return (newCache[ 2 ] = oldCache[ 2 ]); + } else { + // Reuse newcache so results back-propagate to previous elements + outerCache[ dir ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) { + return true; + } + } + } + } + } + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[i]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[0]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[i], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( (elem = unmatched[i]) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction(function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( (elem = temp[i]) ) { + matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) ) { + // Restore matcherIn since elem is not yet a final match + temp.push( (matcherIn[i] = elem) ); + } + } + postFinder( null, (matcherOut = []), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) && + (temp = postFinder ? indexOf( seed, elem ) : preMap[i]) > -1 ) { + + seed[temp] = !(results[temp] = elem); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + }); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[0].type ], + implicitRelative = leadingRelative || Expr.relative[" "], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + (checkContext = context).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( (matcher = Expr.relative[ tokens[i].type ]) ) { + matchers = [ addCombinator(elementMatcher( matchers ), matcher) ]; + } else { + matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[j].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" }) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( (tokens = tokens.slice( j )) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find["TAG"]( "*", outermost ), + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1), + len = elems.length; + + if ( outermost ) { + outermostContext = context !== document && context; + } + + // Add elements passing elementMatchers directly to results + // Keep `i` a string if there are no elements so `matchedCount` will be "00" below + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && (elem = elems[i]) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + while ( (matcher = elementMatchers[j++]) ) { + if ( matcher( elem, context, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + // They will have gone through all possible matchers + if ( (elem = !matcher && elem) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // Apply set filters to unmatched elements + matchedCount += i; + if ( bySet && i !== matchedCount ) { + j = 0; + while ( (matcher = setMatchers[j++]) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !(unmatched[i] || setMatched[i]) ) { + setMatched[i] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[i] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( (selector = compiled.selector || selector) ); + + results = results || []; + + // Try to minimize operations if there is no seed and only one group + if ( match.length === 1 ) { + + // Take a shortcut and set the context if the root selector is an ID + tokens = match[0] = match[0].slice( 0 ); + if ( tokens.length > 2 && (token = tokens[0]).type === "ID" && + support.getById && context.nodeType === 9 && documentIsHTML && + Expr.relative[ tokens[1].type ] ) { + + context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[i]; + + // Abort if we hit a combinator + if ( Expr.relative[ (type = token.type) ] ) { + break; + } + if ( (find = Expr.find[ type ]) ) { + // Search, expanding context for leading sibling combinators + if ( (seed = find( + token.matches[0].replace( runescape, funescape ), + rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context + )) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split("").sort( sortOrder ).join("") === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert(function( div1 ) { + // Should return 1, but returns 4 (following) + return div1.compareDocumentPosition( document.createElement("div") ) & 1; +}); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// http://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert(function( div ) { + div.innerHTML = ""; + return div.firstChild.getAttribute("href") === "#" ; +}) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + }); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert(function( div ) { + div.innerHTML = ""; + div.firstChild.setAttribute( "value", "" ); + return div.firstChild.getAttribute( "value" ) === ""; +}) ) { + addHandle( "value", function( elem, name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + }); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert(function( div ) { + return div.getAttribute("disabled") == null; +}) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + (val = elem.getAttributeNode( name )) && val.specified ? + val.value : + null; + } + }); +} + +return Sizzle; + +})( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; +jQuery.expr[":"] = jQuery.expr.pseudos; +jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; + + + +var rneedsContext = jQuery.expr.match.needsContext; + +var rsingleTag = (/^<(\w+)\s*\/?>(?:<\/\1>|)$/); + + + +var risSimple = /^.[^:#\[\.,]*$/; + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( jQuery.isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + /* jshint -W018 */ + return !!qualifier.call( elem, i, elem ) !== not; + }); + + } + + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + }); + + } + + if ( typeof qualifier === "string" ) { + if ( risSimple.test( qualifier ) ) { + return jQuery.filter( qualifier, elements, not ); + } + + qualifier = jQuery.filter( qualifier, elements ); + } + + return jQuery.grep( elements, function( elem ) { + return ( jQuery.inArray( elem, qualifier ) >= 0 ) !== not; + }); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + return elems.length === 1 && elem.nodeType === 1 ? + jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : [] : + jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + })); +}; + +jQuery.fn.extend({ + find: function( selector ) { + var i, + ret = [], + self = this, + len = self.length; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter(function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + }) ); + } + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + // Needed because $( selector, context ) becomes $( context ).find( selector ) + ret = this.pushStack( len > 1 ? jQuery.unique( ret ) : ret ); + ret.selector = this.selector ? this.selector + " " + selector : selector; + return ret; + }, + filter: function( selector ) { + return this.pushStack( winnow(this, selector || [], false) ); + }, + not: function( selector ) { + return this.pushStack( winnow(this, selector || [], true) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +}); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // Use the correct document accordingly with window argument (sandbox) + document = window.document, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/, + + init = jQuery.fn.init = function( selector, context ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector.charAt(0) === "<" && selector.charAt( selector.length - 1 ) === ">" && selector.length >= 3 ) { + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && (match[1] || !context) ) { + + // HANDLE: $(html) -> $(array) + if ( match[1] ) { + context = context instanceof jQuery ? context[0] : context; + + // scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[1], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[1] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + // Properties of context are called as methods if possible + if ( jQuery.isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[2] ); + + // Check parentNode to catch when Blackberry 4.6 returns + // nodes that are no longer in the document #6963 + if ( elem && elem.parentNode ) { + // Handle the case where IE and Opera return items + // by name instead of ID + if ( elem.id !== match[2] ) { + return rootjQuery.find( selector ); + } + + // Otherwise, we inject the element directly into the jQuery object + this.length = 1; + this[0] = elem; + } + + this.context = document; + this.selector = selector; + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || rootjQuery ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this.context = this[0] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( jQuery.isFunction( selector ) ) { + return typeof rootjQuery.ready !== "undefined" ? + rootjQuery.ready( selector ) : + // Execute immediately if ready is not present + selector( jQuery ); + } + + if ( selector.selector !== undefined ) { + this.selector = selector.selector; + this.context = selector.context; + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + // methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.extend({ + dir: function( elem, dir, until ) { + var matched = [], + cur = elem[ dir ]; + + while ( cur && cur.nodeType !== 9 && (until === undefined || cur.nodeType !== 1 || !jQuery( cur ).is( until )) ) { + if ( cur.nodeType === 1 ) { + matched.push( cur ); + } + cur = cur[dir]; + } + return matched; + }, + + sibling: function( n, elem ) { + var r = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + r.push( n ); + } + } + + return r; + } +}); + +jQuery.fn.extend({ + has: function( target ) { + var i, + targets = jQuery( target, this ), + len = targets.length; + + return this.filter(function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( this, targets[i] ) ) { + return true; + } + } + }); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + pos = rneedsContext.test( selectors ) || typeof selectors !== "string" ? + jQuery( selectors, context || this.context ) : + 0; + + for ( ; i < l; i++ ) { + for ( cur = this[i]; cur && cur !== context; cur = cur.parentNode ) { + // Always skip document fragments + if ( cur.nodeType < 11 && (pos ? + pos.index(cur) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector(cur, selectors)) ) { + + matched.push( cur ); + break; + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.unique( matched ) : matched ); + }, + + // Determine the position of an element within + // the matched set of elements + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[0] && this[0].parentNode ) ? this.first().prevAll().length : -1; + } + + // index in selector + if ( typeof elem === "string" ) { + return jQuery.inArray( this[0], jQuery( elem ) ); + } + + // Locate the position of the desired element + return jQuery.inArray( + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[0] : elem, this ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.unique( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter(selector) + ); + } +}); + +function sibling( cur, dir ) { + do { + cur = cur[ dir ]; + } while ( cur && cur.nodeType !== 1 ); + + return cur; +} + +jQuery.each({ + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return jQuery.dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, i, until ) { + return jQuery.dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return jQuery.dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return jQuery.dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, i, until ) { + return jQuery.dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, i, until ) { + return jQuery.dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return jQuery.sibling( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return jQuery.sibling( elem.firstChild ); + }, + contents: function( elem ) { + return jQuery.nodeName( elem, "iframe" ) ? + elem.contentDocument || elem.contentWindow.document : + jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var ret = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + ret = jQuery.filter( selector, ret ); + } + + if ( this.length > 1 ) { + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + ret = jQuery.unique( ret ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + ret = ret.reverse(); + } + } + + return this.pushStack( ret ); + }; +}); +var rnotwhite = (/\S+/g); + + + +// String to Object options format cache +var optionsCache = {}; + +// Convert String-formatted options into Object-formatted ones and store in cache +function createOptions( options ) { + var object = optionsCache[ options ] = {}; + jQuery.each( options.match( rnotwhite ) || [], function( _, flag ) { + object[ flag ] = true; + }); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + ( optionsCache[ options ] || createOptions( options ) ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + // Last fire value (for non-forgettable lists) + memory, + // Flag to know if list was already fired + fired, + // End of the loop when firing + firingLength, + // Index of currently firing callback (modified by remove if needed) + firingIndex, + // First callback to fire (used internally by add and fireWith) + firingStart, + // Actual callback list + list = [], + // Stack of fire calls for repeatable lists + stack = !options.once && [], + // Fire callbacks + fire = function( data ) { + memory = options.memory && data; + fired = true; + firingIndex = firingStart || 0; + firingStart = 0; + firingLength = list.length; + firing = true; + for ( ; list && firingIndex < firingLength; firingIndex++ ) { + if ( list[ firingIndex ].apply( data[ 0 ], data[ 1 ] ) === false && options.stopOnFalse ) { + memory = false; // To prevent further calls using add + break; + } + } + firing = false; + if ( list ) { + if ( stack ) { + if ( stack.length ) { + fire( stack.shift() ); + } + } else if ( memory ) { + list = []; + } else { + self.disable(); + } + } + }, + // Actual Callbacks object + self = { + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + // First, we save the current length + var start = list.length; + (function add( args ) { + jQuery.each( args, function( _, arg ) { + var type = jQuery.type( arg ); + if ( type === "function" ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && type !== "string" ) { + // Inspect recursively + add( arg ); + } + }); + })( arguments ); + // Do we need to add the callbacks to the + // current firing batch? + if ( firing ) { + firingLength = list.length; + // With memory, if we're not firing then + // we should call right away + } else if ( memory ) { + firingStart = start; + fire( memory ); + } + } + return this; + }, + // Remove a callback from the list + remove: function() { + if ( list ) { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + // Handle firing indexes + if ( firing ) { + if ( index <= firingLength ) { + firingLength--; + } + if ( index <= firingIndex ) { + firingIndex--; + } + } + } + }); + } + return this; + }, + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? jQuery.inArray( fn, list ) > -1 : !!( list && list.length ); + }, + // Remove all callbacks from the list + empty: function() { + list = []; + firingLength = 0; + return this; + }, + // Have the list do nothing anymore + disable: function() { + list = stack = memory = undefined; + return this; + }, + // Is it disabled? + disabled: function() { + return !list; + }, + // Lock the list in its current state + lock: function() { + stack = undefined; + if ( !memory ) { + self.disable(); + } + return this; + }, + // Is it locked? + locked: function() { + return !stack; + }, + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( list && ( !fired || stack ) ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + if ( firing ) { + stack.push( args ); + } else { + fire( args ); + } + } + return this; + }, + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +jQuery.extend({ + + Deferred: function( func ) { + var tuples = [ + // action, add listener, listener list, final state + [ "resolve", "done", jQuery.Callbacks("once memory"), "resolved" ], + [ "reject", "fail", jQuery.Callbacks("once memory"), "rejected" ], + [ "notify", "progress", jQuery.Callbacks("memory") ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + then: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + return jQuery.Deferred(function( newDefer ) { + jQuery.each( tuples, function( i, tuple ) { + var fn = jQuery.isFunction( fns[ i ] ) && fns[ i ]; + // deferred[ done | fail | progress ] for forwarding actions to newDefer + deferred[ tuple[1] ](function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && jQuery.isFunction( returned.promise ) ) { + returned.promise() + .done( newDefer.resolve ) + .fail( newDefer.reject ) + .progress( newDefer.notify ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( this === promise ? newDefer.promise() : this, fn ? [ returned ] : arguments ); + } + }); + }); + fns = null; + }).promise(); + }, + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Keep pipe for back-compat + promise.pipe = promise.then; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 3 ]; + + // promise[ done | fail | progress ] = list.add + promise[ tuple[1] ] = list.add; + + // Handle state + if ( stateString ) { + list.add(function() { + // state = [ resolved | rejected ] + state = stateString; + + // [ reject_list | resolve_list ].disable; progress_list.lock + }, tuples[ i ^ 1 ][ 2 ].disable, tuples[ 2 ][ 2 ].lock ); + } + + // deferred[ resolve | reject | notify ] + deferred[ tuple[0] ] = function() { + deferred[ tuple[0] + "With" ]( this === deferred ? promise : this, arguments ); + return this; + }; + deferred[ tuple[0] + "With" ] = list.fireWith; + }); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( subordinate /* , ..., subordinateN */ ) { + var i = 0, + resolveValues = slice.call( arguments ), + length = resolveValues.length, + + // the count of uncompleted subordinates + remaining = length !== 1 || ( subordinate && jQuery.isFunction( subordinate.promise ) ) ? length : 0, + + // the master Deferred. If resolveValues consist of only a single Deferred, just use that. + deferred = remaining === 1 ? subordinate : jQuery.Deferred(), + + // Update function for both resolve and progress values + updateFunc = function( i, contexts, values ) { + return function( value ) { + contexts[ i ] = this; + values[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( values === progressValues ) { + deferred.notifyWith( contexts, values ); + + } else if ( !(--remaining) ) { + deferred.resolveWith( contexts, values ); + } + }; + }, + + progressValues, progressContexts, resolveContexts; + + // add listeners to Deferred subordinates; treat others as resolved + if ( length > 1 ) { + progressValues = new Array( length ); + progressContexts = new Array( length ); + resolveContexts = new Array( length ); + for ( ; i < length; i++ ) { + if ( resolveValues[ i ] && jQuery.isFunction( resolveValues[ i ].promise ) ) { + resolveValues[ i ].promise() + .done( updateFunc( i, resolveContexts, resolveValues ) ) + .fail( deferred.reject ) + .progress( updateFunc( i, progressContexts, progressValues ) ); + } else { + --remaining; + } + } + } + + // if we're not waiting on anything, resolve the master + if ( !remaining ) { + deferred.resolveWith( resolveContexts, resolveValues ); + } + + return deferred.promise(); + } +}); + + +// The deferred used on DOM ready +var readyList; + +jQuery.fn.ready = function( fn ) { + // Add the callback + jQuery.ready.promise().done( fn ); + + return this; +}; + +jQuery.extend({ + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Hold (or release) the ready event + holdReady: function( hold ) { + if ( hold ) { + jQuery.readyWait++; + } else { + jQuery.ready( true ); + } + }, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Make sure body exists, at least, in case IE gets a little overzealous (ticket #5443). + if ( !document.body ) { + return setTimeout( jQuery.ready ); + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + + // Trigger any bound ready events + if ( jQuery.fn.triggerHandler ) { + jQuery( document ).triggerHandler( "ready" ); + jQuery( document ).off( "ready" ); + } + } +}); + +/** + * Clean-up method for dom ready events + */ +function detach() { + if ( document.addEventListener ) { + document.removeEventListener( "DOMContentLoaded", completed, false ); + window.removeEventListener( "load", completed, false ); + + } else { + document.detachEvent( "onreadystatechange", completed ); + window.detachEvent( "onload", completed ); + } +} + +/** + * The ready event handler and self cleanup method + */ +function completed() { + // readyState === "complete" is good enough for us to call the dom ready in oldIE + if ( document.addEventListener || event.type === "load" || document.readyState === "complete" ) { + detach(); + jQuery.ready(); + } +} + +jQuery.ready.promise = function( obj ) { + if ( !readyList ) { + + readyList = jQuery.Deferred(); + + // Catch cases where $(document).ready() is called after the browser event has already occurred. + // we once tried to use readyState "interactive" here, but it caused issues like the one + // discovered by ChrisS here: http://bugs.jquery.com/ticket/12282#comment:15 + if ( document.readyState === "complete" ) { + // Handle it asynchronously to allow scripts the opportunity to delay ready + setTimeout( jQuery.ready ); + + // Standards-based browsers support DOMContentLoaded + } else if ( document.addEventListener ) { + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed, false ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed, false ); + + // If IE event model is used + } else { + // Ensure firing before onload, maybe late but safe also for iframes + document.attachEvent( "onreadystatechange", completed ); + + // A fallback to window.onload, that will always work + window.attachEvent( "onload", completed ); + + // If IE and not a frame + // continually check to see if the document is ready + var top = false; + + try { + top = window.frameElement == null && document.documentElement; + } catch(e) {} + + if ( top && top.doScroll ) { + (function doScrollCheck() { + if ( !jQuery.isReady ) { + + try { + // Use the trick by Diego Perini + // http://javascript.nwbox.com/IEContentLoaded/ + top.doScroll("left"); + } catch(e) { + return setTimeout( doScrollCheck, 50 ); + } + + // detach all dom ready events + detach(); + + // and execute any waiting functions + jQuery.ready(); + } + })(); + } + } + } + return readyList.promise( obj ); +}; + + +var strundefined = typeof undefined; + + + +// Support: IE<9 +// Iteration over object's inherited properties before its own +var i; +for ( i in jQuery( support ) ) { + break; +} +support.ownLast = i !== "0"; + +// Note: most support tests are defined in their respective modules. +// false until the test is run +support.inlineBlockNeedsLayout = false; + +// Execute ASAP in case we need to set body.style.zoom +jQuery(function() { + // Minified: var a,b,c,d + var val, div, body, container; + + body = document.getElementsByTagName( "body" )[ 0 ]; + if ( !body || !body.style ) { + // Return for frameset docs that don't have a body + return; + } + + // Setup + div = document.createElement( "div" ); + container = document.createElement( "div" ); + container.style.cssText = "position:absolute;border:0;width:0;height:0;top:0;left:-9999px"; + body.appendChild( container ).appendChild( div ); + + if ( typeof div.style.zoom !== strundefined ) { + // Support: IE<8 + // Check if natively block-level elements act like inline-block + // elements when setting their display to 'inline' and giving + // them layout + div.style.cssText = "display:inline;margin:0;border:0;padding:1px;width:1px;zoom:1"; + + support.inlineBlockNeedsLayout = val = div.offsetWidth === 3; + if ( val ) { + // Prevent IE 6 from affecting layout for positioned elements #11048 + // Prevent IE from shrinking the body in IE 7 mode #12869 + // Support: IE<8 + body.style.zoom = 1; + } + } + + body.removeChild( container ); +}); + + + + +(function() { + var div = document.createElement( "div" ); + + // Execute the test only if not already executed in another module. + if (support.deleteExpando == null) { + // Support: IE<9 + support.deleteExpando = true; + try { + delete div.test; + } catch( e ) { + support.deleteExpando = false; + } + } + + // Null elements to avoid leaks in IE. + div = null; +})(); + + +/** + * Determines whether an object can have data + */ +jQuery.acceptData = function( elem ) { + var noData = jQuery.noData[ (elem.nodeName + " ").toLowerCase() ], + nodeType = +elem.nodeType || 1; + + // Do not set data on non-element DOM nodes because it will not be cleared (#8335). + return nodeType !== 1 && nodeType !== 9 ? + false : + + // Nodes accept data unless otherwise specified; rejection can be conditional + !noData || noData !== true && elem.getAttribute("classid") === noData; +}; + + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /([A-Z])/g; + +function dataAttr( elem, key, data ) { + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + + var name = "data-" + key.replace( rmultiDash, "-$1" ).toLowerCase(); + + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = data === "true" ? true : + data === "false" ? false : + data === "null" ? null : + // Only convert to a number if it doesn't change the string + +data + "" === data ? +data : + rbrace.test( data ) ? jQuery.parseJSON( data ) : + data; + } catch( e ) {} + + // Make sure we set the data so it isn't changed later + jQuery.data( elem, key, data ); + + } else { + data = undefined; + } + } + + return data; +} + +// checks a cache object for emptiness +function isEmptyDataObject( obj ) { + var name; + for ( name in obj ) { + + // if the public data object is empty, the private is still empty + if ( name === "data" && jQuery.isEmptyObject( obj[name] ) ) { + continue; + } + if ( name !== "toJSON" ) { + return false; + } + } + + return true; +} + +function internalData( elem, name, data, pvt /* Internal Use Only */ ) { + if ( !jQuery.acceptData( elem ) ) { + return; + } + + var ret, thisCache, + internalKey = jQuery.expando, + + // We have to handle DOM nodes and JS objects differently because IE6-7 + // can't GC object references properly across the DOM-JS boundary + isNode = elem.nodeType, + + // Only DOM nodes need the global jQuery cache; JS object data is + // attached directly to the object so GC can occur automatically + cache = isNode ? jQuery.cache : elem, + + // Only defining an ID for JS objects if its cache already exists allows + // the code to shortcut on the same path as a DOM node with no cache + id = isNode ? elem[ internalKey ] : elem[ internalKey ] && internalKey; + + // Avoid doing any more work than we need to when trying to get data on an + // object that has no data at all + if ( (!id || !cache[id] || (!pvt && !cache[id].data)) && data === undefined && typeof name === "string" ) { + return; + } + + if ( !id ) { + // Only DOM nodes need a new unique ID for each element since their data + // ends up in the global cache + if ( isNode ) { + id = elem[ internalKey ] = deletedIds.pop() || jQuery.guid++; + } else { + id = internalKey; + } + } + + if ( !cache[ id ] ) { + // Avoid exposing jQuery metadata on plain JS objects when the object + // is serialized using JSON.stringify + cache[ id ] = isNode ? {} : { toJSON: jQuery.noop }; + } + + // An object can be passed to jQuery.data instead of a key/value pair; this gets + // shallow copied over onto the existing cache + if ( typeof name === "object" || typeof name === "function" ) { + if ( pvt ) { + cache[ id ] = jQuery.extend( cache[ id ], name ); + } else { + cache[ id ].data = jQuery.extend( cache[ id ].data, name ); + } + } + + thisCache = cache[ id ]; + + // jQuery data() is stored in a separate object inside the object's internal data + // cache in order to avoid key collisions between internal data and user-defined + // data. + if ( !pvt ) { + if ( !thisCache.data ) { + thisCache.data = {}; + } + + thisCache = thisCache.data; + } + + if ( data !== undefined ) { + thisCache[ jQuery.camelCase( name ) ] = data; + } + + // Check for both converted-to-camel and non-converted data property names + // If a data property was specified + if ( typeof name === "string" ) { + + // First Try to find as-is property data + ret = thisCache[ name ]; + + // Test for null|undefined property data + if ( ret == null ) { + + // Try to find the camelCased property + ret = thisCache[ jQuery.camelCase( name ) ]; + } + } else { + ret = thisCache; + } + + return ret; +} + +function internalRemoveData( elem, name, pvt ) { + if ( !jQuery.acceptData( elem ) ) { + return; + } + + var thisCache, i, + isNode = elem.nodeType, + + // See jQuery.data for more information + cache = isNode ? jQuery.cache : elem, + id = isNode ? elem[ jQuery.expando ] : jQuery.expando; + + // If there is already no cache entry for this object, there is no + // purpose in continuing + if ( !cache[ id ] ) { + return; + } + + if ( name ) { + + thisCache = pvt ? cache[ id ] : cache[ id ].data; + + if ( thisCache ) { + + // Support array or space separated string names for data keys + if ( !jQuery.isArray( name ) ) { + + // try the string as a key before any manipulation + if ( name in thisCache ) { + name = [ name ]; + } else { + + // split the camel cased version by spaces unless a key with the spaces exists + name = jQuery.camelCase( name ); + if ( name in thisCache ) { + name = [ name ]; + } else { + name = name.split(" "); + } + } + } else { + // If "name" is an array of keys... + // When data is initially created, via ("key", "val") signature, + // keys will be converted to camelCase. + // Since there is no way to tell _how_ a key was added, remove + // both plain key and camelCase key. #12786 + // This will only penalize the array argument path. + name = name.concat( jQuery.map( name, jQuery.camelCase ) ); + } + + i = name.length; + while ( i-- ) { + delete thisCache[ name[i] ]; + } + + // If there is no data left in the cache, we want to continue + // and let the cache object itself get destroyed + if ( pvt ? !isEmptyDataObject(thisCache) : !jQuery.isEmptyObject(thisCache) ) { + return; + } + } + } + + // See jQuery.data for more information + if ( !pvt ) { + delete cache[ id ].data; + + // Don't destroy the parent cache unless the internal data object + // had been the only thing left in it + if ( !isEmptyDataObject( cache[ id ] ) ) { + return; + } + } + + // Destroy the cache + if ( isNode ) { + jQuery.cleanData( [ elem ], true ); + + // Use delete when supported for expandos or `cache` is not a window per isWindow (#10080) + /* jshint eqeqeq: false */ + } else if ( support.deleteExpando || cache != cache.window ) { + /* jshint eqeqeq: true */ + delete cache[ id ]; + + // When all else fails, null + } else { + cache[ id ] = null; + } +} + +jQuery.extend({ + cache: {}, + + // The following elements (space-suffixed to avoid Object.prototype collisions) + // throw uncatchable exceptions if you attempt to set expando properties + noData: { + "applet ": true, + "embed ": true, + // ...but Flash objects (which have this classid) *can* handle expandos + "object ": "clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" + }, + + hasData: function( elem ) { + elem = elem.nodeType ? jQuery.cache[ elem[jQuery.expando] ] : elem[ jQuery.expando ]; + return !!elem && !isEmptyDataObject( elem ); + }, + + data: function( elem, name, data ) { + return internalData( elem, name, data ); + }, + + removeData: function( elem, name ) { + return internalRemoveData( elem, name ); + }, + + // For internal use only. + _data: function( elem, name, data ) { + return internalData( elem, name, data, true ); + }, + + _removeData: function( elem, name ) { + return internalRemoveData( elem, name, true ); + } +}); + +jQuery.fn.extend({ + data: function( key, value ) { + var i, name, data, + elem = this[0], + attrs = elem && elem.attributes; + + // Special expections of .data basically thwart jQuery.access, + // so implement the relevant behavior ourselves + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = jQuery.data( elem ); + + if ( elem.nodeType === 1 && !jQuery._data( elem, "parsedAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE11+ + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = jQuery.camelCase( name.slice(5) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + jQuery._data( elem, "parsedAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each(function() { + jQuery.data( this, key ); + }); + } + + return arguments.length > 1 ? + + // Sets one value + this.each(function() { + jQuery.data( this, key, value ); + }) : + + // Gets one value + // Try to fetch any internally stored data first + elem ? dataAttr( elem, key, jQuery.data( elem, key ) ) : undefined; + }, + + removeData: function( key ) { + return this.each(function() { + jQuery.removeData( this, key ); + }); + } +}); + + +jQuery.extend({ + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = jQuery._data( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || jQuery.isArray(data) ) { + queue = jQuery._data( elem, type, jQuery.makeArray(data) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // not intended for public consumption - generates a queueHooks object, or returns the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return jQuery._data( elem, key ) || jQuery._data( elem, key, { + empty: jQuery.Callbacks("once memory").add(function() { + jQuery._removeData( elem, type + "queue" ); + jQuery._removeData( elem, key ); + }) + }); + } +}); + +jQuery.fn.extend({ + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[0], type ); + } + + return data === undefined ? + this : + this.each(function() { + var queue = jQuery.queue( this, type, data ); + + // ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[0] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + }); + }, + dequeue: function( type ) { + return this.each(function() { + jQuery.dequeue( this, type ); + }); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = jQuery._data( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +}); +var pnum = (/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/).source; + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var isHidden = function( elem, el ) { + // isHidden might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + return jQuery.css( elem, "display" ) === "none" || !jQuery.contains( elem.ownerDocument, elem ); + }; + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = jQuery.access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + length = elems.length, + bulk = key == null; + + // Sets many values + if ( jQuery.type( key ) === "object" ) { + chainable = true; + for ( i in key ) { + jQuery.access( elems, fn, i, key[i], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !jQuery.isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < length; i++ ) { + fn( elems[i], key, raw ? value : value.call( elems[i], i, fn( elems[i], key ) ) ); + } + } + } + + return chainable ? + elems : + + // Gets + bulk ? + fn.call( elems ) : + length ? fn( elems[0], key ) : emptyGet; +}; +var rcheckableType = (/^(?:checkbox|radio)$/i); + + + +(function() { + // Minified: var a,b,c + var input = document.createElement( "input" ), + div = document.createElement( "div" ), + fragment = document.createDocumentFragment(); + + // Setup + div.innerHTML = "
a"; + + // IE strips leading whitespace when .innerHTML is used + support.leadingWhitespace = div.firstChild.nodeType === 3; + + // Make sure that tbody elements aren't automatically inserted + // IE will insert them into empty tables + support.tbody = !div.getElementsByTagName( "tbody" ).length; + + // Make sure that link elements get serialized correctly by innerHTML + // This requires a wrapper element in IE + support.htmlSerialize = !!div.getElementsByTagName( "link" ).length; + + // Makes sure cloning an html5 element does not cause problems + // Where outerHTML is undefined, this still works + support.html5Clone = + document.createElement( "nav" ).cloneNode( true ).outerHTML !== "<:nav>"; + + // Check if a disconnected checkbox will retain its checked + // value of true after appended to the DOM (IE6/7) + input.type = "checkbox"; + input.checked = true; + fragment.appendChild( input ); + support.appendChecked = input.checked; + + // Make sure textarea (and checkbox) defaultValue is properly cloned + // Support: IE6-IE11+ + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // #11217 - WebKit loses check when the name is after the checked attribute + fragment.appendChild( div ); + div.innerHTML = ""; + + // Support: Safari 5.1, iOS 5.1, Android 4.x, Android 2.3 + // old WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE<9 + // Opera does not clone events (and typeof div.attachEvent === undefined). + // IE9-10 clones events bound via attachEvent, but they don't trigger with .click() + support.noCloneEvent = true; + if ( div.attachEvent ) { + div.attachEvent( "onclick", function() { + support.noCloneEvent = false; + }); + + div.cloneNode( true ).click(); + } + + // Execute the test only if not already executed in another module. + if (support.deleteExpando == null) { + // Support: IE<9 + support.deleteExpando = true; + try { + delete div.test; + } catch( e ) { + support.deleteExpando = false; + } + } +})(); + + +(function() { + var i, eventName, + div = document.createElement( "div" ); + + // Support: IE<9 (lack submit/change bubble), Firefox 23+ (lack focusin event) + for ( i in { submit: true, change: true, focusin: true }) { + eventName = "on" + i; + + if ( !(support[ i + "Bubbles" ] = eventName in window) ) { + // Beware of CSP restrictions (https://developer.mozilla.org/en/Security/CSP) + div.setAttribute( eventName, "t" ); + support[ i + "Bubbles" ] = div.attributes[ eventName ].expando === false; + } + } + + // Null elements to avoid leaks in IE. + div = null; +})(); + + +var rformElems = /^(?:input|select|textarea)$/i, + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu)|click/, + rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)$/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + var tmp, events, t, handleObjIn, + special, eventHandle, handleObj, + handlers, type, namespaces, origType, + elemData = jQuery._data( elem ); + + // Don't attach events to noData or text/comment nodes (but allow plain objects) + if ( !elemData ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !(events = elemData.events) ) { + events = elemData.events = {}; + } + if ( !(eventHandle = elemData.handle) ) { + eventHandle = elemData.handle = function( e ) { + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== strundefined && (!e || jQuery.event.triggered !== e.type) ? + jQuery.event.dispatch.apply( eventHandle.elem, arguments ) : + undefined; + }; + // Add elem as a property of the handle fn to prevent a memory leak with IE non-native events + eventHandle.elem = elem; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnotwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[t] ) || []; + type = origType = tmp[1]; + namespaces = ( tmp[2] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend({ + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join(".") + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !(handlers = events[ type ]) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener/attachEvent if the special events handler returns false + if ( !special.setup || special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + // Bind the global event handler to the element + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle, false ); + + } else if ( elem.attachEvent ) { + elem.attachEvent( "on" + type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + // Nullify elem to prevent memory leaks in IE + elem = null; + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + var j, handleObj, tmp, + origCount, t, events, + special, handlers, type, + namespaces, origType, + elemData = jQuery.hasData( elem ) && jQuery._data( elem ); + + if ( !elemData || !(events = elemData.events) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnotwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[t] ) || []; + type = origType = tmp[1]; + namespaces = ( tmp[2] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[2] && new RegExp( "(^|\\.)" + namespaces.join("\\.(?:.*\\.|)") + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + delete elemData.handle; + + // removeData also checks for emptiness and clears the expando if empty + // so use it instead of delete + jQuery._removeData( elem, "events" ); + } + }, + + trigger: function( event, data, elem, onlyHandlers ) { + var handle, ontype, cur, + bubbleType, special, tmp, i, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split(".") : []; + + cur = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf(".") >= 0 ) { + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split("."); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf(":") < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join("."); + event.namespace_re = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join("\\.(?:.*\\.|)") + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !jQuery.isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === (elem.ownerDocument || document) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( (cur = eventPath[i++]) && !event.isPropagationStopped() ) { + + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( jQuery._data( cur, "events" ) || {} )[ event.type ] && jQuery._data( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && jQuery.acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( (!special._default || special._default.apply( eventPath.pop(), data ) === false) && + jQuery.acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name name as the event. + // Can't use an .isFunction() check here because IE6/7 fails that test. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && elem[ type ] && !jQuery.isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + try { + elem[ type ](); + } catch ( e ) { + // IE<9 dies on focus/blur to hidden element (#1486,#12518) + // only reproducible on winXP IE8 native, not IE9 in IE8 mode + } + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + dispatch: function( event ) { + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( event ); + + var i, ret, handleObj, matched, j, + handlerQueue = [], + args = slice.call( arguments ), + handlers = ( jQuery._data( this, "events" ) || {} )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[0] = event; + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( (matched = handlerQueue[ i++ ]) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( (handleObj = matched.handlers[ j++ ]) && !event.isImmediatePropagationStopped() ) { + + // Triggered event must either 1) have no namespace, or + // 2) have namespace(s) a subset or equal to those in the bound event (both can have no namespace). + if ( !event.namespace_re || event.namespace_re.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( (jQuery.event.special[ handleObj.origType ] || {}).handle || handleObj.handler ) + .apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( (event.result = ret) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var sel, handleObj, matches, i, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + // Black-hole SVG instance trees (#13180) + // Avoid non-left-click bubbling in Firefox (#3861) + if ( delegateCount && cur.nodeType && (!event.button || event.type !== "click") ) { + + /* jshint eqeqeq: false */ + for ( ; cur != this; cur = cur.parentNode || this ) { + /* jshint eqeqeq: true */ + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && (cur.disabled !== true || event.type !== "click") ) { + matches = []; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matches[ sel ] === undefined ) { + matches[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) >= 0 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matches[ sel ] ) { + matches.push( handleObj ); + } + } + if ( matches.length ) { + handlerQueue.push({ elem: cur, handlers: matches }); + } + } + } + } + + // Add the remaining (directly-bound) handlers + if ( delegateCount < handlers.length ) { + handlerQueue.push({ elem: this, handlers: handlers.slice( delegateCount ) }); + } + + return handlerQueue; + }, + + fix: function( event ) { + if ( event[ jQuery.expando ] ) { + return event; + } + + // Create a writable copy of the event object and normalize some properties + var i, prop, copy, + type = event.type, + originalEvent = event, + fixHook = this.fixHooks[ type ]; + + if ( !fixHook ) { + this.fixHooks[ type ] = fixHook = + rmouseEvent.test( type ) ? this.mouseHooks : + rkeyEvent.test( type ) ? this.keyHooks : + {}; + } + copy = fixHook.props ? this.props.concat( fixHook.props ) : this.props; + + event = new jQuery.Event( originalEvent ); + + i = copy.length; + while ( i-- ) { + prop = copy[ i ]; + event[ prop ] = originalEvent[ prop ]; + } + + // Support: IE<9 + // Fix target property (#1925) + if ( !event.target ) { + event.target = originalEvent.srcElement || document; + } + + // Support: Chrome 23+, Safari? + // Target should not be a text node (#504, #13143) + if ( event.target.nodeType === 3 ) { + event.target = event.target.parentNode; + } + + // Support: IE<9 + // For mouse/key events, metaKey==false if it's undefined (#3368, #11328) + event.metaKey = !!event.metaKey; + + return fixHook.filter ? fixHook.filter( event, originalEvent ) : event; + }, + + // Includes some event props shared by KeyEvent and MouseEvent + props: "altKey bubbles cancelable ctrlKey currentTarget eventPhase metaKey relatedTarget shiftKey target timeStamp view which".split(" "), + + fixHooks: {}, + + keyHooks: { + props: "char charCode key keyCode".split(" "), + filter: function( event, original ) { + + // Add which for key events + if ( event.which == null ) { + event.which = original.charCode != null ? original.charCode : original.keyCode; + } + + return event; + } + }, + + mouseHooks: { + props: "button buttons clientX clientY fromElement offsetX offsetY pageX pageY screenX screenY toElement".split(" "), + filter: function( event, original ) { + var body, eventDoc, doc, + button = original.button, + fromElement = original.fromElement; + + // Calculate pageX/Y if missing and clientX/Y available + if ( event.pageX == null && original.clientX != null ) { + eventDoc = event.target.ownerDocument || document; + doc = eventDoc.documentElement; + body = eventDoc.body; + + event.pageX = original.clientX + ( doc && doc.scrollLeft || body && body.scrollLeft || 0 ) - ( doc && doc.clientLeft || body && body.clientLeft || 0 ); + event.pageY = original.clientY + ( doc && doc.scrollTop || body && body.scrollTop || 0 ) - ( doc && doc.clientTop || body && body.clientTop || 0 ); + } + + // Add relatedTarget, if necessary + if ( !event.relatedTarget && fromElement ) { + event.relatedTarget = fromElement === event.target ? original.toElement : fromElement; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + // Note: button is not normalized, so don't use it + if ( !event.which && button !== undefined ) { + event.which = ( button & 1 ? 1 : ( button & 2 ? 3 : ( button & 4 ? 2 : 0 ) ) ); + } + + return event; + } + }, + + special: { + load: { + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + focus: { + // Fire native event if possible so blur/focus sequence is correct + trigger: function() { + if ( this !== safeActiveElement() && this.focus ) { + try { + this.focus(); + return false; + } catch ( e ) { + // Support: IE<9 + // If we error on focus to hidden element (#1486, #12518), + // let .trigger() run the handlers + } + } + }, + delegateType: "focusin" + }, + blur: { + trigger: function() { + if ( this === safeActiveElement() && this.blur ) { + this.blur(); + return false; + } + }, + delegateType: "focusout" + }, + click: { + // For checkbox, fire native event so checked state will be right + trigger: function() { + if ( jQuery.nodeName( this, "input" ) && this.type === "checkbox" && this.click ) { + this.click(); + return false; + } + }, + + // For cross-browser consistency, don't fire native .click() on links + _default: function( event ) { + return jQuery.nodeName( event.target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + }, + + simulate: function( type, elem, event, bubble ) { + // Piggyback on a donor event to simulate a different one. + // Fake originalEvent to avoid donor's stopPropagation, but if the + // simulated event prevents default then we do the same on the donor. + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true, + originalEvent: {} + } + ); + if ( bubble ) { + jQuery.event.trigger( e, null, elem ); + } else { + jQuery.event.dispatch.call( elem, e ); + } + if ( e.isDefaultPrevented() ) { + event.preventDefault(); + } + } +}; + +jQuery.removeEvent = document.removeEventListener ? + function( elem, type, handle ) { + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle, false ); + } + } : + function( elem, type, handle ) { + var name = "on" + type; + + if ( elem.detachEvent ) { + + // #8545, #7054, preventing memory leaks for custom events in IE6-8 + // detachEvent needed property on element, by name of that event, to properly expose it to GC + if ( typeof elem[ name ] === strundefined ) { + elem[ name ] = null; + } + + elem.detachEvent( name, handle ); + } + }; + +jQuery.Event = function( src, props ) { + // Allow instantiation without the 'new' keyword + if ( !(this instanceof jQuery.Event) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + // Support: IE < 9, Android < 4.0 + src.returnValue === false ? + returnTrue : + returnFalse; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || jQuery.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// http://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + if ( !e ) { + return; + } + + // If preventDefault exists, run it on the original event + if ( e.preventDefault ) { + e.preventDefault(); + + // Support: IE + // Otherwise set the returnValue property of the original event to false + } else { + e.returnValue = false; + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + if ( !e ) { + return; + } + // If stopPropagation exists, run it on the original event + if ( e.stopPropagation ) { + e.stopPropagation(); + } + + // Support: IE + // Set the cancelBubble property of the original event to true + e.cancelBubble = true; + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && e.stopImmediatePropagation ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Create mouseenter/leave events using mouseover/out and event-time checks +jQuery.each({ + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mousenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || (related !== target && !jQuery.contains( target, related )) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +}); + +// IE submit delegation +if ( !support.submitBubbles ) { + + jQuery.event.special.submit = { + setup: function() { + // Only need this for delegated form submit events + if ( jQuery.nodeName( this, "form" ) ) { + return false; + } + + // Lazy-add a submit handler when a descendant form may potentially be submitted + jQuery.event.add( this, "click._submit keypress._submit", function( e ) { + // Node name check avoids a VML-related crash in IE (#9807) + var elem = e.target, + form = jQuery.nodeName( elem, "input" ) || jQuery.nodeName( elem, "button" ) ? elem.form : undefined; + if ( form && !jQuery._data( form, "submitBubbles" ) ) { + jQuery.event.add( form, "submit._submit", function( event ) { + event._submit_bubble = true; + }); + jQuery._data( form, "submitBubbles", true ); + } + }); + // return undefined since we don't need an event listener + }, + + postDispatch: function( event ) { + // If form was submitted by the user, bubble the event up the tree + if ( event._submit_bubble ) { + delete event._submit_bubble; + if ( this.parentNode && !event.isTrigger ) { + jQuery.event.simulate( "submit", this.parentNode, event, true ); + } + } + }, + + teardown: function() { + // Only need this for delegated form submit events + if ( jQuery.nodeName( this, "form" ) ) { + return false; + } + + // Remove delegated handlers; cleanData eventually reaps submit handlers attached above + jQuery.event.remove( this, "._submit" ); + } + }; +} + +// IE change delegation and checkbox/radio fix +if ( !support.changeBubbles ) { + + jQuery.event.special.change = { + + setup: function() { + + if ( rformElems.test( this.nodeName ) ) { + // IE doesn't fire change on a check/radio until blur; trigger it on click + // after a propertychange. Eat the blur-change in special.change.handle. + // This still fires onchange a second time for check/radio after blur. + if ( this.type === "checkbox" || this.type === "radio" ) { + jQuery.event.add( this, "propertychange._change", function( event ) { + if ( event.originalEvent.propertyName === "checked" ) { + this._just_changed = true; + } + }); + jQuery.event.add( this, "click._change", function( event ) { + if ( this._just_changed && !event.isTrigger ) { + this._just_changed = false; + } + // Allow triggered, simulated change events (#11500) + jQuery.event.simulate( "change", this, event, true ); + }); + } + return false; + } + // Delegated event; lazy-add a change handler on descendant inputs + jQuery.event.add( this, "beforeactivate._change", function( e ) { + var elem = e.target; + + if ( rformElems.test( elem.nodeName ) && !jQuery._data( elem, "changeBubbles" ) ) { + jQuery.event.add( elem, "change._change", function( event ) { + if ( this.parentNode && !event.isSimulated && !event.isTrigger ) { + jQuery.event.simulate( "change", this.parentNode, event, true ); + } + }); + jQuery._data( elem, "changeBubbles", true ); + } + }); + }, + + handle: function( event ) { + var elem = event.target; + + // Swallow native change events from checkbox/radio, we already triggered them above + if ( this !== elem || event.isSimulated || event.isTrigger || (elem.type !== "radio" && elem.type !== "checkbox") ) { + return event.handleObj.handler.apply( this, arguments ); + } + }, + + teardown: function() { + jQuery.event.remove( this, "._change" ); + + return !rformElems.test( this.nodeName ); + } + }; +} + +// Create "bubbling" focus and blur events +if ( !support.focusinBubbles ) { + jQuery.each({ focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ), true ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + var doc = this.ownerDocument || this, + attaches = jQuery._data( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + jQuery._data( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this, + attaches = jQuery._data( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + jQuery._removeData( doc, fix ); + } else { + jQuery._data( doc, fix, attaches ); + } + } + }; + }); +} + +jQuery.fn.extend({ + + on: function( types, selector, data, fn, /*INTERNAL*/ one ) { + var type, origFn; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + this.on( type, selector, data, types[ type ], one ); + } + return this; + } + + if ( data == null && fn == null ) { + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return this; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return this.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + }); + }, + one: function( types, selector, data, fn ) { + return this.on( types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? handleObj.origType + "." + handleObj.namespace : handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each(function() { + jQuery.event.remove( this, types, fn, selector ); + }); + }, + + trigger: function( type, data ) { + return this.each(function() { + jQuery.event.trigger( type, data, this ); + }); + }, + triggerHandler: function( type, data ) { + var elem = this[0]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +}); + + +function createSafeFragment( document ) { + var list = nodeNames.split( "|" ), + safeFrag = document.createDocumentFragment(); + + if ( safeFrag.createElement ) { + while ( list.length ) { + safeFrag.createElement( + list.pop() + ); + } + } + return safeFrag; +} + +var nodeNames = "abbr|article|aside|audio|bdi|canvas|data|datalist|details|figcaption|figure|footer|" + + "header|hgroup|mark|meter|nav|output|progress|section|summary|time|video", + rinlinejQuery = / jQuery\d+="(?:null|\d+)"/g, + rnoshimcache = new RegExp("<(?:" + nodeNames + ")[\\s/>]", "i"), + rleadingWhitespace = /^\s+/, + rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi, + rtagName = /<([\w:]+)/, + rtbody = /\s*$/g, + + // We have to close these tags to support XHTML (#13200) + wrapMap = { + option: [ 1, "" ], + legend: [ 1, "
", "
" ], + area: [ 1, "", "" ], + param: [ 1, "", "" ], + thead: [ 1, "", "
" ], + tr: [ 2, "", "
" ], + col: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + // IE6-8 can't serialize link, script, style, or any html5 (NoScope) tags, + // unless wrapped in a div with non-breaking characters in front of it. + _default: support.htmlSerialize ? [ 0, "", "" ] : [ 1, "X
", "
" ] + }, + safeFragment = createSafeFragment( document ), + fragmentDiv = safeFragment.appendChild( document.createElement("div") ); + +wrapMap.optgroup = wrapMap.option; +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +function getAll( context, tag ) { + var elems, elem, + i = 0, + found = typeof context.getElementsByTagName !== strundefined ? context.getElementsByTagName( tag || "*" ) : + typeof context.querySelectorAll !== strundefined ? context.querySelectorAll( tag || "*" ) : + undefined; + + if ( !found ) { + for ( found = [], elems = context.childNodes || context; (elem = elems[i]) != null; i++ ) { + if ( !tag || jQuery.nodeName( elem, tag ) ) { + found.push( elem ); + } else { + jQuery.merge( found, getAll( elem, tag ) ); + } + } + } + + return tag === undefined || tag && jQuery.nodeName( context, tag ) ? + jQuery.merge( [ context ], found ) : + found; +} + +// Used in buildFragment, fixes the defaultChecked property +function fixDefaultChecked( elem ) { + if ( rcheckableType.test( elem.type ) ) { + elem.defaultChecked = elem.checked; + } +} + +// Support: IE<8 +// Manipulating tables requires a tbody +function manipulationTarget( elem, content ) { + return jQuery.nodeName( elem, "table" ) && + jQuery.nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ? + + elem.getElementsByTagName("tbody")[0] || + elem.appendChild( elem.ownerDocument.createElement("tbody") ) : + elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = (jQuery.find.attr( elem, "type" ) !== null) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + var match = rscriptTypeMasked.exec( elem.type ); + if ( match ) { + elem.type = match[1]; + } else { + elem.removeAttribute("type"); + } + return elem; +} + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var elem, + i = 0; + for ( ; (elem = elems[i]) != null; i++ ) { + jQuery._data( elem, "globalEval", !refElements || jQuery._data( refElements[i], "globalEval" ) ); + } +} + +function cloneCopyEvent( src, dest ) { + + if ( dest.nodeType !== 1 || !jQuery.hasData( src ) ) { + return; + } + + var type, i, l, + oldData = jQuery._data( src ), + curData = jQuery._data( dest, oldData ), + events = oldData.events; + + if ( events ) { + delete curData.handle; + curData.events = {}; + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + + // make the cloned public data object a copy from the original + if ( curData.data ) { + curData.data = jQuery.extend( {}, curData.data ); + } +} + +function fixCloneNodeIssues( src, dest ) { + var nodeName, e, data; + + // We do not need to do anything for non-Elements + if ( dest.nodeType !== 1 ) { + return; + } + + nodeName = dest.nodeName.toLowerCase(); + + // IE6-8 copies events bound via attachEvent when using cloneNode. + if ( !support.noCloneEvent && dest[ jQuery.expando ] ) { + data = jQuery._data( dest ); + + for ( e in data.events ) { + jQuery.removeEvent( dest, e, data.handle ); + } + + // Event data gets referenced instead of copied if the expando gets copied too + dest.removeAttribute( jQuery.expando ); + } + + // IE blanks contents when cloning scripts, and tries to evaluate newly-set text + if ( nodeName === "script" && dest.text !== src.text ) { + disableScript( dest ).text = src.text; + restoreScript( dest ); + + // IE6-10 improperly clones children of object elements using classid. + // IE10 throws NoModificationAllowedError if parent is null, #12132. + } else if ( nodeName === "object" ) { + if ( dest.parentNode ) { + dest.outerHTML = src.outerHTML; + } + + // This path appears unavoidable for IE9. When cloning an object + // element in IE9, the outerHTML strategy above is not sufficient. + // If the src has innerHTML and the destination does not, + // copy the src.innerHTML into the dest.innerHTML. #10324 + if ( support.html5Clone && ( src.innerHTML && !jQuery.trim(dest.innerHTML) ) ) { + dest.innerHTML = src.innerHTML; + } + + } else if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + // IE6-8 fails to persist the checked state of a cloned checkbox + // or radio button. Worse, IE6-7 fail to give the cloned element + // a checked appearance if the defaultChecked value isn't also set + + dest.defaultChecked = dest.checked = src.checked; + + // IE6-7 get confused and end up setting the value of a cloned + // checkbox/radio button to an empty string instead of "on" + if ( dest.value !== src.value ) { + dest.value = src.value; + } + + // IE6-8 fails to return the selected option to the default selected + // state when cloning options + } else if ( nodeName === "option" ) { + dest.defaultSelected = dest.selected = src.defaultSelected; + + // IE6-8 fails to set the defaultValue to the correct value when + // cloning other types of input fields + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +jQuery.extend({ + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var destElements, node, clone, i, srcElements, + inPage = jQuery.contains( elem.ownerDocument, elem ); + + if ( support.html5Clone || jQuery.isXMLDoc(elem) || !rnoshimcache.test( "<" + elem.nodeName + ">" ) ) { + clone = elem.cloneNode( true ); + + // IE<=8 does not properly clone detached, unknown element nodes + } else { + fragmentDiv.innerHTML = elem.outerHTML; + fragmentDiv.removeChild( clone = fragmentDiv.firstChild ); + } + + if ( (!support.noCloneEvent || !support.noCloneChecked) && + (elem.nodeType === 1 || elem.nodeType === 11) && !jQuery.isXMLDoc(elem) ) { + + // We eschew Sizzle here for performance reasons: http://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + // Fix all IE cloning issues + for ( i = 0; (node = srcElements[i]) != null; ++i ) { + // Ensure that the destination node is not null; Fixes #9587 + if ( destElements[i] ) { + fixCloneNodeIssues( node, destElements[i] ); + } + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0; (node = srcElements[i]) != null; i++ ) { + cloneCopyEvent( node, destElements[i] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + destElements = srcElements = node = null; + + // Return the cloned set + return clone; + }, + + buildFragment: function( elems, context, scripts, selection ) { + var j, elem, contains, + tmp, tag, tbody, wrap, + l = elems.length, + + // Ensure a safe fragment + safe = createSafeFragment( context ), + + nodes = [], + i = 0; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( jQuery.type( elem ) === "object" ) { + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || safe.appendChild( context.createElement("div") ); + + // Deserialize a standard representation + tag = (rtagName.exec( elem ) || [ "", "" ])[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + + tmp.innerHTML = wrap[1] + elem.replace( rxhtmlTag, "<$1>" ) + wrap[2]; + + // Descend through wrappers to the right content + j = wrap[0]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Manually add leading whitespace removed by IE + if ( !support.leadingWhitespace && rleadingWhitespace.test( elem ) ) { + nodes.push( context.createTextNode( rleadingWhitespace.exec( elem )[0] ) ); + } + + // Remove IE's autoinserted from table fragments + if ( !support.tbody ) { + + // String was a , *may* have spurious + elem = tag === "table" && !rtbody.test( elem ) ? + tmp.firstChild : + + // String was a bare or + wrap[1] === "
" && !rtbody.test( elem ) ? + tmp : + 0; + + j = elem && elem.childNodes.length; + while ( j-- ) { + if ( jQuery.nodeName( (tbody = elem.childNodes[j]), "tbody" ) && !tbody.childNodes.length ) { + elem.removeChild( tbody ); + } + } + } + + jQuery.merge( nodes, tmp.childNodes ); + + // Fix #12392 for WebKit and IE > 9 + tmp.textContent = ""; + + // Fix #12392 for oldIE + while ( tmp.firstChild ) { + tmp.removeChild( tmp.firstChild ); + } + + // Remember the top-level container for proper cleanup + tmp = safe.lastChild; + } + } + } + + // Fix #11356: Clear elements from fragment + if ( tmp ) { + safe.removeChild( tmp ); + } + + // Reset defaultChecked for any radios and checkboxes + // about to be appended to the DOM in IE 6/7 (#8060) + if ( !support.appendChecked ) { + jQuery.grep( getAll( nodes, "input" ), fixDefaultChecked ); + } + + i = 0; + while ( (elem = nodes[ i++ ]) ) { + + // #4087 - If origin and destination elements are the same, and this is + // that element, do not do anything + if ( selection && jQuery.inArray( elem, selection ) !== -1 ) { + continue; + } + + contains = jQuery.contains( elem.ownerDocument, elem ); + + // Append to fragment + tmp = getAll( safe.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( contains ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( (elem = tmp[ j++ ]) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + tmp = null; + + return safe; + }, + + cleanData: function( elems, /* internal */ acceptData ) { + var elem, type, id, data, + i = 0, + internalKey = jQuery.expando, + cache = jQuery.cache, + deleteExpando = support.deleteExpando, + special = jQuery.event.special; + + for ( ; (elem = elems[i]) != null; i++ ) { + if ( acceptData || jQuery.acceptData( elem ) ) { + + id = elem[ internalKey ]; + data = id && cache[ id ]; + + if ( data ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Remove cache only if it was not already removed by jQuery.event.remove + if ( cache[ id ] ) { + + delete cache[ id ]; + + // IE does not allow us to delete expando properties from nodes, + // nor does it have a removeAttribute function on Document nodes; + // we must handle all of these cases + if ( deleteExpando ) { + delete elem[ internalKey ]; + + } else if ( typeof elem.removeAttribute !== strundefined ) { + elem.removeAttribute( internalKey ); + + } else { + elem[ internalKey ] = null; + } + + deletedIds.push( id ); + } + } + } + } + } +}); + +jQuery.fn.extend({ + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().append( ( this[0] && this[0].ownerDocument || document ).createTextNode( value ) ); + }, null, value, arguments.length ); + }, + + append: function() { + return this.domManip( arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + }); + }, + + prepend: function() { + return this.domManip( arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + }); + }, + + before: function() { + return this.domManip( arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + }); + }, + + after: function() { + return this.domManip( arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + }); + }, + + remove: function( selector, keepData /* Internal Use Only */ ) { + var elem, + elems = selector ? jQuery.filter( selector, this ) : this, + i = 0; + + for ( ; (elem = elems[i]) != null; i++ ) { + + if ( !keepData && elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem ) ); + } + + if ( elem.parentNode ) { + if ( keepData && jQuery.contains( elem.ownerDocument, elem ) ) { + setGlobalEval( getAll( elem, "script" ) ); + } + elem.parentNode.removeChild( elem ); + } + } + + return this; + }, + + empty: function() { + var elem, + i = 0; + + for ( ; (elem = this[i]) != null; i++ ) { + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + } + + // Remove any remaining nodes + while ( elem.firstChild ) { + elem.removeChild( elem.firstChild ); + } + + // If this is a select, ensure that it displays empty (#12336) + // Support: IE<9 + if ( elem.options && jQuery.nodeName( elem, "select" ) ) { + elem.options.length = 0; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map(function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + }); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined ) { + return elem.nodeType === 1 ? + elem.innerHTML.replace( rinlinejQuery, "" ) : + undefined; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + ( support.htmlSerialize || !rnoshimcache.test( value ) ) && + ( support.leadingWhitespace || !rleadingWhitespace.test( value ) ) && + !wrapMap[ (rtagName.exec( value ) || [ "", "" ])[ 1 ].toLowerCase() ] ) { + + value = value.replace( rxhtmlTag, "<$1>" ); + + try { + for (; i < l; i++ ) { + // Remove element nodes and prevent memory leaks + elem = this[i] || {}; + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch(e) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var arg = arguments[ 0 ]; + + // Make the changes, replacing each context element with the new content + this.domManip( arguments, function( elem ) { + arg = this.parentNode; + + jQuery.cleanData( getAll( this ) ); + + if ( arg ) { + arg.replaceChild( elem, this ); + } + }); + + // Force removal if there was no new content (e.g., from empty arguments) + return arg && (arg.length || arg.nodeType) ? this : this.remove(); + }, + + detach: function( selector ) { + return this.remove( selector, true ); + }, + + domManip: function( args, callback ) { + + // Flatten any nested arrays + args = concat.apply( [], args ); + + var first, node, hasScripts, + scripts, doc, fragment, + i = 0, + l = this.length, + set = this, + iNoClone = l - 1, + value = args[0], + isFunction = jQuery.isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( isFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return this.each(function( index ) { + var self = set.eq( index ); + if ( isFunction ) { + args[0] = value.call( this, index, self.html() ); + } + self.domManip( args, callback ); + }); + } + + if ( l ) { + fragment = jQuery.buildFragment( args, this[ 0 ].ownerDocument, false, this ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + if ( first ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( this[i], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !jQuery._data( node, "globalEval" ) && jQuery.contains( doc, node ) ) { + + if ( node.src ) { + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl ) { + jQuery._evalUrl( node.src ); + } + } else { + jQuery.globalEval( ( node.text || node.textContent || node.innerHTML || "" ).replace( rcleanScript, "" ) ); + } + } + } + } + + // Fix #11809: Avoid leaking memory + fragment = first = null; + } + } + + return this; + } +}); + +jQuery.each({ + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + i = 0, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone(true); + jQuery( insert[i] )[ original ]( elems ); + + // Modern browsers can apply jQuery collections as arrays, but oldIE needs a .get() + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +}); + + +var iframe, + elemdisplay = {}; + +/** + * Retrieve the actual display of a element + * @param {String} name nodeName of the element + * @param {Object} doc Document object + */ +// Called only from within defaultDisplay +function actualDisplay( name, doc ) { + var style, + elem = jQuery( doc.createElement( name ) ).appendTo( doc.body ), + + // getDefaultComputedStyle might be reliably used only on attached element + display = window.getDefaultComputedStyle && ( style = window.getDefaultComputedStyle( elem[ 0 ] ) ) ? + + // Use of this method is a temporary fix (more like optmization) until something better comes along, + // since it was removed from specification and supported only in FF + style.display : jQuery.css( elem[ 0 ], "display" ); + + // We don't have any data stored on the element, + // so use "detach" method as fast way to get rid of the element + elem.detach(); + + return display; +} + +/** + * Try to determine the default display value of an element + * @param {String} nodeName + */ +function defaultDisplay( nodeName ) { + var doc = document, + display = elemdisplay[ nodeName ]; + + if ( !display ) { + display = actualDisplay( nodeName, doc ); + + // If the simple way fails, read from inside an iframe + if ( display === "none" || !display ) { + + // Use the already-created iframe if possible + iframe = (iframe || jQuery( "